Method: corpora.documents.chunks.list

Liste tous les Chunk d'une Document.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la Document contenant des Chunk. Exemple : corpora/my-corpus-123/documents/the-doc-abc

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal de Chunk à renvoyer (par page). Le service peut renvoyer moins de Chunk.

Si aucune valeur n'est spécifiée, 10 valeurs Chunk au maximum sont renvoyées. La taille maximale est de 100 Chunk par page.
pageToken

string

Facultatif. Jeton de page reçu d'un appel chunks.list précédent.

Fournissez le nextPageToken renvoyé dans la réponse en tant qu'argument de la requête suivante pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à chunks.list doivent correspondre à l'appel ayant fourni le jeton de page.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse de chunks.list contenant une liste paginée d'éléments Chunk. Les éléments Chunk sont triés par ordre croissant chunk.create_time.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}
Champs
chunks[]

object (Chunk)

Les valeurs Chunk renvoyées
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, cela signifie qu'il n'y a plus de pages.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la page Présentation de l'authentification.