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

Recurso: Chunk

El fragmento captura toda la información de metadatos sin procesar de los elementos que se van a recomendar o buscar en el modo de fragmento.

Representación 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

Nombre completo del recurso del fragmento. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}/chunks/{chunk_id}.

Este campo debe ser una cadena codificada en UTF-8 con un límite de 1024 caracteres.
id

string

ID único del fragmento actual.
content

string

Content es una cadena de un documento (contenido analizado).
documentMetadata

object (DocumentMetadata)

Metadatos del documento del fragmento actual.
derivedStructData

object (Struct format)

Solo de salida. Este campo es OUTPUT_ONLY. Contiene datos derivados que no están en el documento de entrada original.
pageSpan

object (PageSpan)

Intervalo de páginas del fragmento.
chunkMetadata

object (ChunkMetadata)

Solo de salida. Metadatos del fragmento actual.
dataUrls[]

string

Solo de salida. URLs de datos de imagen si el fragmento actual contiene imágenes. Las URLs de datos se componen de cuatro partes: un prefijo (data:), un tipo MIME que indica el tipo de datos, un token base64 opcional si no es textual y los datos en sí: data:[][;base64],.
annotationContents[]

string

Solo de salida. Contenido de la anotación si el fragmento actual contiene anotaciones.
annotationMetadata[]

object (AnnotationMetadata)

Solo de salida. Los metadatos de la anotación incluyen contenido estructurado en el fragmento actual.
relevanceScore

number

Solo de salida. Representa la puntuación de relevancia basada en la similitud. Una puntuación más alta indica una mayor relevancia del fragmento. La puntuación está en el intervalo [-1,0, 1,0]. Solo se rellena en SearchResponse.

DocumentMetadata

Los metadatos del documento contienen la información del documento del fragmento actual.

Representación JSON 
{
  "uri": string,
  "title": string,
  "mimeType": string,
  "structData": {
    object
  }
}
Campos
uri

string

URI del documento.
title

string

Título del documento.
mimeType

string

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

object (Struct format)

Representación de datos. Los datos JSON estructurados del documento. Debe ajustarse al Schema registrado o se producirá un error INVALID_ARGUMENT.

PageSpan

Intervalo de páginas del fragmento.

Representación JSON 
{
  "pageStart": integer,
  "pageEnd": integer
}
Campos
pageStart

integer

La página de inicio del fragmento.
pageEnd

integer

La página final del fragmento.

ChunkMetadata

Metadatos del fragmento actual. Este campo solo se rellena en la API SearchService.Search.

Representación JSON 
{
  "previousChunks": [
    {
      object (Chunk)
    }
  ],
  "nextChunks": [
    {
      object (Chunk)
    }
  ]
}
Campos
previousChunks[]

object (Chunk)

Los fragmentos anteriores del fragmento actual. SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks controla el número. Este campo solo se rellena en la API SearchService.Search.
nextChunks[]

object (Chunk)

Los siguientes fragmentos del fragmento actual. SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks controla el número. Este campo solo se rellena en la API SearchService.Search.

AnnotationMetadata

Los metadatos de la anotación incluyen contenido estructurado en el fragmento actual.

Representación JSON 
{
  "structuredContent": {
    object (StructuredContent)
  },
  "imageId": string
}
Campos
structuredContent

object (StructuredContent)

Solo de salida. Información de contenido estructurado.
imageId

string

Solo de salida. El ID de la imagen se proporciona si el contenido estructurado se basa en una imagen.

StructuredContent

Información de contenido estructurado.

Representación JSON 
{
  "structureType": enum (StructureType),
  "content": string
}
Campos
structureType

enum (StructureType)

Solo de salida. El tipo de estructura del contenido estructurado.
content

string

Solo de salida. El contenido del contenido estructurado.

StructureType

Define los tipos de contenido estructurado que se pueden extraer.

Enumeraciones
STRUCTURE_TYPE_UNSPECIFIED Valor predeterminado.
SHAREHOLDER_STRUCTURE Estructura de los accionistas.
SIGNATURE_STRUCTURE estructura de la firma.
CHECKBOX_STRUCTURE Estructura de la casilla.

Métodos

get

 Obtiene un Document.

list

 Obtiene una lista de Chunks.