Chunks

Método: corpora.documents.chunks.create

Cria uma Chunk.

Endpoint

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

Parâmetros de caminho

parent string

Obrigatório. O nome do Document em que o Chunk será criado. Exemplo: corpora/my-corpus-123/documents/the-doc-abc. Ele assume a forma corpora/{corpora}/documents/{document}.

Corpo da solicitação

O corpo da solicitação contém uma instância de Chunk.

Campos
name string

Imutável. Identificador. O nome do recurso Chunk. O ID (nome sem o prefixo "corpora/*/documents/*/chunks/") pode conter até 40 caracteres alfanuméricos minúsculos ou traços (-). O ID não pode começar nem terminar com um traço. Se o nome estiver vazio na criação, um ID exclusivo aleatório de 12 caracteres será gerado. Exemplo: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

Obrigatório. O conteúdo do Chunk, como a string de texto. O número máximo de tokens por bloco é 2.043.

customMetadata[] object (CustomMetadata)

Opcional. Metadados personalizados fornecidos pelo usuário armazenados como pares de chave-valor. O número máximo de CustomMetadata por bloco é 20.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta incluirá uma instância de Chunk.

Método: corpora.documents.chunks.list

Lista todos os Chunks em um Document.

Endpoint

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

Parâmetros de caminho

parent string

Obrigatório. O nome do Document que contém Chunks. Exemplo: corpora/my-corpus-123/documents/the-doc-abc. Ele assume a forma corpora/{corpora}/documents/{document}.

Parâmetros de consulta

pageSize integer

Opcional. O número máximo de Chunks a serem retornados (por página). O serviço pode retornar menos Chunks.

Se não for especificado, no máximo 10 Chunks serão retornados. O limite máximo é de 100 Chunks por página.

pageToken string

Opcional. Um token de página recebido de uma chamada chunks.list anterior.

Forneça o nextPageToken retornado na resposta como um argumento para a próxima solicitação e recupere a página seguinte.

Ao paginar, todos os outros parâmetros fornecidos para chunks.list precisam corresponder à chamada que forneceu o token da página.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta de chunks.list contendo uma lista paginada de Chunks. Os Chunks são classificados por chunk.create_time crescente.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Campos
chunks[] object (Chunk)

Os Chunks retornados.

nextPageToken string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá mais páginas.

Representação JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}

Método: corpora.documents.chunks.get

Recebe informações sobre um Chunk específico.

Endpoint

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

Parâmetros de caminho

name string

Obrigatório. O nome do Chunk a ser recuperado. Exemplo: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk. Ele assume a forma corpora/{corpora}/documents/{document}/chunks/{chunk}.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Chunk.

Método: corpora.documents.chunks.patch

Atualiza um Chunk.

Endpoint

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 caminho

chunk.name string

Imutável. Identificador. O nome do recurso Chunk. O ID (nome sem o prefixo "corpora/*/documents/*/chunks/") pode conter até 40 caracteres alfanuméricos minúsculos ou traços (-). O ID não pode começar nem terminar com um traço. Se o nome estiver vazio na criação, um ID exclusivo aleatório de 12 caracteres será gerado. Exemplo: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c. Ele assume a forma corpora/{corpora}/documents/{document}/chunks/{chunk}.

Parâmetros de consulta

updateMask string (FieldMask format)

Obrigatório. Lista de campos a serem atualizados. No momento, isso só permite atualizar customMetadata e data.

É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

Corpo da solicitação

O corpo da solicitação contém uma instância de Chunk.

Campos
data object (ChunkData)

Obrigatório. O conteúdo do Chunk, como a string de texto. O número máximo de tokens por bloco é 2.043.

customMetadata[] object (CustomMetadata)

Opcional. Metadados personalizados fornecidos pelo usuário armazenados como pares de chave-valor. O número máximo de CustomMetadata por bloco é 20.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Chunk.

Método: corpora.documents.chunks.delete

Exclui um Chunk.

Endpoint

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

Parâmetros de caminho

name string

Obrigatório. O nome do recurso do Chunk a ser excluído. Exemplo: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk. Ele assume a forma corpora/{corpora}/documents/{document}/chunks/{chunk}.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se não houver nenhum problema, o corpo da resposta será um objeto JSON vazio.

Método: corpora.documents.chunks.batchCreate

Criação em lote de Chunks.

Endpoint

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

Parâmetros de caminho

parent string

Opcional. O nome do Document em que este lote de Chunks será criado. O campo "parent" em cada CreateChunkRequest precisa corresponder a esse valor. Exemplo: corpora/my-corpus-123/documents/the-doc-abc. Ele assume a forma corpora/{corpora}/documents/{document}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Campos
requests[] object (CreateChunkRequest)

