- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
Lista todos os Document
s 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 |
Obrigatório. O nome da |
Parâmetros de consulta
Parâmetros | |
---|---|
pageSize |
Opcional. O número máximo de Se não for especificado, no máximo 10 |
pageToken |
Opcional. Um token de página recebido de uma chamada Forneça o Ao paginar, todos os outros parâmetros fornecidos para |
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Resposta de documents.list
contendo uma lista paginada de Document
s. As Document
s 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 ( |
Campos | |
---|---|
documents[] |
Os |
nextPageToken |
Um token, que pode ser enviado como |
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.