调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
*全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 实例 ID。 | abb4aa26-3a8e-43dd-82f8-0c3898c9c67f |
| ScriptId | string | 是 | 场景 ID | 64241e64-190c-45d1-af66-06f51c07b090 |
| TranscriberConfig | object | 否 | ASR 配置 | |
| NlsAccessType | string | 否 | ASR 调用方式 枚举值:
| MANAGED |
| NlsEngine | string | 否 | ASR 引擎 枚举值:
| BAILIAN |
| NlsAccessProfile | object | 否 | 关联配置 | |
| AccessProfileId | string | 否 | 三方语音配置 ID(使用豆包、科大等三方 ASR 服务时需配置) | c2c9baae-9351-4c49-a8cb-6f24a83a8718 |
| VocabularyId | string | 否 | 热词表 ID(热词管理页面获取) | cd97223f-42f2-4cd9-95af-e734e2fe1fe3 |
| EndSilenceTimeout | integer | 否 | 静音检测(说话间隔超过 x 毫秒时触发断句,即 VAD) | 700 |
| CustomizationId | string | 否 | ASR 的定制语言模型 ID | cd97223f-42f2-4cd9-95af-e734e2fe1fe4 |
| SpeechNoiseThreshold | integer | 否 | 噪音参数阈值,参数范围:[-100,100]。取值说明如下: 取值越趋于-100,噪音被判定为语音的概率越大。 取值越趋于+100,语音被判定为噪音的概率越大。 | 0 |
| Model | string | 否 | ASR 模型 | Paraformer |
| SynthesizerConfig | object | 否 | TTS 配置 | |
| NlsAccessType | string | 否 | TTS 调用方式 枚举值:
| MANAGED |
| NlsEngine | string | 否 | TTS 引擎 枚举值:
| BAILIAN |
| NlsAccessProfile | object | 否 | 关联配置 | |
| AccessProfileId | string | 否 | 三方语音配置 ID(使用豆包、科大等三方 ASR 服务时需配置) | c2c9baae-9351-4c49-a8cb-6f24a83a8718 |
| Model | string | 否 | TTS 模型 枚举值:
| CosyVoice |
| Voice | string | 否 | 发音人 | longanyang |
| SpeechRate | integer | 否 | 语速 | 0 |
| Volume | integer | 否 | 音量 | 50 |
| PitchRate | integer | 否 | 语调 | 0 |
| PronRules | array<object> | 否 | TTS 纠错列表 | |
| object | 否 | |||
| Pattern | string | 否 | 易错词 | 还钱 |
| Replacement | string | 否 | 同音词 | 环钱 |
| ScriptProfile | object | 否 | 对话能力配置 | |
| ChatbotId | string | 否 | 对话机器人 ID | chatbot-cn-MQuyjjb666 |
| AgentKey | string | 否 | 对话机器人 AgentKey | 1309723684579735_p_beebot_public |
| FunctionMeta | object | 否 | 函数计算配置 | |
| RegionId | string | 否 | 函数服务所在地域 | cn-hangzhou |
| FunctionId | string | 否 | 函数服务 ID | 9b752bbb-805a-4d3e-9013-eab5555c3fef |
| FunctionName | string | 否 | 函数服务名称 | my_funciton |
| HttpTriggerUrl | string | 否 | 函数触发器 URL | http://chat-xxxxx-v-yewiundukb.cn-hangzhou-xxx.run |
| HttpTriggerName | string | 否 | 函数触发器名称 | defaultTrigger |
| Model | string | 否 | 对话模型 | qwen-plus |
| AgentProfile | object | 否 | 对话 Agent 配置 | |
| ScriptProfileTemplateId | string | 否 | 场景模版 ID 枚举值:
| CCC_PROMPTS_DEFAULT |
| PromptsJson | string | 否 | 提示词 json | {\"prompts\":\"我是一个聊天机器人。\"} |
| NluAccessProfile | object | 否 | 关联配置 | |
| AccessProfileId | string | 否 | 三方对话模型配置 ID | c2c9baae-9351-4c49-a8cb-6f24a83a8718 |
| OmniModel | boolean | 否 | 是否为 Omni 模型 | true |
| NluAccessType | string | 否 | 对话模型调用方式 | MANAGED |
| InteractionConfig | object | 否 | 交互配置 | |
| SilenceDetectionConfig | object | 否 | 静默检测配置 | |
| Timeout | integer | 否 | 静默超时时间,单位毫秒。 | 5000 |
| MaxRepeats | integer | 否 | 连续静默轮次挂机 | 3 |
| EndConversationConfig | object | 否 | 挂机配置 | |
| Delay | integer | 否 | 挂机话术播报完成 x 秒后,执行挂机动作。 范围 0~5 | 1 |
| Triggers | array<object> | 否 | 特殊情况拦截 | |
| object | 否 | |||
| TriggerType | string | 否 | TurnLimit:最多交互轮次判断; | TurnLimit |
| TurnLimit | integer | 否 | 当交互轮次超过 x 轮时,执行挂机。 范围 0~100。 等于 0 表示不开启超出轮次挂机。 | 20 |
| ClosingStatement | string | 否 | 达到轮次上限,执行挂机时的播报话术。 | 感谢您的接听,祝您生活愉快,再见! |
| KeyWords | array | 否 | 自定义拦截关键词列表 | |
| string | 否 | 自定义拦截关键词 | 机器人助理 | |
| InitialGreetingDelayMilliseconds | integer | 否 | 接通后,延迟放音时间 | 2000 |
| BackgroundMusicId | string | 否 | 背景音 ID | office-ambience |
| LabelConfig | array<object> | 否 | 自定义标签配置 | |
| object | 否 | |||
| Name | string | 否 | 标签名称 | 是否同意还款 |
| Description | string | 否 | 标签描述 | 用户是否同意于还款截止日期前还款 |
| CandidateValues | array | 否 | 标签可选值列表 | |
| string | 否 | 标签可选值 | 同意 |
返回参数
示例
正常返回示例
JSON格式
{
"Code": "OK",
"HttpStatusCode": 200,
"Message": "Instance af81a389-91f0-4157-8d82-720edd02b66a\n does not exist.",
"RequestId": "C00486CA-8025-5ED8-9AA5-E0AFBA87A098",
"Data": "af81a389-91f0-4157-8d82-720edd02b66b",
"Params": [
"af81a389-91f0-4157-8d82-720edd02b66a"
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 查看变更详情 | ||
| 查看变更详情 | ||
| 查看变更详情 |
