REST Resource: projects.locations.collections.engines.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 の場合にのみ設定されます。

AdkAgentDefinition

ADK を使用して Agent Engine（以前の Reasoning Engine）にデプロイされるエージェントの定義を保存します。

JSON 表現 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "provisionedReasoningEngine": {
    object (ProvisionedReasoningEngine)
  },
  "authorizations": [
    string
  ]
}
フィールド
toolSettings

object (AgentToolSettings)

省略可。エージェントをプランナー LLM に提示する方法を定義するパラメータ。
provisionedReasoningEngine

object (ProvisionedReasoningEngine)

省略可。エージェントが接続されている推論エンジン。
authorizations[]
(deprecated)

string

省略可。非推奨: 代わりに Agent.authorizations を使用してください。必要な認可のリソース名。ユーザーが承認されていない場合、サービスはユーザーがブラウザで開いて承認する必要がある認証 URI を返します。すべての承認が付与されると、ユーザーはクエリを再試行できます。承認はエージェントに転送されます。

形式: projects/{project}/locations/{location}/authorizations/{authorization}

AgentToolSettings

Agentspace プランナー LLM にエージェントを表すツールの設定。

JSON 表現 
{
  "toolDescription": string,
  "inputParameterName": string,
  "inputParameterDescription": string
}
フィールド
toolDescription

string

必須。これは、エージェントをいつ使用すべきかを説明するために LLM によって使用される場合があります。
inputParameterName

string

省略可。関数呼び出しのパラメータ名。このパラメータ名は、そのパラメータに想定されているコンテンツの種類についての LLM 向けのヒントとなります（例: 「質問」、「コマンド」、「検索クエリ」など）。
inputParameterDescription

string

省略可。関数呼び出しのパラメータの説明。この説明は、パラメータに関して LLM 向けに詳細情報（例: 渡されることが想定されているコンテンツの種類、そのコンテンツに対して行うべき操作など）を提供します。

ProvisionedReasoningEngine

エージェントが接続されている推論エンジンを追跡します。このメッセージは、エージェントのライフサイクルを追跡することを目的としたものではありません。代わりに、推論エンジンにすでにデプロイされているエージェントに接続するためのパラメータを定義するためにのみ使用されます。

JSON 表現 
{
  "reasoningEngine": string
}
フィールド
reasoningEngine

string

必須。エージェントが接続されている推論エンジン。形式: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}

ManagedAgentDefinition

Google マネージド エージェントの定義を保存します。

JSON 表現 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "authorizations": [
    string
  ],
  "deploymentInfo": {
    object (DeploymentInfo)
  },

  // Union field agent_config can be only one of the following:
  "dataScienceAgentConfig": {
    object (DataScienceAgentConfig)
  }
  // End of list of possible types for union field agent_config.
}
フィールド
toolSettings

object (AgentToolSettings)

省略可。エージェントをプランナー LLM に提示する方法を定義するパラメータ。
authorizations[]
(deprecated)

string

省略可。非推奨: 代わりに Agent.authorizations を使用してください。必要な認可のリソース名。ユーザーが承認されていない場合、サービスはユーザーがブラウザで開いて承認する必要がある認証 URI を返します。すべての承認が付与されると、ユーザーはクエリを再試行できます。承認はエージェントに転送されます。

形式: projects/{project}/locations/{location}/authorizations/{authorization}
deploymentInfo

object (DeploymentInfo)

出力専用。エージェントの自動デプロイ情報。
共用体フィールド agent_config。エージェント タイプ固有の構成。agent_config は次のいずれかになります。
dataScienceAgentConfig

object (DataScienceAgentConfig)

省略可。Google の事前作成されたデータ サイエンス エージェントに固有の構成。このデータ構造は、エージェントのデプロイとリクエスト時間の構成を保存することを目的としています。

DataScienceAgentConfig

Google の事前作成されたデータ サイエンス エージェントに固有の構成。このデータ構造は、エージェントのデプロイとリクエスト時間の構成を保存することを目的としています。

JSON 表現 
{
  "bqProjectId": string,
  "bqDatasetId": string,
  "blocklistTables": [
    string
  ],
  "allowlistTables": [
    string
  ],
  "nlQueryConfig": {
    object (NlQueryConfig)
  }
}
フィールド
bqProjectId

string

必須。データセットが存在する BigQuery プロジェクト ID。
bqDatasetId

string

必須。エージェントに使用する BigQuery データセット ID。データセットは、bqProjectId で指定されたプロジェクトに存在する必要があります。
blocklistTables[]

string

省略可。エージェントによる使用をブロックする BigQuery テーブル。
allowlistTables[]

string

省略可。エージェントによる使用を許可する BigQuery テーブル。
nlQueryConfig

object (NlQueryConfig)

省略可。お客様が提供した構成。

NlQueryConfig

自然言語から SQL/Python コードへの変換に固有の、お客様が提供した構成を定義します。

JSON 表現 
{
  "nl2sqlPrompt": string,
  "nl2pyPrompt": string,
  "nl2sqlExamples": [
    {
      object (Nl2SqlExample)
    }
  ],
  "schemaDescription": string,
  "bqSqlGenUseCustomPrompt": boolean
}
フィールド
nl2sqlPrompt

string

省略可。お客様が NL2SQL の手順を提供した
nl2pyPrompt

