接口说明

最近更新时间:2019-10-12 17:15:49

接口描述

本接口用于对60秒之内的短音频文件进行快速识别。

  • 支持中文普通话、英语、粤语的识别
  • 支持本地语音上传和语音 URL 上传两种请求方式

接口要求

使用一句话识别 SDK 时,需按照以下要求。

内容 说明
支持语言 中文普通话、英语、粤语
音频属性 采样率:16000Hz或8000Hz、采样精度:16bits、声道:单声道,查看音频属性请参见 常见问题
音频格式 wav、mp3
请求地址 https://asr.tencentcloudapi.com/?{请求参数}
数据长度 本地语音上传不超过600KB、URL 方式上传不超过60s
免费额度 每月15000次
请求频率限制 25次/秒

使用步骤

  1. 首先获取您的 AppID、SecretID 和 SecretKey。在使用该接口前,需要在 语音识别控制台 开通服务,并进入 API 密钥管理页面 新建密钥,生成 AppID、SecretID 和 SecretKey ,用于 SDK 调用时生成签名,签名将用来进行接口鉴权。
  2. 查看您的音频属性和格式,应满足接口支持的属性和格式,否则会请求失败。
  3. 通过 SDK 提交一句话识别的请求。
  4. 如果返回的 code = 0,表示请求成功,同时一句话识别系统会将识别结果返回给客户端;如果返回的 code 不为0,请参见 错误码 查看错误详情。

一句话识别请求

请求参数

请求参数主要由请求 URL请求头部组成。

请求 URL 示例

用户通过语音 URL(https%3a%2f%2fruskin-1256085166.cos.ap-guangzhou.myqcloud.com%2ftest.wav,这是经过 urlencode 编码后的地址)上传的方式(SourceType 为0)请求一句话识别服务,服务的引擎模型为:16k通用模型 (EngSerViceType = 16k_0),一句话语音的采样率为16k,声道数为单声道。

https://asr.tencentcloudapi.com/?Action=SentenceRecognition
&ProjectId=0
&SubServiceType=2
&EngSerViceType=16k_0
&SourceType=0
&Url=https%3a%2f%2fruskin-1256085166.cos.ap-guangzhou.myqcloud.com%2ftest.wav
&SecretId=111
&Timestamp=111
&VoiceFormat=wav
&UsrAudioKey=www
&<公共请求参数>

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SentenceRecognition
Version String 公共参数,本接口取值:2019-06-14
Region String 公共参数,本接口不需要传递此参数
ProjectId Integer 腾讯云项目 ID,可填0,总长度不超过1024字节
SubServiceType Integer 子服务类型,2:一句话识别
EngineServiceType String 引擎模型类型。8k:8k 中文普通话通用,16k:16k 中文普通话通用,16k_en:16k 英语,16k_ca:16k 粤语。
SourceType Integer 语音数据来源, 0:语音 URL、1:语音数据(post body)
VoiceFormat String 识别音频的音频格式,wav 或者 mp3
Url String 语音 URL,公网可下载。当 SourceType 值为 0(语音 URL 上传) 时须填写该字段,为 1 时不填、URL 的长度大于 0,小于 2048,需进行 urlencode 编码。音频时间长度要小于60s。
Data String 语音数据,当 SourceType 值为1(本地语音数据上传)时必须填写,当 SourceType 值为0(语音 URL上传)可不写。要使用 base64 编码(采用 Python 语言时注意读取文件应该为 string 而不是 byte,以 byte 格式读取后要 decode()。编码后的数据不可带有回车换行符)。音频数据要小于600KB。
DataLen Integer 数据长度,单位为字节。当 SourceType 值为1(本地语音数据上传)时必须填写,当 SourceType 值为0(语音 URL上传)可不写(此数据长度为数据未进行 base64 编码时的数据长度)。

一句话识别结果返回

同步返回示例

{
  "Response": {
    "Result": "腾讯云语音识别欢迎您。",
    "RequestId": "8984d9a9-343f-4c67-8fd9-5c79510a12da"
  }
}

返回参数说明

参数名称 类型 描述
Result String 识别结果
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId

错误码

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

错误码 说明
FailedOperation.ServiceIsolate 账号因为欠费停止服务,请在腾讯云账户充值
FailedOperation.UserHasNoFreeAmount 账号本月免费额度已用完
FailedOperation.UserNotRegistered 服务未开通,请在腾讯云官网语音识别控制台开通服务
InternalError 内部错误
InternalError.ErrorConfigure 初始化配置失败
InternalError.ErrorCreateLog 创建日志失败
InternalError.ErrorDownFile 下载音频文件失败
InternalError.ErrorFailNewprequest 新建数组失败
InternalError.ErrorFailWritetodb 写入数据库失败
InternalError.ErrorFileCannotopen 文件无法打开
InternalError.ErrorGetRoute 获取路由失败
InternalError.ErrorMakeLogpath 创建日志路径失败
InternalError.ErrorRecognize 识别失败
InvalidParameter.ErrorContentlength 请求数据长度无效
InvalidParameter.ErrorParamsMissing 参数不全
InvalidParameter.ErrorParsequest 解析请求数据失败
InvalidParameterValue 参数取值错误
InvalidParameterValue.ErrorInvalidAppid AppId 无效
InvalidParameterValue.ErrorInvalidClientip ClientIp 无效
InvalidParameterValue.ErrorInvalidEngservice EngSerViceType 无效
InvalidParameterValue.ErrorInvalidProjectid ProjectId 无效
InvalidParameterValue.ErrorInvalidRequestid RequestId 无效
InvalidParameterValue.ErrorInvalidSourcetype SourceType 无效
InvalidParameterValue.ErrorInvalidSubservicetype SubserviceType 无效
InvalidParameterValue.ErrorInvalidUrl Url 无效
InvalidParameterValue.ErrorInvalidUseraudiokey UsrAudioKey 无效
InvalidParameterValue.ErrorInvalidVoiceFormat 音频编码格式不支持
InvalidParameterValue.ErrorInvalidVoicedata 音频数据无效