MCP Tools Reference: ces.googleapis.com

ツール: list_app_versions

指定されたアプリのすべてのアプリ バージョンを一覧表示します。

次のコードサンプルは、curl を使用して list_app_versions MCP ツールを呼び出す方法を示しています。

Curl リクエスト
curl --location 'https://ces.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "list_app_versions",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

入力スキーマ

AgentService.ListAppVersions のリクエスト メッセージです。

ListAppVersionsRequest

JSON 表現
{
  "parent": string,
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "orderBy": string
}
フィールド
parent

string

必須。アプリのバージョンを一覧表示するアプリのリソース名。

pageSize

integer

省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。

pageToken

string

省略可。前の list AgentService.ListAppVersions 呼び出しから返された next_page_token 値。

filter

string

省略可。アプリのバージョンを一覧表示するときに適用するフィルタ。詳しくは、https://google.aip.dev/160 をご覧ください。

orderBy

string

省略可。並べ替えの基準となるフィールド。「name」と「create_time」のみがサポートされています。詳しくは、https://google.aip.dev/132#ordering をご覧ください。

出力スキーマ

AgentService.ListAppVersions に対するレスポンス メッセージです。

ListAppVersionsResponse

JSON 表現
{
  "appVersions": [
    {
      object (AppVersion)
    }
  ],
  "nextPageToken": string
}
フィールド
appVersions[]

object (AppVersion)

アプリのバージョンのリスト。

nextPageToken

string

次のページを取得するために ListAppVersionsRequest.page_token として送信できるトークン。このフィールドがない場合は、後続のページがないことを示します。

AppVersion

JSON 表現
{
  "name": string,
  "displayName": string,
  "description": string,
  "creator": string,
  "createTime": string,
  "updateTime": string,
  "snapshot": {
    object (AppSnapshot)
  },
  "etag": string
}
フィールド
name

string

ID。アプリ バージョンの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/versions/{version}

displayName

string

省略可。アプリ バージョンの表示名。

description

string

省略可。アプリのバージョンの説明。

creator

string

出力専用。アプリ バージョンを作成したユーザーのメールアドレス。

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

snapshot

object (AppSnapshot)

出力専用。バージョンが作成されたときのアプリのスナップショット。

etag

string

出力専用。読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される Etag。etag が空の場合、更新によって同時変更が上書きされます。

タイムスタンプ

JSON 表現
{
  "seconds": string,
  "nanos": integer
}
フィールド
seconds

string (int64 format)

UNIX エポック 1970-01-01T00:00:00Z からの UTC 時刻の秒数を表します。-62135596800~253402300799 の範囲(両端を含む)にする必要があります(これは 0001-01-01T00:00:00Z~9999-12-31T23:59:59Z に対応します)。

nanos

integer

ナノ秒分解能による、秒の負ではない小数以下部分。このフィールドは、秒の代替ではなく、期間のナノ秒部分です。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない nanos 値を持つ必要があります。0~999,999,999 にする必要があります(両端を含む)。

AppSnapshot

JSON 表現
{
  "app": {
    object (App)
  },
  "agents": [
    {
      object (Agent)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "examples": [
    {
      object (Example)
    }
  ],
  "guardrails": [
    {
      object (Guardrail)
    }
  ],
  "toolsets": [
    {
      object (Toolset)
    }
  ]
}
フィールド
app

object (App)

省略可。アプリの基本設定。

agents[]

object (Agent)

省略可。アプリ内のエージェントのリスト。

tools[]

object (Tool)

省略可。アプリ内のツールのリスト。

examples[]

object (Example)

省略可。アプリ内の例のリスト。

guardrails[]

object (Guardrail)

省略可。アプリのガードレールのリスト。

toolsets[]

object (Toolset)

省略可。アプリ内のツールセットのリスト。

アプリ

JSON 表現
{
  "name": string,
  "displayName": string,
  "description": string,
  "pinned": boolean,
  "rootAgent": string,
  "languageSettings": {
    object (LanguageSettings)
  },
  "timeZoneSettings": {
    object (TimeZoneSettings)
  },
  "audioProcessingConfig": {
    object (AudioProcessingConfig)
  },
  "loggingSettings": {
    object (LoggingSettings)
  },
  "errorHandlingSettings": {
    object (ErrorHandlingSettings)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "toolExecutionMode": enum (ToolExecutionMode),
  "evaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds)
  },
  "variableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "predefinedVariableDeclarations": [
    {
      object (VariableDeclaration)
    }
  ],
  "globalInstruction": string,
  "guardrails": [
    string
  ],
  "dataStoreSettings": {
    object (DataStoreSettings)
  },
  "defaultChannelProfile": {
    object (ChannelProfile)
  },
  "metadata": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "deploymentCount": integer,
  "clientCertificateSettings": {
    object (ClientCertificateSettings)
  },
  "vpcScSettings": {
    object (VpcScSettings)
  },
  "locked": boolean,
  "validationErrors": [
    string
  ],
  "dashboardSettings": {
    object (DashboardSettings)
  }
}
フィールド
name

string

ID。アプリの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}

displayName

string

必須。アプリの表示名。

description

string

省略可。人が読める形式のアプリの説明。

pinned

boolean

省略可。アプリがアプリ一覧に固定されているかどうか。

rootAgent

string

省略可。ルート エージェントはアプリのエントリ ポイントです。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

languageSettings

object (LanguageSettings)

省略可。アプリの言語設定。

timeZoneSettings

object (TimeZoneSettings)

省略可。アプリのタイムゾーン設定。

audioProcessingConfig

object (AudioProcessingConfig)

省略可。アプリの音声処理構成。

loggingSettings

object (LoggingSettings)

省略可。アプリのロギング設定。

errorHandlingSettings

object (ErrorHandlingSettings)

省略可。アプリのエラー処理設定。

modelSettings

object (ModelSettings)

省略可。アプリのデフォルトの LLM モデル設定。個々のリソース(エージェント、ガードレールなど)は、必要に応じてこれらの構成をオーバーライドできます。

toolExecutionMode

enum (ToolExecutionMode)

省略可。アプリのツール実行モード。指定しない場合、デフォルトは PARALLEL です。

evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

省略可。アプリの評価しきい値。

variableDeclarations[]

object (VariableDeclaration)

省略可。変数の宣言。

predefinedVariableDeclarations[]

object (VariableDeclaration)

出力専用。アプリの事前定義変数の宣言。

globalInstruction

string

省略可。アプリ内のすべてのエージェント向けの手順。この手順を使用して、すべてのエージェントに安定した ID またはパーソナリティを設定できます。

guardrails[]

string

省略可。アプリのガードレールのリスト。形式: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

dataStoreSettings

object (DataStoreSettings)

省略可。アプリのデータストア設定。

defaultChannelProfile

object (ChannelProfile)

省略可。アプリで使用されるデフォルトのチャンネル プロファイル。

metadata

map (key: string, value: string)

省略可。アプリに関するメタデータ。このフィールドは、アプリの詳細や想定される用途に関連する追加情報を保存するために使用できます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

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

etag

string

出力専用。読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される Etag。etag が空の場合、更新によって同時変更が上書きされます。

deploymentCount

integer

出力専用。アプリ内のデプロイ数。

clientCertificateSettings

object (ClientCertificateSettings)

省略可。アプリのデフォルトのクライアント証明書の設定。

vpcScSettings

object (VpcScSettings)

省略可。アプリの VPC-SC 設定。

locked

boolean

省略可。アプリが変更のためにロックされているかどうかを示します。アプリがロックされている場合、アプリリソースの変更は拒否されます。

validationErrors[]

string

出力専用。アプリの構成ミスまたは警告。

dashboardSettings

object (DashboardSettings)

省略可。Contact Center Insights ダッシュボードをリンクして構成するためのアプリ固有のダッシュボード設定。

LanguageSettings

JSON 表現
{
  "defaultLanguageCode": string,
  "supportedLanguageCodes": [
    string
  ],
  "enableMultilingualSupport": boolean,
  "fallbackAction": string
}
フィールド
defaultLanguageCode

string

省略可。アプリのデフォルトの言語コード。

supportedLanguageCodes[]

string

省略可。default_language_code に加えて、アプリでサポートされている言語コードのリスト。

enableMultilingualSupport

boolean

省略可。多言語サポートを有効にします。true の場合、アプリ内のエージェントは、事前構築済みの指示を使用して、多言語入力の処理を改善します。

fallbackAction
(deprecated)

string

省略可。非推奨: この機能はサポートされなくなりました。代わりに enable_multilingual_support を使用して、多言語入力の処理を改善します。エージェントがサポートされていない言語で入力を受け取ったときに実行するアクション。

これは、事前定義されたアクションまたはカスタム ツール呼び出しです。有効な値は次のとおりです。- ツールの完全なリソース名。特定のツールの実行をトリガーします。- 「エスカレーション」や「終了」などの事前定義されたシステム アクション。対応する metadata を含む EndSession シグナルをトリガーして会話を終了します。

TimeZoneSettings

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

string

省略可。タイムゾーン データベースに登録されているアプリのタイムゾーン(例: America/Los_Angeles、Europe/Paris)。

AudioProcessingConfig

JSON 表現
{
  "synthesizeSpeechConfigs": {
    string: {
      object (SynthesizeSpeechConfig)
    },
    ...
  },
  "bargeInConfig": {
    object (BargeInConfig)
  },
  "inactivityTimeout": string,
  "ambientSoundConfig": {
    object (AmbientSoundConfig)
  },
  "customVoiceSamples": [
    {
      object (CustomVoiceSample)
    }
  ]
}
フィールド
synthesizeSpeechConfigs

map (key: string, value: object (SynthesizeSpeechConfig))

省略可。エージェントのレスポンスを合成する方法の構成。言語コードから SynthesizeSpeechConfig へのマッピング。

指定した言語コードの構成が見つからない場合は、ルート言語コードの構成が使用されます。たとえば、マップに「en-us」と「en」が含まれていて、指定された言語コードが「en-gb」の場合、「en」の構成が使用されます。

注: 言語コードでは大文字と小文字が区別されません。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

bargeInConfig

object (BargeInConfig)

省略可。ユーザーの割り込みアクティビティに対するエージェントの動作を構成します。

inactivityTimeout

string (Duration format)

省略可。エージェントがユーザーに再エンゲージメントを促すまでの、ユーザーが操作を行っていない(発話や操作がない)時間。設定されていない場合、エージェントはユーザーに再エンゲージメントを促しません。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

ambientSoundConfig

object (AmbientSoundConfig)

省略可。合成されたエージェントのレスポンスとともに再生される環境音の構成。会話の自然さを高めます。

customVoiceSamples[]

object (CustomVoiceSample)

省略可。音声クローンのカスタム音声サンプルを構成します。

SynthesizeSpeechConfigsEntry

JSON 表現
{
  "key": string,
  "value": {
    object (SynthesizeSpeechConfig)
  }
}
フィールド
key

string

value

object (SynthesizeSpeechConfig)

SynthesizeSpeechConfig

JSON 表現
{
  "voice": string,
  "speakingRate": number,
  "model": string,
  "instruction": string
}
フィールド
voice

string

省略可。声の名前。設定されていない場合、サービスは language_code などの他のパラメータに基づいて音声を選択します。

利用可能な音声の一覧については、Cloud Text-to-Speech のサポートされている音声と言語をご覧ください。

speakingRate

number

省略可。読み上げ速度([0.25, 2.0] の範囲)。1.0 は、特定の声でサポートされているネイティブの通常の発声速度を表します。2.0 はその 2 倍の速さで、0.5 は半分の速さです。[0.25, 2.0] の範囲外の値を指定するとエラーが返されます。

model

string

省略可。音声の合成に使用されるモデル。現在サポートされている値: - "gemini-3.1-flash-tts-preview"。空の場合、Chirp3-HD が使用されます。

instruction

string

省略可。生成モデルを使用するときに音声を合成するために使用される指示。

BargeInConfig

JSON 表現
{
  "disableBargeIn": boolean,
  "bargeInAwareness": boolean
}
フィールド
disableBargeIn
(deprecated)

boolean

省略可。非推奨: ChannelProfile では disable_barge_in は非推奨となり、disable_barge_in_control が推奨されます。

エージェントが話している間のユーザーの割り込みを無効にします。true の場合、エージェントのレスポンスの再生中のユーザー入力は無視されます。

bargeInAwareness

boolean

省略可。有効にすると、エージェントは、ユーザーが前のエージェント メッセージをすべて聞いていないという前提に基づいて、次のレスポンスを調整します。エージェントの回答が視覚的に表示されるシナリオでは、この機能を使用しないでください。

所要時間

JSON 表現
{
  "seconds": string,
  "nanos": integer
}
フィールド
seconds

string (int64 format)

期間の秒数(符号付き)。-315,576,000,000 ~+315,576,000,000 の範囲(境界を含む)になります。注: これらの境界は、60 秒/分 * 60 分/時間 * 24 時間/日 * 365.25 日/年 * 10,000 年から計算されます。

nanos

integer

期間のナノ秒分解能による、秒の符号付き小数以下部分。1 秒未満の期間は、0 の seconds フィールドと、正または負の nanos フィールドで表されます。1 秒以上の期間の場合、nanos フィールドのゼロ以外の値は seconds フィールドと同じ符号にする必要があります。-999,999,999~+999,999,999 の範囲内(境界含む)である必要があります。

AmbientSoundConfig

JSON 表現
{
  "volumeGainDb": number,

  // Union field source can be only one of the following:
  "prebuiltAmbientNoise": enum (PrebuiltAmbientNoise),
  "gcsUri": string,
  "prebuiltAmbientSound": string
  // End of list of possible types for union field source.
}
フィールド
volumeGainDb

number

省略可。周囲のノイズでサポートされる通常のネイティブ音量の音量ゲイン(dB)。範囲は [-96.0, 16.0] です。未設定にするか、0.0(dB)に設定すると、ネイティブの通常の信号振幅で再生されます。-6.0(dB)に設定すると、ネイティブの通常の信号振幅の約半分の振幅で再生されます。+6.0(dB)に設定すると、ネイティブの通常の信号振幅の約 2 倍の振幅で再生されます。+10(dB)より大きい値を指定しないことを強くおすすめします。通常は、そのような大きい値を指定しても音量は効果的に増加しません。

共用体フィールド source。合成されたエージェントのレスポンスとともに再生される周囲のノイズ。会話の自然さを高めます。source は次のいずれかになります。
prebuiltAmbientNoise
(deprecated)

enum (PrebuiltAmbientNoise)

省略可。非推奨: prebuilt_ambient_noise は非推奨となり、prebuilt_ambient_sound に置き換えられました。

gcsUri

string

省略可。Cloud Storage に保存されているモノラル チャンネル、16 kHz の WAV ファイルとしての周囲のノイズ。

注: CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com に Cloud Storage オブジェクトに対する storage.objects.get 権限があることを確認してください。

prebuiltAmbientSound

string

省略可。プリビルドの環境音の名前。有効な値は次のとおりです。- "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"

CustomVoiceSample

JSON 表現
{
  "name": string,
  "voiceSampleGcsUri": string,
  "consentAudioGcsUri": string,
  "voiceInstruction": string,
  "previewAudioContent": string,
  "previewText": string,
  "warnings": [
    {
      object (Warning)
    }
  ],
  "voiceInstructionMode": enum (VoiceInstructionMode)
}
フィールド
name

string

省略可。カスタム音声サンプルのユーザー定義名。

voiceSampleGcsUri

string

省略可。音声クローンの音声サンプルの Cloud Storage URI。音声サンプルは、モノラル チャンネルの 24 kHz WAV ファイルである必要があります。

consentAudioGcsUri

string

省略可。音声クローニングの同意音声。

voiceInstruction

string

省略可。声のスタイル、トーン、ペース、発音に関する自然言語による指示。

previewAudioContent

string (bytes format)

出力専用。カスタム音声用に合成されたプレビュー音声。正規 WAV(LINEAR16、24kHz、16 ビット、モノラル)形式。

