REST Resource: projects.locations.collections.engines.assistants.agents

资源：代理

执行预定义的特定任务。

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "description": string,
  "icon": {
    object (Image)
  },
  "createTime": string,
  "updateTime": string,
  "authorizations": [
    string
  ],
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "dataStoreSpecs": {
    object (DataStoreSpecs)
  },
  "state": enum (State),
  "toolSettings": {
    object (AgentToolSettings)
  },
  "languageCode": string,
  "starterPrompts": [
    {
      object (StarterPrompt)
    }
  ],
  "customPlaceholderText": string,

  // Union field definition can be only one of the following:
  "adkAgentDefinition": {
    object (AdkAgentDefinition)
  },
  "managedAgentDefinition": {
    object (ManagedAgentDefinition)
  },
  "a2aAgentDefinition": {
    object (A2AAgentDefinition)
  },
  "dialogflowAgentDefinition": {
    object (DialogflowAgentDefinition)
  }
  // End of list of possible types for union field definition.

  // Union field agent_state_reason can be only one of the following:
  "suspensionReason": string,
  "rejectionReason": string,
  "deploymentFailureReason": string
  // End of list of possible types for union field agent_state_reason.
}
字段
name

string

标识符。代理的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent} 或 projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/agents/{agent}
displayName

string

必需。代理的显示名称。LLM 可能会使用此值自动选择代理来响应用户查询。
description

string

必需。代理的人类可读说明。LLM 可能会使用此值自动选择代理来响应用户查询。
icon

object (Image)

可选。界面上代表代理的图标。
createTime

string (Timestamp format)

仅限输出。创建此代理时的时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

仅限输出。相应代理最近一次更新时的时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
authorizations[]
(deprecated)

string

可选。已弃用：请改用 Agent.authorization_config。相应代理所需的授权列表。
authorizationConfig

object (AuthorizationConfig)

可选。代理所需的授权。
dataStoreSpecs

object (DataStoreSpecs)

可选。与代理关联的 DataStoreSpecs。如果不设置此字段，则会使用引擎中的所有数据存储区。
state

enum (State)

仅限输出。代理的生命周期状态。
toolSettings
(deprecated)

object (AgentToolSettings)

可选。已弃用：计划迁移到 AgentCard 定义。
languageCode

string

可选。说明、displayName 和 starterPrompts 字段中文字的语言代码。
starterPrompts[]

object (StarterPrompt)

可选。要在代理的着陆页上向用户显示的初始提示建议。
customPlaceholderText

string

可选。用户输入任何文本之前，文本框中显示的自定义占位符文本。
联合字段 definition。代理的定义。LINT.IfChange(definition) definition 只能是下列其中一项：
adkAgentDefinition

object (AdkAgentDefinition)

可选。代理的行为定义为 ADK 代理。
managedAgentDefinition

object (ManagedAgentDefinition)

可选。Google 管理的代理的行为。
a2aAgentDefinition

object (A2AAgentDefinition)

可选。代理的行为定义为 A2A 代理。
dialogflowAgentDefinition

object (DialogflowAgentDefinition)

可选。代理的行为定义为 Dialogflow 代理。
联合字段 agent_state_reason。代理处于当前状态的原因。agent_state_reason 只能是下列其中一项：
suspensionReason

string

仅限输出。代理被中止的原因。仅在状态为 SUSPENDED 时设置。
rejectionReason

string

仅限输出。代理被拒绝的原因。仅当状态为 PRIVATE 且通过拒绝达到此状态时才设置此字段。
deploymentFailureReason

string

仅限输出。代理部署失败的原因。仅在状态为 DEPLOYMENT_FAILED 时设置。

方法

create

 创建 Agent。

delete

 删除 Agent。

deploy

 部署 Agent。

disableAgent

 停用代理。

enableAgent

 启用代理。

get

 获取 Agent。

getAgentView

 针对给定的 Agent 返回一个 AgentView，其中包含有关代理的其他信息。

getIamPolicy

 获取代理资源的访问权限控制政策。

list

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

patch

 更新 Agent

rejectAgent

 拒绝向公众提供的代理。

requestAgentReview

 通过使代理可供审核，向管理员展示代理。

setIamPolicy

 设置代理资源的访问权限控制政策。

suspendAgent

 暂停代理。

withdrawAgent

 撤消向公众提供的代理。