REST Resource: projects.locations.apps

資源：應用程式
方法

資源：應用程式

應用程式是代理程式群組的頂層容器，包括根代理程式和子代理程式，以及相關聯的設定。這些代理程式會共同運作，在應用程式環境中達成特定目標。

JSON 表示法

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`) }, "locked": boolean }

{
  "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)
  },
  "locked": boolean
}

欄位
`name`	`string` ID。應用程式的專屬 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` 選用。應用程式中所有代理程式的指令。您可以使用這項指令，為所有代理程式設定穩定的身分或個性。
`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)` 選用。應用程式的預設用戶端憑證設定。
`locked`	`boolean` 選用。指出應用程式是否已鎖定，無法進行變更。如果應用程式已鎖定，系統會拒絕修改應用程式資源。

LanguageSettings

應用程式的語言設定。

JSON 表示法
{ "defaultLanguageCode": string, "supportedLanguageCodes": [ string ], "enableMultilingualSupport": boolean, "fallbackAction": string }

欄位
`defaultLanguageCode`	`string` 選用。應用程式的預設語言代碼。
`supportedLanguageCodes[]`	`string` 選用。應用程式支援的語言代碼清單 (`defaultLanguageCode` 除外)。
`enableMultilingualSupport`	`boolean` 選用。啟用多語言支援。如果設為 true，應用程式中的代理程式會使用預先建構的指令，提升多語言輸入內容的處理品質。
`fallbackAction`	`string` 選用。代理程式收到不支援語言的輸入內容時，應執行的動作。這可以是預先定義的動作或自訂工具呼叫。有效值包括：- 工具的完整資源名稱，可觸發特定工具執行作業。- 預先定義的系統動作，例如「升級」或「結束」，這類動作會觸發 `EndSession` 信號和相應的 `metadata`，以終止對話。

TimeZoneSettings

應用程式的時區設定。

JSON 表示法
{ "timeZone": string }

欄位

欄位
`timeZone`	`string` 選用。應用程式的時區 (取自時區資料庫)，例如 America/Los_Angeles、Europe/Paris。

timeZone

string

選用。應用程式的時區 (取自時區資料庫)，例如 America/Los_Angeles、Europe/Paris。

AudioProcessingConfig

設定如何處理及傳送輸入和輸出音訊。

JSON 表示法

JSON 表示法
{ "synthesizeSpeechConfigs": { string: { object (`SynthesizeSpeechConfig`) }, ... }, "bargeInConfig": { object (`BargeInConfig`) }, "inactivityTimeout": string, "ambientSoundConfig": { object (`AmbientSoundConfig`) } }

{
  "synthesizeSpeechConfigs": {
    string: {
      object (SynthesizeSpeechConfig)
    },
    ...
  },
  "bargeInConfig": {
    object (BargeInConfig)
  },
  "inactivityTimeout": string,
  "ambientSoundConfig": {
    object (AmbientSoundConfig)
  }
}

欄位
`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)` 選用。代理程式提示使用者重新互動前，使用者無活動 (沒有語音或互動) 的時間長度。如未設定，服務專員不會提示使用者重新參與對話。時間長度以秒為單位，最多可有 9 個小數位數，並應以「`s`」結尾，例如：`"3.5s"`。
`ambientSoundConfig`	`object (AmbientSoundConfig)` 選用。設定要與合成的代理程式回覆內容一起播放的環境音效，提升對話的自然程度。

SynthesizeSpeechConfig

代理程式回應的合成方式設定。

JSON 表示法
{ "voice": string, "speakingRate": number }

欄位

欄位
`voice`	`string` 選用。語音的名稱。如未設定，服務會根據其他參數 (例如 languageCode) 選擇語音。如需可用語音清單，請參閱 Cloud Text-to-Speech 的「支援的語音和語言」。
`speakingRate`	`number` 選用。語音速率/速度，範圍為 [0.25, 2.0]。1.0 為特定語音支援的正常原生速度。2.0 為兩倍速，0.5 為一半的速度。如果值超出 [0.25, 2.0] 範圍，系統會傳回錯誤。

voice

string

選用。語音的名稱。如未設定，服務會根據其他參數 (例如 languageCode) 選擇語音。

如需可用語音清單，請參閱 Cloud Text-to-Speech 的「支援的語音和語言」。

speakingRate

number