Base64 でエンコードされた文字列。

previewText

string

省略可。カスタム音声のプレビュー音声を合成するためのテキスト。

warnings[]

object (Warning)

出力専用。音声クローンの処理中に発生した警告メッセージ(音声レベルが低いなど)。

voiceInstructionMode

enum (VoiceInstructionMode)

省略可。音声サンプルの指示モード。指定しない場合、デフォルトは NO_INSTRUCTION です。

警告

JSON 表現
{
  "message": string,
  "type": enum (WarningType)
}
フィールド
message

string

出力専用。警告の説明(人が読める形式)。

type

enum (WarningType)

出力専用。警告のタイプ。

LoggingSettings

JSON 表現
{
  "redactionConfig": {
    object (RedactionConfig)
  },
  "audioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "unredactedAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "bigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "unredactedBigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "cloudLoggingSettings": {
    object (CloudLoggingSettings)
  },
  "conversationLoggingSettings": {
    object (ConversationLoggingSettings)
  },
  "evaluationAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "metricAnalysisSettings": {
    object (MetricAnalysisSettings)
  },
  "requiredRecordingConsent": boolean
}
フィールド
redactionConfig

object (RedactionConfig)

省略可。機密データを秘匿化する方法の構成。

audioRecordingConfig

object (AudioRecordingConfig)

省略可。音声インタラクションの録音方法の構成。音声は、RedactionConfig で構成されているとおりに秘匿化されます。

unredactedAudioRecordingConfig

object (AudioRecordingConfig)

省略可。編集されていない音声の追加録音を構成します。これは、音声の秘匿化が enabled の場合に、通常は監査またはモニタリングの目的で、未加工の音声コピーを保持するために使用できます。

bigqueryExportSettings

object (BigQueryExportSettings)

省略可。アプリの BigQuery Export 動作を構成します。会話データは、RedactionConfig で構成された秘匿化の対象となります。

unredactedBigqueryExportSettings

object (BigQueryExportSettings)

省略可。アプリの BigQuery Export 動作を構成します。有効にすると、編集されていない会話データが BigQuery テーブルにエクスポートされます。

cloudLoggingSettings

object (CloudLoggingSettings)

省略可。アプリの Cloud Logging の動作を記述する設定。

conversationLoggingSettings

object (ConversationLoggingSettings)

省略可。アプリの会話ロギング動作を記述する設定。

evaluationAudioRecordingConfig

object (AudioRecordingConfig)

省略可。評価のために音声インタラクションを録音する方法の構成。デフォルトでは、評価セッションの音声録音は有効になっていません。

metricAnalysisSettings

object (MetricAnalysisSettings)

省略可。アプリの LLM 分析パイプラインの会話データの収集動作を記述する設定。

requiredRecordingConsent

boolean

省略可。アプリが録音内容を事前に通知する必要があるかどうか。

true の場合、セッションは録音をオフにして開始され、クライアントが SessionInput.recording_control を送信するまでオフのままになります。その後、その時点からすべてのターンが決定されます。これには、音声録音、会話履歴、BigQuery Export、Cloud Logging が含まれます。

false(デフォルト)の場合、上記の設定が独自に決定され、クライアントは何も送信する必要がありません。

RedactionConfig

JSON 表現
{
  "enableRedaction": boolean,
  "inspectTemplate": string,
  "deidentifyTemplate": string
}
フィールド
enableRedaction

boolean

省略可。true の場合、会話履歴、Cloud Logging、音声録音など、さまざまなロギング シナリオで秘匿化が適用されます。

inspectTemplate

string

省略可。機密データの種類の検出を構成するための DLP 検査テンプレート名。

形式: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}

deidentifyTemplate

string

省略可。コンテンツの匿名化方法を指示する DLP 匿名化テンプレート名。

形式: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

AudioRecordingConfig

JSON 表現
{
  "gcsBucket": string,
  "gcsPathPrefix": string
}
フィールド
gcsBucket

string

省略可。セッションの音声録音を保存する Cloud Storage バケット。URI は「gs://」で始まる必要があります。

データ所在地の要件を満たすバケットのロケーションを選択してください。

注: Cloud Storage バケットがアプリとは異なるプロジェクトにある場合は、CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com に storage.objects.create 権限を付与する必要があります。

gcsPathPrefix

string

省略可。音声録音の Cloud Storage パスの接頭辞。

この接頭辞には、次のプレースホルダを含めることができます。これらのプレースホルダは、提供時に動的に置き換えられます。- $project: プロジェクト ID - $location: アプリの場所 - $app: アプリ ID - $date: YYYY-MM-DD 形式のセッション日付 - $session: セッション ID

パスの接頭辞が指定されていない場合は、デフォルトの接頭辞 $project/$location/$app/$date/$session/ が使用されます。

BigQueryExportSettings

JSON 表現
{
  "enabled": boolean,
  "project": string,
  "dataset": string
}
フィールド
enabled

boolean

省略可。BigQuery Export が有効になっているかどうかを示します。

project

string

省略可。データのエクスポート先となる BigQuery データセットのプロジェクト ID。

注: BigQuery データセットがアプリとは異なるプロジェクトにある場合は、CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com に roles/bigquery.admin ロールを付与する必要があります。

dataset

string

省略可。データのエクスポート先となる BigQuery データセット ID。

CloudLoggingSettings

JSON 表現
{
  "enableCloudLogging": boolean
}
フィールド
enableCloudLogging

boolean

省略可。セッションで Cloud Logging を有効にするかどうか。

ConversationLoggingSettings

JSON 表現
{
  "disableConversationLogging": boolean,
  "retentionWindow": string
}
フィールド
disableConversationLogging

boolean

省略可。セッションの会話ロギングを無効にするかどうか。

retentionWindow

string (Duration format)

省略可。会話の保持期間を制御します。設定しない場合、会話は 365 日間保持されます。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

MetricAnalysisSettings

JSON 表現
{
  "llmMetricsOptedOut": boolean
}
フィールド
llmMetricsOptedOut

boolean

省略可。LLM 分析指標の会話データを収集するかどうか。true の場合、会話データは LLM 分析指標用に収集されません。それ以外の場合、会話データは収集されます。

ErrorHandlingSettings

JSON 表現
{
  "errorHandlingStrategy": enum (ErrorHandlingStrategy),
  "fallbackResponseConfig": {
    object (FallbackResponseConfig)
  },
  "endSessionConfig": {
    object (EndSessionConfig)
  }
}
フィールド
errorHandlingStrategy

enum (ErrorHandlingStrategy)

省略可。エラー処理に使用する戦略。

fallbackResponseConfig

object (FallbackResponseConfig)

省略可。フォールバック レスポンスを処理するための構成。

endSessionConfig

object (EndSessionConfig)

省略可。システムエラー(LLM エラーなど)が発生した場合にセッションを終了するための構成。

FallbackResponseConfig

JSON 表現
{
  "customFallbackMessages": {
    string: string,
    ...
  },
  "maxFallbackAttempts": integer
}
フィールド
customFallbackMessages

map (key: string, value: string)

省略可。システムエラー(LLM エラーなど)が発生した場合の代替メッセージ。サポートされている言語コードでマッピングされます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

maxFallbackAttempts

integer

省略可。エージェントが EndSession シグナルを出力する前に試行するフォールバックの最大数。

CustomFallbackMessagesEntry

JSON 表現
{
  "key": string,
  "value": string
}
フィールド
key

string

value

string

EndSessionConfig

JSON 表現
{

  // Union field _escalate_session can be only one of the following:
  "escalateSession": boolean
  // End of list of possible types for union field _escalate_session.
}
フィールド

共用体フィールド _escalate_session。

_escalate_session は次のいずれかになります。

escalateSession

boolean

省略可。EndSession でセッションをエスカレーションするかどうか。セッションがエスカレーションされた場合、metadata in EndSession に session_escalated = true が含まれます。詳しくは、https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent をご覧ください。

ModelSettings

JSON 表現
{
  "model": string,
  "thinkingLevel": enum (ThinkingLevel),

  // Union field _temperature can be only one of the following:
  "temperature": number
  // End of list of possible types for union field _temperature.
}
フィールド
model

string

省略可。エージェントが使用する LLM モデル。設定されていない場合、エージェントは親エージェントからモデルを継承します。

thinkingLevel

enum (ThinkingLevel)

省略可。モデルの思考レベル。

共用体フィールド _temperature。

_temperature は次のいずれかになります。

temperature

number

省略可。設定すると、この温度が LLM モデルに使用されます。Temperature は、モデルの回答のランダム性を制御します。温度が低いほど、予測可能な回答が生成されます。温度が高いほど、より創造的な回答が生成されます。

EvaluationMetricsThresholds

JSON 表現
{
  "goldenEvaluationMetricsThresholds": {
    object (GoldenEvaluationMetricsThresholds)
  },
  "hallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "goldenHallucinationMetricBehavior": enum (HallucinationMetricBehavior),
  "scenarioHallucinationMetricBehavior": enum (HallucinationMetricBehavior)
}
フィールド
goldenEvaluationMetricsThresholds

object (GoldenEvaluationMetricsThresholds)

省略可。ゴールデン評価指標のしきい値。

hallucinationMetricBehavior
(deprecated)

enum (HallucinationMetricBehavior)

省略可。非推奨: 代わりに、golden_hallucination_metric_behavior を使用してください。ハルシネーション指標の動作は、現在、ゴールデン評価に使用されています。

goldenHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

省略可。ゴールデン評価のハルシネーション指標の動作。

scenarioHallucinationMetricBehavior

enum (HallucinationMetricBehavior)

省略可。シナリオ評価のハルシネーション指標の動作。

GoldenEvaluationMetricsThresholds

JSON 表現
{
  "turnLevelMetricsThresholds": {
    object (TurnLevelMetricsThresholds)
  },
  "expectationLevelMetricsThresholds": {
    object (ExpectationLevelMetricsThresholds)
  },
  "toolMatchingSettings": {
    object (ToolMatchingSettings)
  }
}
フィールド
turnLevelMetricsThresholds

object (TurnLevelMetricsThresholds)

省略可。ターンレベルの指標のしきい値。

expectationLevelMetricsThresholds

object (ExpectationLevelMetricsThresholds)

省略可。期待値レベルの指標のしきい値。

toolMatchingSettings

object (ToolMatchingSettings)

省略可。ツールのマッチング設定。余分なツール呼び出しとは、実行中に存在するものの、ゴールデン エクスペクテーションのツール呼び出しと一致しないツール呼び出しです。

TurnLevelMetricsThresholds

JSON 表現
{
  "semanticSimilarityChannel": enum (SemanticSimilarityChannel),

  // Union field _semantic_similarity_success_threshold can be only one of the
  // following:
  "semanticSimilaritySuccessThreshold": integer
  // End of list of possible types for union field
  // _semantic_similarity_success_threshold.

  // Union field _overall_tool_invocation_correctness_threshold can be only one
  // of the following:
  "overallToolInvocationCorrectnessThreshold": number
  // End of list of possible types for union field
  // _overall_tool_invocation_correctness_threshold.
}
フィールド
semanticSimilarityChannel

enum (SemanticSimilarityChannel)

省略可。評価に使用するセマンティック類似性チャネル。

共用体フィールド _semantic_similarity_success_threshold。

_semantic_similarity_success_threshold は次のいずれかになります。

semanticSimilaritySuccessThreshold

integer

省略可。意味的類似性の成功しきい値。0 ~ 4 の整数を指定してください。デフォルトは >= 3 です。

共用体フィールド _overall_tool_invocation_correctness_threshold。

_overall_tool_invocation_correctness_threshold は次のいずれかになります。

overallToolInvocationCorrectnessThreshold

number

省略可。ツール呼び出しの全体的な正確性の成功しきい値。0 ~ 1 の浮動小数点数にする必要があります。デフォルトは 1.0 です。

ExpectationLevelMetricsThresholds

JSON 表現
{

  // Union field _tool_invocation_parameter_correctness_threshold can be only one
  // of the following:
  "toolInvocationParameterCorrectnessThreshold": number
  // End of list of possible types for union field
  // _tool_invocation_parameter_correctness_threshold.
}
フィールド

共用体フィールド _tool_invocation_parameter_correctness_threshold。

_tool_invocation_parameter_correctness_threshold は次のいずれかになります。

toolInvocationParameterCorrectnessThreshold

number

省略可。個々のツール呼び出しパラメータの正確性の成功しきい値。0 ~ 1 の浮動小数点数にする必要があります。デフォルトは 1.0 です。

ToolMatchingSettings

JSON 表現
{
  "extraToolCallBehavior": enum (ExtraToolCallBehavior)
}
フィールド
extraToolCallBehavior

enum (ExtraToolCallBehavior)

省略可。追加のツール呼び出しの動作。デフォルトは FAIL です。

VariableDeclaration

JSON 表現
{
  "name": string,
  "description": string,
  "schema": {
    object (Schema)
  }
}
フィールド
name

string

必須。変数の名前。名前の先頭は英字またはアンダースコアにする必要があります。使用できる文字は、英字、数字、アンダースコアのみです。

description

string

必須。変数の説明。

schema

object (Schema)

必須。変数のスキーマ。

スキーマ

JSON 表現
{
  "type": enum (Type),
  "properties": {
    string: {
      object (Schema)
    },
    ...
  },
  "required": [
    string
  ],
  "description": string,
  "items": {
    object (Schema)
  },
  "nullable": boolean,
  "uniqueItems": boolean,
  "prefixItems": [
    {
      object (Schema)
    }
  ],
  "additionalProperties": {
    object (Schema)
  },
  "anyOf": [
    {
      object (Schema)
    }
  ],
  "enum": [
    string
  ],
  "default": value,
  "ref": string,
  "defs": {
    string: {
      object (Schema)
    },
    ...
  },
  "title": string,
  "minItems": string,
  "maxItems": string,

  // Union field _minimum can be only one of the following:
  "minimum": number
  // End of list of possible types for union field _minimum.

  // Union field _maximum can be only one of the following:
  "maximum": number
  // End of list of possible types for union field _maximum.
}
フィールド
type

enum (Type)

必須。データの型。

properties

map (key: string, value: object (Schema))

省略可。Type.OBJECT のプロパティ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

required[]

string

省略可。Type.OBJECT の必須プロパティ。

description

string

省略可。データの説明。

items

object (Schema)

省略可。Type.ARRAY の要素のスキーマ。

nullable

boolean

省略可。値が null の可能性があるかどうかを示します。

uniqueItems

boolean

省略可。配列内の項目が一意である必要があることを示します。TYPE.ARRAY にのみ適用されます。

prefixItems[]

object (Schema)

省略可。Type.ARRAY の初期要素のスキーマ。

additionalProperties

object (Schema)

省略可。ブール値またはオブジェクト。追加のプロパティの有無を制御します。

anyOf[]

object (Schema)

省略可。値は、リスト内のサブスキーマのいずれか(1 つ以上)に対して検証する必要があります。

enum[]

string

省略可。プリミティブ型の要素の可能な値(列挙型形式)。例: 1. 方向は、{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} のように定義できます。2. 部屋番号は、{type:INTEGER, format:enum, enum:["101", "201", "301"]} のように定義できます。

default

value (Value format)

省略可。データのデフォルト値。

ref

string

省略可。スキーマノード間の間接参照を可能にします。値は、ルート defs の子への有効な参照にする必要があります。

たとえば、次のスキーマは、「Pet」という名前のスキーマノードへの参照を定義しています。

type: object
properties:
  pet:
    ref: #/defs/Pet
defs:
  Pet:
    type: object
    properties:
      name:
        type: string

「pet」プロパティの値は、「Pet」という名前のスキーマノードへの参照です。詳細については、https://json-schema.org/understanding-json-schema/structuring をご覧ください。

defs

map (key: string, value: object (Schema))

省略可。ref で使用する定義のマップ。スキーマのルートでのみ使用できます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

title

string

省略可。スキーマのタイトル。

minItems

string (int64 format)

