REST Resource: projects.locations.dataStores.branches.documents.chunks

資源:Chunk

區塊會擷取項目所有原始中繼資料資訊,以便在區塊模式中推薦或搜尋項目。

JSON 表示法
{
  "name": string,
  "id": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "derivedStructData": {
    object
  },
  "pageSpan": {
    object (PageSpan)
  },
  "chunkMetadata": {
    object (ChunkMetadata)
  },
  "dataUrls": [
    string
  ],
  "annotationContents": [
    string
  ],
  "annotationMetadata": [
    {
      object (AnnotationMetadata)
    }
  ],
  "relevanceScore": number
}
欄位
name

string

區塊的完整資源名稱。格式:projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}/chunks/{chunk_id}

這個欄位必須是 UTF-8 編碼的字串,長度上限為 1024 個字元。

id

string

目前區塊的專屬區塊 ID。

content

string

內容是文件中的字串 (已剖析的內容)。

documentMetadata

object (DocumentMetadata)

目前區塊的文件中繼資料。

derivedStructData

object (Struct format)

僅供輸出。這個欄位為 OUTPUT_ONLY。當中包含原始輸入文件中沒有的衍生資料。

pageSpan

object (PageSpan)

區塊的頁面範圍。

chunkMetadata

object (ChunkMetadata)

僅供輸出。目前區塊的中繼資料。

dataUrls[]

string

僅供輸出。如果目前的區塊包含圖片,則為圖片資料網址。資料 URL 由四個部分組成:前置字元 (data:)、指出資料類型的 MIME 類型、非文字資料的選用 base64 權杖,以及資料本身:data:[][;base64],

annotationContents[]

string

僅供輸出。如果目前的區塊包含註解,則為註解內容。

annotationMetadata[]

object (AnnotationMetadata)

僅供輸出。註解中繼資料包含目前區塊中的結構化內容。

relevanceScore

number

僅供輸出。代表根據相似度計算出的關聯性分數。分數越高,表示區塊關聯性越高。分數範圍為 [-1.0, 1.0]。只會在 SearchResponse 上填入。

方法

get

取得 Document

list

取得 Chunk 清單。