Chunks

Método: corpora.documents.chunks.create

Crea un Chunk.

Extremo

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

Parámetros de ruta

parent string

Es obligatorio. Es el nombre del Document en el que se creará este Chunk. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc Toma la forma corpora/{corpora}/documents/{document}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Chunk.

Campos
name string

Inmutable. Es el identificador. Nombre del recurso de 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 en el momento de la creación, se generará un ID único aleatorio de 12 caracteres. Ejemplo: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

Es obligatorio. Es el contenido de Chunk, como la cadena de texto. La cantidad máxima de tokens por fragmento es de 2,043.

customMetadata[] object (CustomMetadata)

Opcional. Son los metadatos personalizados que proporciona el usuario y que se almacenan como pares clave-valor. La cantidad máxima de CustomMetadata por fragmento es 20.

Cuerpo de la respuesta

Si el proceso se realiza de forma correcta, el cuerpo de la respuesta contiene una instancia recién creada de Chunk.

Método: corpora.documents.chunks.list

Enumera todos los Chunk en un Document.

Extremo

get https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

Parámetros de ruta

parent string

Es obligatorio. Nombre del Document que contiene Chunk. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc Toma la forma corpora/{corpora}/documents/{document}.

Parámetros de consulta

pageSize integer

Opcional. Es la cantidad máxima de Chunks que se devolverán (por página). El servicio puede devolver menos objetos Chunk.

Si no se especifica, se devolverán, como máximo, 10 Chunks. El límite de tamaño máximo es de 100 Chunk por página.

pageToken string

Opcional. Un token de página, recibido desde una llamada chunks.list anterior.

Proporciona el nextPageToken que se devolvió en la respuesta como argumento para la siguiente solicitud y, así, recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a chunks.list deben coincidir con la llamada que proporcionó el token de la página.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Respuesta de chunks.list que contiene una lista paginada de Chunks. Los objetos Chunk se ordenan de forma ascendente según chunk.create_time.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Campos
chunks[] object (Chunk)

Son los objetos Chunk que se devolvieron.

nextPageToken string

Un token, que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá más páginas.

Representación JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}

Método: corpora.documents.chunks.get

Obtiene información sobre un Chunk específico.

Extremo

get https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}

Parámetros de ruta

name string

Es obligatorio. Nombre del Chunk que se recuperará. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk Toma la forma corpora/{corpora}/documents/{document}/chunks/{chunk}.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Chunk.

Método: corpora.documents.chunks.patch

Actualiza un Chunk.

Extremo

patch https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

Parámetros de ruta

chunk.name string

Inmutable. Es el identificador. Nombre del recurso de 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 en el momento de la creación, se generará un ID único aleatorio de 12 caracteres. Ejemplo: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c Toma la forma corpora/{corpora}/documents/{document}/chunks/{chunk}.

Parámetros de consulta

updateMask string (FieldMask format)

Es obligatorio. La lista de campos que se deben actualizar. Actualmente, solo se admite la actualización de customMetadata y data.

Esta es una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: "user.displayName,photo".

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Chunk.

Campos
data object (ChunkData)

Es obligatorio. Es el contenido de Chunk, como la cadena de texto. La cantidad máxima de tokens por fragmento es de 2,043.

customMetadata[] object (CustomMetadata)

Opcional. Son los metadatos personalizados que proporciona el usuario y que se almacenan como pares clave-valor. La cantidad máxima de CustomMetadata por fragmento es 20.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Chunk.

Método: corpora.documents.chunks.delete

Borra un Chunk.

Extremo

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}

Parámetros de ruta

name string

Es obligatorio. Es el nombre del recurso del Chunk que se borrará. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk Toma la forma corpora/{corpora}/documents/{document}/chunks/{chunk}.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta es un objeto JSON vacío.

Método: corpora.documents.chunks.batchCreate

Crea Chunks por lotes.

Extremo

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchCreate

Parámetros de ruta

parent string

Opcional. Es el nombre del Document en el que se creará este lote de Chunks. El campo principal de cada CreateChunkRequest debe coincidir con este valor. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc Toma la forma corpora/{corpora}/documents/{document}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Campos
requests[] object (CreateChunkRequest)