省略可。Type.ARRAY の要素の最小数。

maxItems

string (int64 format)

省略可。Type.ARRAY の要素の最大数。

共用体フィールド _minimum。

_minimum は次のいずれかになります。

minimum

number

省略可。Type.INTEGER と Type.NUMBER の最小値。

共用体フィールド _maximum。

_maximum は次のいずれかになります。

maximum

number

省略可。Type.INTEGER と Type.NUMBER の最大値。

PropertiesEntry

JSON 表現
{
  "key": string,
  "value": {
    object (Schema)
  }
}
フィールド
key

string

value

object (Schema)

値

JSON 表現
{

  // Union field kind can be only one of the following:
  "nullValue": null,
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "structValue": {
    object
  },
  "listValue": array
  // End of list of possible types for union field kind.
}
フィールド
共用体フィールド kind。値の種類。kind は次のいずれかになります。
nullValue

null

JSON null を表します。

numberValue

number

JSON 番号を表します。NaN、Infinity、-Infinity は JSON でサポートされていないため、使用できません。また、JSON 形式では一般に数値型で大きな Int64 値がサポートされていないため、大きな Int64 値を表すこともできません。

stringValue

string

JSON 文字列を表します。

boolValue

boolean

JSON ブール値(JSON の true または false リテラル)を表します。

structValue

object (Struct format)

JSON オブジェクトを表します。

listValue

array (ListValue format)

JSON 配列を表します。

構造体

JSON 表現
{
  "fields": {
    string: value,
    ...
  }
}
フィールド
fields

map (key: string, value: value (Value format))

動的に型指定される値の順序なしのマップ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

FieldsEntry

JSON 表現
{
  "key": string,
  "value": value
}
フィールド
key

string

value

value (Value format)

ListValue

JSON 表現
{
  "values": [
    value
  ]
}
フィールド
values[]

value (Value format)

動的に型指定される値の繰り返しフィールド。

DefsEntry

JSON 表現
{
  "key": string,
  "value": {
    object (Schema)
  }
}
フィールド
key

string

value

object (Schema)

DataStoreSettings

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

object (Engine)

出力専用。アプリのエンジン。

エンジン

JSON 表現
{
  "name": string,
  "type": enum (Type)
}
フィールド
name

string

出力専用。エンジンのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

type

enum (Type)

出力専用。エンジンのタイプ。

ChannelProfile

JSON 表現
{
  "profileId": string,
  "channelType": enum (ChannelType),
  "personaProperty": {
    object (PersonaProperty)
  },
  "webWidgetConfig": {
    object (WebWidgetConfig)
  },
  "whatsappConfig": {
    object (WhatsAppConfig)
  },
  "instagramConfig": {
    object (InstagramConfig)
  },

  // Union field _disable_dtmf can be only one of the following:
  "disableDtmf": boolean
  // End of list of possible types for union field _disable_dtmf.

  // Union field _disable_barge_in_control can be only one of the following:
  "disableBargeInControl": boolean
  // End of list of possible types for union field _disable_barge_in_control.

  // Union field _noise_suppression_level can be only one of the following:
  "noiseSuppressionLevel": string
  // End of list of possible types for union field _noise_suppression_level.
}
フィールド
profileId

string

省略可。チャネル プロファイルの固有識別子。

channelType

enum (ChannelType)

省略可。チャンネル プロファイルのタイプ。

personaProperty

object (PersonaProperty)

省略可。チャンネル プロフィールの persona プロパティ。

webWidgetConfig

object (WebWidgetConfig)

省略可。ウェブ ウィジェットの構成。

whatsappConfig

object (WhatsAppConfig)

省略可。WhatsApp デプロイに固有の構成。

instagramConfig

object (InstagramConfig)

省略可。Instagram デプロイに固有の構成。

共用体フィールド _disable_dtmf。

_disable_dtmf は次のいずれかになります。

disableDtmf

boolean

省略可。DTMF(デュアルトーン マルチ周波数)を無効にするかどうか。

共用体フィールド _disable_barge_in_control。

_disable_barge_in_control は次のいずれかになります。

disableBargeInControl

boolean

省略可。会話でユーザーの割り込み制御を無効にするかどうか。- true: エージェントが話している間、ユーザーの割り込みは無効になります。- false: エージェントは、ユーザーが割り込めるタイミングを自動的に制御します。

共用体フィールド _noise_suppression_level。

_noise_suppression_level は次のいずれかになります。

noiseSuppressionLevel

string

省略可。チャンネル プロファイルのノイズ サプレッション レベル。使用できる値は「low」、「moderate」、「high」、「very_high」です。

PersonaProperty

JSON 表現
{
  "persona": enum (Persona)
}
フィールド
persona

enum (Persona)

省略可。チャンネルのペルソナ。

WebWidgetConfig

JSON 表現
{
  "modality": enum (Modality),
  "theme": enum (Theme),
  "webWidgetTitle": string,
  "securitySettings": {
    object (SecuritySettings)
  }
}
フィールド
modality

enum (Modality)

省略可。ウェブ ウィジェットのモダリティ。

theme

enum (Theme)

省略可。ウェブ ウィジェットのテーマ。

webWidgetTitle

string

省略可。ウェブ ウィジェットのタイトル。

securitySettings

object (SecuritySettings)

省略可。ウェブ ウィジェットのセキュリティ設定。

SecuritySettings

JSON 表現
{
  "enablePublicAccess": boolean,
  "enableOriginCheck": boolean,
  "allowedOrigins": [
    string
  ],
  "enableRecaptcha": boolean
}
フィールド
enablePublicAccess

boolean

省略可。ウェブ ウィジェットへの公開アクセスが有効かどうかを示します。true の場合、ウェブ ウィジェットは一般公開されます。false の場合、ウェブ ウィジェットを独自の認証および認可システムと統合して、CES エージェントにアクセスするための有効な認証情報を返す必要があります。

enableOriginCheck

boolean

省略可。ウェブ ウィジェットのオリジン チェックが有効になっているかどうかを示します。true の場合、ウェブ ウィジェットはウェブ ウィジェットを読み込むウェブサイトのオリジンを確認し、同じオリジンまたは許可されたオリジンでのみ読み込みを許可します。

allowedOrigins[]

string

省略可。ウェブ ウィジェットのホストを許可されているオリジン。オリジンは RFC 6454 で定義されています。空の場合、すべてのオリジンが許可されます。最大 100 個のオリジンを指定できます。例: 「https://example.com」

enableRecaptcha

boolean

省略可。ウェブ ウィジェットの reCAPTCHA による確認が有効になっているかどうかを示します。

WhatsAppConfig

JSON 表現
{
  "wabaId": string,
  "phoneNumberId": string,
  "phoneNumber": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
フィールド
wabaId

string

必須。WhatsApp Business のアカウント ID。

phoneNumberId

string

必須。Meta の電話番号 ID。

phoneNumber

string

省略可。E.164 形式の電話番号。

displayName

string

出力専用。取得された Meta ビジネス ページの名前。

thumbnailUrl

string

出力専用。取得された Meta ビジネス プロフィールのサムネイル URL。

description

string

出力専用。Meta のビジネス ページまたはプロフィールの説明。

InstagramConfig

JSON 表現
{
  "instagramAccountId": string,
  "displayName": string,
  "thumbnailUrl": string,
  "description": string
}
フィールド
instagramAccountId

string

必須。Instagram のアカウント ID。

displayName

string

出力専用。取得された Meta ビジネス ページの名前。

thumbnailUrl

string

出力専用。取得された Meta ビジネス プロフィールのサムネイル URL。

description

string

出力専用。Meta のビジネス ページまたはプロフィールの説明。

MetadataEntry

JSON 表現
{
  "key": string,
  "value": string
}
フィールド
key

string

value

string

ClientCertificateSettings

JSON 表現
{
  "tlsCertificate": string,
  "privateKey": string,
  "passphrase": string
}
フィールド
tlsCertificate

string

必須。PEM 形式でエンコードされた TLS 証明書。この文字列には、開始ヘッダー行と終了フッター行を含める必要があります。

privateKey

string

必須。PEM 形式でエンコードされた秘密鍵を保存する SecretManager シークレット バージョン リソースの名前。形式: projects/{project}/secrets/{secret}/versions/{version}

passphrase

string

省略可。秘密鍵を復号するためのパスフレーズを保存する SecretManager のシークレット バージョン リソースの名前。秘密鍵が暗号化されていない場合は、未設定のままにします。形式: projects/{project}/secrets/{secret}/versions/{version}

VpcScSettings

JSON 表現
{
  "allowedOrigins": [
    string
  ]
}
フィールド
allowedOrigins[]

string

省略可。VPC Service Controls が有効になっている場合に、アプリの OpenAPI ツールが直接呼び出すことができる、許可された HTTP(S) オリジン。これらの文字列は、ポートが指定されている場合はポートも含めて、オリジンと完全に一致している必要があります。例: 「https://example.com」または「https://example.com:443」。このリストは、直接 HTTP 呼び出しを行う可能性のある Python ツールにはまだ適用されません。

DashboardSettings

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

string

省略可。アプリに関連付けられているデフォルトのコンタクト センターの分析情報ダッシュボードのリソース名。これは、ユーザーがアプリのモニタリング ビューに移動したときに表示されるダッシュボードです。

形式: projects/{project}/locations/{location}/dashboards/{dashboard}

エージェント

JSON 表現
{
  "name": string,
  "displayName": string,
  "description": string,
  "modelSettings": {
    object (ModelSettings)
  },
  "instruction": string,
  "tools": [
    string
  ],
  "childAgents": [
    string
  ],
  "beforeAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterAgentCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterModelCallbacks": [
    {
      object (Callback)
    }
  ],
  "beforeToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "afterToolCallbacks": [
    {
      object (Callback)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "guardrails": [
    string
  ],
  "etag": string,
  "toolsets": [
    {
      object (AgentToolset)
    }
  ],
  "generatedSummary": string,
  "transferRules": [
    {
      object (TransferRule)
    }
  ],
  "validationErrors": [
    string
  ],

  // Union field agent_type can be only one of the following:
  "llmAgent": {
    object (LlmAgent)
  },
  "remoteDialogflowAgent": {
    object (RemoteDialogflowAgent)
  },
  "remoteA2aAgent": {
    object (RemoteA2aAgent)
  }
  // End of list of possible types for union field agent_type.
}
フィールド
name

string

ID。エージェントの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

displayName

string

必須。エージェントの表示名。

description

string

省略可。人が読める形式のエージェントの説明。

modelSettings

object (ModelSettings)

省略可。LLM モデルの構成。

instruction

string

省略可。エージェントの動作をガイドする LLM モデルの手順。

tools[]

string

省略可。エージェントで使用可能なツールのリスト。形式: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

childAgents[]

string

省略可。エージェント ツリー内の子エージェントのリスト。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

beforeAgentCallbacks[]

object (Callback)

省略可。エージェントが呼び出される前に実行するコールバック。指定されたコールバックは、リストに指定された順序で順次実行されます。コールバックがオーバーライドされたレスポンスを返すと、実行が停止し、残りのコールバックはスキップされます。

afterAgentCallbacks[]

object (Callback)

省略可。エージェントが呼び出された後に実行するコールバック。指定されたコールバックは、リストに指定された順序で順次実行されます。コールバックがオーバーライドされたレスポンスを返すと、実行が停止し、残りのコールバックはスキップされます。

beforeModelCallbacks[]

object (Callback)

省略可。モデルが呼び出される前に実行するコールバック。モデルへの呼び出しが複数ある場合、コールバックは複数回実行されます。指定されたコールバックは、リストに指定された順序で順次実行されます。コールバックがオーバーライドされたレスポンスを返すと、実行が停止し、残りのコールバックはスキップされます。

afterModelCallbacks[]

object (Callback)

省略可。モデルの呼び出し後に実行するコールバック。モデルへの呼び出しが複数ある場合、コールバックは複数回実行されます。指定されたコールバックは、リストに指定された順序で順次実行されます。コールバックがオーバーライドされたレスポンスを返すと、実行が停止し、残りのコールバックはスキップされます。

beforeToolCallbacks[]

object (Callback)

省略可。ツールが呼び出される前に実行するコールバック。複数のツール呼び出しがある場合、コールバックは複数回実行されます。指定されたコールバックは、リストに指定された順序で順次実行されます。コールバックがオーバーライドされたレスポンスを返すと、実行が停止し、残りのコールバックはスキップされます。

afterToolCallbacks[]

object (Callback)

省略可。ツールの呼び出し後に実行するコールバック。複数のツール呼び出しがある場合、コールバックは複数回実行されます。指定されたコールバックは、リストに指定された順序で順次実行されます。コールバックがオーバーライドされたレスポンスを返すと、実行が停止し、残りのコールバックはスキップされます。

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

guardrails[]

string

省略可。エージェントのガードレールのリスト。形式: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

etag

string

読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される Etag。etag が空の場合、更新によって同時変更が上書きされます。

toolsets[]

object (AgentToolset)

省略可。エージェントのツールセットのリスト。

generatedSummary

string

出力専用。エージェントが LLM アシスタントによって生成された場合、このフィールドには生成の概要が含まれます。

transferRules[]

object (TransferRule)

省略可。エージェント転送ルール。複数のルールが一致する場合は、リストの最初のルールが使用されます。

validationErrors[]

string

出力専用。エージェントの品質に影響する可能性のある、エージェントの構成ミスやエラー。

共用体フィールド agent_type。エージェントのタイプ。agent_type は次のいずれかになります。
llmAgent

object (LlmAgent)

省略可。デフォルトのエージェント タイプ。

remoteDialogflowAgent

object (RemoteDialogflowAgent)

省略可。エージェントの実行に使用されるリモート Dialogflow エージェント。このフィールドが設定されている場合、他のすべてのエージェント レベルのプロパティは無視されます。

注: Dialogflow エージェントがアプリとは異なるプロジェクトにある場合は、CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com に roles/dialogflow.client を付与する必要があります。

remoteA2aAgent

object (RemoteA2aAgent)

省略可。エージェントの実行に使用されるリモート A2A エージェント。

RemoteDialogflowAgent

JSON 表現
{
  "agent": string,
  "flowId": string,
  "environmentId": string,
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  },
  "respectResponseInterruptionSettings": boolean,
  "languageCodeVariable": string
}
フィールド
agent

string

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

flowId

string

省略可。Dialogflow エージェントのフローのフロー ID。

environmentId

string

省略可。エージェントの実行に使用される Dialogflow エージェントの環境 ID。指定しない場合は、ドラフト環境が使用されます。

inputVariableMapping

map (key: string, value: string)

省略可。アプリ変数名と Dialogflow セッション パラメータ名のマッピング。Dialogflow エージェントに入力として送信されます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

outputVariableMapping

map (key: string, value: string)

省略可。Dialogflow エージェントの実行が終了した後に CES エージェントに返されるアプリ変数名への Dialogflow セッション パラメータ名のマッピング。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

respectResponseInterruptionSettings

boolean

省略可。Dialogflow エージェントで構成されたメッセージ レベルの割り込み設定を尊重するかどうかを示します。

  • false の場合: Dialogflow エージェントからのすべてのレスポンス メッセージは、アプリレベルの割り込み設定に従います。
  • true の場合: allow_playback_interruption が true に設定されているレスポンス メッセージのみが割り込み可能になり、他のすべてのメッセージはアプリレベルの割り込み設定に従います。
languageCodeVariable

string

省略可。Dialogflow セッションで使用する言語コードを含む変数の名前。指定しない場合は、Dialogflow エージェントのデフォルトの言語コードが使用されます。

InputVariableMappingEntry

JSON 表現
{
  "key": string,
  "value": string
}
フィールド
key

string

value

string

OutputVariableMappingEntry

JSON 表現
{
  "key": string,
  "value": string
}
フィールド
key

string

value

string

RemoteA2aAgent

JSON 表現
{
  "a2aConfig": {
    object (RemoteA2aConfig)
  }
}
フィールド
a2aConfig

object (RemoteA2aConfig)

必須。A2A 接続の構成。

RemoteA2aConfig

JSON 表現
{
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  },
  "streamingEnabled": boolean,
  "contextId": string,

  // Union field agent_spec can be only one of the following:
  "agentCard": {
    object (AgentCard)
  },
  "agentRegistry": string
  // End of list of possible types for union field agent_spec.
}
フィールド
apiAuthentication