選用。語音速率/速度，範圍為 [0.25, 2.0]。1.0 為特定語音支援的正常原生速度。2.0 為兩倍速，0.5 為一半的速度。如果值超出 [0.25, 2.0] 範圍，系統會傳回錯誤。

BargeInConfig

設定如何處理使用者插話活動。

JSON 表示法
{ "disableBargeIn": boolean, "bargeInAwareness": boolean }

欄位

欄位
`disableBargeIn (deprecated)`	`boolean` 這個項目已淘汰！選用。在代理程式說話時，禁止使用者插話。如果為 true，系統會忽略代理程式回應播放期間的使用者輸入內容。已淘汰：`disableBargeIn` 已淘汰，改用 ChannelProfile 中的 `disableBargeInControl`。
`bargeInAwareness`	`boolean` 選用。如果啟用這項功能，代理程式會根據使用者未完整聽到先前代理程式訊息的假設，調整下一個回覆。如果服務專員的回覆會以視覺化方式顯示，請勿使用這項功能。

disableBargeIn
(deprecated)

boolean

選用。在代理程式說話時，禁止使用者插話。如果為 true，系統會忽略代理程式回應播放期間的使用者輸入內容。

已淘汰：disableBargeIn 已淘汰，改用 ChannelProfile 中的 disableBargeInControl。

bargeInAwareness

boolean

選用。如果啟用這項功能，代理程式會根據使用者未完整聽到先前代理程式訊息的假設，調整下一個回覆。如果服務專員的回覆會以視覺化方式顯示，請勿使用這項功能。

AmbientSoundConfig

設定要與合成的代理程式回覆內容一起播放的環境音效，提升對話的自然程度。

JSON 表示法

