用于显示代理的数据。
| JSON 表示法 |
|---|
{ "name": string, "displayName": string, "description": string, "icon": { object ( |
| 字段 | |
|---|---|
name |
代理的资源名称。格式: |
displayName |
必需。代理的显示名称。该字段的语言为 |
description |
必需。代理的人类可读说明。该字段可能被 LLM 用于自动选择相应代理来响应用户查询,并生成代理步骤的初始版本,供用户修改。该字段的语言为 |
icon |
可选。在界面上代表相应代理的图标。 |
agentType |
仅限输出。代理的类型。 |
agentOrigin |
不可变。代理的来源。 |
state |
仅限输出。代理的状态。 |
userPermissions |
用户对相应代理拥有的权限。 |
suggestedPrompts[] |
可选。代理的建议提示,将在代理着陆页上显示。 |
customPlaceholderText |
在用户输入任何文本之前显示在文本框中的自定义占位符文本。 |
userAnnotations |
可选。当前调用方针对代理的用户级注解。 |
agentSharingState |
仅限输出。代理的共享状态。 |
联合字段 agent_state_reason。代理处于其当前状态的原因。agent_state_reason 只能是下列其中一项: |
|
suspensionReason |
代理被暂停的原因。仅在状态为“SUSPENDED”时设置。 |
rejectionReason |
代理被拒绝的原因。仅在状态为“PRIVATE”且因被拒绝而进入该状态时设置。 |
deploymentFailureReason |
代理部署失败的原因。仅在状态为“DEPLOYMENT_FAILED”时设置。 |
AgentType
代理的类型。
| 枚举 | |
|---|---|
AGENT_TYPE_UNSPECIFIED |
代理类型未指定。 |
NO_CODE |
无代码代理。 |
HTTP |
HTTP 代理。 |
ADK |
ADK 代理。 |
MANAGED |
由 Google 管理的代理。 |
A2A |
A2A 代理。 |
DIALOGFLOW |
Dialogflow 代理。 |
LOW_CODE |
低代码代理。 |
UserPermissions
用户对代理拥有的权限。
| JSON 表示法 |
|---|
{ "canRun": boolean, "canView": boolean, "canEdit": boolean, "canWithdraw": boolean, "canRequestReview": boolean, "canDelete": boolean, "canProposeUsers": boolean } |
| 字段 | |
|---|---|
canRun |
指示用户是否可以运行此代理。 |
canView |
指示用户是否可以查看此代理的来源。 |
canEdit |
指示用户是否可以修改此代理。 |
canWithdraw |
指示用户是否可以撤销此代理。 |
canRequestReview |
指示用户是否可以针对此代理申请审核。 |
canDelete |
指示用户是否可以删除此代理。 |
canProposeUsers |
指示用户是否可以提议与其他用户共享此代理。 |
SuggestedPrompt
代理的建议提示,将在代理着陆页上显示。
| JSON 表示法 |
|---|
{ "text": string } |
| 字段 | |
|---|---|
text |
必需。建议提示的文本。 该字段的语言为 |
UserAnnotations
代理的基于 UserAnnotation 的用户级注解。
| JSON 表示法 |
|---|
{ "pinned": boolean, "viewed": boolean } |
| 字段 | |
|---|---|
pinned |
可选。指示代理是否已置顶;已置顶的代理将显示在代理列表的顶部。 |
viewed |
可选。指示用户是否已查看过代理。 |
AgentSharingState
代理可能的共享状态。
| 枚举 | |
|---|---|
AGENT_SHARING_STATE_UNSPECIFIED |
共享状态未指定。 |
NOT_SHARED |
代理未共享。 |
PENDING |
代理待审核。 |
SHARED |
代理已与其他用户共享。 |
REJECTED |
代理共享请求已遭拒。 |