object (ApiAuthentication)

省略可。リモート エージェントを呼び出すための認証構成。レジストリ参照ですでに認証が処理されている場合は省略可能です。

inputVariableMapping

map (key: string, value: string)

省略可。リモート エージェントの入力変数名と GECX 変数名のマッピング。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

outputVariableMapping

map (key: string, value: string)

省略可。リモート エージェントの出力変数名と GECX 変数名のマッピング。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

streamingEnabled

boolean

省略可。リモート エージェントでストリーミングが有効になっているかどうか。

contextId

string

省略可。空でない場合、リモート A2A エージェントとのやり取りではこのコンテキスト ID が使用されます。この context_id フィールドは、$context.variables.order_agent_session_id などのセッション変数を参照できます。

共用体フィールド agent_spec。リモート エージェントの仕様。agent_spec は次のいずれかになります。
agentCard

object (AgentCard)

省略可。インラインで定義された完全なエージェント カード。

agentRegistry

string

省略可。Agent Registry 内のエージェントへの参照。形式: projects/{project}/locations/{location}/agents/{agent}

AgentCard

JSON 表現
{
  "name": string,
  "description": string,
  "supportedInterfaces": [
    {
      object (AgentInterface)
    }
  ],
  "version": string,
  "skills": [
    {
      object (AgentSkill)
    }
  ]
}
フィールド
name

string

必須。人が読める形式のエージェントの名前。

description

string

必須。エージェントのアクション / ソリューション スペースのドメインの説明。

supportedInterfaces[]

object (AgentInterface)

必須。サポートされているインターフェースの順序付きリスト。1 つ目のエントリが優先されます。

version

string

必須。エージェントのバージョン。

skills[]

object (AgentSkill)

必須。スキルは、エージェントが実行できる能力の単位を表します。これはやや抽象的かもしれませんが、エージェントが成功する可能性が高い、より焦点を絞った一連のアクションを表しています。

AgentInterface

JSON 表現
{
  "url": string,
  "protocolBinding": string,
  "tenant": string,
  "protocolVersion": string
}
フィールド
url

string

必須。このインターフェースが利用可能な URL。本番環境では、有効な絶対 HTTPS URL である必要があります。例: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"

protocolBinding

string

必須。この URL でサポートされているプロトコル バインディング。これはオープン形式の文字列で、他のプロトコル バインディングに簡単に拡張できます。正式にサポートされているコアは、JSONRPC、GRPC、HTTP+JSON です。

tenant

string

エージェントを呼び出すときにリクエストで使用されるテナント ID。

protocolVersion

string

必須。このインターフェースが公開する A2A プロトコルのバージョン。メジャー バージョンごとに、サポートされている最新のマイナー バージョンを使用します。例: 「0.3」、「1.0」

AgentSkill

JSON 表現
{
  "id": string,
  "name": string,
  "description": string,
  "tags": [
    string
  ],
  "examples": [
    string
  ],
  "inputModes": [
    string
  ],
  "outputModes": [
    string
  ]
}
フィールド
id

string

必須。エージェントのスキルの固有識別子。

name

string

必須。人が読める形式のスキルの名前。

description

string

必須。スキルの詳細な説明。

tags[]

string

必須。スキルの機能を説明するキーワードのセット。

examples[]

string

このスキルで処理できるプロンプトやシナリオの例。

inputModes[]

string

このスキルでサポートされている入力メディアタイプのセット。エージェントのデフォルトをオーバーライドします。

outputModes[]

string

このスキルでサポートされている出力メディアタイプのセット。エージェントのデフォルトをオーバーライドします。

ApiAuthentication

JSON 表現
{

  // Union field auth_config can be only one of the following:
  "apiKeyConfig": {
    object (ApiKeyConfig)
  },
  "oauthConfig": {
    object (OAuthConfig)
  },
  "serviceAgentIdTokenAuthConfig": {
    object (ServiceAgentIdTokenAuthConfig)
  },
  "serviceAccountAuthConfig": {
    object (ServiceAccountAuthConfig)
  },
  "bearerTokenConfig": {
    object (BearerTokenConfig)
  }
  // End of list of possible types for union field auth_config.
}
フィールド
共用体フィールド auth_config。認証構成。auth_config は次のいずれかになります。
apiKeyConfig

object (ApiKeyConfig)

省略可。API キー認証の構成。

oauthConfig

object (OAuthConfig)

省略可。OAuth の構成。

serviceAgentIdTokenAuthConfig

object (ServiceAgentIdTokenAuthConfig)

省略可。CES サービス エージェントから生成された ID トークン認証の構成。

serviceAccountAuthConfig

object (ServiceAccountAuthConfig)

省略可。サービス アカウント認証の構成。

bearerTokenConfig

object (BearerTokenConfig)

省略可。署名なしトークン認証の構成。

ApiKeyConfig

JSON 表現
{
  "keyName": string,
  "apiKeySecretVersion": string,
  "requestLocation": enum (RequestLocation)
}
フィールド
keyName

string

必須。API キーのパラメータ名またはヘッダー名。例: API リクエストが「https://example.com/act?X-Api-Key=」の場合、「X-Api-Key」がパラメータ名になります。

apiKeySecretVersion

string

必須。API キーを保存する SecretManager シークレット バージョン リソースの名前。形式: projects/{project}/secrets/{secret}/versions/{version}

注: CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com に roles/secretmanager.secretAccessor ロールを付与する必要があります。

requestLocation

enum (RequestLocation)

必須。リクエスト内のキーの場所。

OAuthConfig

JSON 表現
{
  "oauthGrantType": enum (OauthGrantType),
  "clientId": string,
  "clientSecretVersion": string,
  "tokenEndpoint": string,
  "scopes": [
    string
  ]
}
フィールド
oauthGrantType

enum (OauthGrantType)

必須。OAuth 権限付与タイプ。

clientId

string

必須。OAuth プロバイダのクライアント ID。

clientSecretVersion

string

必須。クライアント シークレットを保存する SecretManager シークレット バージョン リソースの名前。形式: projects/{project}/secrets/{secret}/versions/{version}

注: CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com に roles/secretmanager.secretAccessor ロールを付与する必要があります。

tokenEndpoint

string

必須。アクセス トークンと交換する OAuth プロバイダのトークン エンドポイント。

scopes[]

string

省略可。付与する OAuth スコープ。

ServiceAccountAuthConfig

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

string

必須。認証に使用されるサービス アカウントのメールアドレス。CES はこのサービス アカウントを使用してアクセス トークンを交換し、アクセス トークンはリクエストの Authorization ヘッダーで送信されます。

サービス アカウントには、CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com に付与された roles/iam.serviceAccountTokenCreator ロールが必要です。

scopes[]

string

省略可。付与する OAuth スコープ。指定しない場合は、デフォルトのスコープ https://www.googleapis.com/auth/cloud-platform が使用されます。

BearerTokenConfig

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

string

必須。署名なしトークン。$context.variables.<name_of_variable> の形式で指定してください。

InputVariableMappingEntry

JSON 表現
{
  "key": string,
  "value": string
}
フィールド
key

string

value

string

OutputVariableMappingEntry

JSON 表現
{
  "key": string,
  "value": string
}
フィールド
key

string

value

string

コールバック

JSON 表現
{
  "description": string,
  "disabled": boolean,
  "proactiveExecutionEnabled": boolean,

  // Union field callback can be only one of the following:
  "pythonCode": string
  // End of list of possible types for union field callback.
}
フィールド
description

string

省略可。人が読める形式のコールバックの説明。

disabled

boolean

省略可。コールバックが無効かどうか。無効なコールバックはエージェントによって無視されます。

proactiveExecutionEnabled

boolean

省略可。有効にすると、コールバックは中間モデル出力でも実行されます。この設定は、モデル呼び出し後コールバックにのみ影響します。有効にする際は注意してください。通常、モデル呼び出し後コールバックは、すべてのモデル レスポンスを受信した後にのみ実行する必要があります。プロアクティブな実行を有効にすると、実行コストとレイテンシに悪影響を及ぼす可能性があるため、有効にするのはまれな状況に限定する必要があります。

共用体フィールド callback。実行するコールバック。callback は次のいずれかになります。
pythonCode

string

必須。コールバックで実行する Python コード。

AgentToolset

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

string

必須。ツールセットのリソース名。形式: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

toolIds[]

string

省略可。ツールセットをフィルタするツール ID。

TransferRule

JSON 表現
{
  "childAgent": string,
  "direction": enum (Direction),

  // Union field rule_type can be only one of the following:
  "deterministicTransfer": {
    object (DeterministicTransfer)
  },
  "disablePlannerTransfer": {
    object (DisablePlannerTransfer)
  }
  // End of list of possible types for union field rule_type.
}
フィールド
childAgent

string

必須。ルールが適用される子エージェントのリソース名。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

direction

enum (Direction)

必須。転送の方向。

共用体フィールド rule_type。ルールの種類。rule_type は次のいずれかになります。
deterministicTransfer

object (DeterministicTransfer)

省略可。条件が満たされると、ターゲット エージェントにすぐに転送されるルール。

disablePlannerTransfer

object (DisablePlannerTransfer)

省略可。プランナーがターゲット エージェントに転送できないようにするルール。

DeterministicTransfer

JSON 表現
{

  // Union field condition_type can be only one of the following:
  "expressionCondition": {
    object (ExpressionCondition)
  },
  "pythonCodeCondition": {
    object (PythonCodeCondition)
  }
  // End of list of possible types for union field condition_type.
}
フィールド
共用体フィールド condition_type。評価する条件。condition_type は次のいずれかになります。
expressionCondition

object (ExpressionCondition)

省略可。セッション状態の条件を評価するルール。条件が true と評価されると、転送が行われます。

pythonCodeCondition

object (PythonCodeCondition)

省略可。Python コードブロックを使用して条件を評価するルール。条件が true と評価されると、転送が行われます。

ExpressionCondition

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

string

必須。cloud.api.Expression 条件の文字列表現。

PythonCodeCondition

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

string

必須。実行する Python コード。

DisablePlannerTransfer

JSON 表現
{
  "expressionCondition": {
    object (ExpressionCondition)
  }
}
フィールド
expressionCondition

object (ExpressionCondition)

必須。条件が true と評価された場合、プランナーはターゲット エージェントに転送できません。

ツール

JSON 表現
{
  "name": string,
  "displayName": string,
  "executionType": enum (ExecutionType),
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "generatedSummary": string,
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },
  "readOnly": boolean,

  // Union field tool_type can be only one of the following:
  "clientFunction": {
    object (ClientFunction)
  },
  "openApiTool": {
    object (OpenApiTool)
  },
  "googleSearchTool": {
    object (GoogleSearchTool)
  },
  "connectorTool": {
    object (ConnectorTool)
  },
  "dataStoreTool": {
    object (DataStoreTool)
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mcpTool": {
    object (McpTool)
  },
  "fileSearchTool": {
    object (FileSearchTool)
  },
  "systemTool": {
    object (SystemTool)
  },
  "agentTool": {
    object (AgentTool)
  },
  "widgetTool": {
    object (WidgetTool)
  },
  "remoteAgentTool": {
    object (RemoteAgentTool)
  }
  // End of list of possible types for union field tool_type.
}
フィールド
name

string

ID。ツールのリソース名。形式:

  • projects/{project}/locations/{location}/apps/{app}/tools/{tool}: スタンドアロン ツール。
  • projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}: ツールセットから取得されたツール。

これらのツールは動的で出力専用です。ツールが想定される場所で直接参照することはできません。

displayName

string

出力専用。ツールの表示名。ツールのタイプに基づいて派生します。たとえば、[ClientFunction][Tool.ClientFunction] の表示名は、name プロパティから派生します。

executionType

enum (ExecutionType)

省略可。ツールの実行タイプ。

timeout

string (Duration format)

省略可。ツールの実行のタイムアウト。設定しない場合、デフォルトのタイムアウトは SYNCHRONOUS ツールでは 30 秒、ASYNCHRONOUS ツールでは 60 秒です。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

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

etag

string

読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される Etag。etag が空の場合、更新によって同時変更が上書きされます。

generatedSummary

string

出力専用。ツールが LLM アシスタントによって生成された場合、このフィールドには生成の概要が含まれます。

toolFakeConfig

object (ToolFakeConfig)

省略可。フェイクモードでのツールの動作の構成。

readOnly

boolean

出力専用。ツールが読み取り専用かどうかを示します。true の場合、ユーザーはツールを変更できません。

共用体フィールド tool_type。ツールのタイプ。tool_type は次のいずれかになります。
clientFunction

object (ClientFunction)

省略可。クライアント関数。

openApiTool

object (OpenApiTool)

省略可。Open API ツール。

googleSearchTool

object (GoogleSearchTool)

省略可。Google 検索ツール。

connectorTool

object (ConnectorTool)

省略可。Integration Connector ツール。

dataStoreTool

object (DataStoreTool)

省略可。データストア ツール。

pythonFunction

object (PythonFunction)

省略可。Python 関数ツール。

mcpTool

object (McpTool)

省略可。MCP ツール。MCP ツールを直接作成または更新することはできません。MCP ツールセットによって管理されます。

fileSearchTool

object (FileSearchTool)

省略可。ファイル検索ツール。

systemTool

object (SystemTool)

省略可。システムツール。

agentTool

object (AgentTool)

省略可。エージェント ツール。

widgetTool

object (WidgetTool)

省略可。ウィジェット ツール。

remoteAgentTool

object (RemoteAgentTool)

省略可。リモート エージェント ツール。

ClientFunction

JSON 表現
{
  "name": string,
  "description": string,
  "parameters": {
    object (Schema)
  },
  "response": {
    object (Schema)
  }
}
フィールド
name

string

必須。関数名。

description

string

省略可。関数の説明。

parameters

object (Schema)

省略可。関数パラメータのスキーマ。

response

object (Schema)

省略可。関数レスポンスのスキーマ。

OpenApiTool

JSON 表現
{
  "openApiSchema": string,
  "name": string,
  "description": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
フィールド
openApiSchema

string

必須。JSON 形式または YAML 形式の OpenAPI スキーマ。

name

string

省略可。ツールの名前。指定しない場合、ツールの名前は OpenAPI スキーマの operation.operationId から派生します。

description

string

省略可。ツールの説明。指定しない場合、ツールの説明は OpenAPI スキーマ(operation.description または operation.summary)から派生します。

apiAuthentication

object (ApiAuthentication)

省略可。API で必要な認証情報。

tlsConfig

object (TlsConfig)

省略可。TLS 構成。クライアントが信頼するカスタム サーバー証明書が含まれます。

serviceDirectoryConfig

object (ServiceDirectoryConfig)

省略可。Service Directory の構成。

ignoreUnknownFields

boolean

省略可。true の場合、エージェントは API レスポンスの不明なフィールドを無視します。

url

string

省略可。Open API スキーマのサーバー URL。このフィールドは、スキーマにサーバー URL が含まれている場合に、エクスポート プロセス中に環境依存関係のツールでのみ設定されます。インポート プロセス中に、この URL が環境の依存関係に存在し、スキーマに $env_var プレースホルダがある場合、スキーマのプレースホルダが置き換えられます。

TlsConfig

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

object (CaCert)

必須。HTTPS 検証で許可されるカスタム CA 証明書のリストを指定します。

CaCert

JSON 表現
{
  "displayName": string,
  "cert": string
}
フィールド
displayName

string

必須。許可されたカスタム CA 証明書の名前。これは、カスタム CA 証明書の曖昧さを解消するために使用できます。

cert

string (bytes format)

必須。HTTPS 検証で許可されるカスタム CA 証明書(DER 形式)。これにより、デフォルトの SSL トラストストアがオーバーライドされます。これが空または未指定の場合、CES は Google のデフォルトのトラストストアを使用して証明書を検証します。注: HTTPS サーバー証明書が「サブジェクト代替名」で署名されていることを確認してください。たとえば、以下のコマンドで証明書に自己署名することができます。

   openssl x509 -req -days 200 -in example.com.csr \
     -signkey example.com.key \
     -out example.com.crt \
     -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

Base64 でエンコードされた文字列。

ServiceDirectoryConfig

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

string

必須。Service Directory サービスの名前。形式: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}。サービス ディレクトリのロケーションは、アプリのロケーションと同じにする必要があります。

