Method: corpora.documents.list

Elenca tutti i Document in un Corpus.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome del Corpus che contiene Document. Esempio: corpora/my-corpus-123

Parametri di ricerca

Parametri
pageSize

integer

Campo facoltativo. Il numero massimo di Document da restituire (per pagina). Il servizio potrebbe restituire meno Document.

Se non specificato, verranno restituiti al massimo 10 Document. Il limite per le dimensioni massime è di 20 Document s per pagina.
pageToken

string

Campo facoltativo. Un token di pagina, ricevuto da una precedente chiamata a documents.list.

Fornisci il nextPageToken restituito nella risposta come argomento per la richiesta successiva per recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti a documents.list devono corrispondere alla chiamata che ha fornito il token della pagina.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Risposta da documents.list contenente un elenco impaginato di Document. I valori Document sono ordinati in base al valore document.create_time crescente.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}
Campi
documents[]

object (Document)

Sono stati restituiti Document.
nextPageToken

string

Un token, che può essere inviato come pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non ci sono altre pagine.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Panoramica dell'autenticazione.