Obrigatório. As mensagens de solicitação que especificam os Chunks a serem criados. É possível criar no máximo 100 Chunks em um lote.

Corpo da resposta

Resposta de chunks.batchCreate contendo uma lista de Chunks criados.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Campos
chunks[] object (Chunk)

Chunks criados.

Representação JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

CreateChunkRequest

Solicitação para criar um Chunk.

Campos
parent string

Obrigatório. O nome do Document em que o Chunk será criado. Exemplo: corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

Obrigatório. O Chunk a ser criado.

Representação JSON 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}

Método: corpora.documents.chunks.batchUpdate

Atualiza em lote Chunks.

Endpoint

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

Parâmetros de caminho

parent string

Opcional. O nome do Document que contém os Chunks a serem atualizados. O campo "parent" em cada UpdateChunkRequest precisa corresponder a esse valor. Exemplo: corpora/my-corpus-123/documents/the-doc-abc. Ele assume a forma corpora/{corpora}/documents/{document}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Campos
requests[] object (UpdateChunkRequest)

Obrigatório. As mensagens de solicitação que especificam os Chunks a serem atualizados. É possível atualizar até 100 Chunks em um lote.

Corpo da resposta

Resposta de chunks.batchUpdate contendo uma lista de Chunks atualizados.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Campos
chunks[] object (Chunk)

Chunks atualizados.

Representação JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

UpdateChunkRequest

Solicitação para atualizar um Chunk.

Campos
chunk object (Chunk)

Obrigatório. O Chunk a ser atualizado.

updateMask string (FieldMask format)

Obrigatório. Lista de campos a serem atualizados. No momento, isso só permite atualizar customMetadata e data.

É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

Representação JSON 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}

Método: corpora.documents.chunks.batchDelete

Exclui Chunks em lote.

Endpoint

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

Parâmetros de caminho

parent string

Opcional. O nome do Document que contém os Chunks a serem excluídos. O campo "parent" em cada DeleteChunkRequest precisa corresponder a esse valor. Exemplo: corpora/my-corpus-123/documents/the-doc-abc. Ele assume a forma corpora/{corpora}/documents/{document}.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Campos
requests[] object (DeleteChunkRequest)

Obrigatório. As mensagens de solicitação que especificam os Chunks a serem excluídos.

Corpo da resposta

Se não houver nenhum problema, o corpo da resposta será um objeto JSON vazio.

DeleteChunkRequest

Solicitação para excluir um Chunk.

Campos
name string

Obrigatório. O nome do recurso do Chunk a ser excluído. Exemplo: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk

Representação JSON 
{
  "name": string
}

Recurso REST: corpora.documents.chunks

Recurso: Chunk

Um Chunk é uma subparte de um Document que é tratado como uma unidade independente para fins de representação e armazenamento de vetores. Um Corpus pode ter no máximo um milhão de Chunks.

Campos
name string

Imutável. Identificador. O nome do recurso Chunk. O ID (nome sem o prefixo "corpora/*/documents/*/chunks/") pode conter até 40 caracteres alfanuméricos minúsculos ou traços (-). O ID não pode começar nem terminar com um traço. Se o nome estiver vazio na criação, um ID exclusivo aleatório de 12 caracteres será gerado. Exemplo: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

Obrigatório. O conteúdo do Chunk, como a string de texto. O número máximo de tokens por bloco é 2.043.

customMetadata[] object (CustomMetadata)

Opcional. Metadados personalizados fornecidos pelo usuário armazenados como pares de chave-valor. O número máximo de CustomMetadata por bloco é 20.

createTime string (Timestamp format)

Apenas saída. O carimbo de data/hora de quando o Chunk foi criado.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Apenas saída. O carimbo de data/hora da última atualização do Chunk.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

state enum (State)

Apenas saída. Estado atual do Chunk.

Representação JSON 
{
  "name": string,
  "data": {
    object (ChunkData)
  },
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State)
}

ChunkData

Dados extraídos que representam o conteúdo Chunk.

Campos
data Union type
data pode ser apenas de um dos tipos a seguir:
stringValue string

O conteúdo Chunk como uma string. O número máximo de tokens por bloco é 2.043.

Representação JSON 
{

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

Estado

Estados do ciclo de vida de um Chunk.

Enums
STATE_UNSPECIFIED O valor padrão. Esse valor é usado se o estado for omitido.
STATE_PENDING_PROCESSING Chunk está sendo processado (armazenamento de embeddings e vetores).
STATE_ACTIVE Chunk é processado e fica disponível para consulta.
STATE_FAILED Falha no processamento de Chunk.