GoogleSearchTool

JSON 表現
{
  "name": string,
  "description": string,
  "contextUrls": [
    string
  ],
  "preferredDomains": [
    string
  ],
  "excludeDomains": [
    string
  ],
  "promptConfig": {
    object (PromptConfig)
  }
}
フィールド
name

string

必須。ツールの名前。

description

string

省略可。ツールの目的の説明。

contextUrls[]

string

省略可。コンテンツは、コンテキストとグラウンディングのために、これらの URL から直接取得されます。例: "https://example.com/path.html"。指定できる URL は 20 個までです。

preferredDomains[]

string

省略可。検索結果を制限するドメインを指定します。例: "example.com"、"another.site"。最大 20 個のドメインを指定できます。

excludeDomains[]

string

省略可。検索結果から除外するドメインのリスト。例: "example.com"。除外できるドメインは最大 2,000 個です。

promptConfig

object (PromptConfig)

省略可。テキストと音声の検索結果をどのように処理すべきかについて、プランナーに渡されるプロンプト指示。

PromptConfig

JSON 表現
{
  "textPrompt": string,
  "voicePrompt": string
}
フィールド
textPrompt

string

省略可。チャット会話でエージェントとやり取りする際にシステム指示に使用されるプロンプトを定義します。設定されていない場合は、デフォルトのプロンプトが使用されます。

voicePrompt

string

省略可。音声会話でエージェントとやり取りする際にシステム指示に使用されるプロンプトを定義します。設定されていない場合は、デフォルトのプロンプトが使用されます。

ConnectorTool

JSON 表現
{
  "connection": string,
  "action": {
    object (Action)
  },
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "name": string,
  "description": string
}
フィールド
connection

string

必須。参照される Integration Connectors 接続の完全なリソース名。形式: projects/{project}/locations/{location}/connections/{connection}

action

object (Action)

必須。ツールが使用するアクション。

authConfig

object (EndUserAuthConfig)

省略可。Integration Connectors での認証の処理方法を構成します。デフォルトでは、Integration Connectors API リクエストで管理者認証が渡されます。別のエンドユーザー認証構成でオーバーライドできます。注: ここで EUC 構成を指定するには、接続で認証のオーバーライドが有効になっている必要があります。有効になっていない場合、ConnectorTool の作成は失敗します。詳細については、https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override をご覧ください。

name

string

省略可。エージェントがこの ConnectorTool を呼び出すかどうかを判断するために使用できるツールの名前。

description

string

省略可。エージェントがこの ConnectorTool を呼び出すかどうかを判断するために使用できるツールの説明。

アクション

JSON 表現
{
  "inputFields": [
    string
  ],
  "outputFields": [
    string
  ],

  // Union field action_spec can be only one of the following:
  "connectionActionId": string,
  "entityOperation": {
    object (EntityOperation)
  }
  // End of list of possible types for union field action_spec.
}
フィールド
inputFields[]

string

省略可。オペレーションの入力として使用するエンティティ フィールド。フィールドが指定されていない場合は、Entity のすべてのフィールドが使用されます。

outputFields[]

string

省略可。オペレーションから返されるエンティティ フィールド。フィールドが指定されていない場合、Entity のすべてのフィールドが返されます。

共用体フィールド action_spec。ツールで使用するように構成するアクションの仕様。action_spec は次のいずれかになります。
connectionActionId

string

ツールが使用する接続アクションの ID。

entityOperation

object (EntityOperation)

ツールで使用するエンティティ オペレーションの構成。

EntityOperation

JSON 表現
{
  "entityId": string,
  "operation": enum (OperationType)
}
フィールド
entityId

string

必須。エンティティの ID。

operation

enum (OperationType)

必須。エンティティに対して実行するオペレーション。

EndUserAuthConfig

JSON 表現
{

  // Union field auth_config can be only one of the following:
  "oauth2AuthCodeConfig": {
    object (Oauth2AuthCodeConfig)
  },
  "oauth2JwtBearerConfig": {
    object (Oauth2JwtBearerConfig)
  }
  // End of list of possible types for union field auth_config.
}
フィールド
共用体フィールド auth_config。認証構成。auth_config は次のいずれかになります。
oauth2AuthCodeConfig

object (Oauth2AuthCodeConfig)

OAuth 2.0 認証コード認証。

oauth2JwtBearerConfig

object (Oauth2JwtBearerConfig)

JWT プロファイル OAuth 2.0 認可権限付与認証。

Oauth2AuthCodeConfig

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

string

必須。渡す OAuth トークン パラメータの名前。$context.variables.<name_of_variable> の形式で指定してください。

Oauth2JwtBearerConfig

JSON 表現
{
  "issuer": string,
  "subject": string,
  "clientKey": string
}
フィールド
issuer

string

必須。渡す発行者パラメータ名。$context.variables.<name_of_variable> の形式で指定してください。

subject

string

必須。渡すサブジェクト パラメータ名。$context.variables.<name_of_variable> の形式で指定してください。

clientKey

string

必須。渡すクライアント パラメータ名。$context.variables.<name_of_variable> の形式で指定してください。

DataStoreTool

JSON 表現
{
  "name": string,
  "description": string,
  "boostSpecs": [
    {
      object (BoostSpecs)
    }
  ],
  "modalityConfigs": [
    {
      object (ModalityConfig)
    }
  ],
  "filterParameterBehavior": enum (FilterParameterBehavior),

  // Union field search_source can be only one of the following:
  "dataStoreSource": {
    object (DataStoreSource)
  },
  "engineSource": {
    object (EngineSource)
  }
  // End of list of possible types for union field search_source.
}
フィールド
name

string

必須。データストア ツールの名前。

description

string

省略可。ツールの説明。

boostSpecs[]

object (BoostSpecs)

省略可。特定のドキュメントをブーストするブースト仕様。

modalityConfigs[]

object (ModalityConfig)

省略可。データストアのモダリティ構成。

filterParameterBehavior

enum (FilterParameterBehavior)

省略可。フィルタ パラメータの動作。

共用体フィールド search_source。検索ソース(単一の DataStore または Engine)を定義します。search_source は次のいずれかになります。
dataStoreSource

object (DataStoreSource)

省略可。1 つの特定の DataStore 内を検索します。

engineSource

object (EngineSource)

省略可。エンジン内(複数の DataStore にまたがる可能性あり)で検索します。

DataStoreSource

JSON 表現
{
  "filter": string,
  "dataStore": {
    object (DataStore)
  }
}
フィールド
filter

string

省略可。DataStore のフィルタ仕様。参照: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

dataStore

object (DataStore)

省略可。データストア。

DataStore

JSON 表現
{
  "name": string,
  "type": enum (DataStoreType),
  "documentProcessingMode": enum (DocumentProcessingMode),
  "displayName": string,
  "createTime": string,
  "connectorConfig": {
    object (ConnectorConfig)
  }
}
フィールド
name

string

必須。DataStore の完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}

type

enum (DataStoreType)

出力専用。データストアのタイプ。このフィールドは読み取り専用で、サーバーによって入力されます。

documentProcessingMode

enum (DocumentProcessingMode)

出力専用。データストア接続のドキュメント処理モード。PUBLIC_WEB データストアと UNSTRUCTURED データストアにのみ設定されます。

displayName

string

出力専用。データストアの表示名。

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

connectorConfig

object (ConnectorConfig)

出力専用。データストア接続のコネクタ構成。

ConnectorConfig

JSON 表現
{
  "collection": string,
  "collectionDisplayName": string,
  "dataSource": string
}
フィールド
collection

string

データストアが属するコレクションのリソース名。

collectionDisplayName

string

データストアが属するコレクションの表示名。

dataSource

string

データソース名。例: salesforce、jira、confluence、bigquery。

EngineSource

JSON 表現
{
  "engine": string,
  "dataStoreSources": [
    {
      object (DataStoreSource)
    }
  ],
  "filter": string
}
フィールド
engine

string

必須。Engine の完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

dataStoreSources[]

object (DataStoreSource)

省略可。エンジン内の特定の DataStore をターゲットにするために使用します。空の場合、検索はエンジンに関連付けられているすべての DataStore に適用されます。

filter

string

省略可。エンジン全体で検索に適用されるフィルタ。「data_store_sources」が指定されている場合は、関連性がなく、使用されません。参照: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

BoostSpecs

JSON 表現
{
  "dataStores": [
    string
  ],
  "spec": [
    {
      object (BoostSpec)
    }
  ]
}
フィールド
dataStores[]

string

必須。ブースト構成が適用されるデータストア。DataStore の完全なリソース名(例: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore})。

spec[]

object (BoostSpec)

必須。ブースト仕様のリスト。

BoostSpec

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

object (ConditionBoostSpec)

必須。ブースト仕様のリスト。

ConditionBoostSpec

JSON 表現
{
  "condition": string,
  "boost": number,
  "boostControlSpec": {
    object (BoostControlSpec)
  }
}
フィールド
condition

string

必須。ブースト条件を指定する式。構文は、フィルタ式の構文と同じです。現在、サポートされている条件は BCP-47 言語コードのリストのみです。例: 言語 en または fr の候補をブーストするには: (lang_code: ANY("en", "fr"))

boost

number

省略可。ブーストの強さ。[-1, 1] の範囲で指定します。ブーストが負の値である場合は順位を下げることを意味します。デフォルトは 0.0 です。

1.0 に設定すると、候補に強力なプロモーションが与えられます。ただし、ブーストされた候補が上位の結果になるとは限りません。

-1.0 に設定すると、候補に大きなデモートが与えられます。ただし、関連性の高い他の候補は引き続き表示されることがあります。

0.0 に設定すると、ブーストは適用されません。ブースト条件は無視されます。

boostControlSpec

object (BoostControlSpec)

省略可。顧客定義の属性値に基づくカスタム ランキングの複雑な仕様。

BoostControlSpec

JSON 表現
{
  "fieldName": string,
  "attributeType": enum (AttributeType),
  "interpolationType": enum (InterpolationType),
  "controlPoints": [
    {
      object (ControlPoint)
    }
  ]
}
フィールド
fieldName

string

省略可。ブースト量を決定するために値が使用されるフィールドの名前。

attributeType

enum (AttributeType)

省略可。ブースト額の決定に使用する属性のタイプ。属性値は、指定された field_name のフィールド値から導出できます。数値の場合、attribute_value = numerical_field_value となります。ただし、鮮度の場合は、attribute_value = (time.now() - datetime_field_value) となります。

interpolationType

enum (InterpolationType)

省略可。以下に表示されているコントロール ポイントを接続するために適用される補完タイプ。

controlPoints[]

object (ControlPoint)

省略可。曲線の定義に使用されるコントロール ポイント。単調関数(上記の interpolation_type で定義)は、ここに記載されているコントロール ポイントを通過します。

ControlPoint

JSON 表現
{
  "attributeValue": string,
  "boostAmount": number
}
フィールド
attributeValue

string

省略可。以下のいずれか: 1. 数値フィールドの値。2. 鮮度の期間仕様: 値は XSD dayTimeDuration 値(ISO 8601 期間値の制限付きサブセット)としてフォーマットする必要があります。このパターンは [nD][T[nH][nM][nS]] です。

boostAmount

number

省略可。attribute_value が上記で指定した値と評価された場合にスコアをブーストする値(-1 ~ 1)。

ModalityConfig

JSON 表現
{
  "modalityType": enum (ModalityType),
  "rewriterConfig": {
    object (RewriterConfig)
  },
  "summarizationConfig": {
    object (SummarizationConfig)
  },
  "groundingConfig": {
    object (GroundingConfig)
  },
  "snippetsConfig": {
    object (SnippetsConfig)
  }
}
フィールド
modalityType

enum (ModalityType)

必須。モダリティ タイプ。

rewriterConfig

object (RewriterConfig)

省略可。リライターの構成。

summarizationConfig

object (SummarizationConfig)

省略可。要約の構成。

groundingConfig

object (GroundingConfig)

省略可。グラウンディング構成。

snippetsConfig

object (SnippetsConfig)

省略可。スニペットの構成。

RewriterConfig

JSON 表現
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
フィールド
modelSettings

object (ModelSettings)

必須。LLM モデルの構成。

prompt

string

省略可。プロンプトの定義。設定されていない場合は、デフォルトのプロンプトが使用されます。

disabled

boolean

省略可。リライターが無効かどうか。

SummarizationConfig

JSON 表現
{
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "disabled": boolean
}
フィールド
modelSettings

object (ModelSettings)

省略可。LLM モデルの構成。

prompt

string

省略可。プロンプトの定義。設定されていない場合は、デフォルトのプロンプトが使用されます。

disabled

boolean

省略可。要約が無効になっているかどうか。

GroundingConfig

JSON 表現
{
  "groundingLevel": number,
  "disabled": boolean
}
フィールド
groundingLevel

number

省略可。取得されたソースに基づく回答のグラウンディングのしきい値。値の構成可能な範囲は [1, 5] です。このレベルは、回答のグラウンディングのしきい値として使用されます。つまり、グラウンディング スコアがしきい値を下回るすべての回答は、関連するスニペットのみを返すようにフォールバックされます。

たとえば、レベルが 3 の場合、レスポンスが返されるには、グラウンデッドネス スコアが 3 以上である必要があります。

disabled

boolean

省略可。グラウンディングが無効かどうか。

SnippetsConfig

JSON 表現
{
  "enableSnippets": boolean,
  "maxSnippets": integer
}
フィールド
enableSnippets

boolean

省略可。スニペットが有効かどうか。

maxSnippets

integer

省略可。クエリごとに返すスニペットの数。設定しない場合、デフォルトですべてのスニペットがサービスから返されます。

PythonFunction

JSON 表現
{
  "name": string,
  "pythonCode": string,
  "description": string,
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  }
}
フィールド
name

string

省略可。実行する Python 関数の名前。Python コードで定義された Python 関数名と一致する必要があります。大文字と小文字が区別されます。名前が指定されていない場合は、Python コードで定義された最初の関数が使用されます。

pythonCode

string

省略可。ツールで実行する Python コード。

description

string

出力専用。Python コードの docstring から解析された Python 関数の説明。

serviceDirectoryConfig

object (ServiceDirectoryConfig)

省略可。ツールの Service Directory 構成。

McpTool

JSON 表現
{
  "name": string,
  "nameOverride": string,
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  },
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "state": enum (State)
}
フィールド
name

string

必須。MCP ツールの名前。

nameOverride

string

省略可。MCP ツールの名前のオーバーライド。名前が Toolset のオーバーライドによってオーバーライドされた場合、このフィールドに値が入力されます。

description

string

省略可。MCP ツールの説明。

inputSchema

object (Schema)

省略可。MCP ツールの入力引数のスキーマ。

outputSchema

object (Schema)

省略可。MCP ツールの出力引数のスキーマ。

serverAddress

string