JSON 表示法
{ "volumeGainDb": number, // Union field `source` can be only one of the following: "prebuiltAmbientNoise": enum (`AmbientSoundConfig.PrebuiltAmbientNoise`), "gcsUri": string, "prebuiltAmbientSound": string // End of list of possible types for union field `source`. }

{
  "volumeGainDb": number,

  // Union field source can be only one of the following:
  "prebuiltAmbientNoise": enum (AmbientSoundConfig.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)，系統會以約為正常原生訊號振幅的兩倍振幅播放。強烈建議您不要設定超過 +10 (dB) 的值，因為在超過這個值之後，通常就無法有效提高音量。
聯集欄位 `source`。與合成的代理程式回覆一起播放的環境噪音，可提升對話的自然度。`source` 只能是下列其中一個設定：
`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`	街道的環境噪音。

LoggingSettings

用於說明應用程式記錄行為的設定。

JSON 表示法

JSON 表示法
{ "redactionConfig": { object (`RedactionConfig`) }, "audioRecordingConfig": { object (`AudioRecordingConfig`) }, "bigqueryExportSettings": { object (`BigQueryExportSettings`) }, "cloudLoggingSettings": { object (`CloudLoggingSettings`) }, "conversationLoggingSettings": { object (`ConversationLoggingSettings`) }, "evaluationAudioRecordingConfig": { object (`AudioRecordingConfig`) }, "metricAnalysisSettings": { object (`MetricAnalysisSettings`) } }

{
  "redactionConfig": {
    object (RedactionConfig)
  },
  "audioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "bigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "cloudLoggingSettings": {
    object (CloudLoggingSettings)
  },
  "conversationLoggingSettings": {
    object (ConversationLoggingSettings)
  },
  "evaluationAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "metricAnalysisSettings": {
    object (MetricAnalysisSettings)
  }
}

欄位
`redactionConfig`	`object (RedactionConfig)` 選用。如何遮蓋機密資料的設定。
`audioRecordingConfig`	`object (AudioRecordingConfig)` 選用。設定如何記錄語音互動。
`bigqueryExportSettings`	`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}`

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 bucket。URI 的開頭必須為「gs://」。請選擇符合資料落地要求的 bucket 位置。注意：如果 Cloud Storage 值區與應用程式位於不同專案，請將 `storage.objects.create` 權限授予 CES 服務代理程式 `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com`。
`gcsPathPrefix`	`string` 選用。錄音的 Cloud Storage 路徑前置字串。前置字串可包含下列預留位置，系統會在放送時動態替換： - $project：專案 ID - $location：應用程式位置 - $app：應用程式 ID - $date：工作階段日期，格式為 YYYY-MM-DD - $session：工作階段 ID 如果未指定路徑前置字串，系統會使用預設前置字串 `$project/$location/$app/$date/$session/`。

gcsBucket

string

選用。用來儲存通話錄音的 Cloud Storage bucket。URI 的開頭必須為「gs://」。

請選擇符合資料落地要求的 bucket 位置。

注意：如果 Cloud Storage 值區與應用程式位於不同專案，請將 storage.objects.create 權限授予 CES 服務代理程式 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com。

gcsPathPrefix

string

選用。錄音的 Cloud Storage 路徑前置字串。

前置字串可包含下列預留位置，系統會在放送時動態替換： - $project：專案 ID - $location：應用程式位置 - $app：應用程式 ID - $date：工作階段日期，格式為 YYYY-MM-DD - $session：工作階段 ID

如果未指定路徑前置字串，系統會使用預設前置字串 $project/$location/$app/$date/$session/。

BigQueryExportSettings

用於說明應用程式 BigQuery 匯出行為的設定。

JSON 表示法
{ "enabled": boolean, "project": string, "dataset": string }

欄位

欄位
`enabled`	`boolean` 選用。指出是否已啟用 BigQuery 匯出功能。
`project`	`string` 選用。要匯出資料的 BigQuery 資料集專案 ID。注意：如果 BigQuery 資料集與應用程式位於不同專案，請將 `roles/bigquery.admin` 角色授予 CES 服務代理程式 `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com`。
`dataset`	`string` 選用。要將資料匯出至哪個 BigQuery 資料集。

enabled

boolean

選用。指出是否已啟用 BigQuery 匯出功能。

project

string

選用。要匯出資料的 BigQuery 資料集專案 ID。

注意：如果 BigQuery 資料集與應用程式位於不同專案，請將 roles/bigquery.admin 角色授予 CES 服務代理程式 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com。

dataset

string

選用。要將資料匯出至哪個 BigQuery 資料集。

CloudLoggingSettings

用於說明應用程式 Cloud Logging 行為的設定。

JSON 表示法
{ "enableCloudLogging": boolean }

欄位

欄位
`enableCloudLogging`	`boolean` 選用。是否為工作階段啟用 Cloud Logging。

enableCloudLogging

boolean

選用。是否為工作階段啟用 Cloud Logging。

ConversationLoggingSettings

用來描述應用程式對話記錄行為的設定。

JSON 表示法
{ "disableConversationLogging": boolean }

欄位

欄位
`disableConversationLogging`	`boolean` 選用。是否要停用工作階段的對話記錄功能。

disableConversationLogging

boolean

選用。是否要停用工作階段的對話記錄功能。

MetricAnalysisSettings

設定，用於說明 LLM 分析指標管道的對話資料收集行為。

JSON 表示法
{ "llmMetricsOptedOut": boolean }

欄位

欄位
`llmMetricsOptedOut`	`boolean` 選用。是否要收集對話資料，以取得 LLM 分析指標。如果為 true，系統就不會收集對話資料，以用於 LLM 分析指標；否則系統會收集對話資料。

llmMetricsOptedOut

boolean

選用。是否要收集對話資料，以取得 LLM 分析指標。如果為 true，系統就不會收集對話資料，以用於 LLM 分析指標；否則系統會收集對話資料。

ErrorHandlingSettings

設定，說明應用程式中應如何處理錯誤。

JSON 表示法
{ "errorHandlingStrategy": enum (`ErrorHandlingSettings.ErrorHandlingStrategy`) }

欄位

欄位
`errorHandlingStrategy`	`enum (ErrorHandlingSettings.ErrorHandlingStrategy)` 選用。用於錯誤處理的策略。

errorHandlingStrategy

enum (ErrorHandlingSettings.ErrorHandlingStrategy)

選用。用於錯誤處理的策略。

ErrorHandlingSettings.ErrorHandlingStrategy

定義錯誤處理策略。

列舉
`ERROR_HANDLING_STRATEGY_UNSPECIFIED`	未指定錯誤處理策略。預設值為 FALLBACK_RESPONSE。
`NONE`	未啟用任何特定處理方式。
`FALLBACK_RESPONSE`	如果發生 LLM 錯誤，系統會向使用者傳回備用訊息。

App.ToolExecutionMode

定義代理程式同時選取多個工具時的工具執行行為。

列舉
`TOOL_EXECUTION_MODE_UNSPECIFIED`	未指定工具執行模式。預設值為 PARALLEL。
`PARALLEL`	如果選取多個工具，系統會以相同的 ToolContext 平行執行這些工具。
`SEQUENTIAL`	如果選取多個工具，系統會依序執行。只有在前一個工具完成後，系統才會執行下一個工具，且下一個工具可以查看前一個工具更新的 ToolContext。

EvaluationMetricsThresholds

評估作業中指標的門檻設定。

JSON 表示法

JSON 表示法
{ "goldenEvaluationMetricsThresholds": { object (`EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds`) }, "hallucinationMetricBehavior": enum (`EvaluationMetricsThresholds.HallucinationMetricBehavior`), "goldenHallucinationMetricBehavior": enum (`EvaluationMetricsThresholds.HallucinationMetricBehavior`), "scenarioHallucinationMetricBehavior": enum (`EvaluationMetricsThresholds.HallucinationMetricBehavior`) }

{
  "goldenEvaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds)
  },
  "hallucinationMetricBehavior": enum (EvaluationMetricsThresholds.HallucinationMetricBehavior),
  "goldenHallucinationMetricBehavior": enum (EvaluationMetricsThresholds.HallucinationMetricBehavior),
  "scenarioHallucinationMetricBehavior": enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)
}

