Docuents

Recurso REST: 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 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 vazio no momento da 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 do recuperador semântico"

customMetadata[] object (CustomMetadata)

Opcional. Metadados personalizados fornecidos pelo usuário armazenados como pares de chave-valor usados para consultas. 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 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".

createTime string (Timestamp format)

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

Método: corpora.documents.create

Cria um Document vazio.

Endpoint

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

Parâmetros de caminho

parent string

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

Corpo da solicitação

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

Corpo da resposta

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

Método: corpora.documents.list

Lista todos os Documents em uma Corpus.

Endpoint

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

Parâmetros de caminho

parent string

Obrigatório. O nome da Corpus que contém Documents. Exemplo: corpora/my-corpus-123. Ele assume o formato corpora/{corpora}.

Parâmetros de consulta

pageSize integer

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

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

pageToken string

Opcional. Um token de página recebido de uma chamada documents.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 documents.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 documents.list contendo uma lista paginada de Documents. As Documents são classificadas por document.create_time crescente.

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

.
Campos
documents[] object (Document)

Os Documents 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 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

Método: corpora.documents.query

Executa a pesquisa semântica em uma Document.

Endpoint

postar https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query

Parâmetros de caminho

name string

Obrigatório. O nome do Document a ser consultado. 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
query string

Obrigatório. String de consulta para realizar uma pesquisa semântica.

resultsCount integer

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

Se não for especificado, serão retornados no máximo 10 Chunks. A contagem máxima de resultados especificada é 100.

metadataFilters[] object (MetadataFilter)

Opcional. Filtrar por metadados Chunk. Cada objeto MetadataFilter precisa corresponder a uma chave exclusiva. Vários objetos MetadataFilter são unidos por "AND" lógicos.

Observação: a filtragem no nível Document não é compatível com essa solicitação porque um nome Document já foi especificado.

Exemplo de consulta: (ano >= 2020 OR ano < 2010) AND (gênero = drama OR gênero = ação)

Lista de objetos MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" condições = [{int_value = 2020, operations = GREATER_EQUAL}, {int_value = 2010, operations = LESS}}, {key = "chunk.custom_metadata.genre" condições = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}}]

Exemplo de consulta para um intervalo numérico de valores: (ano > 2015 E ano <= 2020)

Lista de objetos MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; condições = [{int_value = 2020, operations = LESS_EQUAL}]}]

Observação: "AND"s para a mesma chave são compatíveis apenas com valores numéricos. Valores de string são compatíveis apenas com "OR"s para a mesma chave.

Corpo da resposta

Resposta de documents.query contendo uma lista de blocos relevantes.

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

.
Campos
relevantChunks[] object (RelevantChunk)

Os blocos relevantes retornados.

Representação JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Método: corpora.documents.get

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

Endpoint

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

Parâmetros de caminho

name string

Obrigatório. O nome do Document a ser recuperado. 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 precisa estar vazio.

Corpo da resposta

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

Método: corpora.documents.patch

Atualiza um Document.

Endpoint

patch https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

Parâmetros de caminho

document.name string

Imutável. Identificador. O nome do recurso Document. O ID (nome sem o prefixo "corpora/*/documents/") 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 vazio no momento da 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. Ele assume o formato corpora/{corpora}/documents/{document}.

Parâmetros de consulta

updateMask string (FieldMask format)

Obrigatório. Lista de campos a serem atualizados. No momento, só é possível atualizar displayName e customMetadata.

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

Corpo da resposta

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

Método: corpora.documents.delete

Exclui um Document.

Endpoint

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

Parâmetros de caminho

name string

Obrigatório. O nome do recurso do Document a ser excluído. Exemplo: corpora/my-corpus-123/documents/the-doc-abc. Ele assume o formato corpora/{corpora}/documents/{document}.

Parâmetros de consulta

force boolean

Opcional. Se definida como verdadeira, todos os Chunks e objetos relacionados a esse Document também serão excluídos.

Se for falso (o padrão), um erro FAILED_PRECONDITION será retornado se Document contiver Chunks.

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.

CustomMetadata

Metadados fornecidos pelo usuário armazenados como pares de chave-valor.

Representação JSON 
{
  "key": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // End of list of possible types for union field value.
}
.
Campos
key string

Obrigatório. A chave dos metadados a serem armazenados.

Campo de união value.

value pode ser apenas de um dos tipos a seguir:

stringValue string

O valor da string dos metadados a serem armazenados.

stringListValue object (StringList)

O valor StringList dos metadados a serem armazenados.

numericValue number

O valor numérico dos metadados a serem armazenados.

StringList

Valores de string fornecidos pelo usuário atribuídos a uma única chave de metadados.

Representação JSON 
{
  "values": [
    string
  ]
}
.
Campos
values[] string

Os valores da string dos metadados a serem armazenados.