Chunks

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 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. Nombre del recurso de Chunk. El ID (nombre sin incluir 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 cadena de texto La cantidad máxima de tokens por fragmento es 2,043.

customMetadata[] object (CustomMetadata)

Opcional. Metadatos personalizados proporcionados por el usuario almacenados 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 cuándo se creó Chunk.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una 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 una 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. 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.

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

Método: corpora.documents.chunks.create

Crea un Chunk.

Extremo

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

Parámetros de ruta

parent string

Obligatorio. 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.

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

Muestra una lista de todos los Chunk de una Document.

Extremo

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

Parámetros de ruta

parent string

Obligatorio. Es el 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. La cantidad máxima de elementos Chunk que se mostrarán (por página). Es posible que el servicio muestre menos Chunk.

Si no se especifica, se mostrarán 10 Chunk como máximo. 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 muestra en la respuesta como un argumento para la siguiente solicitud a fin de 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 Chunk. Los elementos Chunk se ordenan de forma ascendente por chunk.create_time.

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

Campos
chunks[] object (Chunk)

Los Chunk que se muestran.

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

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

Parámetros de ruta

name string

Obligatorio. El 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

parche 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. Identificador. Nombre del recurso de Chunk. El ID (nombre sin incluir 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 Toma la forma corpora/{corpora}/documents/{document}/chunks/{chunk}.

Parámetros de consulta

updateMask string (FieldMask format)

Obligatorio. La lista de campos que se deben actualizar. Actualmente, esto solo 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.

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

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

Parámetros de ruta

name string

Obligatorio. 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 está vacío.

Método: corpora.documents.chunks.batchCreate

Crea Chunk por lotes.

Extremo

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

Parámetros de ruta

parent string

Opcional. El nombre del Document en el que se creará este lote de Chunk. El campo superior 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)

Obligatorio. Los mensajes de solicitud que especifican los Chunk que se crearán. Se puede crear un máximo de 100 Chunk en un lote.

Cuerpo de la respuesta

Respuesta de chunks.batchCreate que contiene una lista de las Chunk creadas.

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

Campos
chunks[] object (Chunk)

Se crearon Chunk.

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

CreateChunkRequest

Solicitud para crear un Chunk.

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

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

chunk object (Chunk)

Obligatorio. El Chunk que se creará.

Método: corpora.documents.chunks.method

Actualización por lotes Chunks.

Extremo

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

Parámetros de ruta

parent string

Opcional. Es el nombre del Document que contiene los objetos Chunk que se actualizarán. El campo superior 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)

Obligatorio. Los mensajes de solicitud que especifican los Chunk que se actualizarán. Se puede actualizar un máximo de 100 Chunk en un lote.

Cuerpo de la respuesta

Respuesta de chunks.batchUpdate que contiene una lista de Chunk actualizadas.

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

Solicitud para actualizar un Chunk.

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

Obligatorio. El Chunk que se actualizará.

updateMask string (FieldMask format)

Obligatorio. La lista de campos que se deben actualizar. Actualmente, esto solo 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".

Método: corpora.documents.chunks.batchDelete

Borra Chunk por lotes.

Extremo

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

Parámetros de ruta

parent string

Opcional. El nombre del Document que contiene los Chunk que se borrarán. El campo superior 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)

Obligatorio. 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 está vacío.

DeleteChunkRequest

Solicitud para borrar un Chunk.

Representación JSON 
{
  "name": string
}
Campos
name string

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