Method: corpora.documents.chunks.list

Document 内のすべての Chunk を一覧表示します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。Chunk を含む Document の名前。例: corpora/my-corpus-123/documents/the-doc-abc

クエリ パラメータ

パラメータ
pageSize

integer

（省略可）返される Chunk の最大数（1 ページあたり）。サービスが返す Chunk の数が少なくなる場合があります。

指定されていない場合は、最大で 10 個の Chunk が返されます。サイズの上限は 1 ページあたり 100 Chunk です。
pageToken

string

（省略可）前の chunks.list 呼び出しで受け取ったページトークン。

レスポンスで返された nextPageToken を次のリクエストの引数として指定し、次のページを取得します。

ページ分割を行う場合、chunks.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

Chunk のページ分けされたリストを含む chunks.list からのレスポンス。Chunk は chunk.create_time の昇順で並べ替えられます。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}
フィールド
chunks[]

object (Chunk)

返された Chunk。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、これ以上ページはありません。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、認証の概要をご覧ください。