AgentView

用于显示代理的数据。

JSON 表示法
{
  "name": string,
  "displayName": string,
  "description": string,
  "icon": {
    object (Image)
  },
  "agentType": enum (AgentType),
  "agentOrigin": enum (AgentOrigin),
  "state": enum (State),
  "userPermissions": {
    object (UserPermissions)
  },
  "suggestedPrompts": [
    {
      object (SuggestedPrompt)
    }
  ],
  "customPlaceholderText": string,
  "userAnnotations": {
    object (UserAnnotations)
  },
  "agentSharingState": enum (AgentSharingState),

  // 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}

displayName

string

必需。代理的显示名称。该字段的语言为 Agent.language_code;如果启用了翻译,则为 ListAvailableAgentViewsRequest.language_code

description

string

必需。代理的人类可读说明。该字段可能被 LLM 用于自动选择相应代理来响应用户查询,并生成代理步骤的初始版本,供用户修改。该字段的语言为 Agent.language_code;如果启用了翻译,则为 ListAvailableAgentViewsRequest.language_code

icon

object (Image)

可选。在界面上代表相应代理的图标。

agentType

enum (AgentType)

仅限输出。代理的类型。

agentOrigin

enum (AgentOrigin)

不可变。代理的来源。

state

enum (State)

仅限输出。代理的状态。

userPermissions

object (UserPermissions)

用户对相应代理拥有的权限。

suggestedPrompts[]

object (SuggestedPrompt)

可选。代理的建议提示,将在代理着陆页上显示。

customPlaceholderText

string

在用户输入任何文本之前显示在文本框中的自定义占位符文本。

userAnnotations

object (UserAnnotations)

可选。当前调用方针对代理的用户级注解。

agentSharingState

enum (AgentSharingState)

仅限输出。代理的共享状态。

联合字段 agent_state_reason。代理处于其当前状态的原因。agent_state_reason 只能是下列其中一项:
suspensionReason

string

代理被暂停的原因。仅在状态为“SUSPENDED”时设置。

rejectionReason

string

代理被拒绝的原因。仅在状态为“PRIVATE”且因被拒绝而进入该状态时设置。

deploymentFailureReason

string

代理部署失败的原因。仅在状态为“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

boolean

指示用户是否可以运行此代理。

canView

boolean

指示用户是否可以查看此代理的来源。

canEdit

boolean

指示用户是否可以修改此代理。

canWithdraw

boolean

指示用户是否可以撤销此代理。

canRequestReview

boolean

指示用户是否可以针对此代理申请审核。

canDelete

boolean

指示用户是否可以删除此代理。

canProposeUsers

boolean

指示用户是否可以提议与其他用户共享此代理。

SuggestedPrompt

代理的建议提示,将在代理着陆页上显示。

JSON 表示法
{
  "text": string
}
字段
text

string

必需。建议提示的文本。 该字段的语言为 Agent.language_code;如果启用了翻译,则为 ListAvailableAgentViewsRequest.language_code

UserAnnotations

代理的基于 UserAnnotation 的用户级注解。

JSON 表示法
{
  "pinned": boolean,
  "viewed": boolean
}
字段
pinned

boolean

可选。指示代理是否已置顶;已置顶的代理将显示在代理列表的顶部。

viewed

boolean

可选。指示用户是否已查看过代理。

AgentSharingState

代理可能的共享状态。

枚举
AGENT_SHARING_STATE_UNSPECIFIED 共享状态未指定。
NOT_SHARED 代理未共享。
PENDING 代理待审核。
SHARED 代理已与其他用户共享。
REJECTED 代理共享请求已遭拒。