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

Recurso: Chunk

O chunk captura todas as informações de metadados brutos de itens a serem recomendados ou pesquisados no modo de chunk.

Representação 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
}
Campos
name

string

O nome completo do recurso do chunk. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}/chunks/{chunk_id}.

Esse campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.

id

string

ID exclusivo do chunk atual.

content

string

O conteúdo é uma string de um documento (conteúdo analisado).

documentMetadata

object (DocumentMetadata)

Metadados do documento do chunk atual.

derivedStructData

object (Struct format)

Apenas saída. Esse campo é OUTPUT_ONLY. Ele contém dados derivados que não estão no documento de entrada original.

pageSpan

object (PageSpan)

Intervalo de páginas do chunk.

chunkMetadata

object (ChunkMetadata)

Apenas saída. Metadados do chunk atual.

dataUrls[]

string

Apenas saída. URLs de dados de imagem se o chunk atual contiver imagens. Os URLs de dados são compostos por quatro partes: um prefixo (data:), um tipo MIME que indica o tipo de dados, um token base64 opcional se não for textual e os dados em si: data:[][;base64],

annotationContents[]

string

Apenas saída. Conteúdo de anotação se o chunk atual contiver anotações.

annotationMetadata[]

object (AnnotationMetadata)

Apenas saída. Os metadados de anotação incluem conteúdo estruturado no chunk atual.

relevanceScore

number

Apenas saída. Representa a pontuação de relevância com base na similaridade. Uma pontuação mais alta indica maior relevância do chunk. A pontuação está no intervalo [-1.0, 1.0]. Preenchido apenas em SearchResponse.

Métodos

get

Recebe um Document.

list

Recebe uma lista de Chunks.