工具:create_deployment
在给定应用中创建新部署。
以下示例演示了如何使用 curl 调用 create_deployment 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_deployment", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
输入架构
AgentService.CreateDeployment 的请求消息。
CreateDeploymentRequest
| JSON 表示法 |
|---|
{
"parent": string,
"deploymentId": string,
"deployment": {
object ( |
| 字段 | |
|---|---|
parent |
必需。父应用。格式: |
deploymentId |
可选。要用于部署的 ID,该 ID 将成为部署资源名称的最后一个组成部分。如果未提供,系统会自动为部署分配唯一 ID。 |
deployment |
必需。要创建的部署。 |
部署
| JSON 表示法 |
|---|
{ "name": string, "displayName": string, "appVersion": string, "channelProfile": { object ( |
| 字段 | |
|---|---|
name |
标识符。相应部署的资源名称。格式: |
displayName |
必需。部署的显示名称。 |
appVersion |
可选。要部署的应用版本的资源名称。格式: |
channelProfile |
必需。部署中使用的渠道配置文件。 |
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 为空,则更新会覆盖任何并发更改。 |
experimentConfig |
可选。部署的实验配置。 |
whatsappCredentials |
可选。仅限输入。配置 WhatsApp 渠道配置文件时需要临时 WhatsApp 凭据。 |
instagramCredentials |
可选。仅限输入。配置 Instagram 频道个人资料时需要提供临时 Instagram 凭据。 |
modelSettings |
可选。部署的模型设置。替换在应用/代理级配置的模型设置。注意:部署级模型设置替换功能受许可名单限制。请与 CXAS 团队联系以启用此字段。 |
modality |
可选。部署的模态。注意:部署级模态替换功能受许可名单限制。请与 CXAS 团队联系以启用此字段。 |
ChannelProfile
| JSON 表示法 |
|---|
{ "profileId": string, "channelType": enum ( |
| 字段 | |
|---|---|
profileId |
可选。频道配置的唯一标识符。 |
channelType |
可选。频道配置文件的类型。 |
personaProperty |
可选。频道个人资料的身份属性。 |
disableDtmf |
可选。是否停用 DTMF(双音多频)。 |
disableBargeInControl |
可选。是否在对话中停用用户抢占控制。- true:在代理说话时,系统会停用用户中断。- false:智能体保留对用户何时可以中断的自动控制权。 |
webWidgetConfig |
可选。Web widget 的配置。 |
noiseSuppressionLevel |
可选。渠道配置文件的降噪级别。可用的值为“low”“moderate”“high”“very_high”。 |
whatsappConfig |
可选。特定于 WhatsApp 部署的配置。 |
instagramConfig |
可选。特定于 Instagram 部署的配置。 |
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 验证。 |
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 商家资料缩略图网址。 |
description |
仅限输出。Meta 商家页面或资料的说明。 |
InstagramConfig
| JSON 表示法 |
|---|
{ "instagramAccountId": string, "displayName": string, "thumbnailUrl": string, "description": string } |
| 字段 | |
|---|---|
instagramAccountId |
必需。Instagram 账号 ID。 |
displayName |
仅限输出。提取的 Meta 商家页面名称。 |
thumbnailUrl |
仅限输出。提取的 Meta 商家资料缩略图网址。 |
description |
仅限输出。Meta 商家页面或资料的说明。 |
时间戳
| 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 之间(含边界值)。 |
ExperimentConfig
| JSON 表示法 |
|---|
{
"versionRelease": {
object ( |
| 字段 | |
|---|---|
versionRelease |
可选。实验的版本发布。 |
VersionRelease
| JSON 表示法 |
|---|
{ "state": enum ( |
| 字段 | |
|---|---|
state |
可选。版本发布的状态。 |
trafficAllocations[] |
可选。版本发布的流量分配。 |
TrafficAllocation
| JSON 表示法 |
|---|
{ "id": string, "trafficPercentage": integer, "appVersion": string } |
| 字段 | |
|---|---|
id |
可选。流量分配的 ID。自由格式的字符串,最多 128 个字符。 |
trafficPercentage |
可选。流量分配的流量百分比。必须介于 0 到 100 之间。 |
appVersion |
可选。流量分配的应用版本。格式: |
WhatsAppCredentials
| JSON 表示法 |
|---|
{ "authCode": string, "pin": string, "phoneNumber": string, "businessAccountId": string, "wabaId": string, "conversationProfileId": string } |
| 字段 | |
|---|---|
authCode |
必需。嵌入式注册流程提供的 Meta 授权代码。 |
pin |
必需。用户为两步验证创建的 6 位数 PIN 码。 |
phoneNumber |
必需。用于注册 WhatsApp 的手机号码。 |
businessAccountId |
必需。要用于手机号码的商家账号 ID。 |
wabaId |
必需。WhatsApp Business 账号 ID。 |
conversationProfileId |
可选。要用于部署的对话配置文件 ID。 |
InstagramCredentials
| JSON 表示法 |
|---|
{ "authCode": string, "conversationProfileId": string } |
| 字段 | |
|---|---|
authCode |
必需。嵌入式注册流程提供的 Meta 授权代码。 |
conversationProfileId |
可选。要用于部署的对话配置文件 ID。 |
ModelSettings
| JSON 表示法 |
|---|
{ "model": string, // Union field |
| 字段 | |
|---|---|
model |
可选。智能体应使用的 LLM 模型。如果未设置,代理将从其父智能体继承模型。 |
联合字段
|
|
temperature |
可选。如果设置,系统将使用此温度值来运行 LLM 模型。温度可控制模型回答的随机性。温度越低,生成的回答就越可预测。温度越高,生成的回答就越有创意。 |
ChannelType
频道配置文件的类型。
| 枚举 | |
|---|---|
UNKNOWN |
未知渠道类型。 |
WEB_UI |
Web 界面渠道。 |
API |
API 渠道。 |
TWILIO |
Twilio 渠道。 |
GOOGLE_TELEPHONY_PLATFORM |
Google 电话平台渠道。 |
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 |
未知角色。 |
CONCISE |
智能体给出的回答简明扼要 |
CHATTY |
代理会提供更多背景信息、说明和详细信息 |
模态
Web widget 的模态。
| 枚举 | |
|---|---|
MODALITY_UNSPECIFIED |
未知模态。 |
CHAT_AND_VOICE |
微件支持聊天和语音输入。 |
VOICE_ONLY |
该 widget 仅支持语音输入。 |
CHAT_ONLY |
该 widget 仅支持聊天输入。 |
CHAT_VOICE_AND_VIDEO |
微件支持聊天、语音和视频输入。 |
主题
网络微件的主题。
| 枚举 | |
|---|---|
THEME_UNSPECIFIED |
未知主题。 |
LIGHT |
浅色主题。 |
DARK |
深色主题。 |
州
实验的状态。
| 枚举 | |
|---|---|
STATE_UNSPECIFIED |
未指定状态。 |
PENDING |
已弃用:此状态不再使用。 |
RUNNING |
运行状态。实验正在运行且有效。 |
DONE |
已弃用:此状态不再使用。 |
EXPIRED |
已弃用:此状态不再使用。 |
模态
部署的模态。
| 枚举 | |
|---|---|
MODALITY_UNSPECIFIED |
未知模态。 |
MODALITY_TEXT |
文本模态。 |
MODALITY_VOICE |
语音模态。 |
MODALITY_VIDEO |
视频模态。 |
输出架构
部署表示应用的不可变且可查询的版本。它用于部署具有特定渠道配置的应用版本。
部署
| JSON 表示法 |
|---|
{ "name": string, "displayName": string, "appVersion": string, "channelProfile": { object ( |
| 字段 | |
|---|---|
name |
标识符。相应部署的资源名称。格式: |
displayName |
必需。部署的显示名称。 |
appVersion |
可选。要部署的应用版本的资源名称。格式: |
channelProfile |
必需。部署中使用的渠道配置文件。 |
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 为空,则更新会覆盖任何并发更改。 |
experimentConfig |
可选。部署的实验配置。 |
whatsappCredentials |
可选。仅限输入。配置 WhatsApp 渠道配置文件时需要临时 WhatsApp 凭据。 |
instagramCredentials |
可选。仅限输入。配置 Instagram 频道个人资料时需要提供临时 Instagram 凭据。 |
modelSettings |
可选。部署的模型设置。替换在应用/代理级配置的模型设置。注意:部署级模型设置替换功能受许可名单限制。请与 CXAS 团队联系以启用此字段。 |
modality |
可选。部署的模态。注意:部署级模态替换功能受许可名单限制。请与 CXAS 团队联系以启用此字段。 |
ChannelProfile
| JSON 表示法 |
|---|
{ "profileId": string, "channelType": enum ( |
| 字段 | |
|---|---|
profileId |
可选。频道配置的唯一标识符。 |
channelType |
可选。频道配置文件的类型。 |
personaProperty |
可选。频道个人资料的身份属性。 |
disableDtmf |
可选。是否停用 DTMF(双音多频)。 |
disableBargeInControl |
可选。是否在对话中停用用户抢占控制。- true:在代理说话时,系统会停用用户中断。- false:智能体保留对用户何时可以中断的自动控制权。 |
webWidgetConfig |
可选。Web widget 的配置。 |
noiseSuppressionLevel |
可选。渠道配置文件的降噪级别。可用的值为“low”“moderate”“high”“very_high”。 |
whatsappConfig |
可选。特定于 WhatsApp 部署的配置。 |
instagramConfig |
可选。特定于 Instagram 部署的配置。 |
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 验证。 |
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 商家资料缩略图网址。 |
description |
仅限输出。Meta 商家页面或资料的说明。 |
InstagramConfig
| JSON 表示法 |
|---|
{ "instagramAccountId": string, "displayName": string, "thumbnailUrl": string, "description": string } |
| 字段 | |
|---|---|
instagramAccountId |
必需。Instagram 账号 ID。 |
displayName |
仅限输出。提取的 Meta 商家页面名称。 |
thumbnailUrl |
仅限输出。提取的 Meta 商家资料缩略图网址。 |
description |
仅限输出。Meta 商家页面或资料的说明。 |
时间戳
| 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 之间(含边界值)。 |
ExperimentConfig
| JSON 表示法 |
|---|
{
"versionRelease": {
object ( |
| 字段 | |
|---|---|
versionRelease |
可选。实验的版本发布。 |
VersionRelease
| JSON 表示法 |
|---|
{ "state": enum ( |
| 字段 | |
|---|---|
state |
可选。版本发布的状态。 |
trafficAllocations[] |
可选。版本发布的流量分配。 |
TrafficAllocation
| JSON 表示法 |
|---|
{ "id": string, "trafficPercentage": integer, "appVersion": string } |
| 字段 | |
|---|---|
id |
可选。流量分配的 ID。自由格式的字符串,最多 128 个字符。 |
trafficPercentage |
可选。流量分配的流量百分比。必须介于 0 到 100 之间。 |
appVersion |
可选。流量分配的应用版本。格式: |
WhatsAppCredentials
| JSON 表示法 |
|---|
{ "authCode": string, "pin": string, "phoneNumber": string, "businessAccountId": string, "wabaId": string, "conversationProfileId": string } |
| 字段 | |
|---|---|
authCode |
必需。嵌入式注册流程提供的 Meta 授权代码。 |
pin |
必需。用户为两步验证创建的 6 位数 PIN 码。 |
phoneNumber |
必需。用于注册 WhatsApp 的手机号码。 |
businessAccountId |
必需。要用于手机号码的商家账号 ID。 |
wabaId |
必需。WhatsApp Business 账号 ID。 |
conversationProfileId |
可选。要用于部署的对话配置文件 ID。 |
InstagramCredentials
| JSON 表示法 |
|---|
{ "authCode": string, "conversationProfileId": string } |
| 字段 | |
|---|---|
authCode |
必需。嵌入式注册流程提供的 Meta 授权代码。 |
conversationProfileId |
可选。要用于部署的对话配置文件 ID。 |
ModelSettings
| JSON 表示法 |
|---|
{ "model": string, // Union field |
| 字段 | |
|---|---|
model |
可选。智能体应使用的 LLM 模型。如果未设置,代理将从其父智能体继承模型。 |
联合字段
|
|
temperature |
可选。如果设置,系统将使用此温度值来运行 LLM 模型。温度可控制模型回答的随机性。温度越低,生成的回答就越可预测。温度越高,生成的回答就越有创意。 |
ChannelType
频道配置文件的类型。
| 枚举 | |
|---|---|
UNKNOWN |
未知渠道类型。 |
WEB_UI |
Web 界面渠道。 |
API |
API 渠道。 |
TWILIO |
Twilio 渠道。 |
GOOGLE_TELEPHONY_PLATFORM |
Google 电话平台渠道。 |
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 |
未知角色。 |
CONCISE |
智能体给出的回答简明扼要 |
CHATTY |
代理会提供更多背景信息、说明和详细信息 |
模态
Web widget 的模态。
| 枚举 | |
|---|---|
MODALITY_UNSPECIFIED |
未知模态。 |
CHAT_AND_VOICE |
微件支持聊天和语音输入。 |
VOICE_ONLY |
该 widget 仅支持语音输入。 |
CHAT_ONLY |
该 widget 仅支持聊天输入。 |
CHAT_VOICE_AND_VIDEO |
微件支持聊天、语音和视频输入。 |
主题
网络微件的主题。
| 枚举 | |
|---|---|
THEME_UNSPECIFIED |
未知主题。 |
LIGHT |
浅色主题。 |
DARK |
深色主题。 |
州
实验的状态。
| 枚举 | |
|---|---|
STATE_UNSPECIFIED |
未指定状态。 |
PENDING |
已弃用:此状态不再使用。 |
RUNNING |
运行状态。实验正在运行且有效。 |
DONE |
已弃用:此状态不再使用。 |
EXPIRED |
已弃用:此状态不再使用。 |
模态
部署的模态。
| 枚举 | |
|---|---|
MODALITY_UNSPECIFIED |
未知模态。 |
MODALITY_TEXT |
文本模态。 |
MODALITY_VOICE |
语音模态。 |
MODALITY_VIDEO |
视频模态。 |
工具注释
破坏性提示:✅ | 等幂性提示:❌ | 只读提示:❌ | 开放世界提示:❌