Listet alle Document
s 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 |
Erforderlich. Der Name der |
Abfrageparameter
Parameter | |
---|---|
pageSize |
Optional. Die maximale Anzahl von Wenn keine Vorgabe erfolgt, werden maximal 10 |
pageToken |
Optional. Ein Seitentoken, das von einem vorherigen Geben Sie das in der Antwort zurückgegebene Beim Paginieren müssen alle anderen für |
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Antwort von documents.list
mit einer paginierten Liste von Document
s. 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 ( |
Felder | |
---|---|
documents[] |
Die zurückgegebenen |
nextPageToken |
Ein Token, das als |
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.