ツール: create_app
指定されたプロジェクトとロケーションに新しいアプリを作成します。
次のコードサンプルは、curl を使用して create_app 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": "create_app", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
入力スキーマ
AgentService.CreateApp のリクエスト メッセージです。
CreateAppRequest
| JSON 表現 |
|---|
{
"parent": string,
"appId": string,
"app": {
object ( |
| フィールド | |
|---|---|
parent |
必須。アプリを作成するビジネスのリソース名。 |
appId |
省略可。アプリに使用する ID。アプリのリソース名の最終的なコンポーネントになります。指定しない場合、アプリに一意の ID が自動的に割り当てられます。 |
app |
必須。作成するアプリ。 |
アプリ
| JSON 表現 |
|---|
{ "name": string, "displayName": string, "description": string, "pinned": boolean, "rootAgent": string, "languageSettings": { object ( |
| フィールド | |
|---|---|
name |
ID。アプリの固有識別子。形式: |
displayName |
必須。アプリの表示名。 |
description |
省略可。アプリの説明(人が読める形式)。 |
pinned |
省略可。アプリがアプリリストに固定されているかどうか。 |
rootAgent |
省略可。ルート エージェントはアプリのエントリ ポイントです。形式: |
languageSettings |
省略可。アプリの言語設定。 |
timeZoneSettings |
省略可。アプリのタイムゾーン設定。 |
audioProcessingConfig |
省略可。アプリの音声処理構成。 |
loggingSettings |
省略可。アプリのロギング設定。 |
errorHandlingSettings |
省略可。アプリの設定のエラー処理。 |
modelSettings |
省略可。アプリのデフォルトの LLM モデル設定。個々のリソース(エージェント、ガードレールなど)は、必要に応じてこれらの構成をオーバーライドできます。 |
toolExecutionMode |
省略可。アプリのツール実行モード。指定しない場合、デフォルトは PARALLEL になります。 |
evaluationMetricsThresholds |
省略可。アプリの評価しきい値。 |
variableDeclarations[] |
省略可。変数の宣言。 |
predefinedVariableDeclarations[] |
出力専用。アプリの事前定義変数の宣言。 |
globalInstruction |
省略可。アプリ内のすべてのエージェントに対する指示。この指示を使用して、すべてのエージェントにわたって安定した ID または人格を設定できます。 |
guardrails[] |
省略可。アプリのガードレールのリスト。形式: |
dataStoreSettings |
省略可。アプリのデータストア設定。 |
defaultChannelProfile |
省略可。アプリで使用されるデフォルトのチャンネル プロファイル。 |
metadata |
省略可。アプリに関するメタデータ。このフィールドは、アプリの詳細や想定される用途に関連する追加情報を保存するために使用できます。
|
createTime |
出力専用。アプリが作成されたときのタイムスタンプ。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
updateTime |
出力専用。アプリが最後に更新されたときのタイムスタンプ。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
etag |
出力専用。読み取り、変更、書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。 |
deploymentCount |
出力専用。アプリのデプロイ数。 |
clientCertificateSettings |
省略可。アプリのデフォルトのクライアント証明書設定。 |
vpcScSettings |
省略可。アプリの VPC-SC 設定。 |
locked |
省略可。アプリが変更のためにロックされているかどうかを示します。アプリがロックされている場合、アプリリソースの変更は拒否されます。 |
validationErrors[] |
出力専用。アプリの構成の誤りや警告。 |
dashboardSettings |
省略可。Contact Center Insights ダッシュボードのリンクと構成を行うためのアプリ固有のダッシュボード設定。 |
LanguageSettings
| JSON 表現 |
|---|
{ "defaultLanguageCode": string, "supportedLanguageCodes": [ string ], "enableMultilingualSupport": boolean, "fallbackAction": string } |
| フィールド | |
|---|---|
defaultLanguageCode |
省略可。アプリのデフォルトの言語コード。 |
supportedLanguageCodes[] |
省略可。 |
enableMultilingualSupport |
省略可。多言語サポートを有効にします。true の場合、アプリ内のエージェントは、多言語入力の処理を改善するために、事前構築済みの手順を使用します。 |
fallbackAction |
省略可。非推奨: この機能はサポートされなくなりました。代わりに これは、事前定義されたアクションまたはカスタムのツール呼び出しにできます。有効な値は次のとおりです。- 特定のツールの実行をトリガーするツールの完全なリソース名。- 「エスカレーション」や「終了」などの事前定義されたシステム アクション。対応する |
TimeZoneSettings
| JSON 表現 |
|---|
{ "timeZone": string } |
| フィールド | |
|---|---|
timeZone |
省略可。タイムゾーン データベースにあるアプリのタイムゾーン(例: America/Los_Angeles、Europe/Paris)。 |
AudioProcessingConfig
| JSON 表現 |
|---|
{ "synthesizeSpeechConfigs": { string: { object ( |
| フィールド | |
|---|---|
synthesizeSpeechConfigs |
省略可。エージェントのレスポンスを合成する方法の構成。言語コードから 指定された言語コードの構成が見つからない場合は、ルート言語コードの構成が使用されます。たとえば、マップに「en-us」と「en」が含まれていて、指定された言語コードが「en-gb」の場合、「en」構成が使用されます。 注: 言語コードでは大文字と小文字が区別されません。
|
bargeInConfig |
省略可。ユーザーの割り込みアクティビティに対するエージェントの動作を構成します。 |
inactivityTimeout |
省略可。エージェントがユーザーに再エンゲージメントを促すまでの、ユーザーの操作がない(発話や操作がない)時間。設定されていない場合、エージェントはユーザーに再エンゲージメントを促しません。
|
ambientSoundConfig |
省略可。会話の自然さを高めるために、合成されたエージェントの応答とともに再生されるアンビエント サウンドの構成。 |
SynthesizeSpeechConfigsEntry
| JSON 表現 |
|---|
{
"key": string,
"value": {
object ( |
| フィールド | |
|---|---|
key |
|
value |
|
SynthesizeSpeechConfig
| JSON 表現 |
|---|
{ "voice": string, "voiceSampleGcsUri": string, "speakingRate": number, "model": string, "instruction": string, "consentAudioGcsUri": string } |
| フィールド | |
|---|---|
voice |
省略可。声の名前。設定しない場合、言語コードなどの他のパラメータに基づいて音声が選択されます。 利用可能な音声の一覧については、Cloud Text-to-Speech のサポートされている音声と言語を参照してください。 |
voiceSampleGcsUri |
省略可。非推奨: 代わりに、 音声クローニング用の音声サンプルの Cloud Storage URI。音声サンプルは、モノラル チャンネルの 24 kHz WAV ファイルである必要があります。 注: CES サービス エージェント |
speakingRate |
省略可。発声速度。0.25 ~ 2.0 の範囲で指定します。1.0 は、特定の声でサポートされているネイティブの通常の発声速度を表します。2.0 はその 2 倍の速さで、0.5 は半分の速さです。範囲 [0.25, 2.0] 外の値を指定すると、エラーが返されます。 |
model |
省略可。音声の合成に使用されるモデル。現在サポートされている値: - 「gemini-3.1-flash-tts-preview」。空の場合、Chirp3-HD が使用されます。 |
instruction |
省略可。生成モデルを使用する際に音声の合成に使用される指示。 |
consentAudioGcsUri |
省略可。非推奨: 代わりに、 音声クローニングの同意音声の Cloud Storage URI。 |
BargeInConfig
| JSON 表現 |
|---|
{ "disableBargeIn": boolean, "bargeInAwareness": boolean } |
| フィールド | |
|---|---|
disableBargeIn |
省略可。非推奨: ChannelProfile で エージェントが話している間、ユーザーの割り込みを無効にします。true の場合、エージェントの応答の再生中のユーザー入力は無視されます。 |
bargeInAwareness |
省略可。有効にすると、エージェントは、ユーザーが直前のエージェント メッセージをすべて聞いていないという前提に基づいて、次のレスポンスを調整します。エージェントの回答が視覚的に表示されるシナリオでは使用しないでください。 |
所要時間
| JSON 表現 |
|---|
{ "seconds": string, "nanos": integer } |
| フィールド | |
|---|---|
seconds |
期間の符号付き秒数。-315,576,000,000 ~+315,576,000,000 の範囲(両端を含む)にする必要があります。注: これらの境界は、60 秒/分 * 60 分/時間 * 24 時間/日 * 365.25 日/年 * 10,000 年から計算されます。 |
nanos |
期間のナノ秒分解能による、秒の符号付き小数以下部分。1 秒未満の期間は、0 の |
AmbientSoundConfig
| JSON 表現 |
|---|
{ "volumeGainDb": number, // Union field |
| フィールド | |
|---|---|
volumeGainDb |
省略可。周囲のノイズによってサポートされるネイティブの通常の音量の音量ゲイン(dB 単位)。範囲は [-96.0, 16.0] です。未設定にするか、0.0(dB)に設定すると、ネイティブの通常の信号振幅で再生されます。-6.0(dB)に設定すると、ネイティブの通常の信号振幅の約半分の振幅で再生されます。+6.0(dB)に設定すると、ネイティブの通常の信号振幅の約 2 倍の振幅で再生されます。+10(dB)より大きい値を指定しないことを強くおすすめします。通常は、そのような大きい値を指定しても音量は効果的に増加しません。 |
共用体フィールド source。会話の自然さを高めるために、合成されたエージェントの回答とともに再生される周囲のノイズ。source は次のいずれかになります。 |
|
prebuiltAmbientNoise |
省略可。非推奨: |
gcsUri |
省略可。Cloud Storage に保存されているモノラル チャンネルの 16 kHz WAV ファイルとしての周囲のノイズ。 注: CES サービス エージェント |
prebuiltAmbientSound |
省略可。プリビルドのアンビエント サウンドの名前。有効な値は、- "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner" です。 |
LoggingSettings
| JSON 表現 |
|---|
{ "redactionConfig": { object ( |
| フィールド | |
|---|---|
redactionConfig |
省略可。センシティブ データを編集する方法の構成。 |
audioRecordingConfig |
省略可。音声インタラクションの記録方法の構成。音声は |
unredactedAudioRecordingConfig |
省略可。編集されていない音声の追加録音を構成します。これは、音声の編集が |
bigqueryExportSettings |
省略可。アプリの BigQuery エクスポートの動作を構成します。会話データは、 |
unredactedBigqueryExportSettings |
省略可。アプリの BigQuery エクスポートの動作を構成します。有効になっている場合、編集されていない会話データが BigQuery テーブルにエクスポートされます。 |
cloudLoggingSettings |
省略可。アプリの Cloud Logging の動作を記述する設定。 |
conversationLoggingSettings |
省略可。アプリの会話ロギングの動作を記述する設定。 |
evaluationAudioRecordingConfig |
省略可。評価のために音声インタラクションを記録する方法の構成。デフォルトでは、評価セッションで音声録音は有効になっていません。 |
metricAnalysisSettings |
省略可。アプリの LLM 分析パイプラインの会話データの収集の動作を記述する設定。 |
RedactionConfig
| JSON 表現 |
|---|
{ "enableRedaction": boolean, "inspectTemplate": string, "deidentifyTemplate": string } |
| フィールド | |
|---|---|
enableRedaction |
省略可。true の場合、会話履歴、Cloud Logging、音声録音など、さまざまなロギング シナリオで秘匿化が適用されます。 |
inspectTemplate |
省略可。機密データ型の検出を構成する DLP 検査テンプレート名。 形式: |
deidentifyTemplate |
省略可。コンテンツの匿名化方法を指定する DLP 匿名化テンプレート名。 形式: |
AudioRecordingConfig
| JSON 表現 |
|---|
{ "gcsBucket": string, "gcsPathPrefix": string } |
| フィールド | |
|---|---|
gcsBucket |
省略可。セッションの音声録音を保存する Cloud Storage バケット。URI は「gs://」で始まる必要があります。 データ所在地に関する要件を満たすバケットのロケーションを選択してください。 注: Cloud Storage バケットがアプリとは異なるプロジェクトにある場合は、CES サービス エージェント |
gcsPathPrefix |
省略可。音声録音の Cloud Storage パスの接頭辞。 この接頭辞には、次のプレースホルダを含めることができます。これらのプレースホルダは、配信時に動的に置き換えられます。- $project: プロジェクト ID - $location: アプリの場所 - $app: アプリ ID - $date: YYYY-MM-DD 形式のセッションの日付 - $session: セッション ID パス接頭辞が指定されていない場合は、デフォルトの接頭辞 |
BigQueryExportSettings
| JSON 表現 |
|---|
{ "enabled": boolean, "project": string, "dataset": string } |
| フィールド | |
|---|---|
enabled |
省略可。BigQuery エクスポートが有効になっているかどうかを示します。 |
project |
省略可。データのエクスポート先の BigQuery データセットのプロジェクト ID。 注: BigQuery データセットがアプリとは異なるプロジェクトにある場合は、CES サービス エージェント |
dataset |
省略可。データのエクスポート先の BigQuery データセット ID。 |
CloudLoggingSettings
| JSON 表現 |
|---|
{ "enableCloudLogging": boolean } |
| フィールド | |
|---|---|
enableCloudLogging |
省略可。セッションで Cloud Logging を有効にするかどうか。 |
ConversationLoggingSettings
| JSON 表現 |
|---|
{ "disableConversationLogging": boolean, "retentionWindow": string } |
| フィールド | |
|---|---|
disableConversationLogging |
省略可。セッションの会話のロギングを無効にするかどうか。 |
retentionWindow |
省略可。会話の保持期間を制御します。設定されていない場合、会話は 365 日間保持されます。
|
MetricAnalysisSettings
| JSON 表現 |
|---|
{ "llmMetricsOptedOut": boolean } |
| フィールド | |
|---|---|
llmMetricsOptedOut |
省略可。llm 分析指標の会話データを収集するかどうか。true の場合、llm 分析指標の会話データは収集されません。それ以外の場合、会話データは収集されます。 |
ErrorHandlingSettings
| JSON 表現 |
|---|
{ "errorHandlingStrategy": enum ( |
| フィールド | |
|---|---|
errorHandlingStrategy |
省略可。エラー処理に使用する戦略。 |
fallbackResponseConfig |
省略可。フォールバック レスポンスを処理するための構成。 |
endSessionConfig |
省略可。システムエラー(LLM エラーなど)が発生した場合にセッションを終了するための構成。 |
FallbackResponseConfig
| JSON 表現 |
|---|
{ "customFallbackMessages": { string: string, ... }, "maxFallbackAttempts": integer } |
| フィールド | |
|---|---|
customFallbackMessages |
省略可。システムエラー(LLM エラーなど)が発生した場合のフォールバック メッセージ。サポートされている言語コードでマッピングされます。
|
maxFallbackAttempts |
省略可。 |
CustomFallbackMessagesEntry
| JSON 表現 |
|---|
{ "key": string, "value": string } |
| フィールド | |
|---|---|
key |
|
value |
|
EndSessionConfig
| JSON 表現 |
|---|
{ // Union field |
| フィールド | |
|---|---|
共用体フィールド
|
|
escalateSession |
省略可。 |
ModelSettings
| JSON 表現 |
|---|
{ "model": string, // Union field |
| フィールド | |
|---|---|
model |
省略可。エージェントが使用する LLM モデル。設定されていない場合、エージェントは親エージェントからモデルを継承します。 |
共用体フィールド
|
|
temperature |
省略可。設定すると、この Temperature が LLM モデルに使用されます。Temperature は、モデルのレスポンスのランダム性を制御します。温度が低いほど、予測しやすい回答が生成されます。温度が高いほど、より創造的な回答が生成されます。 |
EvaluationMetricsThresholds
| JSON 表現 |
|---|
{ "goldenEvaluationMetricsThresholds": { object ( |
| フィールド | |
|---|---|
goldenEvaluationMetricsThresholds |
省略可。ゴールデン評価指標のしきい値。 |
hallucinationMetricBehavior |
省略可。非推奨: 代わりに、 |
goldenHallucinationMetricBehavior |
省略可。ゴールデン評価のハルシネーション指標の動作。 |
scenarioHallucinationMetricBehavior |
省略可。シナリオ評価のハルシネーション指標の動作。 |
GoldenEvaluationMetricsThresholds
| JSON 表現 |
|---|
{ "turnLevelMetricsThresholds": { object ( |
| フィールド | |
|---|---|
turnLevelMetricsThresholds |
省略可。ターンレベルの指標のしきい値。 |
expectationLevelMetricsThresholds |
省略可。期待レベルの指標のしきい値。 |
toolMatchingSettings |
省略可。ツール マッチングの設定。余分なツール呼び出しとは、実行には存在するが、ゴールデン エクスペクテーションのどのツール呼び出しとも一致しないツール呼び出しのことです。 |
TurnLevelMetricsThresholds
| JSON 表現 |
|---|
{ "semanticSimilarityChannel": enum ( |
| フィールド | |
|---|---|
semanticSimilarityChannel |
省略可。評価に使用する意味的類似性チャネル。 |
共用体フィールド
|
|
semanticSimilaritySuccessThreshold |
省略可。意味的類似度の成功しきい値。0 ~ 4 の整数を指定してください。デフォルトは 3 以上です。 |
共用体フィールド
|
|
overallToolInvocationCorrectnessThreshold |
省略可。ツール呼び出しの全体的な正しさの成功しきい値。0 ~ 1 の浮動小数点数にする必要があります。デフォルトは 1.0 です。 |
ExpectationLevelMetricsThresholds
| JSON 表現 |
|---|
{ // Union field |
| フィールド | |
|---|---|
共用体フィールド
|
|
toolInvocationParameterCorrectnessThreshold |
省略可。個々のツール呼び出しパラメータの正しさの成功しきい値。0 ~ 1 の浮動小数点数にする必要があります。デフォルトは 1.0 です。 |
ToolMatchingSettings
| JSON 表現 |
|---|
{
"extraToolCallBehavior": enum ( |
| フィールド | |
|---|---|
extraToolCallBehavior |
省略可。追加のツール呼び出しの動作。デフォルトは FAIL です。 |
VariableDeclaration
| JSON 表現 |
|---|
{
"name": string,
"description": string,
"schema": {
object ( |
| フィールド | |
|---|---|
name |
必須。変数の名前。名前の先頭は英字またはアンダースコアにする必要があります。使用できるのは、英字、数字、アンダースコアのみです。 |
description |
必須。変数の説明。 |
schema |
必須。変数のスキーマ。 |
スキーマ
| JSON 表現 |
|---|
{ "type": enum ( |
| フィールド | |
|---|---|
type |
必須。データの型。 |
properties |
省略可。Type.OBJECT のプロパティ。
|
required[] |
省略可。Type.OBJECT の必須プロパティ。 |
description |
省略可。データの説明。 |
items |
省略可。Type.ARRAY の要素のスキーマ。 |
nullable |
省略可。値が null の可能性があるかどうかを示します。 |
uniqueItems |
省略可。配列内の項目が一意であることを示します。TYPE.ARRAY にのみ適用されます。 |
prefixItems[] |
省略可。Type.ARRAY の初期要素のスキーマ。 |
additionalProperties |
省略可。ブール値またはオブジェクトのいずれか。追加のプロパティの存在を制御します。 |
anyOf[] |
省略可。値は、リスト内のサブスキーマのいずれか(1 つ以上)に対して検証される必要があります。 |
enum[] |
省略可。プリミティブ型の要素の可能な値(列挙型形式)。例: 1. 方向は {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. アパートの部屋番号は {type:INTEGER, format:enum, enum:["101", "201", "301"]} と定義できます。 |
default |
省略可。データのデフォルト値。 |
ref |
省略可。スキーマノード間の間接参照を許可します。値は、ルート たとえば、次のスキーマは「Pet」という名前のスキーマノードへの参照を定義します。 「pet」プロパティの値は、「Pet」という名前のスキーマノードへの参照です。詳しくは、https://json-schema.org/understanding-json-schema/structuring をご覧ください。 |
defs |
省略可。
|
title |
省略可。スキーマのタイトル。 |
minItems |
省略可。Type.ARRAY の要素の最小数。 |
maxItems |
省略可。Type.ARRAY の要素の最大数。 |
共用体フィールド
|
|
minimum |
省略可。Type.INTEGER と Type.NUMBER の最小値。 |
共用体フィールド
|
|
maximum |
省略可。Type.INTEGER と Type.NUMBER の最大値。 |
PropertiesEntry
| JSON 表現 |
|---|
{
"key": string,
"value": {
object ( |
| フィールド | |
|---|---|
key |
|
value |
|
値
| JSON 表現 |
|---|
{ // Union field |
| フィールド | |
|---|---|
共用体フィールド kind。値の種類。kind は次のいずれかになります。 |
|
nullValue |
JSON |
numberValue |
JSON 数値を表します。 |
stringValue |
JSON 文字列を表します。 |
boolValue |
JSON ブール値(JSON の |
structValue |
JSON オブジェクトを表します。 |
listValue |
JSON 配列を表します。 |
構造体
| JSON 表現 |
|---|
{ "fields": { string: value, ... } } |
| フィールド | |
|---|---|
fields |
動的に型指定される値の順序なしのマップ。
|
FieldsEntry
| JSON 表現 |
|---|
{ "key": string, "value": value } |
| フィールド | |
|---|---|
key |
|
value |
|
ListValue
| JSON 表現 |
|---|
{ "values": [ value ] } |
| フィールド | |
|---|---|
values[] |
動的に型指定される値の繰り返しフィールド。 |
DefsEntry
| JSON 表現 |
|---|
{
"key": string,
"value": {
object ( |
| フィールド | |
|---|---|
key |
|
value |
|
DataStoreSettings
| JSON 表現 |
|---|
{
"engines": [
{
object ( |
| フィールド | |
|---|---|
engines[] |
出力専用。アプリのエンジン。 |
エンジン
| JSON 表現 |
|---|
{
"name": string,
"type": enum ( |
| フィールド | |
|---|---|
name |
出力専用。エンジンのリソース名。形式: |
type |
出力専用。エンジンの種類。 |
ChannelProfile
| JSON 表現 |
|---|
{ "profileId": string, "channelType": enum ( |
| フィールド | |
|---|---|
profileId |
省略可。チャネル プロファイルの一意の識別子。 |
channelType |
省略可。チャンネル プロファイルのタイプ。 |
personaProperty |
省略可。チャンネル プロファイルのペルソナ プロパティ。 |
webWidgetConfig |
省略可。ウェブ ウィジェットの構成。 |
whatsappConfig |
省略可。WhatsApp のデプロイに固有の構成。 |
instagramConfig |
省略可。Instagram デプロイ固有の構成。 |
共用体フィールド
|
|
disableDtmf |
省略可。DTMF(デュアルトーン マルチ周波数)を無効にするかどうか。 |
共用体フィールド
|
|
disableBargeInControl |
省略可。会話でユーザーの割り込み制御を無効にするかどうか。- true: エージェントが話している間、ユーザーによる割り込みが無効になります。- false: エージェントは、ユーザーが割り込みできるタイミングを自動的に制御します。 |
共用体フィールド
|
|
noiseSuppressionLevel |
省略可。チャンネル プロファイルのノイズ サプレッション レベル。使用可能な値は、「low」、「moderate」、「high」、「very_high」です。 |
PersonaProperty
| JSON 表現 |
|---|
{
"persona": enum ( |
| フィールド | |
|---|---|
persona |
省略可。チャンネルのペルソナ。 |
WebWidgetConfig
| JSON 表現 |
|---|
{ "modality": enum ( |
| フィールド | |
|---|---|
modality |
省略可。ウェブ ウィジェットのモダリティ。 |
theme |
省略可。ウェブ ウィジェットのテーマ。 |
webWidgetTitle |
省略可。ウェブ ウィジェットのタイトル。 |
securitySettings |
省略可。ウェブ ウィジェットのセキュリティ設定。 |
SecuritySettings
| JSON 表現 |
|---|
{ "enablePublicAccess": boolean, "enableOriginCheck": boolean, "allowedOrigins": [ string ], "enableRecaptcha": boolean } |
| フィールド | |
|---|---|
enablePublicAccess |
省略可。ウェブ ウィジェットへの一般公開アクセスが有効かどうかを示します。 |
enableOriginCheck |
省略可。ウェブ ウィジェットのオリジン チェックが有効かどうかを示します。 |
allowedOrigins[] |
省略可。ウェブ ウィジェットのホストを許可されているオリジン。オリジンは RFC 6454 で定義されています。空の場合、すべてのオリジンが許可されます。最大 100 個のオリジンを指定できます。例: "https://example.com" |
enableRecaptcha |
省略可。ウェブ ウィジェットの reCAPTCHA による確認が有効かどうかを示します。 |
WhatsAppConfig
| JSON 表現 |
|---|
{ "wabaId": string, "phoneNumberId": string, "phoneNumber": string, "displayName": string, "thumbnailUrl": string, "description": string } |
| フィールド | |
|---|---|
wabaId |
必須。WhatsApp Business のアカウント ID。 |
phoneNumberId |
必須。Meta の電話番号 ID。 |
phoneNumber |
省略可。E.164 形式の電話番号。 |
displayName |
出力専用。取得した Meta のビジネス ページ名。 |
thumbnailUrl |
出力専用。取得した Meta ビジネス プロフィールのサムネイル URL。 |
description |
出力専用。Meta のビジネス ページまたはプロフィールの説明。 |
InstagramConfig
| JSON 表現 |
|---|
{ "instagramAccountId": string, "displayName": string, "thumbnailUrl": string, "description": string } |
| フィールド | |
|---|---|
instagramAccountId |
必須。Instagram のアカウント ID。 |
displayName |
出力専用。取得した Meta のビジネス ページ名。 |
thumbnailUrl |
出力専用。取得した Meta ビジネス プロフィールのサムネイル URL。 |
description |
出力専用。Meta のビジネス ページまたはプロフィールの説明。 |
MetadataEntry
| JSON 表現 |
|---|
{ "key": string, "value": string } |
| フィールド | |
|---|---|
key |
|
value |
|
タイムスタンプ
| JSON 表現 |
|---|
{ "seconds": string, "nanos": integer } |
| フィールド | |
|---|---|
seconds |
UNIX エポック 1970-01-01T00:00:00Z からの UTC 時刻の秒数を表します。-62135596800~253402300799 の範囲(両端を含む)にする必要があります(これは 0001-01-01T00:00:00Z~9999-12-31T23:59:59Z に対応します)。 |
nanos |
ナノ秒分解能による、秒の負ではない小数以下部分。このフィールドは、秒の代替ではなく、期間のナノ秒部分です。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない nanos 値を持つ必要があります。0~999,999,999 にする必要があります(両端を含む)。 |
ClientCertificateSettings
| JSON 表現 |
|---|
{ "tlsCertificate": string, "privateKey": string, "passphrase": string } |
| フィールド | |
|---|---|
tlsCertificate |
必須。PEM 形式でエンコードされた TLS 証明書。この文字列には、ヘッダーの開始行とフッターの終了行を含める必要があります。 |
privateKey |
必須。PEM 形式でエンコードされた秘密鍵を保存する SecretManager シークレット バージョン リソースの名前。形式: |
passphrase |
省略可。秘密鍵を復号するためのパスフレーズを保存する SecretManager シークレット バージョン リソースの名前。秘密鍵が暗号化されていない場合は、設定しないでください。形式: |
VpcScSettings
| JSON 表現 |
|---|
{ "allowedOrigins": [ string ] } |
| フィールド | |
|---|---|
allowedOrigins[] |
省略可。VPC Service Controls が有効になっている場合に、アプリ内の OpenAPI ツールが直接呼び出すことができる許可された HTTP(s) オリジン。これらの文字列は、指定されたポートを含め、オリジンと完全に一致している必要があります。(例: 「https://example.com」、「https://example.com:443」)。このリストは、HTTP 呼び出しを直接行う可能性のある Python ツールにはまだ適用されていません。 |
DashboardSettings
| JSON 表現 |
|---|
{ "defaultDashboard": string } |
| フィールド | |
|---|---|
defaultDashboard |
省略可。アプリに関連付けられているデフォルトの Contact Center Insights ダッシュボードのリソース名。ユーザーがアプリのモニタリング ビューに移動したときに表示されるダッシュボードです。 形式: |
PrebuiltAmbientNoise
プリビルドの周囲のノイズ。
| 列挙型 | |
|---|---|
PREBUILT_AMBIENT_NOISE_UNSPECIFIED |
指定されていません。 |
RETAIL_STORE |
小売店の周囲のノイズ。 |
CONVENTION_HALL |
コンベンション ホールの周囲のノイズ。 |
OUTDOOR |
街の周囲のノイズ。 |
ErrorHandlingStrategy
エラー処理の戦略を定義します。
| 列挙型 | |
|---|---|
ERROR_HANDLING_STRATEGY_UNSPECIFIED |
エラー処理方式が指定されていません。 |
NONE |
特別な処理は有効になっていません。 |
FALLBACK_RESPONSE |
システムエラー(LLM エラーなど)が発生した場合、フォールバック メッセージがユーザーに返されます。 |
END_SESSION |
システムエラー(LLM エラーなど)が発生した場合、EndSession シグナルが発行されます。 |
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_SEARCH |
アプリの SOLUTION_TYPE_SEARCH エンジン。アプリに追加されたすべてのコネクタ データストアがこのエンジンに追加されます。 |
ENGINE_TYPE_CHAT |
チャット エンジンのタイプ。アプリの SOLUTION_TYPE_CHAT エンジン。アプリに追加されたすべてのコネクタ データストアがこのエンジンに追加されます。 |
ChannelType
チャンネル プロファイルのタイプ。
| 列挙型 | |
|---|---|
UNKNOWN |
不明なチャネル タイプ。 |
WEB_UI |
ウェブ UI チャネル。 |
API |
API チャネル。 |
TWILIO |
Twilio チャネル。 |
GOOGLE_TELEPHONY_PLATFORM |
Google Telephony Platform チャンネル。 |
CONTACT_CENTER_AS_A_SERVICE |
Contact Center as a Service(CCaaS)チャネル。 |
CONTACT_CENTER_AS_A_SERVICE_CHAT |
Contact Center as a Service(CCaaS Chat)チャネル。 |
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 |
ダークモード。 |
出力スキーマ
このリソースは、ネットワーク API 呼び出しの結果である長時間実行オペレーションを表します。
オペレーション
| JSON 表現 |
|---|
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field |
| フィールド | |
|---|---|
name |
サーバーによって割り当てられる名前。最初にその名前を返すサービスと同じサービス内でのみ一意になります。デフォルトの HTTP マッピングを使用している場合は、 |
metadata |
オペレーションに関連付けられているサービス固有のメタデータ。通常は進捗情報や、作成日時などの共通メタデータが含まれます。一部のサービスでは、このようなメタデータが提供されないこともあります。メタデータがある場合、長時間実行オペレーションを返すメソッドでは、メタデータの型をドキュメント化しておく必要があります。 任意の型のフィールドを含むオブジェクト。型を識別する URI を含むフィールド |
done |
値が |
共用体フィールド result。オペレーションの結果。error または有効な response になります。done == false の場合、error も response も設定されません。done == true の場合、error または response のどちらか 1 つだけが設定されます。一部のサービスでは結果が返されない場合があります。result は次のいずれかになります。 |
|
error |
失敗またはキャンセルされた場合のオペレーションのエラー結果。 |
response |
オペレーションの通常の成功レスポンス。元のメソッドで成功時にデータが返されない場合( 任意の型のフィールドを含むオブジェクト。型を識別する URI を含むフィールド |
すべて
| JSON 表現 |
|---|
{ "typeUrl": string, "value": string } |
| フィールド | |
|---|---|
typeUrl |
シリアル化された Protobuf メッセージの型を識別します。URI 参照は、スラッシュで終わる接頭辞と完全修飾型名で構成されます。 例: type.googleapis.com/google.protobuf.StringValue この文字列には 接頭辞は任意であり、Protobuf 実装では、最後の すべての型 URL 文字列は、有効な URI 参照である必要があります。また、テキスト形式の場合、参照の内容は英数字、パーセント エンコードされたエスケープ、および次のセットの文字(外側のバッククォートを除く)のみで構成されている必要があります。
|
value |
type_url で記述された型の Protobuf シリアル化を保持します。 Base64 でエンコードされた文字列。 |
ステータス
| JSON 表現 |
|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
| フィールド | |
|---|---|
code |
ステータス コード。 |
message |
デベロッパー向けのエラー メッセージ。英語で記述します。ユーザー向けのエラー メッセージは、ローカライズして |
details[] |
エラーの詳細を保持するメッセージのリスト。API が使用する共通のメッセージ タイプのセットがあります。 任意のデータ型のフィールドを含むオブジェクトであり、型を識別する URI を含むフィールド |
ツールのアノテーション
ツールのアノテーションは、特定のツールの基本的なリスクを説明するために MCP クライアントに送信されます。ほとんどのクライアントはこれらのヒントを信頼できないものとして扱いますが、確認プロンプトをユーザーに送信するタイミングを決定するために使用できます。
タイトル文字列とともに、次のブール値のヒントが次のように定義されています。
readOnlyHint: true の場合、ツールは環境を変更しません。デフォルトは false です。destructiveHint: true の場合、ツールは破壊的なアクションを実行できます。false の場合、ツールは追加アクションのみを実行できます。デフォルト値は true です。idempotentHint: true の場合、同じ引数でツールを繰り返し呼び出しても、環境に影響はありません。デフォルトは false です。openWorldHint: true の場合、ツールは外部エンティティの「オープン ワールド」とやり取りできます。false の場合、ツールは内部エンティティとのみやり取りできます。たとえば、ウェブ検索ツールはオープン ワールドですが、メモリツールはオープン ワールドではありません。
破壊的ヒント: ✅ | べき等ヒント: ❌ | 読み取り専用ヒント: ❌ | オープン ワールド ヒント: ❌