Chunks

Recurso REST: corpora.documents.chunks

Recurso: Chunk

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

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

Imutável. Identificador. O nome do recurso Chunk. O ID (nome sem o prefixo "corpora/*/documents/*/chunks/") pode ter até 40 caracteres alfanuméricos minúsculos ou traços (-). Ele 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 de 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.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

Apenas saída. O carimbo de data/hora de quando o Chunk foi atualizado pela última vez.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

state enum (State)

Apenas saída. Estado atual da Chunk.

ChunkData

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

Representação 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ão data.

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.

Estado

Estados para o ciclo de vida de uma Chunk.

Enums
STATE_UNSPECIFIED O valor padrão. Esse valor será usado se o estado for omitido.
STATE_PENDING_PROCESSING Chunk está sendo processado (incorporação e armazenamento vetorial).
STATE_ACTIVE Chunk foi processado e está disponível para consulta.
STATE_FAILED Falha ao processar Chunk.

Método: corpora.documents.chunks.create

Cria uma Chunk.

Endpoint

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

Parâmetros de caminho

parent string

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

Corpo da solicitação

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

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 uma Document.

Endpoint

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

Parâmetros de caminho

parent string

Obrigatório. O nome da Document que contém Chunks. Exemplo: corpora/my-corpus-123/documents/the-doc-abc. Ele assume o formato 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, serão retornados no máximo 10 Chunks. O limite máximo de tamanho é 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 a fim de recuperar a próxima página.

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. As Chunks são classificadas 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

recebe 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 o formato 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 ter até 40 caracteres alfanuméricos minúsculos ou traços (-). Ele 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 o formato corpora/{corpora}/documents/{document}/chunks/{chunk}.

Parâmetros de consulta

updateMask string (FieldMask format)

Obrigatório. Lista de campos a serem atualizados. No momento, só é possível 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.

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

excluir 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 o formato 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 concluída, o corpo da resposta estará vazio.

Método: corpora.documents.chunks.batchCreate

Crie Chunks em lote.

Endpoint

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

Parâmetros de caminho

parent string

Opcional. O nome do Document em que esse lote de Chunks será criado. O campo pai em cada CreateChunkRequest precisa corresponder a esse valor. Exemplo: corpora/my-corpus-123/documents/the-doc-abc. Ele assume o formato 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. Mensagens de solicitação especificando 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 criadas.

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.

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

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

chunk object (Chunk)

Obrigatório. O Chunk a ser criado.

Método: corpora.documents.chunks.batchUpdate

Atualização em lote de Chunks.

Endpoint

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

Parâmetros de caminho

parent string

Opcional. O nome da Document que contém os Chunks a serem atualizados. O campo pai em cada UpdateChunkRequest precisa corresponder a esse valor. Exemplo: corpora/my-corpus-123/documents/the-doc-abc. Ele assume o formato 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. Mensagens de solicitação especificando os Chunks a serem atualizados. No máximo 100 Chunks podem ser atualizados em um lote.

Corpo da resposta

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

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.

Representação JSON 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}
.
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, só é possível atualizar customMetadata e data.

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

Método: corpora.documents.chunks.batchDelete

Exclua Chunks em lote.

Endpoint

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

Parâmetros de caminho

parent string

Opcional. O nome da Document que contém as Chunks a serem excluídas. O campo pai em cada DeleteChunkRequest precisa corresponder a esse valor. Exemplo: corpora/my-corpus-123/documents/the-doc-abc. Ele assume o formato 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 especificando os Chunks a serem excluídos.

Corpo da resposta

Se a solicitação for concluída, o corpo da resposta estará vazio.

DeleteChunkRequest

Solicitação para excluir um Chunk.

Representação JSON 
{
  "name": string
}
.
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