REST Resource: corpora.documents.chunks

Recurso: pedaços de código

Um Chunk é uma subparte de um Document que é tratada como uma unidade independente para fins de representação vetorial e armazenamento. Uma 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 em letras minúsculas ou traços (-). Ele não pode começar nem terminar com um traço. Se o nome estiver em branco 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. Carimbo de data/hora de quando a Chunk foi criada.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, 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 UTC "Zulu" RFC3339, 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 de Chunk como uma string. O número máximo de tokens por bloco é 2.043.

Estado

Estados do 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étodos

batchCreate

 Cria Chunks em lote.

batchDelete

 Excluir Chunks em lote.

batchUpdate

 Atualização em lote de Chunks.

create

 Cria uma Chunk.

delete

 Exclui um Chunk.

get

 Recebe informações sobre uma Chunk específica.

list

 Lista todos os Chunks em uma Document.

patch

 Atualiza um Chunk.