REST Resource: projects.locations.apps

资源：App
方法

资源：应用

应用可用作一组代理（包括根代理及其子代理）以及相关联配置的顶层容器。这些代理协同工作，以在应用环境中实现特定目标。

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` 标识符。应用的唯一标识符。格式：`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)` 可选。应用的 TimeZone 设置。
`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 规范化（即转换为 UTC 零时区格式并在末尾附加 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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` 可选。当代理收到不受支持的语言的输入时要执行的操作。可以是预定义的操作，也可以是自定义的工具调用。有效值包括：- 工具的完整资源名称，用于触发特定工具执行。- 预定义的系统操作，例如“升级”或“退出”，此类操作会触发具有相应 `metadata` 的 `EndSession` 信号来终止对话。

TimeZoneSettings

应用的 TimeZone 设置。

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)` 可选。在代理提示用户重新互动之前，用户处于非活跃状态（无语音或互动）的时长。如果未设置，代理将不会提示用户重新互动。该时长以秒为单位，最多包含九个小数位，以“`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` 可选。环境噪声支持的正常原生音量的音量增益（以分贝为单位），范围为 [-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` 可选。作为单声道 16kHz WAV 文件存储在 Cloud Storage 中的环境噪声。注意：请确保 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 导出行为的设置。如果已启用，对话数据将导出到 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 存储桶。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/`。

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 导出行为的设置。

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

字段

字段
`enabled`	`boolean` 可选。指示是否已启用 BigQuery 导出。
`project`	`string` 可选。要将数据导出到的 BigQuery 数据集的项目 ID。注意：如果 BigQuery 数据集与应用不在同一项目中，您应向 CES 服务代理 `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com` 授予 `roles/bigquery.admin` 角色。
`dataset`	`string` 可选。要将数据导出到的 BigQuery 数据集。

enabled

boolean

可选。指示是否已启用 BigQuery 导出。

project

string

可选。要将数据导出到的 BigQuery 数据集的项目 ID。

注意：如果 BigQuery 数据集与应用不在同一项目中，您应向 CES 服务代理 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com 授予 roles/bigquery.admin 角色。

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`	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