必須。MCP サーバーのサーバーアドレス(例: 「https://example.com/mcp/」)。サーバーが MCP SDK で構築されている場合、URL の末尾に「/mcp/」を付ける必要があります。Streamable HTTP トランスポート ベースのサーバーのみがサポートされています。これは、McpToolset の server_address と同じです。詳細については、https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http をご覧ください。

apiAuthentication

object (ApiAuthentication)

省略可。MCP サーバーに対してツールを実行するために必要な認証情報。署名なしトークン認証の場合、トークンはツールの実行にのみ適用され、ツールのリストには適用されません。これには、認証なしでツールを一覧表示できる必要があります。

tlsConfig

object (TlsConfig)

省略可。TLS 構成。クライアントが信頼する必要があるカスタム サーバー証明書が含まれます。

serviceDirectoryConfig

object (ServiceDirectoryConfig)

省略可。境界内のサービス名を解決するために使用される、VPC-SC の Service Directory 構成。

customHeaders

map (key: string, value: string)

省略可。MCP サーバーへのリクエストで送信するカスタム ヘッダー。値は $context.variables.<name_of_variable> 形式にする必要があり、セッション変数で設定できます。詳細については、https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection をご覧ください。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

state

enum (State)

出力専用。外部サーバー上のツールの動的な可用性状態。

CustomHeadersEntry

JSON 表現
{
  "key": string,
  "value": string
}
フィールド
key

string

value

string

FileSearchTool

JSON 表現
{
  "corpusType": enum (CorpusType),
  "name": string,
  "description": string,
  "fileCorpus": string
}
フィールド
corpusType

enum (CorpusType)

省略可。コーパスのタイプ。デフォルトは FULLY_MANAGED です。

name

string

必須。ツール名。

description

string

省略可。ツールの説明。

fileCorpus

string

省略可。ファイルが保存されているコーパス。形式: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

SystemTool

JSON 表現
{
  "name": string,
  "description": string
}
フィールド
name

string

必須。システムツールの名前。

description

string

出力専用。システムツールの説明。

AgentTool

JSON 表現
{
  "name": string,
  "description": string,
  "agent": string
}
フィールド
name

string

必須。エージェント ツールの名前。

description

string

省略可。ツールの目的の説明。

agent

string

省略可。ツールのエントリ ポイントであるエージェントのリソース名。形式: projects/{project}/locations/{location}/agents/{agent}

WidgetTool

JSON 表現
{
  "name": string,
  "description": string,
  "widgetType": enum (WidgetType),
  "uiConfig": {
    object
  },
  "dataMapping": {
    object (DataMapping)
  },
  "textResponseConfig": {
    object (TextResponseConfig)
  },

  // Union field input can be only one of the following:
  "parameters": {
    object (Schema)
  }
  // End of list of possible types for union field input.
}
フィールド
name

string

必須。ウィジェット ツールの表示名。

description

string

省略可。ウィジェット ツールの説明。

widgetType

enum (WidgetType)

省略可。ウィジェット ツールのタイプ。指定しない場合、デフォルトのタイプは CUSTOMIZED になります。

uiConfig

object (Struct format)

省略可。ウィジェットをレンダリングするための構成。

dataMapping

object (DataMapping)

省略可。ソースツールのデータをウィジェットの入力パラメータにマッピングする方法を定義するマッピング。

textResponseConfig

object (TextResponseConfig)

省略可。常に含まれるテキスト レスポンスの構成。

共用体フィールド input。ウィジェット ツールの入力。input は次のいずれかになります。
parameters

object (Schema)

省略可。ウィジェット ツールの入力パラメータ。

DataMapping

JSON 表現
{
  "sourceToolName": string,
  "fieldMappings": {
    string: string,
    ...
  },
  "pythonFunction": {
    object (PythonFunction)
  },
  "mode": enum (Mode),
  "pythonScript": string
}
フィールド
sourceToolName

string

省略可。ウィジェットにデータを提供するツールのリソース名(検索ツールやカスタム関数など)。形式: projects/{project}/locations/{location}/agents/{agent}/tools/{tool}

fieldMappings

map (key: string, value: string)

省略可。ウィジェットの入力パラメータ フィールドと、ソースツールの対応する出力フィールドのマッピング。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

pythonFunction

object (PythonFunction)

省略可。ソースツールの出力をウィジェットの入力形式に変換するために使用される Python 関数の構成。

mode

enum (Mode)

省略可。データ マッピングのモード。

pythonScript
(deprecated)

string

非推奨: 代わりに、python_function を使用してください。

FieldMappingsEntry

JSON 表現
{
  "key": string,
  "value": string
}
フィールド
key

string

value

string

TextResponseConfig

JSON 表現
{
  "type": enum (Type),
  "staticText": string,
  "textResponseInstruction": string
}
フィールド
type

enum (Type)

省略可。テキスト レスポンスを提供する戦略。

staticText

string

省略可。type が STATIC の場合に返される静的テキスト レスポンス。

textResponseInstruction

string

省略可。テキスト レスポンスの生成方法に関する LLM への指示。タイプが LLM_GENERATED の場合、テキスト レスポンス パラメータの説明として使用されます。

RemoteAgentTool

JSON 表現
{
  "name": string,
  "description": string,
  "agentCard": {
    object (AgentCard)
  },
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "statefulAgent": boolean,
  "inputVariableMapping": {
    string: string,
    ...
  },
  "outputVariableMapping": {
    string: string,
    ...
  }
}
フィールド
name

string

必須。ツールの名前。

description

string

必須。ツールの説明。

agentCard

object (AgentCard)

必須。このツールが呼び出すリモート エージェントのエージェント カード。

apiAuthentication

object (ApiAuthentication)

省略可。リモート エージェントを呼び出すための認証構成。

statefulAgent

boolean

省略可。有効にすると、CXAS アプリとリモート エージェント間のやり取りで同じコンテキストが共有されます。リモート エージェントが context_id を返すと、このリモート エージェント ツールのセッション全体で保持されます。

inputVariableMapping

map (key: string, value: string)

省略可。リモート エージェントの入力変数名と GECX 変数名のマッピング。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

outputVariableMapping

map (key: string, value: string)

省略可。リモート エージェントの出力変数名と GECX 変数名のマッピング。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

InputVariableMappingEntry

JSON 表現
{
  "key": string,
  "value": string
}
フィールド
key

string

value

string

OutputVariableMappingEntry

JSON 表現
{
  "key": string,
  "value": string
}
フィールド
key

string

value

string

ToolFakeConfig

JSON 表現
{
  "enableFakeMode": boolean,

  // Union field tool_response can be only one of the following:
  "codeBlock": {
    object (CodeBlock)
  }
  // End of list of possible types for union field tool_response.
}
フィールド
enableFakeMode

boolean

省略可。ツールがフェイクモードを使用しているかどうか。

共用体フィールド tool_response。レスポンスは静的であるか、Python 関数によって提供されます。tool_response は次のいずれかになります。
codeBlock

object (CodeBlock)

省略可。実際のツール呼び出しの代わりに実行されるコードブロック。

CodeBlock

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

string

必須。ツールフェイク モードで呼び出される Python コード。想定される Python 関数シグネチャ - すべてのツール呼び出しをキャッチする場合: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: 特定のツール呼び出しをキャッチする場合: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: 関数が None を返すと、代わりに実際のツールが呼び出されます。

例

JSON 表現
{
  "name": string,
  "displayName": string,
  "description": string,
  "entryAgent": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "invalid": boolean,
  "etag": string
}
フィールド
name

string

ID。サンプルの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/examples/{example}

displayName

string

必須。サンプルの表示名。

description

string

省略可。人が読める形式のサンプルの説明。

entryAgent

string

省略可。最初に会話を処理するエージェント。指定しない場合、この例はルート エージェントによって処理される会話を表します。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

messages[]

object (Message)

省略可。会話を構成するメッセージのコレクション。

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

invalid

boolean

出力専用。参照元のリソースが削除されると、この例は無効になる可能性があります。無効な例は、少数ショットの例として使用されません。

etag

string

読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される Etag。etag が空の場合、更新によって同時変更が上書きされます。

メッセージ

JSON 表現
{
  "role": string,
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "eventTime": string
}
フィールド
role

string

省略可。会話内のロール(ユーザー、エージェントなど)。

chunks[]

object (Chunk)

省略可。一連のチャンクとしてのメッセージのコンテンツ。

eventTime

string (Timestamp format)

省略可。メッセージが送信または受信されたときのタイムスタンプ。メッセージが example の一部である場合は使用しないでください。

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

チャンク

JSON 表現
{

  // Union field data can be only one of the following:
  "text": string,
  "transcript": string,
  "blob": {
    object (Blob)
  },
  "payload": {
    object
  },
  "image": {
    object (Image)
  },
  "toolCall": {
    object (ToolCall)
  },
  "toolResponse": {
    object (ToolResponse)
  },
  "agentTransfer": {
    object (AgentTransfer)
  },
  "updatedVariables": {
    object
  },
  "defaultVariables": {
    object
  }
  // End of list of possible types for union field data.
}
フィールド
共用体フィールド data。データをチャンク化する。data は次のいずれかになります。
text

string

省略可。テキストデータ。

transcript

string

省略可。音声に関連付けられた文字起こし。

blob

object (Blob)

省略可。blob データ。

payload

object (Struct format)

省略可。カスタム ペイロード データ。

image

object (Image)

省略可。画像データ。

toolCall

object (ToolCall)

省略可。ツール実行リクエスト。

toolResponse

object (ToolResponse)

省略可。ツール実行レスポンス。

agentTransfer

object (AgentTransfer)

省略可。エージェント転送イベント。

updatedVariables

object (Struct format)

構造体は、会話で更新された変数を表します。変数名でキー設定されます。

defaultVariables

object (Struct format)

構造体は、会話の開始時にデフォルトの変数を表します。変数名でキー設定されます。

Blob

JSON 表現
{
  "mimeType": string,
  "data": string
}
フィールド
mimeType

string

必須。ソースデータの IANA 標準 MIME タイプ。

data

string (bytes format)

必須。blob の未加工バイト。

Base64 でエンコードされた文字列。

画像

JSON 表現
{
  "mimeType": string,
  "data": string,
  "altText": string
}
フィールド
mimeType

string

必須。ソースデータの IANA 標準 MIME タイプ。サポートされている画像タイプには、image/png、image/jpeg、image/webp があります。

data

string (bytes format)

必須。画像の未加工のバイト数。

Base64 でエンコードされた文字列。

altText

string

省略可。画像の代替テキスト。

ToolCall

JSON 表現
{
  "id": string,
  "displayName": string,
  "args": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,
  "targetApp": string,

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
フィールド
id

string

省略可。ツール呼び出しの固有識別子。入力されている場合、クライアントは ToolResponse で照合用のウェブ商品アイテム ID を含む実行結果を返す必要があります。

displayName

string

出力専用。ツールの表示名。

args

object (Struct format)

省略可。ツールの入力パラメータと値(JSON オブジェクト形式)。

parentToolCallId

string

出力専用。親呼び出しに代わって動作するサブエージェントによって発行された場合に、この呼び出しの原因となったツール呼び出しの ID。最上位の呼び出しの場合は空です。クライアントは、すべてのステップを兄弟としてレンダリングするのではなく、サブエージェントの作業を、それを開始した呼び出しの下にグループ化できます。

agentName

string

出力専用。この呼び出しを発行したエージェントの人が読める形式の名前(「Contract Architect」など)。ルート エージェントが発行した場合は空になります。

targetApp

string

出力専用。この呼び出しの対象となるアプリ。アシスタントが呼び出しのリソース引数から取得します。アプリのリソース名、ロケーション スコープのツールの場合は PROJECT、セッション ローカルのツールの場合は空です。プロジェクト スコープのアシスタント セッションでのみ設定されます。

共用体フィールド tool_identifier。実行するツールの識別子。永続化されたツールまたはツールセットのツールのいずれかです。tool_identifier は次のいずれかになります。
tool

string

省略可。実行するツールの名前。形式: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

toolsetTool

object (ToolsetTool)

省略可。実行するツールセット ツール。

ToolsetTool

JSON 表現
{
  "toolset": string,
  "toolId": string
}
フィールド
toolset

string

必須。このツールの派生元である Toolset のリソース名。形式: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

toolId

string

省略可。スキーマを取得するツールをフィルタするためのツール ID。

ToolResponse

JSON 表現
{
  "id": string,
  "displayName": string,
  "response": {
    object
  },
  "parentToolCallId": string,
  "agentName": string,
  "targetApp": string,

  // Union field tool_identifier can be only one of the following:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of list of possible types for union field tool_identifier.
}
フィールド
id

string

省略可。レスポンスの対象となる tool call の照合用のウェブ商品アイテム ID。

displayName

string

出力専用。ツールの表示名。

response

object (Struct format)

必須。JSON オブジェクト形式のツール実行結果。「output」キーを使用してツールのレスポンスを指定し、「error」キーを使用してエラーの詳細(存在する場合)を指定します。「output」キーと「error」キーが指定されていない場合、「response」全体がツールの実行結果として扱われます。

parentToolCallId

string

出力専用。親呼び出しに代わって動作するサブエージェントによって発行された場合に、この呼び出しの原因となったツール呼び出しの ID。最上位の呼び出しの場合は空です。クライアントは、すべてのステップを兄弟としてレンダリングするのではなく、サブエージェントの作業を、それを開始した呼び出しの下にグループ化できます。

agentName

string

出力専用。この呼び出しを発行したエージェントの人が読める形式の名前(「Contract Architect」など)。ルート エージェントが発行した場合は空になります。

targetApp

string

出力専用。実行されたツールの対象となったアプリ。ToolCall.target_app をミラーリングします。

共用体フィールド tool_identifier。実行されたツールの識別子。永続化されたツールまたはツールセットのツールのいずれかです。tool_identifier は次のいずれかになります。
tool

string

省略可。実行するツールの名前。形式: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

toolsetTool

object (ToolsetTool)

省略可。実行されたツールセット ツール。

AgentTransfer

JSON 表現
{
  "targetAgent": string,
  "displayName": string
}
フィールド
targetAgent

string

必須。会話の転送先のエージェント。この時点から、エージェントが会話を処理します。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

displayName

string

出力専用。エージェントの表示名。

ガードレール

JSON 表現
{
  "name": string,
  "displayName": string,
  "description": string,
  "enabled": boolean,
  "action": {
    object (TriggerAction)
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,

  // Union field guardrail_type can be only one of the following:
  "contentFilter": {
    object (ContentFilter)
  },
  "llmPromptSecurity": {
    object (LlmPromptSecurity)
  },
  "llmPolicy": {
    object (LlmPolicy)
  },
  "modelSafety": {
    object (ModelSafety)
  },
  "codeCallback": {
    object (CodeCallback)
  },
  "supervisor": {
    object (Supervisor)
  }
  // End of list of possible types for union field guardrail_type.
}
フィールド
name

string

ID。ガードレールの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

displayName

string

必須。ガードレールの表示名。

description

string

省略可。ガードレールの説明。

enabled

boolean

省略可。ガードレールが有効かどうか。

action

object (TriggerAction)

省略可。ガードレールがトリガーされたときに実行するアクション。

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

etag

string

読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される Etag。etag が空の場合、更新によって同時変更が上書きされます。

共用体フィールド guardrail_type。ガードレールの種類。guardrail_type は次のいずれかになります。
contentFilter

object (ContentFilter)

省略可。特定のコンテンツが会話で使用されることを禁止するガードレール。

llmPromptSecurity

object (LlmPromptSecurity)

省略可。LLM の分類に基づいてプロンプトが安全でないと判断された場合に会話をブロックするガードレール。

llmPolicy

object (LlmPolicy)

省略可。LLM の分類に基づいて LLM の回答がポリシーに違反していると判断された場合に、会話をブロックするガードレール。

modelSafety

object (ModelSafety)

省略可。モデルの安全設定に基づいて LLM のレスポンスが安全でないと判断された場合に、会話をブロックするガードレール。

codeCallback

object (CodeCallback)

省略可。コールバックの実行結果に基づいて会話をブロックする可能性のあるガードレール。

supervisor

object (Supervisor)

省略可。監督者の介入を実行するガードレール。

ContentFilter

JSON 表現
{
  "bannedContents": [
    string
  ],
  "bannedContentsInUserInput": [
    string
  ],
  "bannedContentsInAgentResponse": [
    string
  ],
  "matchType": enum (MatchType),
  "disregardDiacritics": boolean,
  "sensitiveWordsExemptions": [
    string
  ]
}
フィールド
bannedContents[]

string

省略可。禁止されたフレーズのリスト。ユーザー入力とエージェントの回答の両方に適用されます。

bannedContentsInUserInput[]

string

省略可。禁止されたフレーズのリスト。ユーザー入力にのみ適用されます。

bannedContentsInAgentResponse[]

string

省略可。禁止されたフレーズのリスト。エージェントの回答にのみ適用されます。

matchType

enum (MatchType)

必須。コンテンツ フィルタのマッチタイプ。

disregardDiacritics

boolean

省略可。true の場合、照合時に発音区別符号が無視されます。

sensitiveWordsExemptions[]

string

省略可。このガードレールで許可される機密性の高い単語リストのエントリ。match_type が SENSITIVE_WORDS の場合にのみ有効です。各値はリストのエントリと一致する必要があります(大文字と小文字は区別されず、前後の空白は無視されます)。その他の値は無視されます。このガードレールにのみ適用されます。最大 1,000 個のエントリ(各エントリは最大 256 文字)。

LlmPromptSecurity

JSON 表現
{
  "failOpen": boolean,

  // Union field security_config can be only one of the following:
  "defaultSettings": {
    object (DefaultSecuritySettings)
  },
  "customPolicy": {
    object (LlmPolicy)
  }
  // End of list of possible types for union field security_config.
}
フィールド
failOpen

boolean

省略可。ガードレールで LLM エラーが発生した場合の動作を決定します。- true の場合: ガードレールはバイパスされます。- false(デフォルト)の場合: ガードレールがトリガー / ブロックされます。

注: カスタム ポリシーが指定されている場合、このフィールドは無視され、ポリシーの「fail_open」構成が優先されます。

共用体フィールド security_config。セキュリティ構成モードを定義します。ユーザーは次のいずれかの構成を選択する必要があります。security_config は次のいずれかになります。
defaultSettings

object (DefaultSecuritySettings)

省略可。システムの事前定義されたデフォルトのセキュリティ設定を使用します。このモードを選択するには、リクエストに空の「default_settings」メッセージを含めます。その中の「default_prompt_template」フィールドは、レスポンスでサーバーによって入力されます。

customPolicy

object (LlmPolicy)

省略可。ユーザー定義の LlmPolicy を使用して、セキュリティ ガードレールを構成します。

DefaultSecuritySettings

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

string

出力専用。システムで使用されるデフォルトのプロンプト テンプレート。このフィールドは、システムがデフォルトで使用するプロンプトをユーザーに表示するためのものです。これは OUTPUT_ONLY です。

LlmPolicy

JSON 表現
{
  "maxConversationMessages": integer,
  "modelSettings": {
    object (ModelSettings)
  },
  "prompt": string,
  "policyScope": enum (PolicyScope),
  "failOpen": boolean,
  "allowShortUtterance": boolean
}
フィールド
maxConversationMessages

integer

省略可。このポリシーをチェックする際に、会話の最後の「n」個のメッセージを考慮します。設定しない場合、デフォルト値の 10 が使用されます。

modelSettings

object (ModelSettings)

省略可。モデル設定。

prompt

string

必須。ポリシー プロンプト。セッション変数プレースホルダ({var})と {agent_system_instruction} をサポートし、エージェントの解決済みシステム指示を挿入します。

policyScope

enum (PolicyScope)

必須。会話中にポリシー チェックを適用するタイミングを定義します。POLICY_SCOPE_UNSPECIFIED に設定すると、ポリシーはユーザー入力に適用されます。ポリシーをエージェントのレスポンスに適用すると、エージェントがレスポンスを返すまでに追加のレイテンシが発生します。

failOpen

boolean

省略可。ポリシー チェック中にエラーが発生した場合は、フェイルオープンしてガードレールをトリガーしない。

allowShortUtterance

boolean

省略可。デフォルトでは、短い発話に対しては LLM ポリシー チェックがバイパスされます。この設定を有効にすると、通常はスキップされる発話を含むすべての発話にポリシー チェックが適用されます。

ModelSafety

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

object (SafetySetting)

必須。安全に関する設定のリスト。

SafetySetting

JSON 表現
{
  "category": enum (HarmCategory),
  "threshold": enum (HarmBlockThreshold)
}
フィールド
category

enum (HarmCategory)

必須。有害カテゴリ。

threshold

enum (HarmBlockThreshold)

必須。有害ブロックのしきい値。

CodeCallback

JSON 表現
{
  "beforeAgentCallback": {
    object (Callback)
  },
  "afterAgentCallback": {
    object (Callback)
  },
  "beforeModelCallback": {
    object (Callback)
  },
  "afterModelCallback": {
    object (Callback)
  }
}
フィールド
beforeAgentCallback

object (Callback)

省略可。エージェントが呼び出される前に実行するコールバック。各コールバック関数は、少なくとも次のものを含む構造(辞書やオブジェクトなど)を返す必要があります。- 'decision': 'OK' または 'TRIGGER'。- 'reason': 決定の理由を説明する文字列。「TRIGGER」の判定により、それ以降の処理が停止する場合があります。

afterAgentCallback

object (Callback)

省略可。エージェントが呼び出された後に実行されるコールバック。各コールバック関数は、少なくとも次のものを含む構造(辞書やオブジェクトなど)を返す必要があります。- 'decision': 'OK' または 'TRIGGER'。- 'reason': 決定の理由を説明する文字列。「TRIGGER」の判定により、それ以降の処理が停止する場合があります。

beforeModelCallback

object (Callback)

省略可。モデルが呼び出される前に実行するコールバック。モデルへの呼び出しが複数ある場合、コールバックは複数回実行されます。各コールバック関数は、少なくとも次のものを含む構造(辞書やオブジェクトなど)を返す必要があります。- 'decision': 'OK' または 'TRIGGER'。- 'reason': 決定の理由を説明する文字列。「TRIGGER」の判定により、それ以降の処理が停止する場合があります。

afterModelCallback

object (Callback)

省略可。モデルの呼び出し後に実行するコールバック。モデルへの呼び出しが複数ある場合、コールバックは複数回実行されます。各コールバック関数は、少なくとも次のものを含む構造(辞書やオブジェクトなど)を返す必要があります。- 'decision': 'OK' または 'TRIGGER'。- 'reason': 決定の理由を説明する文字列。「TRIGGER」の判定により、それ以降の処理が停止する場合があります。

スーパーバイザー

JSON 表現
{
  "type": enum (Type),
  "detectionMode": enum (DetectionMode)
}
フィールド
type

enum (Type)

省略可。スーパーバイザーのタイプ。

detectionMode

enum (DetectionMode)

省略可。スーパーバイザーの検出モード。

TriggerAction

JSON 表現
{

  // Union field action can be only one of the following:
  "respondImmediately": {
    object (RespondImmediately)
  },
  "transferAgent": {
    object (TransferAgent)
  },
  "generativeAnswer": {
    object (GenerativeAnswer)
  }
  // End of list of possible types for union field action.
}
フィールド
共用体フィールド action。必要な対応。action は次のいずれかになります。
respondImmediately

object (RespondImmediately)

省略可。事前構成されたレスポンスですぐに応答する。

transferAgent

object (TransferAgent)

省略可。会話を別のエージェントに転送する。

generativeAnswer

object (GenerativeAnswer)

省略可。生成回答で応答する。

RespondImmediately

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

object (Response)

必須。エージェントが選択できる返信定型文。レスポンスはランダムに選択されます。

レスポンス

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

string

必須。エージェントが応答するテキスト。

disabled

boolean

省略可。レスポンスが無効かどうか。無効にされたレスポンスはエージェントによって使用されません。

TransferAgent

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

string

必須。会話の転送先となるエージェントの名前。エージェントは、現在のエージェントと同じアプリに存在する必要があります。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

GenerativeAnswer

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

string

必須。生成回答に使用するプロンプト。

ツールセット

JSON 表現
{
  "name": string,
  "displayName": string,
  "description": string,
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionType": enum (ExecutionType),
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // Union field toolset_type can be only one of the following:
  "mcpToolset": {
    object (McpToolset)
  },
  "openApiToolset": {
    object (OpenApiToolset)
  },
  "connectorToolset": {
    object (ConnectorToolset)
  }
  // End of list of possible types for union field toolset_type.
}
フィールド
name

string

ID。ツールセットの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

displayName

string

省略可。ツールセットの表示名。同じアプリ内で一意である必要があります。

description

string

省略可。ツールセットの説明。

timeout

string (Duration format)

省略可。ツールセットの実行のタイムアウト。設定しない場合、デフォルトのタイムアウトは SYNCHRONOUS ツールセットでは 30 秒、ASYNCHRONOUS ツールセットでは 60 秒です。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

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

etag

string

読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。

executionType

enum (ExecutionType)

省略可。ツールセット内のツールの実行タイプ。

toolFakeConfig

object (ToolFakeConfig)

省略可。フェイクモードでのツールの動作の構成。

共用体フィールド toolset_type。ツールセットのタイプ。toolset_type は次のいずれかになります。
mcpToolset

object (McpToolset)

省略可。MCP サーバーが提供するツールのリストを含むツールセット。

openApiToolset

object (OpenApiToolset)

省略可。OpenAPI スキーマで定義されたツールのリストを含むツールセット。

connectorToolset

object (ConnectorToolset)

省略可。Integration Connectors 接続からツールを生成するツールセット。

McpToolset

JSON 表現
{
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "toolOverrides": [
    {
      object (McpToolOverride)
    }
  ]
}
フィールド
serverAddress

string

必須。MCP サーバーのアドレス(例: 「https://example.com/mcp/」)。サーバーが MCP SDK で構築されている場合、URL の末尾に「/mcp/」を付ける必要があります。Streamable HTTP トランスポート ベースのサーバーのみがサポートされています。詳細については、https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http をご覧ください。

apiAuthentication

object (ApiAuthentication)

省略可。ツールにアクセスして MCP サーバーに対してツールを実行するために必要な認証情報。署名なしトークン認証の場合、トークンはツールの実行にのみ適用され、ツールのリストには適用されません。これには、認証なしでツールを一覧表示できる必要があります。

serviceDirectoryConfig

object (ServiceDirectoryConfig)

省略可。境界内のサービス名を解決するために使用される、VPC-SC の Service Directory 構成。

tlsConfig

object (TlsConfig)

省略可。TLS 構成。クライアントが信頼する必要があるカスタム サーバー証明書が含まれます。

customHeaders

map (key: string, value: string)

省略可。MCP サーバーへのリクエストで送信するカスタム ヘッダー。値は $context.variables.<name_of_variable> 形式にする必要があり、セッション変数で設定できます。詳細については、https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection をご覧ください。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

toolOverrides[]

object (McpToolOverride)

省略可。このツールセット内の個々のツールのオーバーライド。これにより、説明や名前などの特定の詳細をオーバーライドしたり、ツールの状態を固定して完全に動的にならないようにしたりできます。

CustomHeadersEntry

JSON 表現
{
  "key": string,
  "value": string
}
フィールド
key

string

value

string

McpToolOverride

JSON 表現
{
  "tool": string,
  "nameOverride": string,
  "descriptionOverride": string,
  "snapshot": {
    object (McpToolDefinition)
  }
}
フィールド
tool

string

必須。MCP サーバーから出力されたツールの元の名前。

nameOverride

string

省略可。存在する場合、このツールはエージェントで元の名前ではなくこの名前を使用します。これは主に、MCP サーバーが提供するツールの名前が不適切な場合に、エイリアスとして使用されます。

descriptionOverride

string

省略可。存在する場合、このツールはサーバーからの元の説明ではなく、この説明を使用します。

snapshot

object (McpToolDefinition)

出力専用。このツールが存在する場合、ツールは「固定」され、サーバーが一時的に利用できなくなった場合やオーバーライドが存在しない場合に、スナップショット値をフォールバックとして使用します。

McpToolDefinition

JSON 表現
{
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  }
}
フィールド
description

string

出力専用。MCP ツールの説明。これは、McpToolOverride の description_override でオーバーライドできます。

inputSchema

object (Schema)

出力専用。MCP ツールの入力引数のスキーマ。

outputSchema

object (Schema)

出力専用。MCP ツールの出力引数のスキーマ。

OpenApiToolset

JSON 表現
{
  "openApiSchema": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
フィールド
openApiSchema

string

必須。ツールセットの OpenAPI スキーマ。

apiAuthentication

object (ApiAuthentication)

省略可。API で必要な認証情報。

tlsConfig

object (TlsConfig)

省略可。TLS 構成。カスタム サーバー証明書が含まれます。

serviceDirectoryConfig

object (ServiceDirectoryConfig)

省略可。Service Directory の構成。

ignoreUnknownFields

boolean

省略可。true の場合、エージェントは OpenAPI スキーマで定義されたすべてのオペレーションの API レスポンスで不明なフィールドを無視します。

url

string

省略可。Open API スキーマのサーバー URL。このフィールドは、スキーマにサーバー URL が含まれている場合に、エクスポート プロセス中に環境依存関係のツールセットにのみ設定されます。インポート プロセス中に、この URL が環境の依存関係に存在し、スキーマに $env_var プレースホルダがある場合、スキーマのプレースホルダが置き換えられます。

ConnectorToolset

JSON 表現
{
  "connection": string,
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "connectorActions": [
    {
      object (Action)
    }
  ]
}
フィールド
connection

string

必須。参照される Integration Connectors 接続の完全なリソース名。形式: projects/{project}/locations/{location}/connections/{connection}

authConfig

object (EndUserAuthConfig)

省略可。Integration Connectors での認証の処理方法を構成します。デフォルトでは、Integration Connectors API リクエストで管理者認証が渡されます。別のエンドユーザー認証構成でオーバーライドできます。注: ここで EUC 構成を指定するには、接続で認証のオーバーライドが有効になっている必要があります。有効になっていない場合、ツールセットの作成は失敗します。参照: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override

connectorActions[]

object (Action)

必須。ツールを生成するコネクタ アクション / エンティティ オペレーションのリスト。

PrebuiltAmbientNoise

プリビルドの周囲のノイズ。

列挙型
PREBUILT_AMBIENT_NOISE_UNSPECIFIED 指定されていません。
RETAIL_STORE 小売店の周囲のノイズ。
CONVENTION_HALL コンベンション ホールの周囲のノイズ。
OUTDOOR 通りの周囲のノイズ。

WarningType

音声サンプルの処理中に発生した警告の種類。

列挙型
WARNING_TYPE_UNSPECIFIED 未指定の警告タイプ。
LOW_AUDIO_LEVEL 音声サンプルの音量が小さすぎる(RMS 振幅が小さいなど)。

VoiceInstructionMode

音声サンプルの指示モード。

列挙型
VOICE_INSTRUCTION_MODE_UNSPECIFIED 指示モードが指定されていません。デフォルトは NO_INSTRUCTION です。
NO_INSTRUCTION 音声指示は使用されません。
GENERATE_INSTRUCTION 音声指示は、音声サンプルから AI によって自動的に生成されます。
CUSTOM_INSTRUCTION ユーザーが指定したカスタム音声指示。

ErrorHandlingStrategy

エラー処理の戦略を定義します。

列挙型
ERROR_HANDLING_STRATEGY_UNSPECIFIED 不明なエラー処理方式。
NONE 特定の処理は有効になっていません。
FALLBACK_RESPONSE システムエラー(LLM エラーなど)が発生した場合、ユーザーに代替メッセージが返されます。
END_SESSION システムエラー(LLM エラーなど)が発生した場合、EndSession シグナルが送信されます。

ThinkingLevel

モデルの思考レベルの構成。

列挙型
THINKING_LEVEL_UNSPECIFIED 思考レベルが指定されていません。
DEFAULT デフォルトの思考レベル。
LOW 思考レベルが低い。
MEDIUM 中程度の思考レベル。
HIGH 高度な思考レベル。

ToolExecutionMode

エージェントが同時に複数のツールを選択した場合のツールの実行動作を定義します。

列挙型
TOOL_EXECUTION_MODE_UNSPECIFIED ツール実行モードが指定されていません。デフォルトは PARALLEL です。
PARALLEL 複数のツールが選択されている場合、それらは同じ ToolContext で並列に実行されます。
SEQUENTIAL 複数のツールが選択されている場合は、順番に実行されます。次のツールは、前のツールが完了した後にのみ実行され、前のツールから更新された ToolContext を確認できます。

SemanticSimilarityChannel

使用する意味的類似度チャンネル。

列挙型
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED 指標が指定されていません。デフォルトは TEXT です。
TEXT テキストの意味的類似性を使用します。
AUDIO 音声の意味的類似性を使用します。

ExtraToolCallBehavior

追加のツール呼び出しが発生した場合の動作を定義します。余分なツール呼び出しとは、実行中に存在するものの、ゴールデン エクスペクテーションのツール呼び出しと一致しないツール呼び出しです。

列挙型
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED 未指定の動作。デフォルトは FAIL です。
FAIL 余分なツール呼び出しが検出された場合は、評価を不合格にします。
ALLOW 追加のツール呼び出しを許可します。

HallucinationMetricBehavior

ハルシネーション指標の動作。動作に関係なく、指標は常に計算されます。違いは、無効にすると、その指標が全体的な評価スコアの計算に使用されないことです。

列挙型
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED 未指定のハルシネーション指標の動作。
DISABLED ハルシネーション指標を無効にします。
ENABLED ハルシネーション指標を有効にします。

種類

OpenAPI のデータ型。

列挙型
TYPE_UNSPECIFIED 未指定
STRING 文字列型。
INTEGER 整数型。
NUMBER 数値型。
BOOLEAN ブール型。
OBJECT オブジェクト タイプ。
ARRAY 配列型。

NullValue

JSON null を表します。

NullValue は、1 つの値のみを持つ列挙型を使用して Value 型のユニオンの null 値を表すセンチネルです。

0 以外の値を持つ NullValue 型のフィールドは無効と見なされます。ほとんどの ProtoJSON シリアライザは、整数値に関係なく、null_value が JSON null として設定された Value を出力するため、0 値に往復します。

列挙型
NULL_VALUE Null 値。

種類

エンジンのタイプ。https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType と https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest のドキュメントをご覧ください。

列挙型
TYPE_UNSPECIFIED エンジンタイプが指定されていません。
ENGINE_TYPE_CHAT チャット エンジンのタイプ。アプリの SOLUTION_TYPE_CHAT エンジン。アプリに追加されたすべてのコネクタ データストアがこのエンジンに追加されます。

ChannelType

チャンネル プロファイルのタイプ。

列挙型
UNKNOWN 不明なチャネルタイプ。
WEB_UI ウェブ UI チャネル。
API API チャネル。
TWILIO Twilio チャネル。
GOOGLE_TELEPHONY_PLATFORM Google テレフォニー プラットフォーム チャネル。
CONTACT_CENTER_AS_A_SERVICE Contact Center as a Service(CCaaS)チャネル。
CONTACT_CENTER_AS_A_SERVICE_CHAT Contact Center as a Service(CCaaS チャット)チャネル。
FIVE9 Five9 チャネル。
CONTACT_CENTER_INTEGRATION サードパーティのコンタクト センター統合チャネル。
WHATSAPP WhatsApp チャネル。
INSTAGRAM Instagram チャンネル。

ペルソナ

チャンネルのペルソナ。

列挙型
UNKNOWN UNKNOWN ペルソナ。
CONCISE エージェントは、簡潔かつ要点を押さえた回答を心がけている
CHATTY エージェントが追加のコンテキスト、説明、詳細情報を提供する

モダリティ

ウェブ ウィジェットのモダリティ。

列挙型
MODALITY_UNSPECIFIED 不明なモダリティ。
CHAT_AND_VOICE ウィジェットはチャット入力と音声入力の両方をサポートしています。
VOICE_ONLY ウィジェットは音声入力のみをサポートしています。
CHAT_ONLY ウィジェットはチャット入力のみをサポートしています。
CHAT_VOICE_AND_VIDEO ウィジェットは、チャット、音声、動画の入力をサポートしています。

テーマ

ウェブ ウィジェットのテーマ。

列挙型
THEME_UNSPECIFIED 不明なテーマ。
LIGHT ライトモード。
DARK ダークモード。

RequestLocation

リクエスト内の API キーの場所。

列挙型
REQUEST_LOCATION_UNSPECIFIED 指定なし。この値は使用されるべきではありません。
HEADER HTTP ヘッダーのキーを表します。
QUERY_STRING クエリ文字列のキーを表します。

OauthGrantType

OAuth 権限付与タイプ。クライアント認証情報の付与のみがサポートされています。

列挙型
OAUTH_GRANT_TYPE_UNSPECIFIED 指定なし。デフォルトは CLIENT_CREDENTIAL です。
CLIENT_CREDENTIAL クライアント認証情報フローを表します。

方向

転送の方向。

列挙型
DIRECTION_UNSPECIFIED 方向が指定されていません。
PARENT_TO_CHILD 親エージェントから子エージェントに転送します。
CHILD_TO_PARENT 子エージェントから親エージェントに転送します。

OperationType

エンティティに対して実行するオペレーション。

列挙型
OPERATION_TYPE_UNSPECIFIED オペレーション タイプが指定されていません。無効です。ConnectorTool の作成 / 更新は失敗します。
LIST リスト オペレーション。
GET オペレーションを取得します。
CREATE 作成オペレーション。
UPDATE 更新オペレーション。
DELETE 削除オペレーション。

DataStoreType

データストアのタイプ。

列挙型
DATA_STORE_TYPE_UNSPECIFIED 指定なし。この値は、データストア タイプが指定されていないことを示します。そのため、検索時には使用されません。
PUBLIC_WEB 一般公開ウェブ コンテンツを含むデータストア。
UNSTRUCTURED 構造化されていない非公開データを含むデータストア。
FAQ よくある質問として使用される構造化データを含むデータストア。
CONNECTOR ファーストパーティ サービスまたはサードパーティ サービスへのコネクタであるデータストア。

DocumentProcessingMode

データストアのドキュメント処理モード。

列挙型
DOCUMENT_PROCESSING_MODE_UNSPECIFIED 指定されていません。
DOCUMENTS ドキュメントはドキュメントとして処理されます。
CHUNKS ドキュメントはチャンクに変換されます。

AttributeType

カスタム ランキングを適用する属性(または関数)。

列挙型
ATTRIBUTE_TYPE_UNSPECIFIED AttributeType が指定されていません。
NUMERICAL 数値フィールドの値は、ブースト額を動的に更新するために使用されます。この場合、コントロール ポイントの attribute_value(x 値)は、boost_amount が指定されている数値フィールドの実際の値になります。
FRESHNESS 鮮度のユースケースでは、属性値は現在時刻と指定された datetime フィールドの日付の間の期間になります。値は、XSD dayTimeDuration 値(ISO 8601 期間値の制限付きサブセット)としてフォーマットする必要があります。このパターンは [nD][T[nH][nM][nS]] です。例: 5D、3DT12H30M、T24H。

InterpolationType

適用する補完タイプ。デフォルトは線形(区分線形)です。

列挙型
INTERPOLATION_TYPE_UNSPECIFIED 補完タイプが指定されていません。この場合、デフォルトは Linear になります。
LINEAR 区分線形補完タイプが適用されます。

ModalityType

モダリティ タイプ。

列挙型
MODALITY_TYPE_UNSPECIFIED モダリティ タイプが指定されていません。
TEXT テキスト モダリティ。
AUDIO 音声モダリティ。

FilterParameterBehavior

フィルタ パラメータの動作。

列挙型
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED デフォルトのフィルタ動作。コネクタ データストアの一致フィルタを含めます。残りのデータストア タイプでは、フィルタ入力パラメータは省略されます。
ALWAYS_INCLUDE すべてのデータストア タイプにフィルタ パラメータを常に含めます。
NEVER_INCLUDE フィルタ パラメータは、データストアのタイプに関係なく、ツール パラメータのリストに含まれません。

状態

ツールの動的な可用性の状態を表します。

列挙型
STATE_UNSPECIFIED デフォルトの状態。
ACTIVE ツールは利用可能であり、サーバーによってアクティブに提供されています。
INACTIVE ツールは構成または固定されていますが、現在サーバーから提供されていません。
STALE ツールはサーバーに存在しますが、サーバー上のバージョンと一致しません。

CorpusType

Vertex RAG コーパスのタイプ。

列挙型
CORPUS_TYPE_UNSPECIFIED コーパスタイプが指定されていません。
USER_OWNED コーパスはユーザーによって作成され、所有されます。
FULLY_MANAGED コーパスはエージェントによって作成されます。

WidgetType

利用可能なすべてのウィジェット タイプ。今後、この列挙型に新しい値が追加される可能性があります。

列挙型
WIDGET_TYPE_UNSPECIFIED ウィジェット タイプが指定されていません。
CUSTOM カスタム ウィジェット タイプ。
PRODUCT_DETAILS 商品の詳細ウィジェット。
QUICK_ACTIONS クイック操作ウィジェット。
PRODUCT_COMPARISON 商品比較ウィジェット。
ADVANCED_PRODUCT_DETAILS 高度な商品詳細ウィジェット。
SHORT_FORM ショート動画ウィジェット。
OVERALL_SATISFACTION 全体的な満足度ウィジェット。
ORDER_SUMMARY 注文概要ウィジェット。
APPOINTMENT_DETAILS 予約の詳細ウィジェット。
APPOINTMENT_SCHEDULER 予約スケジューラ ウィジェット。
CONTACT_FORM お問い合わせフォーム ウィジェット。

モード

ソースツールからウィジェットにデータをマッピングするために使用される戦略。

列挙型
MODE_UNSPECIFIED モードが指定されていません。
FIELD_MAPPING データ変換には field_mappings マップを使用します。
PYTHON_SCRIPT データ変換に python_script を使用します。

種類

テキスト レスポンスの生成方法を定義します。

列挙型
TYPE_UNSPECIFIED 未指定のタイプ。
NONE LLM は、会話のコンテキストに基づいて、ウィジェットとともにテキスト レスポンスを生成するかどうかを動的に決定します。
LLM_GENERATED LLM は、テキスト レスポンスを生成するように明示的に要求されます。
STATIC 常に、事前定義された静的テキスト レスポンスが使用されます。

ExecutionType

ツールまたはツールセットの実行タイプ。

列挙型
EXECUTION_TYPE_UNSPECIFIED 実行タイプが指定されていません。指定しない場合のデフォルトは SYNCHRONOUS です。
SYNCHRONOUS ツールは同期的に実行されます。ツールが戻るまで、セッションはブロックされます。
ASYNCHRONOUS ツールは非同期で実行されます。セッションは、ツールの実行中も継続されます。

MatchType

コンテンツ フィルタのマッチタイプ。

列挙型
MATCH_TYPE_UNSPECIFIED マッチタイプが指定されていません。
SIMPLE_STRING_MATCH コンテンツは部分文字列の文字ごとに照合されます。
WORD_BOUNDARY_STRING_MATCH コンテンツは、テキスト内のパターンが単語区切り文字で囲まれている場合にのみ一致します。禁止フレーズには単語区切り文字を含めることもできます。
REGEXP_MATCH コンテンツは正規表現構文を使用して照合されます。
SENSITIVE_WORDS コンテンツは、システムで管理されている機密性の高い単語やフレーズのリストと照合されます。この一致タイプのガードレールをアプリまたはエージェントに接続すると、影響を受けるエージェントのデフォルトのセンシティブ ワード フィルタが置き換えられます。デフォルトのフィルタを無効にするには、ガードレールを無効にします。

PolicyScope

会話中にポリシー チェックを適用するタイミングを定義します。

列挙型
POLICY_SCOPE_UNSPECIFIED ポリシーのスコープが指定されていません。
USER_QUERY ポリシー チェックはユーザー入力時にトリガーされます。
AGENT_RESPONSE ポリシー チェックはエージェントのレスポンスでトリガーされます。このポリシー スコープを適用すると、エージェントが応答するまでにレイテンシが追加されます。
USER_QUERY_AND_AGENT_RESPONSE ポリシー チェックは、ユーザー入力とエージェントの回答の両方でトリガーされます。このポリシー スコープを適用すると、エージェントが応答するまでにレイテンシが追加されます。

HarmCategory

有害カテゴリ。

列挙型
HARM_CATEGORY_UNSPECIFIED 有害カテゴリが指定されていません。
HARM_CATEGORY_HATE_SPEECH 有害カテゴリはヘイトスピーチです。
HARM_CATEGORY_DANGEROUS_CONTENT 有害カテゴリは危険なコンテンツです。
HARM_CATEGORY_HARASSMENT 有害カテゴリはハラスメントです。
HARM_CATEGORY_SEXUALLY_EXPLICIT 有害カテゴリは、性的描写が露骨なコンテンツです。
HARM_CATEGORY_PROFANITY 有害カテゴリは冒とく的な表現です。
HARM_CATEGORY_TOXIC 有害カテゴリは有害です。

HarmBlockThreshold

ブロックの確率ベースのしきい値レベル。

列挙型
HARM_BLOCK_THRESHOLD_UNSPECIFIED 有害ブロックのしきい値が指定されていません。
BLOCK_LOW_AND_ABOVE 低いしきい値以上をブロックします(つまり、より多くのものをブロックします)。
BLOCK_MEDIUM_AND_ABOVE 中程度のしきい値以上をブロックします。
BLOCK_ONLY_HIGH 高しきい値のみをブロックします(つまり、ブロックを少なくします)。
BLOCK_NONE ブロックなし。
OFF 安全フィルタをオフにします。

種類

スーパーバイザーのタイプ。

列挙型
TYPE_UNSPECIFIED タイプは指定されていません。
INVALID_TEXT テキストの問題タイプが無効です。
LANGUAGE_SHIFT 言語シフトの問題の種類。
SPEAKER_SHIFT スピーカーのシフトに関する問題の種類。
AUDIO_MISMATCH 音声の不一致に関する問題の種類。
MISSING_TOOL_CALL ツール呼び出しの問題の種類がありません。
CUSTOM カスタムの問題タイプ。
CHOPPY_AUDIO 音声が途切れる問題の種類。
PROFANITY エージェントの不適切な表現に関する問題の種類。

DetectionMode

スーパーバイザーの検出モード。

列挙型
DETECTION_MODE_UNSPECIFIED 検出モードが指定されていません。デフォルトは NON_BLOCKING です。
NON_BLOCKING 非ブロッキング検出モード。スーパーバイザーの検出が進行中の場合、レスポンスはブロックされません。
BLOCKING ブロック検出モード。スーパーバイザーの検出が進行中の場合、レスポンスはブロックされます。

ツールのアノテーション

ツールのアノテーションは、特定のツールの基本的なリスクを説明するために MCP クライアントに送信されます。ほとんどのクライアントは、これらのヒントを信頼できないものとして扱いますが、確認プロンプトをユーザーに送信するタイミングを決定するために使用できます。

タイトル文字列とともに、次のブール値のヒントが定義されています。

  • readOnlyHint: true の場合、ツールは環境を変更しません。デフォルトは false です。
  • destructiveHint: true の場合、ツールは破壊的なアクションを実行できます。false の場合、ツールは追加アクションのみを実行できます。デフォルト値は true です。
  • idempotentHint: true の場合、同じ引数でツールを繰り返し呼び出しても、環境に副次的影響は発生しません。デフォルトは false です。
  • openWorldHint: true の場合、ツールは外部エンティティの「オープンワールド」とやり取りできます。false の場合、ツールは内部エンティティとのみやり取りできます。たとえば、ウェブ検索ツールはオープン ワールドですが、メモリツールはオープン ワールドではありません。

破壊的ヒント: ❌ | べき等ヒント: ✅ | 読み取り専用ヒント: ✅ | オープン ワールド ヒント: ❌