Method: corpora.documents.list

Listet alle Documents in einer Corpus auf.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Name der Corpus, die Documents enthält. Beispiel: corpora/my-corpus-123

Abfrageparameter

Parameter
pageSize

integer

Optional. Die maximale Anzahl von Documents, die zurückgegeben werden sollen (pro Seite). Der Dienst gibt möglicherweise weniger Documents zurück.

Wenn keine Vorgabe erfolgt, werden maximal 10 Documents zurückgegeben. Die maximale Größe beträgt 20 Documents pro Seite.
pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen documents.list-Aufruf empfangen wurde.

Geben Sie das in der Antwort zurückgegebene nextPageToken als Argument für die nächste Anfrage an, um die nächste Seite abzurufen.

Beim Paginieren müssen alle anderen für documents.list bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort von documents.list mit einer paginierten Liste von Documents. Die Document-Werte werden nach aufsteigender document.create_time sortiert.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}
Felder
documents[]

object (Document)

Die zurückgegebenen Documents.
nextPageToken

string

Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, sind keine weiteren Seiten vorhanden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.