Method: corpora.documents.list

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

必須。Document を含む Corpus の名前。例: corpora/my-corpus-123

クエリ パラメータ

パラメータ
pageSize

integer

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

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

string

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

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

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

リクエストの本文

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

レスポンスの本文

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

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

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

object (Document)

返された Document。
nextPageToken

string

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

認可スコープ

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

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

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