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

Ressource : Chunk

Le bloc capture toutes les informations brutes sur les métadonnées des éléments à recommander ou à rechercher en mode bloc.

Représentation 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
}
Champs
name

string

Nom complet de la ressource du bloc. Format : projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}/chunks/{chunk_id}.

Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères.

id

string

ID unique du bloc actuel.

content

string

Le contenu est une chaîne provenant d'un document (contenu analysé).

documentMetadata

object (DocumentMetadata)

Métadonnées du document provenant du bloc actuel.

derivedStructData

object (Struct format)

Uniquement en sortie. Ce champ est OUTPUT_ONLY. Il contient des données dérivées qui ne figurent pas dans le document d'entrée d'origine.

pageSpan

object (PageSpan)

Étendue de la page du bloc.

chunkMetadata

object (ChunkMetadata)

Uniquement en sortie. Métadonnées du bloc actuel.

dataUrls[]

string

Uniquement en sortie. URL des données d'image si le bloc actuel contient des images. Les URL de données se composent de quatre parties : un préfixe (data:), un type MIME indiquant le type de données, un jeton base64 facultatif si les données ne sont pas textuelles et les données elles-mêmes : data:[][;base64],

annotationContents[]

string

Uniquement en sortie. Contenu des annotations si le bloc actuel en contient.

annotationMetadata[]

object (AnnotationMetadata)

Uniquement en sortie. Les métadonnées d'annotation incluent le contenu structuré du bloc actuel.

relevanceScore

number

Uniquement en sortie. Représente le score de pertinence basé sur la similarité. Plus le score est élevé, plus le bloc est pertinent. Le score est compris dans la plage [-1,0, 1,0]. Renseigné uniquement sur SearchResponse.

Méthodes

get

Récupère un Document.

list

Obtient une liste de Chunk.