Method: corpora.documents.list

Lista todos os Documents em uma Corpus.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome da Corpus que contém Documents. Exemplo: corpora/my-corpus-123

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. O número máximo de Documents para retornar (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 de tamanho 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 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:

Representação JSON 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}
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 este campo for omitido, não haverá mais páginas.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

Para saber mais, consulte a Visão geral da autenticação.