string

省略可。お客様は、データ分析用の Python コードを作成するよう LLM に指示しました。
nl2sqlExamples[]

object (Nl2SqlExample)

省略可。お客様から、入力と期待される SQL の両方を含む NL2SQL の例が提供されました。
schemaDescription

string

省略可。BigQuery データセットのスキーマの自然言語による説明。
bqSqlGenUseCustomPrompt

boolean

省略可。BigQuery SQL Gen サービスでカスタム プロンプトを使用するかどうか。

Nl2SqlExample

単一の NL2SQL の例。

JSON 表現 
{
  "query": string,
  "expectedSql": string,
  "expectedResponse": string
}
フィールド
query

string

省略可。回答する自然言語クエリ。
expectedSql

string

省略可。想定される SQL 出力。
expectedResponse

string

省略可。クエリに対する想定されるレスポンス。

DeploymentInfo

エージェントの自動デプロイ情報。

JSON 表現 
{
  "operation": string,
  "finishTime": string
}
フィールド
operation

string

出力専用。デプロイの長時間実行オペレーション リソース。デプロイ ステータスのポーリングに使用できます。デプロイが完了すると、このフィールドは空になります。デプロイが失敗した場合、このフィールドには失敗した LRO のリソース名が含まれますが、オペレーション リソース自体はしばらくすると自動的に削除されます。
finishTime

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"。

A2AAgentDefinition

A2A を使用するエージェントの保存された定義。

JSON 表現 
{

  // Union field agent_card can be only one of the following:
  "jsonAgentCard": string,
  "remoteAgentCard": {
    object (RemoteAgentcard)
  }
  // End of list of possible types for union field agent_card.
}
Fields
共用体フィールド agent_card。エージェントの名前、機能、認証情報などを保存します。agent_card には次のいずれか 1 つだけを指定できます。
jsonAgentCard

string

省略可。エージェント カードは JSON 文字列です。
remoteAgentCard

object (RemoteAgentcard)

省略可。リモート エージェント カード。

RemoteAgentcard

リモートでホストされるエージェント カードの定義。

JSON 表現 
{
  "uri": string
}
フィールド
uri

string

必須。エージェント カードの URI。

DialogflowAgentDefinition

Dialogflow エージェントを使用するエージェントの保存された定義。

JSON 表現 
{
  "toolSettings": {
    object (AgentToolSettings)
  },
  "dialogflowAgent": string
}
フィールド
toolSettings

object (AgentToolSettings)

省略可。エージェントをプランナー LLM に提示する方法を定義するパラメータ。
dialogflowAgent

string

必須。基盤となる Dialogflow エージェントのリソース名。形式: projects/{project}/locations/{location}/agents/{agent}

画像

画像を表します。

JSON 表現 
{

  // Union field storage_method can be only one of the following:
  "uri": string,
  "content": string
  // End of list of possible types for union field storage_method.
}
Fields
共用体フィールド storage_method。URI または base64 文字列としてエンコードされたコンテンツのいずれかになります。storage_method は次のいずれかになります。
uri

string

イメージの URI。
content

string

Base64 でエンコードされた画像ファイルの内容。

AuthorizationConfig

必要な承認について説明します。

JSON 表現 
{
  "toolAuthorizations": [
    string
  ],
  "agentAuthorization": string
}
フィールド
toolAuthorizations[]

string

省略可。エージェントが他のリソースにアクセスするために必要な承認のリスト。認証トークンは、リクエスト本文の一部としてエージェントに渡されます。
agentAuthorization

string

省略可。エージェントの呼び出しに必要な承認。認証トークンは、リクエストの認証ヘッダーの一部としてエージェントに渡されます。

DataStoreSpecs

データストア仕様のセットを表します。

JSON 表現 
{
  "specs": [
    {
      object (DataStoreSpec)
    }
  ]
}
フィールド
specs[]

object (DataStoreSpec)

省略可。検索呼び出しでフィルタする DataStore と、それらのデータストアの構成を定義する仕様。これは、複数のデータストアを持つ Engine でのみ考慮されます。

状態

エージェントのライフサイクル ステータスの有効な値。

列挙型
STATE_UNSPECIFIED 状態は指定されていません。
CONFIGURED エージェントは構成されていますが、まだデプロイはトリガーされていません。
DEPLOYING エージェントがデプロイされています。
DISABLED エージェントは管理者のみが利用できます。
DEPLOYMENT_FAILED エージェントのデプロイに失敗しました。
PRIVATE エージェントは作成者のみが利用できます。
ENABLED エージェントは、アクセス権を持つユーザーが利用できます。
SUSPENDED エージェントは一時的に利用できませんが、アクセス権を持つユーザーには表示されます。

StarterPrompt

エージェントのランディング ページでユーザーに表示するスターター プロンプトの候補。

JSON 表現 
{
  "text": string
}
フィールド
text

string

必須。スターター プロンプトのテキスト。

メソッド

create

 Agent を作成します。

delete

 Agent を削除します。

deploy

 Agent をデプロイします。

get

 Agent を取得します。

getAgentView

 指定された Agent の AgentView を返します。これには、エージェントに関する追加情報が含まれています。

list

 呼び出し元によって作成された Assistant のすべての Agent を一覧表示します。

patch

 Agent を更新します