1. 接入准备
1.1 SDK获取
1.2 接入须知
开发者在调用前请先查看一句话识别的接口说明,了解接口的使用要求和使用步骤。
该接口需要手机能够连接网络(3G、4G、5G 或 Wi-Fi 等)
运行 Demo 必须设置 AppID、SecretID、SecretKey,可在 API 密钥管理 中获取。
1.3 开发环境
添加一句话识别SDK har
"dependencies": {QCloudOneSentence": "file:./sdk/qcloudonesentence.har"}
需根据实际路径替换配置
2. 快速接入
以下为demo中的代码片段,完整代码请参考sdk/demo工程
2.1 配置识别任务
let builder = new QCloud.OneSentence.Builder()builder.secretID = this._secret_idbuilder.secretKey = this._secret_keybuilder.token = this._tokenbuilder.setApiParam(QCloud.OneSentence.kEngSerViceType, '16k_zh')builder.setApiParam(QCloud.OneSentence.kSourceType, 0)builder.setApiParam(QCloud.OneSentence.kVoiceFormat, 'mp3')builder.setApiParam(QCloud.OneSentence.kUrl, this._url)
配置识别任务相关参数
2.2 启动识别任务
使用上面的Builder可以启动识别任务获取结果
this._result = await builder.build().task
3. 主要接口类和方法说明
3.1 Builder类说明
Builder 用于创建语音识别任务
方法
i. setApiParam(key: string, value: string | number | null)
名称 | 类型 | 描述 |
key | string | 请求后台的参数名称 |
value | string|number|null | 请求后台的参数值,null 时将删除已设置的参数,number 会转为 string 后设置 |
ii. getApiParam(key: string): string | number | null
获取已设置的请求参数
名称 | 类型 | 描述 |
key | string | 参数名称 |
iii .build(): Controller
创建并启动识别任务同时返回识别任务控制器
属性
名称 | 类型 | 描述 |
secretID | string | 腾讯云临时 secretId |
secretKey | string | 腾讯云临时 secretKey |
token | string |
3.2 Controller类说明
Controller 用于控制识别任务的流程
属性
名称 | 类型 | 描述 |
task | Promise<string> | 识别任务,识别任务正常结束则此 Promise 正常返回后台返回参数,否则抛出异常 |
4. 错误码
识别任务抛出类型为 SDKErrorImpl 时的错误码
错误码 | 名称 | 描述 |
-1 | UNKNOWN_ERROR | 未知错误 |
1 | NETWORK_ERROR | 网络错误 |
2 | SERVER_ERROR | 服务端错误,详情通过 message 查看 |