欄位
`goldenEvaluationMetricsThresholds`	`object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds)` 選用。黃金評估指標門檻。
`hallucinationMetricBehavior (deprecated)`	`enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)` 這個項目已淘汰！選用。已淘汰：請改用 `goldenHallucinationMetricBehavior`。目前黃金評估會使用幻覺指標行為。
`goldenHallucinationMetricBehavior`	`enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)` 選用。黃金評估的幻覺指標行為。
`scenarioHallucinationMetricBehavior`	`enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)` 選用。情境評估的錯覺指標行為。

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds

黃金評估的設定。

JSON 表示法

JSON 表示法
{ "turnLevelMetricsThresholds": { object (`EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds`) }, "expectationLevelMetricsThresholds": { object (`EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds`) }, "toolMatchingSettings": { object (`EvaluationMetricsThresholds.ToolMatchingSettings`) } }

{
  "turnLevelMetricsThresholds": {
    object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds)
  },
  "expectationLevelMetricsThresholds": {
    object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds)
  },
  "toolMatchingSettings": {
    object (EvaluationMetricsThresholds.ToolMatchingSettings)
  }
}

欄位

欄位
`turnLevelMetricsThresholds`	`object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds)` 選用。回合層級指標的門檻。
`expectationLevelMetricsThresholds`	`object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds)` 選用。預期等級指標門檻。
`toolMatchingSettings`	`object (EvaluationMetricsThresholds.ToolMatchingSettings)` 選用。工具比對設定。額外工具呼叫是指執行作業中出現的工具呼叫，但與黃金期望中的任何工具呼叫都不相符。

turnLevelMetricsThresholds

object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds)

選用。回合層級指標的門檻。

expectationLevelMetricsThresholds

object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds)

選用。預期等級指標門檻。

toolMatchingSettings

object (EvaluationMetricsThresholds.ToolMatchingSettings)

選用。工具比對設定。額外工具呼叫是指執行作業中出現的工具呼叫，但與黃金期望中的任何工具呼叫都不相符。

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds

開啟等級指標門檻。

JSON 表示法

JSON 表示法
{ "semanticSimilarityChannel": enum (`EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel`), "semanticSimilaritySuccessThreshold": integer, "overallToolInvocationCorrectnessThreshold": number }

{
  "semanticSimilarityChannel": enum (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel),
  "semanticSimilaritySuccessThreshold": integer,
  "overallToolInvocationCorrectnessThreshold": number
}

欄位

欄位
`semanticSimilarityChannel`	`enum (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel)` 選用。用於評估的語意相似度管道。
`semanticSimilaritySuccessThreshold`	`integer` 選用。語意相似度的成功門檻。必須是介於 0 到 4 之間的整數。預設值為 >= 3。
`overallToolInvocationCorrectnessThreshold`	`number` 選用。工具整體叫用正確性的成功門檻。必須是介於 0 到 1 之間的浮點數。預設值為 1.0。

semanticSimilarityChannel

enum (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel)

選用。用於評估的語意相似度管道。

semanticSimilaritySuccessThreshold

integer

選用。語意相似度的成功門檻。必須是介於 0 到 4 之間的整數。預設值為 >= 3。

overallToolInvocationCorrectnessThreshold

number

選用。工具整體叫用正確性的成功門檻。必須是介於 0 到 1 之間的浮點數。預設值為 1.0。

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel

