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

Risorsa: Loschinsetto

La modalità Chunk acquisisce tutte le informazioni sui metadati non elaborati degli elementi da consigliare o cercare.

Rappresentazione 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
}
Campi
name

string

Il nome completo della risorsa del blocco. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}/chunks/{chunk_id}.

Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.
id

string

ID univoco del segmento corrente.
content

string

I contenuti sono una stringa di un documento (contenuti analizzati).
documentMetadata

object (DocumentMetadata)

I metadati del documento del chunk corrente.
derivedStructData

object (Struct format)

Solo output. Questo campo è OUTPUT_ONLY. Contiene dati derivati che non sono presenti nel documento di input originale.
pageSpan

object (PageSpan)

Intervallo di pagine del blocco.
chunkMetadata

object (ChunkMetadata)

Solo output. Metadati del chunk corrente.
dataUrls[]

string

Solo output. URL dei dati delle immagini se il chunk corrente contiene immagini. Gli URL dei dati sono composti da quattro parti: un prefisso (data:), un tipo MIME che indica il tipo di dati, un token base64 facoltativo se non testuale e i dati stessi: data:[][;base64],
annotationContents[]

string

Solo output. Contenuti delle annotazioni se il blocco attuale contiene annotazioni.
annotationMetadata[]

object (AnnotationMetadata)

Solo output. I metadati dell'annotazione includono contenuti strutturati nel chunk corrente.
relevanceScore

number

Solo output. Rappresenta il punteggio di pertinenza basato sulla somiglianza. Un punteggio più alto indica una maggiore pertinenza del segmento. Il punteggio è compreso nell'intervallo [-1,0, 1,0]. Compilato solo su SearchResponse.

DocumentMetadata

I metadati del documento contengono le informazioni del documento del chunk attuale.

Rappresentazione JSON 
{
  "uri": string,
  "title": string,
  "mimeType": string,
  "structData": {
    object
  }
}
Campi
uri

string

L'URI del documento.
title

string

Il titolo del documento.
mimeType

string

Il tipo MIME del documento. https://www.iana.org/assignments/media-types/media-types.xhtml.
structData

object (Struct format)

Rappresentazione dei dati. I dati JSON strutturati per il documento. Deve essere conforme a Schema registrato o viene generato un errore INVALID_ARGUMENT.

PageSpan

Intervallo di pagine del blocco.

Rappresentazione JSON 
{
  "pageStart": integer,
  "pageEnd": integer
}
Campi
pageStart

integer

La pagina iniziale del blocco.
pageEnd

integer

La pagina finale del segmento.

ChunkMetadata

Metadati del chunk corrente. Questo campo viene compilato solo nell'API SearchService.Search.

Rappresentazione JSON 
{
  "previousChunks": [
    {
      object (Chunk)
    }
  ],
  "nextChunks": [
    {
      object (Chunk)
    }
  ]
}
Campi
previousChunks[]

object (Chunk)

I chunk precedenti del chunk corrente. Il numero è controllato da SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. Questo campo viene compilato solo nell'API SearchService.Search.
nextChunks[]

object (Chunk)

I chunk successivi del chunk corrente. Il numero è controllato da SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. Questo campo viene compilato solo nell'API SearchService.Search.

AnnotationMetadata

I metadati dell'annotazione includono contenuti strutturati nel chunk corrente.

Rappresentazione JSON 
{
  "structuredContent": {
    object (StructuredContent)
  },
  "imageId": string
}
Campi
structuredContent

object (StructuredContent)

Solo output. Le informazioni sui contenuti strutturati.
imageId

string

Solo output. L'ID immagine viene fornito se i contenuti strutturati si basano su un'immagine.

StructuredContent

Le informazioni sui contenuti strutturati.

Rappresentazione JSON 
{
  "structureType": enum (StructureType),
  "content": string
}
Campi
structureType

enum (StructureType)

Solo output. Il tipo di struttura dei contenuti strutturati.
content

string

Solo output. Il contenuto dei contenuti strutturati.

StructureType

Definisce i tipi di contenuti strutturati che possono essere estratti.

Enum
STRUCTURE_TYPE_UNSPECIFIED Valore predefinito.
SHAREHOLDER_STRUCTURE Struttura azionaria.
SIGNATURE_STRUCTURE struttura della firma.
CHECKBOX_STRUCTURE Struttura della casella di controllo.

Metodi

get

 Riceve un Document.

list

 Recupera un elenco di Chunk.