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

呼び出し元によって作成された Assistant のすべての Agent を一覧表示します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
parent

string

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

クエリ パラメータ

パラメータ
pageSize

integer

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

string

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

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

string

省略可。昇順で並べ替えるフィールドのカンマ区切りリスト。降順にするには、フィールド名の後に desc を使用します。サポートされているフィールド:

  • updateTime
  • isPinned

例:

  • "updateTime desc"
  • "isPinned desc,updateTime desc": エージェントを isPinned で並べ替え、次に updateTime で並べ替えます。

リクエストの本文

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

レスポンスの本文

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

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

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

object (Agent)

呼び出し元から見える親 Assistant のエージェント。
nextPageToken

string

次のページを取得するために ListAgentsRequest.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.agents.list

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