录音文件识别请求

最近更新时间:2020-01-15 19:33:57

1. 接口描述

接口请求域名: asr.tencentcloudapi.com 。

本接口服务对录音时长1小时以内的录音文件进行识别,异步返回识别全部结果。
• 接口是 HTTP RESTful 形式
• 接口支持wav、mp3、silk、amr、m4a等主流音频格式
• 支持语音 URL 和本地语音文件两种请求方式
• 本地语音文件上传的文件不能大于5MB,语音 URL的音频时长不能长于1小时
• 支持中文普通话、英语和粤语。
• 支持回调或轮询的方式获取结果,结果获取请参考 录音文件识别结果查询

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateRecTask。
Version String 公共参数,本接口取值:2019-06-14。
Region String 公共参数,本接口不需要传递此参数。
EngineModelType String 引擎模型类型。
8k_zh:电话 8k 中文普通话通用,可用于双声道音频的识别;
8k_zh_s:电话 8k 中文普通话话者分离,仅用于单声道;
16k_zh:16k 中文普通话通用;
16k_en:16k 英语;
16k_ca:16k 粤语。
ChannelNum Integer 语音声道数。1:单声道;2:双声道(仅在电话 8k 通用模型下支持)。
ResTextFormat Integer 识别结果文本编码方式。0:UTF-8。
SourceType Integer 语音数据来源。0:语音 URL;1:语音数据(post body)。
CallbackUrl String 回调 URL,用户自行搭建的用于接收识别结果的服务器地址, 长度小于2048字节。如果用户使用回调方式获取识别结果,需提交该参数;如果用户使用轮询方式获取识别结果,则无需提交该参数。
Url String 语音的URL地址,需要公网可下载。长度小于2048字节,当 SourceType 值为 0 时须填写该字段,为 1 时不需要填写。注意:请确保录音文件时长在一个小时之内,否则可能识别失败。请保证文件的下载速度,否则可能下载失败。
Data String 语音数据,当SourceType 值为1时必须填写,为0可不写。要base64编码(采用python语言时注意读取文件应该为string而不是byte,以byte格式读取后要decode()。编码后的数据不可带有回车换行符)。音频数据要小于5MB。
DataLen Integer 数据长度,当 SourceType 值为1时必须填写,为0可不写(此数据长度为数据未进行base64编码时的数据长度)。
HotwordId String 热词id。用于调用对应的热词表,如果在调用语音识别服务时,不进行单独的热词id设置,自动生效默认热词;如果进行了单独的热词id设置,那么将生效单独设置的热词id。

3. 输出参数

参数名称 类型 描述
Data Task 录音文件识别的请求返回结果,包含结果查询需要的TaskId
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 语音 URL 方式请求

用户通过语音 url 地址方式请求。 用户通过语音 url(https://ruskin-1256085166.cos.ap-guangzhou.myqcloud.com/test.wav) 的方式请求录音文件识别服务,服务的引擎模型为8k_0,识别的录音文件为单声道,采样率为8k。

输入示例

https://asr.tencentcloudapi.com/?Action=CreateRecTask
&ChannelNum=1
&EngineModelType=8k_0
&ResTextFormat=0
&SourceType=0
&Url=https%3a%2f%2fruskin-1256085166.cos.ap-guangzhou.myqcloud.com%2ftest.wav
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
    "Data": {
      "TaskId": 1396665
    }
  }
}

示例2 本地语音上传方式请求

用户通过本地语音上传方式请求。 用户通过本地上传语音(Data 为用户实际上传的从音频文件读取的音频数据)的方式请求录音文件识别服务,服务的引擎模型为8k_0,识别的录音文件为单声道,采样率为8k。

输入示例

https://asr.tencentcloudapi.com/?Action=CreateRecTask
&ChannelNum=1
&Data=UklGRq5pAQ...
&DataLen = 92598
&EngineModelType = 8k_0
&ResTextFormat = 0 
&SourceType = 1
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
    "Data": {
      "TaskId": 1393265
    }
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.ErrorDownFile 下载音频文件失败。
FailedOperation.ErrorRecognize 识别失败。
FailedOperation.NoSuchTask 错误的TaskId。
FailedOperation.ServiceIsolate 账号因为欠费停止服务,请在腾讯云账户充值。
FailedOperation.UserHasNoFreeAmount 账号本月免费额度已用完。
FailedOperation.UserNotRegistered 服务未开通,请在腾讯云官网语音识别控制台开通服务。
InternalError.FailAccessDatabase 访问数据库失败。
InternalError.FailAccessRedis 访问Redis失败。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
UnknownParameter 未知参数错误。