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

リソース: Agent

事前定義された特定のタスクを実行します。

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

ID。エージェントのリソース名。形式: 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)

省略可。UI でエージェントを表すアイコン。
createTime

string (Timestamp format)

出力専用。このエージェントが作成されたときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に 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 正規化され、小数点以下は 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

省略可。description、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

 一般公開されているエージェントを取り消します。