工具:get_app
获取指定应用的详细信息。
以下示例演示了如何使用 curl 调用 get_app MCP 工具。
| Curl 请求 |
|---|
curl --location 'https://ces.[REGION].rep.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "get_app", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
输入架构
AgentService.GetApp 的请求消息。
GetAppRequest
| JSON 表示法 |
|---|
{ "name": string } |
| 字段 | |
|---|---|
name |
必需。要检索的应用的资源名称。 |
输出架构
应用可用作一组代理(包括根代理及其子代理)以及相关联配置的顶层容器。这些代理协同工作,以在应用环境中实现特定目标。
应用
| JSON 表示法 |
|---|
{ "name": string, "displayName": string, "description": string, "pinned": boolean, "rootAgent": string, "languageSettings": { object ( |
| 字段 | |
|---|---|
name |
标识符。应用的唯一标识符。格式: |
displayName |
必需。应用的显示名称。 |
description |
可选。应用的人类可读说明。 |
pinned |
可选。应用是否固定在应用列表中。 |
rootAgent |
可选。根代理是应用的入口点。格式: |
languageSettings |
可选。应用的语言设置。 |
timeZoneSettings |
可选。应用的 TimeZone 设置。 |
audioProcessingConfig |
可选。应用的音频处理配置。 |
loggingSettings |
可选。应用的日志记录设置。 |
errorHandlingSettings |
可选。应用错误处理设置。 |
modelSettings |
可选。应用的默认 LLM 模型设置。各个资源(例如代理、安全屏障)可以根据需要替换这些配置。 |
toolExecutionMode |
可选。应用的工具执行模式。如果未提供,将默认为 PARALLEL。 |
evaluationMetricsThresholds |
可选。应用的评估阈值。 |
variableDeclarations[] |
可选。变量的声明。 |
predefinedVariableDeclarations[] |
仅限输出。应用的预定义变量的声明。 |
globalInstruction |
可选。应用中所有代理的指令。您可以使用此指令为所有代理设置稳定的身份或个性。 |
guardrails[] |
可选。应用的防护栏列表。格式: |
dataStoreSettings |
可选。应用的数据存储区设置。 |
defaultChannelProfile |
可选。应用使用的默认渠道配置文件。 |
metadata |
可选。有关应用的元数据。此字段可用于存储与应用详情或预期用途相关的其他信息。 包含一系列 |
createTime |
仅限输出。应用创建时的时间戳。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
updateTime |
仅限输出。上次更新应用时的时间戳。 采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
etag |
仅限输出。用于确保对象在读取-修改-写入操作期间未发生更改的 ETag。如果 etag 为空,则更新会覆盖任何并发更改。 |
deploymentCount |
仅限输出。应用中的部署数量。 |
clientCertificateSettings |
可选。应用的默认客户端证书设置。 |
locked |
可选。指示应用是否已锁定以防止更改。如果应用处于锁定状态,对应用资源的修改将被拒绝。 |
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, "speakingRate": number } |
| 字段 | |
|---|---|
voice |
可选。语音的名称。如果未设置,则该服务将根据其他参数(例如 language_code)选择语音。 如需查看可用的语音列表,请参阅 Cloud Text-to-Speech 的支持的语音和语言。 |
speakingRate |
可选。朗读速率/速度,范围为 [0.25, 2.0]。1.0 表示特定语音支持的正常原生速度。2.0 表示快一倍的速度,0.5 则表示原有速度的一半。如果值不在 [0.25, 2.0] 范围内,系统会返回错误。 |
BargeInConfig
| JSON 表示法 |
|---|
{ "disableBargeIn": boolean, "bargeInAwareness": boolean } |
| 字段 | |
|---|---|
disableBargeIn |
可选。在代理说话时禁止用户插话。如果为 true,则在代理回答播放期间,系统会忽略用户输入。 已弃用: |
bargeInAwareness |
可选。如果启用此功能,代理会根据用户未听到之前代理消息的全部内容这一假设来调整其下一次响应。在以视觉方式显示代理响应的场景中,不应使用此属性。 |
时长
| JSON 表示法 |
|---|
{ "seconds": string, "nanos": integer } |
| 字段 | |
|---|---|
seconds |
时间段的带符号秒数。必须介于 -315,576,000,000 到 +315,576,000,000 之间(含边界值)。注意:这些界限的计算依据是:60 秒/分钟 * 60 分钟/小时 * 24 小时/天 * 365.25 天/年 * 10000 年 |
nanos |
时间跨度的有符号秒数小数部分(以纳秒为单位)。时长不足 1 秒时, |
AmbientSoundConfig
| JSON 表示法 |
|---|
{ "volumeGainDb": number, // Union field |
| 字段 | |
|---|---|
volumeGainDb |
可选。环境噪声支持的正常原生音量的音量增益(以分贝为单位),范围为 [-96.0, 16.0]。如果未设置,或设置为 0.0 (dB) 的值,则以正常的原生信号振幅播放。如果值为 -6.0 (dB),将使用约为正常原生信号幅度一半的幅度进行播放。如果值为 +6.0 (dB),将使用约为正常原生信号幅度一倍的幅度进行播放。我们强烈建议不要超过 +10 (dB),因为通常情况下,任何大于此值的响度都不会产生实际的响度增加效果。 |
联合字段 source。与合成的代理响应一起播放的环境噪音,以增强对话的自然感。source 只能是下列其中一项: |
|
prebuiltAmbientNoise |
可选。已弃用: |
gcsUri |
可选。作为单声道 16kHz WAV 文件存储在 Cloud Storage 中的环境噪声。 注意:请确保 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 |
可选。用于配置应如何记录音频互动。 |
bigqueryExportSettings |
可选。用于描述应用的 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 数据集。 |
CloudLoggingSettings
| JSON 表示法 |
|---|
{ "enableCloudLogging": boolean } |
| 字段 | |
|---|---|
enableCloudLogging |
可选。是否为会话启用 Cloud Logging。 |
ConversationLoggingSettings
| JSON 表示法 |
|---|
{ "disableConversationLogging": boolean } |
| 字段 | |
|---|---|
disableConversationLogging |
可选。是否为会话停用对话日志记录。 |
MetricAnalysisSettings
| JSON 表示法 |
|---|
{ "llmMetricsOptedOut": boolean } |
| 字段 | |
|---|---|
llmMetricsOptedOut |
可选。是否收集对话数据以用于 LLM 分析指标。如果为 true,则不会收集对话数据以用于 LLM 分析指标;否则,将收集对话数据。 |
ErrorHandlingSettings
| JSON 表示法 |
|---|
{
"errorHandlingStrategy": enum ( |
| 字段 | |
|---|---|
errorHandlingStrategy |
可选。用于错误处理的策略。 |
ModelSettings
| JSON 表示法 |
|---|
{ "model": string, // Union field |
| 字段 | |
|---|---|
model |
可选。智能体应使用的 LLM 模型。如果未设置,代理将沿用其父代理的模型。 |
联合字段
|
|
temperature |
可选。如果设置,系统将使用此温度值来运行 LLM 模型。温度可控制模型回答的随机性。温度越低,生成的回答就越可预测。温度越高,生成的回答就越有创意。 |
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[] |
可选。该值应根据列表中的任何(一个或多个)子架构进行验证。 |
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 |
表示 null 值。 |
numberValue |
表示双精度值。 |
stringValue |
表示字符串值。 |
boolValue |
表示布尔值。 |
structValue |
表示结构化值。 |
listValue |
表示重复的 |
结构体
| 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 |
可选。频道资料的身份属性。 |
disableDtmf |
可选。是否停用 DTMF(双音多频)。 |
disableBargeInControl |
可选。是否在对话中停用用户抢占控制。- true:在代理说话时,系统会停用用户中断。- false:智能体保留对用户何时可以中断的自动控制权。 |
webWidgetConfig |
可选。Web widget 的配置。 |
noiseSuppressionLevel |
可选。渠道配置文件的降噪级别。可选的值包括“low”“moderate”“high”“very_high”。 |
PersonaProperty
| JSON 表示法 |
|---|
{
"persona": enum ( |
| 字段 | |
|---|---|
persona |
可选。频道的角色。 |
WebWidgetConfig
| JSON 表示法 |
|---|
{ "modality": enum ( |
| 字段 | |
|---|---|
modality |
可选。网络 widget 的模态。 |
theme |
可选。网络微件的主题。 |
webWidgetTitle |
可选。网络 widget 的标题。 |
securitySettings |
可选。Web widget 的安全设置。 |
SecuritySettings
| JSON 表示法 |
|---|
{ "enablePublicAccess": boolean, "enableOriginCheck": boolean, "allowedOrigins": [ string ], "enableRecaptcha": boolean } |
| 字段 | |
|---|---|
enablePublicAccess |
可选。指示是否已启用对 Web widget 的公开访问权限。如果为 |
enableOriginCheck |
可选。指示是否为 Web widget 启用了来源检查。如果值为 |
allowedOrigins[] |
可选。允许托管 Web widget 的来源。来源由 RFC 6454 定义。如果为空,则允许所有来源。最多允许 100 个来源。示例:“https://example.com” |
enableRecaptcha |
可选。指示是否已启用 Web widget 的 reCAPTCHA 验证。 |
MetadataEntry
| JSON 表示法 |
|---|
{ "key": string, "value": string } |
| 字段 | |
|---|---|
key |
|
value |
|
时间戳
| JSON 表示法 |
|---|
{ "seconds": string, "nanos": integer } |
| 字段 | |
|---|---|
seconds |
表示世界协调时间 (UTC) 的秒数(从 Unix 纪元 1970-01-01T00:00:00Z 开始算起)。必须介于 -62135596800 到 253402300799 之间(含边界值),对应于 0001-01-01T00:00:00Z 到 9999-12-31T23:59:59Z。 |
nanos |
秒数的非负小数部分(以纳秒为单位)。此字段是时长的纳秒部分,而不是秒的替代项。对于含小数部分的负秒数,仍必须包含按时间递升的非负纳秒值。必须在 0 到 999,999,999 之间(含边界值)。 |
ClientCertificateSettings
| JSON 表示法 |
|---|
{ "tlsCertificate": string, "privateKey": string, "passphrase": string } |
| 字段 | |
|---|---|
tlsCertificate |
必需。采用 PEM 格式编码的 TLS 证书。此字符串必须包含起始标题行和结束页脚行。 |
privateKey |
必需。存储以 PEM 格式编码的私钥的 SecretManager 密文版本资源名称。格式: |
passphrase |
可选。用于存储解密私钥的口令的 SecretManager 密文版本资源的名称。如果私钥未加密,则应保持未设置状态。格式: |
工具注释
破坏性提示:❌ | 等幂性提示:✅ | 只读提示:✅ | 开放世界提示:❌