Method: corpora.list

ユーザーが所有するすべての Corpora を一覧表示します。

HTTP リクエスト

GET https://generativelanguage.googleapis.com/v1beta/corpora

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

クエリ パラメータ

パラメータ
pageSize

integer

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

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

string

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

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

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

リクエストの本文

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

レスポンスの本文

Corpora のページ分けされたリストを含む corpora.list からのレスポンス。結果は corpus.create_time の昇順で表示されます。

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

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

object (Corpus)

返されたコーパス。
nextPageToken

string

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

認可スコープ

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

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

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