Method: corpora.documents.chunks.list

Listet alle Chunks in einer Document auf.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Name der Document, die Chunks enthält. Beispiel: corpora/my-corpus-123/documents/the-doc-abc

Abfrageparameter

Parameter
pageSize

integer

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

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

string

Optional. Ein Seitentoken, das von einem vorherigen chunks.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 chunks.list bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort von chunks.list mit einer paginierten Liste von Chunks. Die Chunk-Werte werden nach aufsteigender chunk.create_time sortiert.

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

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

object (Chunk)

Die zurückgegebenen Chunks.
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.