2023/12/22 15:59:00
key-value 说明
在声网 SDK 提供的插件相关方法和回调中,key
和 value
参数取决于你使用的插件。本页提供云知声转写插件支持的 key
和 value
说明。
方法 key 和 value
调用声网 SDK 的 setExtensionPropertyWithVendor
方法时,支持传入以下 key
:
方法的 key | 描述 | value |
---|---|---|
init_asr | 初始化 | 包含以下参数: |
start_asr | 开始识别 | 详见下面的 start_asr 参数说明 |
stop_asr | 结束识别 | 无 |
start_asr 参数说明
当 key
为 start_asr
时,value
包含以下参数:
参数名 | 类型 | 必须/可选 | 描述 | 默认值 |
---|---|---|---|---|
user_id | String | 可选 | 用户标识。建议传入,方便排查问题。 | 无 |
domain | String | 可选 |
| general |
lang | String | 可选 | 语言,支持设为:
| cn |
format | String | 可选 | 音频格式 | pcm |
sample | String | 可选 | 采样率,支持设为:
| 16k |
type | String | 可选 | 结果类型:
| fixed |
punctuation | Boolean | 可选 | 是否开启标点符号添加:
| true |
post_proc | Boolean | 可选 | 是否开启数字格式转为阿拉伯数字格式:
| true |
acoustic_setting | String | 可选 | 声学模型:
| near |
回调 key 和 value
声网 SDK 的 onEvent
回调可能包括以下 key:
onEvent 回调的 key | 描述 | value |
---|---|---|
asr_error | 错误类型 | String 型,错误信息 |
asr_result | 语音识别结果 | 详见下面的 asr_result 参数说明 |
asr_result 参数说明
当 key
为 asr_result
时,value
包含以下参数:
参数 | 类型 | 描述 | 是否为空 |
---|---|---|---|
code | Int | 处理结果 | NO |
msg | String | 结果说明 | NO |
sid | String | 服务端生成的 session id。申请服务端排查问题时需要提供此 id | NO |
type | String | 结果类型:
| NO |
text | String | 识别结果 | NO |
start_time | String | 句子开始时间,单位 ms(可变结果不返回此字段) | YES |
end_time | String | 句子结束时间,单位 ms(可变结果不返回此字段) | YES |
错误码
错误码 | 说明 | 解决方法 |
---|---|---|
0 | 正确 | 无需 |
401 | 签名校验失败 | 检查 appkey 和 signature 是否正确;检查计算签名的参数 appkey 、timestamp 、secret 是否按照协议要求拼接 |
403 | 时钟偏移校验失败 | 检查服务器时间是否标准,相差 5 分钟以上会报此错误 |
20101 | WebSocket 连接空闲时间超过 10s | 检查客户端代码 |
20102 | 参数错误 | 客户端检查参数是否正确 |
20103 | 内部错误 | 建议重试,或者提工单,工单详情请提供 sid |
20104 | 资源不足 | 建议重试,或者提工单,工单详情请提供 sid |
20105 | 音频长度超过 120 分钟 | 检查音频时长是否过长,减小音频长度 |
20106 | 非法的 appkey | 检查 appkey 是否合法 |
20107 | 套餐时长使用完 | 购买时长套餐 |
20108 | 并发超限制 | 减小并发或者购买并发套餐 |
20109 | 客户端 IP 不在白名单内 | 检查是否开启白名单,同时检查客户端出口 IP 是否在 IP 白名单中 |