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

仅限输出。如果当前块包含图片,则为图片数据网址。数据网址由四部分组成:前缀 (data:)、指示数据类型的 MIME 类型、可选的 base64 令牌(如果是非文本数据)和数据本身:data:[][;base64],

annotationContents[]

string

仅限输出。如果当前块包含注释,则为注释内容。

annotationMetadata[]

object (AnnotationMetadata)

仅限输出。注解元数据包含当前块中的结构化内容。

relevanceScore

number

仅限输出。表示基于相似性的相关性得分。得分越高,表示块的相关性越高。得分介于 [-1.0, 1.0] 范围内。仅在 SearchResponse 上填充。

方法

get

获取 Document

list

获取 Chunk 的列表。