REST Resource: corpora.documents

Recurso: Document

Um Document é uma coleção de Chunks. Um Corpus pode ter no máximo 10.000 Documents.

Representação JSON
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
Campos
name

string

Imutável. Identificador. O nome do recurso Document. O ID (nome sem o prefixo "corpora/*/documents/") pode conter até 40 caracteres alfanuméricos em minúsculas 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 nome exclusivo será derivado de displayName com um sufixo aleatório de 12 caracteres. Exemplo: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName

string

Opcional. O nome de exibição legível para o Document. O nome de exibição não pode ter mais de 512 caracteres, incluindo espaços. Exemplo: "Documentação de semantic Retriever"

customMetadata[]

object (CustomMetadata)

Opcional. Metadados personalizados fornecidos pelo usuário armazenados como pares de chave-valor usados para consulta. Um Document pode ter no máximo 20 CustomMetadata.

updateTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora de quando o Document 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".

createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora de quando a Document 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".

Métodos

create

Cria um Document vazio.

delete

Exclui um Document.

get

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

list

Lista todos os Documents em uma Corpus.

patch

Atualiza um Document.

query

Executa pesquisa semântica em um Document.