REST Resource: corpora.documents.chunks

Recurso: bloque

Un Chunk es una subparte de una Document que se trata como una unidad independiente para fines de representación y almacenamiento de vectores. Un Corpus puede tener un máximo de 1 millón de Chunk.

Representación JSON
{
  "name": string,
  "data": {
    object (ChunkData)
  },
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State)
}
Campos
name

string

Inmutable. Identificador. El nombre del recurso Chunk. El ID (nombre sin el prefijo "corpora/*/documents/*/chunks/") puede contener hasta 40 caracteres alfanuméricos en minúscula o guiones (-). El ID no puede comenzar ni terminar con un guion. Si el nombre está vacío durante la creación, se generará un ID único aleatorio de 12 caracteres. Ejemplo: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data

object (ChunkData)

Obligatorio. El contenido de Chunk, como la string de texto La cantidad máxima de tokens por fragmento es 2,043.

customMetadata[]

object (CustomMetadata)

Opcional. El usuario proporcionó metadatos personalizados que se almacenaron como pares clave-valor. La cantidad máxima de CustomMetadata por fragmento es 20.

createTime

string (Timestamp format)

Solo salida. La marca de tiempo de la creación de Chunk.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Solo salida. La marca de tiempo de la última actualización de Chunk.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

state

enum (State)

Solo salida. Es el estado actual de Chunk.

ChunkData

Datos extraídos que representan el contenido de Chunk.

Representación JSON
{

  // Union field data can be only one of the following:
  "stringValue": string
  // End of list of possible types for union field data.
}
Campos

Campo de unión data.

data puede ser una de las siguientes opciones:

stringValue

string

El contenido de Chunk como una cadena La cantidad máxima de tokens por fragmento es 2,043.

Estado

Estados para el ciclo de vida de un Chunk

Enumeradores
STATE_UNSPECIFIED Es el valor predeterminado. Este valor se usa si se omite el estado.
STATE_PENDING_PROCESSING Se está procesando Chunk (incorporación y almacenamiento vectorial).
STATE_ACTIVE Chunk se procesó y está disponible para realizar consultas.
STATE_FAILED Se produjo un error al procesar Chunk.

Métodos

batchCreate

Crea Chunk por lotes.

batchDelete

Borra Chunk por lotes.

batchUpdate

Actualización por lotes de Chunk.

create

Crea un Chunk.

delete

Borra un Chunk.

get

Obtiene información sobre un Chunk específico.

list

Enumera todos los Chunk en una Document.

patch

Actualiza un objeto Chunk.