要使用的語意相似度管道。

列舉
`SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED`	未指定指標。預設值為 TEXT。
`TEXT`	使用文字語意相似度。
`AUDIO`	使用音訊語意相似度。

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds

期望層級指標門檻。

JSON 表示法
{ "toolInvocationParameterCorrectnessThreshold": number }

欄位

欄位
`toolInvocationParameterCorrectnessThreshold`	`number` 選用。個別工具叫用參數正確性的成功門檻。必須是介於 0 到 1 之間的浮點數。預設值為 1.0。

toolInvocationParameterCorrectnessThreshold

number

選用。個別工具叫用參數正確性的成功門檻。必須是介於 0 到 1 之間的浮點數。預設值為 1.0。

EvaluationMetricsThresholds.ToolMatchingSettings

比對工具呼叫的設定。

JSON 表示法
{ "extraToolCallBehavior": enum (`EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior`) }

欄位

欄位
`extraToolCallBehavior`	`enum (EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior)` 選用。額外工具呼叫的行為。預設值為 FAIL。

extraToolCallBehavior

enum (EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior)

選用。額外工具呼叫的行為。預設值為 FAIL。

EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior

定義遇到額外工具呼叫時的行為。額外工具呼叫是指執行作業中出現的工具呼叫，但與黃金期望中的任何工具呼叫都不相符。

列舉
`EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED`	未指定行為。預設值為 FAIL。
`FAIL`	如果遇到額外的工具呼叫，則評估失敗。
`ALLOW`	允許額外的工具呼叫。

EvaluationMetricsThresholds.HallucinationMetricBehavior

幻覺指標行為。無論行為為何，系統一律會計算指標。不同之處在於，如果停用這項指標，系統就不會用來計算整體評估分數。

列舉
`HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED`	未指定幻覺指標行為。
`DISABLED`	停用錯覺指標。
`ENABLED`	啟用錯覺指標。

App.VariableDeclaration

定義變數的結構和中繼資料。

JSON 表示法
{ "name": string, "description": string, "schema": { object (`Schema`) } }

欄位

欄位
`name`	`string` 這是必要旗標，變數名稱。名稱開頭須為英文字母或底線，且只能由英文字母、數字或底線組成。
`description`	`string` 這是必要旗標，變數說明。
`schema`	`object (Schema)` 這是必要旗標，變數的結構定義。

name

string

這是必要旗標，變數名稱。名稱開頭須為英文字母或底線，且只能由英文字母、數字或底線組成。

description

string

這是必要旗標，變數說明。

schema

object (Schema)

這是必要旗標，變數的結構定義。

DataStoreSettings

應用程式的資料儲存庫相關設定。

JSON 表示法
{ "engines": [ { object (`DataStoreSettings.Engine`) } ] }

欄位

欄位
`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_SEARCH`	應用程式的 SOLUTION_TYPE_SEARCH 引擎。新增至應用程式的所有連接器資料存放區都會新增至這個引擎。
`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}

方法
`create`	在指定專案和位置中建立新應用程式。
`delete`	刪除指定應用程式。
`executeTool`	使用指定引數執行指定工具。
`exportApp`	匯出指定應用程式。
`get`	取得指定應用程式的詳細資料。
`importApp`	匯入指定應用程式。
`list`	列出指定專案和位置中的應用程式。
`patch`	更新指定的應用程式。
`retrieveToolSchema`	擷取指定工具的結構定義。

REST Resource: projects.locations.apps 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

資源：應用程式

LanguageSettings

TimeZoneSettings

AudioProcessingConfig

SynthesizeSpeechConfig

BargeInConfig

AmbientSoundConfig

AmbientSoundConfig.PrebuiltAmbientNoise

LoggingSettings

RedactionConfig

AudioRecordingConfig

BigQueryExportSettings

CloudLoggingSettings

ConversationLoggingSettings

MetricAnalysisSettings

ErrorHandlingSettings

ErrorHandlingSettings.ErrorHandlingStrategy

App.ToolExecutionMode

EvaluationMetricsThresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds

EvaluationMetricsThresholds.ToolMatchingSettings

EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior

EvaluationMetricsThresholds.HallucinationMetricBehavior

App.VariableDeclaration

DataStoreSettings

DataStoreSettings.Engine

DataStoreSettings.Engine.Type

ClientCertificateSettings

方法

REST Resource: projects.locations.apps