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

列出调用方在 Assistant 下创建的所有 Agent。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
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 文档。