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)

省略可。UI でエージェントを表すアイコン。
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

エージェントが一時停止された理由。状態が一時停止の場合にのみ設定されます。
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 に基づく、Agent のユーザー単位のアノテーション。

JSON 表現 
{
  "pinned": boolean,
  "viewed": boolean
}
フィールド
pinned

boolean

省略可。エージェントが固定されているかどうか。固定されているエージェントはエージェント リストの上部に表示されます。
viewed

boolean

省略可。エージェントがユーザーに表示されたかどうか。

AgentSharingState

エージェントが取り得る共有状態。

列挙型
AGENT_SHARING_STATE_UNSPECIFIED 共有状態が指定されていません。
NOT_SHARED エージェントは共有されません。
PENDING エージェントは審査待ちです。
SHARED エージェントが他のユーザーと共有されています。
REJECTED エージェントの共有リクエストが拒否されました。