Method: projects.locations.collections.engines.assistants.list

Engine のすべての Assistant を一覧表示します。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/engines/*}/assistants

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

パスパラメータ

パラメータ
parent

string

必須。親リソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

クエリ パラメータ

パラメータ
pageSize

integer

返す Assistant の最大数。指定しない場合、デフォルトは 100 です。最大許容値は 1,000 です。これを超える値は 1,000 に強制変換されます。
pageToken

string

前回の AssistantService.ListAssistants 呼び出しから受け取ったページトークン ListAssistantsResponse.next_page_token。後続のページを取得するにはこれを指定します。

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

リクエストの本文

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

レスポンスの本文

AssistantService.ListAssistants メソッドに対するレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

object (Assistant)

お客様のすべての Assistant。
nextPageToken

string

次のページを取得するために ListAssistantsRequest.page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • discoveryengine.assistants.list

詳細については、IAM のドキュメントをご覧ください。