Documents

A API File Search faz referência aos seus arquivos de origem ou documentos brutos como objetos de arquivo temporários.

Método: fileSearchStores.documents.delete

Exclui um Document.

Endpoint

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

Parâmetros de caminho

name string

Obrigatório. O nome do recurso do Document a ser excluído. Exemplo: fileSearchStores/my-file-search-store-123/documents/the-doc-abc. Ele assume a forma fileSearchStores/{filesearchstore}/documents/{document}.

Parâmetros de consulta

force boolean

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

Se for "false" (o padrão), um erro FAILED_PRECONDITION será retornado se Document contiver algum 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: fileSearchStores.documents.get

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

Endpoint

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

Parâmetros de caminho

name string

Obrigatório. O nome do Document a ser recuperado. Exemplo: fileSearchStores/my-file-search-store-123/documents/the-doc-abc. Ele assume a forma fileSearchStores/{filesearchstore}/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: fileSearchStores.documents.list

Lista todos os Documents em um Corpus.

Endpoint

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

Parâmetros de caminho

parent string

Obrigatório. O nome do FileSearchStore que contém Documents. Exemplo: fileSearchStores/my-file-search-store-123. Ele assume a forma fileSearchStores/{filesearchstore}.

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, no máximo 10 Documents serão retornados. O limite máximo é 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 e recupere a página seguinte.

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. Os Documents são classificados 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: fileSearchStores.documents.query

Realiza uma pesquisa semântica em um Document.

Endpoint

post https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/documents/*}:query

Parâmetros de caminho

name string

Obrigatório. O nome do Document a ser consultado. Exemplo: fileSearchStores/my-file-search-store-123/documents/the-doc-abc. Ele assume a forma fileSearchStores/{filesearchstore}/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 a 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, no máximo 10 Chunks serão retornados. O número máximo de resultados especificado é 100.

metadataFilters[] object (MetadataFilter)

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

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

Exemplo de consulta: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter object list: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}}]

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

MetadataFilter object list: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Observação: os "AND" para a mesma chave só são aceitos para valores numéricos. Os valores de string só aceitam "OR"s para a mesma chave.

Corpo da resposta

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

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

Campos
relevantChunks[] object (RelevantChunk)

Os trechos relevantes retornados.

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

Recurso REST: fileSearchStores.documents

Recurso: Document

Um Document é uma coleção de Chunks.

Campos
name string

Imutável. Identificador. O nome do recurso Document. O ID (nome sem o prefixo "fileSearchStores/*/documents/") pode ter 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 nome exclusivo será derivado de displayName junto com um sufixo aleatório de 12 caracteres. Exemplo: fileSearchStores/{file_search_store_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 Semantic Retriever"

customMetadata[] object (CustomMetadata)

Opcional. Metadados personalizados fornecidos pelo usuário armazenados como pares de chave-valor usados para consultas. Um Document pode ter até 20 CustomMetadata.

updateTime string (Timestamp format)

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

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".

createTime string (Timestamp format)

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

state enum (State)

Apenas saída. Estado atual do Document.

sizeBytes string (int64 format)

Apenas saída. O tamanho dos bytes brutos ingeridos no documento.

mimeType string

Apenas saída. O tipo MIME do documento.

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

Estado

Estados do ciclo de vida de um Document.

Tipos enumerados
STATE_UNSPECIFIED O valor padrão. Esse valor é usado se o estado for omitido.
STATE_PENDING Alguns Chunks do Document estão sendo processados (armazenamento de embeddings e vetores).
STATE_ACTIVE Todos os Chunks do Document são processados e ficam disponíveis para consulta.
STATE_FAILED Alguns Chunks do Document não foram processados.