REST Resource: projects.locations.apps

リソース: App

アプリは、ルート エージェントとそのサブエージェント、および関連する構成を含むエージェント グループの最上位コンテナとして機能します。これらのエージェントは、アプリのコンテキスト内で特定の目標を達成するために連携します。

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 (App.ToolExecutionMode),
  "evaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds)
  },
  "variableDeclarations": [
    {
      object (App.VariableDeclaration)
    }
  ],
  "predefinedVariableDeclarations": [
    {
      object (App.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,
  "evaluationPersonas": [
    {
      object (EvaluationPersona)
    }
  ],
  "evaluationSettings": {
    object (EvaluationSettings)
  },
  "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 (App.ToolExecutionMode)

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

evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

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

variableDeclarations[]

object (App.VariableDeclaration)

省略可。変数の宣言。

predefinedVariableDeclarations[]

object (App.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

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

evaluationPersonas[]

object (EvaluationPersona)

省略可。アプリの評価ペルソナ。このフィールドは、評価に使用できるペルソナを定義するために使用されます。最大 30 個のペルソナを定義できます。

evaluationSettings

object (EvaluationSettings)

省略可。アプリの評価設定。

validationErrors[]

string

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

dashboardSettings

object (DashboardSettings)

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

LanguageSettings

アプリの言語設定。

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

string

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

supportedLanguageCodes[]

string

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

enableMultilingualSupport

boolean

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

fallbackAction
(deprecated)

string

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

これは、事前定義されたアクションまたはカスタム ツール呼び出しです。有効な値は次のとおりです。- ツールの完全なリソース名。特定のツールの実行をトリガーします。- 「エスカレーション」や「終了」などの事前定義されたシステム アクション。対応する 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)

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

SynthesizeSpeechConfig

エージェントのレスポンスを合成する方法の構成。

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

string

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

利用可能な音声の一覧については、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 では disableBargeIn は非推奨となり、disableBargeInControl が推奨されます。

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

bargeInAwareness

boolean

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

AmbientSoundConfig

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

JSON 表現
{
  "volumeGainDb": number,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "prebuiltAmbientNoise": enum (AmbientSoundConfig.PrebuiltAmbientNoise),
  "gcsUri": string,
  "prebuiltAmbientSound": string
  // End of mutually exclusive fields.
}
フィールド
volumeGainDb

number

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

合成されたエージェントのレスポンスとともに再生される周囲のノイズ。会話の自然さを高めます。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
prebuiltAmbientNoise
(deprecated)

enum (AmbientSoundConfig.PrebuiltAmbientNoise)

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

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"

相互に排他的なフィールドの終了。

AmbientSoundConfig.PrebuiltAmbientNoise

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

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

CustomVoiceSample

音声クローニングに使用されるカスタム音声サンプルの構成。

JSON 表現
{
  "name": string,
  "voiceSampleGcsUri": string,
  "consentAudioGcsUri": string,
  "voiceInstruction": string,
  "previewAudioContent": string,
  "previewText": string,
  "warnings": [
    {
      object (CustomVoiceSample.Warning)
    }
  ],
  "voiceInstructionMode": enum (CustomVoiceSample.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 (CustomVoiceSample.Warning)

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

voiceInstructionMode

enum (CustomVoiceSample.VoiceInstructionMode)

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

CustomVoiceSample.Warning

音声サンプルの処理中に発生した警告メッセージ。

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

string

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

type

enum (CustomVoiceSample.Warning.WarningType)

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

CustomVoiceSample.Warning.WarningType

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

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

CustomVoiceSample.VoiceInstructionMode

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

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

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 分析パイプラインの会話データの収集動作を記述する設定。

RedactionConfig

機密データの処理方法を指示する構成。

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

boolean

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

inspectTemplate

string

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

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

deidentifyTemplate

string

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

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

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

アプリの BigQuery Export の動作を記述する設定。

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

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

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

LLM 分析指標パイプラインの会話データの収集動作を記述する設定。

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

boolean

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

ErrorHandlingSettings

アプリでのエラーの処理方法を記述する設定。

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

enum (ErrorHandlingSettings.ErrorHandlingStrategy)

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

fallbackResponseConfig

object (ErrorHandlingSettings.FallbackResponseConfig)

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

endSessionConfig

object (ErrorHandlingSettings.EndSessionConfig)

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

ErrorHandlingSettings.ErrorHandlingStrategy

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

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

ErrorHandlingSettings.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 シグナルを出力する前に試行するフォールバックの最大数。

ErrorHandlingSettings.EndSessionConfig

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

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

boolean

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

App.ToolExecutionMode

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

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

App.VariableDeclaration

変数の構造とメタデータを定義します。

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

string

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

description

string

必須。変数の説明。

schema

object (Schema)

必須。変数のスキーマ。

DataStoreSettings

アプリのデータストア関連の設定。

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

object (DataStoreSettings.Engine)

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

DataStoreSettings.Engine

データストアが接続されているエンジン。Vertex AI Search(https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction)をご覧ください。

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

string

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

type

enum (DataStoreSettings.Engine.Type)

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

DataStoreSettings.Engine.Type

エンジンのタイプ。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 エンジン。アプリに追加されたすべてのコネクタ データストアがこのエンジンに追加されます。

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

アプリの VPC-SC 設定。

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

string

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

EvaluationSettings

評価の設定。

JSON 表現
{
  "scenarioConversationInitiator": enum (EvaluationSettings.ScenarioConversationInitiator),
  "goldenRunMethod": enum (GoldenRunMethod),
  "goldenEvaluationToolCallBehaviour": enum (EvaluationToolCallBehaviour),
  "scenarioEvaluationToolCallBehaviour": enum (EvaluationToolCallBehaviour),
  "metricsConfig": {
    object (EvaluationMetricsConfig)
  },
  "scenarioExecutionMode": enum (EvaluationSettings.ScenarioExecutionMode),
  "evaluationRunCachingSettings": {
    object (EvaluationRunCachingSettings)
  }
}
フィールド
scenarioConversationInitiator

enum (EvaluationSettings.ScenarioConversationInitiator)

省略可。シナリオ評価で会話を開始する人。

goldenRunMethod

enum (GoldenRunMethod)

省略可。ゴールデン評価の実行に使用されるデフォルトのメソッド。これは、RunEvaluationRequest で goldenRunMethod が指定されていない場合に使用されます。

goldenEvaluationToolCallBehaviour

enum (EvaluationToolCallBehaviour)

省略可。ゴールデン評価のデフォルトのツール呼び出し動作を構成します。

scenarioEvaluationToolCallBehaviour

enum (EvaluationToolCallBehaviour)

省略可。シナリオ評価のデフォルトのツール呼び出し動作を構成します。

metricsConfig

object (EvaluationMetricsConfig)

省略可。評価のデフォルト指標を構成します。

scenarioExecutionMode

enum (EvaluationSettings.ScenarioExecutionMode)

省略可。シナリオ評価の実行モード。指定しない場合、デフォルトは QUALITY_OPTIMIZED になります。

evaluationRunCachingSettings

object (EvaluationRunCachingSettings)

省略可。評価実行に使用するキャッシュ設定。

EvaluationSettings.ScenarioConversationInitiator

シナリオ評価セッションで誰が会話を開始するかを決定します。

列挙型
SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED 指定なし。デフォルトは USER です。
USER ユーザーが会話を開始します。
AGENT エージェントが会話を開始します。

DashboardSettings

アプリに関連付けられたダッシュボードの設定。モニタリング ビューに表示されます。

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

string

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

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

メソッド

chatAiAssistant

指定されたアシスタント セッションで AI アシスタントの Arc を実行します。

create

指定されたプロジェクトとロケーションに新しいアプリを作成します。

delete

指定されたアプリを削除します。

executeTool

指定された引数を使用して、指定されたツールを実行します。

exportApp

指定したアプリをエクスポートします。

generateAppResource

特定のリソース(

generateOnboardingSuggestions

Arc のゼロ状態に対してパーソナライズされたオンボーディングの候補を生成します。アプリ内のアシスタント セッション履歴からリクエスト元のユーザーを分類(新規 / 探索中 / 再訪)し、メッセージが送信される前にレンダリングする候補ワード(セッションの再開、作業の続行、新しいタスクの開始)を返します。

get

指定されたアプリの詳細を取得します。

getExtendedAgentCard

認証済みエージェントの拡張エージェント カードを取得します。

importApp

指定されたアプリをインポートします。

importEvaluations

評価をアプリにインポートします。

list

指定されたプロジェクトとロケーションのアプリを一覧表示します。

patch

指定したアプリを更新します。

retrieveToolSchema

指定されたツールのスキーマを取得します。

runAssistant

指定されたアシスタント セッションのアシスタント エージェントを実行します。

runEvaluation

アプリの評価を実行します。

testPersonaVoice

ペルソナの音声をテストします。