Es obligatorio. Son los mensajes de solicitud que especifican los objetos Chunk que se crearán. Se puede crear un máximo de 100 Chunks en un lote.

Cuerpo de la respuesta

Respuesta de chunks.batchCreate que contiene una lista de Chunk creados.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Campos
chunks[] object (Chunk)

Se crearon los Chunk.

Representación JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

CreateChunkRequest

Es la solicitud para crear un Chunk.

Campos
parent string

Es obligatorio. Es el nombre del Document en el que se creará este Chunk. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

Es obligatorio. Es el objeto Chunk que se creará.

Representación JSON 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}

Método: corpora.documents.chunks.batchUpdate

Actualiza Chunks por lotes.

Extremo

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchUpdate

Parámetros de ruta

parent string

Opcional. Nombre del Document que contiene los Chunks que se actualizarán. El campo principal de cada UpdateChunkRequest debe coincidir con este valor. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc Toma la forma corpora/{corpora}/documents/{document}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Campos
requests[] object (UpdateChunkRequest)

Es obligatorio. Son los mensajes de solicitud que especifican los Chunk que se actualizarán. Se puede actualizar un máximo de 100 objetos Chunk en un lote.

Cuerpo de la respuesta

Es la respuesta de chunks.batchUpdate que contiene una lista de objetos Chunk actualizados.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Campos
chunks[] object (Chunk)

Se actualizaron los Chunk.

Representación JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

UpdateChunkRequest

Es la solicitud para actualizar un Chunk.

Campos
chunk object (Chunk)

Es obligatorio. Es el Chunk que se actualizará.

updateMask string (FieldMask format)

Es obligatorio. La lista de campos que se deben actualizar. Actualmente, solo se admite la actualización de customMetadata y data.

Esta es una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: "user.displayName,photo".

Representación JSON 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}

Método: corpora.documents.chunks.batchDelete

Borra Chunks por lotes.

Extremo

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchDelete

Parámetros de ruta

parent string

Opcional. Es el nombre del Document que contiene los Chunks que se borrarán. El campo principal de cada DeleteChunkRequest debe coincidir con este valor. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc Toma la forma corpora/{corpora}/documents/{document}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Campos
requests[] object (DeleteChunkRequest)

Es obligatorio. Son los mensajes de solicitud que especifican los Chunk que se borrarán.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta es un objeto JSON vacío.

DeleteChunkRequest

Es la solicitud para borrar un Chunk.

Campos
name string

Es obligatorio. Es el nombre del recurso del Chunk que se borrará. Ejemplo: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk

Representación JSON 
{
  "name": string
}

Recurso de REST: corpora.documents.chunks

Recurso: Chunk

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

Campos
name string

Inmutable. Es el identificador. Nombre del recurso de 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 en el momento de la creación, se generará un ID único aleatorio de 12 caracteres. Ejemplo: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

Es obligatorio. Es el contenido de Chunk, como la cadena de texto. La cantidad máxima de tokens por fragmento es de 2,043.

customMetadata[] object (CustomMetadata)

Opcional. Son los metadatos personalizados que proporciona el usuario y que se almacenan como pares clave-valor. La cantidad máxima de CustomMetadata por fragmento es 20.

createTime string (Timestamp format)

Solo salida. Es la marca de tiempo de cuándo se creó el Chunk.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

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

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

state enum (State)

Solo salida. Es el estado actual del Chunk.

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

ChunkData

Son los datos extraídos que representan el contenido de Chunk.

Campos
data Union type
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 de 2,043.

Representación JSON 
{

  // data
  "stringValue": string
  // Union type
}

Estado

Estados del ciclo de vida de un Chunk.

Enumeraciones
STATE_UNSPECIFIED Es el valor predeterminado. Este valor se usa si se omite el estado.
STATE_PENDING_PROCESSING Chunk se está procesando (almacenamiento de embeddings y vectores).
STATE_ACTIVE Chunk se procesa y está disponible para consultas.
STATE_FAILED No se pudo procesar Chunk.