一句话识别

最近更新时间:2020-09-21 08:00:06

1. 接口描述

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

本接口用于对60秒之内的短音频文件进行识别。
• 支持中文普通话、英语、粤语、日语、上海话方言。
• 支持本地语音文件上传和语音URL上传两种请求方式,音频时长不能超过60s。
• 音频格式支持wav、mp3;采样率支持8000Hz或者16000Hz;采样精度支持16bits;声道支持单声道。
• 当音频文件通过请求中body内容上传时,请求大小不能超过3MB。
• 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8"
• 签名方法参考 公共参数 中签名方法v3。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SentenceRecognition。
Version String 公共参数,本接口取值:2019-06-14。
Region String 公共参数,本接口不需要传递此参数。
ProjectId Integer 腾讯云项目 ID,可填 0,总长度不超过 1024 字节。
SubServiceType Integer 子服务类型。2: 一句话识别。
EngSerViceType String 引擎模型类型。
电话场景:
• 8k_en:电话 8k 英语;
• 8k_zh:电话 8k 中文普通话通用;
非电话场景:
• 16k_zh:16k 中文普通话通用;
• 16k_en:16k 英语;
• 16k_ca:16k 粤语;
• 16k_ja:16k 日语;
•16k_wuu-SH:16k 上海话方言。
SourceType Integer 语音数据来源。0:语音 URL;1:语音数据(post body)。
VoiceFormat String 识别音频的音频格式。mp3、wav。
UsrAudioKey String 用户端对此任务的唯一标识,用户自助生成,用于用户查找识别结果。
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()。编码后的数据不可带有回车换行符)。数据长度要小于3MB(Base64后)。
DataLen Integer 数据长度,单位为字节。当 SourceType 值为1(本地语音数据上传)时必须填写,当 SourceType 值为0(语音 URL上传)可不写(此数据长度为数据未进行base64编码时的数据长度)。
HotwordId String 热词id。用于调用对应的热词表,如果在调用语音识别服务时,不进行单独的热词id设置,自动生效默认热词;如果进行了单独的热词id设置,那么将生效单独设置的热词id。
FilterDirty Integer 是否过滤脏词(目前支持中文普通话引擎)。0:不过滤脏词;1:过滤脏词;2:将脏词替换为 * 。
FilterModal Integer 是否过语气词(目前支持中文普通话引擎)。0:不过滤语气词;1:部分过滤;2:严格过滤 。
FilterPunc Integer 是否过滤标点符号(目前支持中文普通话引擎)。 0:不过滤,1:过滤句末标点,2:过滤所有标点。默认为0。
ConvertNumMode Integer 是否进行阿拉伯数字智能转换。0:不转换,直接输出中文数字,1:根据场景智能转换为阿拉伯数字。默认值为1
WordInfo Integer 是否显示词级别时间戳。0:不显示;1:显示,不包含标点时间戳,2:显示,包含标点时间戳。支持引擎8k_zh,16k_zh,16k_en,16k_ca,16k_ja,16k_wuu-SH

3. 输出参数

参数名称 类型 描述
Result String 识别结果。
AudioDuration Integer 请求的音频时长,单位为ms
WordSize Integer 词时间戳列表的长度
注意:此字段可能返回 null,表示取不到有效值。
WordList Array of SentenceWord 词时间戳列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 通过语音Url来调用接口

用户通过语音Url的方式(SourceType为0)请求一句话识别服务,请求模型为电话 8k中文 (EngSerViceType = 8k_zh),音频格式为wav(采样率为8k,单声道)

输入示例

POST / HTTP/1.1
Host: asr.tencentcloudapi.com
Content-Type: application/json; charset=utf-8
X-TC-Version: 2019-06-14
X-TC-Region: ap-shanghai
X-TC-Action: SentenceRecognition
X-TC-Timestamp: 1599140162
Authorization: TC3-HMAC-SHA256 Credential=AKIDYu6A16GdCxUlnbTSVItxvhxxx2gpbx2/2020-09-03/asr/tc3_request, SignedHeaders=content-type;host, Signature=0615f73a69c6b054affd69e4b1cbb68fbe84ae8024a9347df4aa5054933adac8
<公共请求参数>

{"UsrAudioKey": "test", "SubServiceType": 2, "Url": "http://tes.cos.ap-guangzhou.myqcloud.com/test.wav", "ProjectId": 0, "EngSerViceType": "8k_zh", "VoiceFormat": "wav", "SourceType": 0}

输出示例

{
  "Response": {
    "Result": "张先生,您好。那个为了规范保险从业人员的销售行为,也为了更好的保护您的合法权益。",
    "AudioDuration": 15000,
    "RequestId": "8984d9a9-343f-4c67-8fd9-5c79510a12da"
  }
}

示例2 通过语音数据来调用接口

用户通过上传语音数据(Data)的方式(SourceType为1)请求一句话识别服务,请求模型为电话 8k中文 (EngSerViceType = 8k_zh),音频格式为wav(采样率为8k,单声道)

输入示例

POST / HTTP/1.1
Host: asr.tencentcloudapi.com
Content-Type: application/json; charset=utf-8
X-TC-Version: 2019-06-14
X-TC-Region: ap-shanghai
X-TC-Action: SentenceRecognition
X-TC-Timestamp: 1599140479
Authorization: TC3-HMAC-SHA256 Credential=AKIDYu6A16GdCxUlnbTSVItxvhOr6B2xxxx2/2020-09-03/asr/tc3_request, SignedHeaders=content-type;host, Signature=aa5e2b8b16ced1ac9f877c9a92dab641dcd940837f5869a9e933688c181094de
<公共请求参数>

{"UsrAudioKey": "test", "SubServiceType": 2, "ProjectId": 0, "EngSerViceType": "8k_zh", "VoiceFormat": "wav", "Data": "eGNmYXNkZmFzZmFzZGZhc2RmCg==", "SourceType": 1}

输出示例

{
  "Response": {
    "Result": "张先生,您好。那个为了规范保险从业人员的销售行为,也为了更好的保护您的合法权益。",
    "AudioDuration": 15000,
    "RequestId": "8984d9a9-343f-4c67-8fd9-5c79510a12da"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ErrorRecognize 识别失败。
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 音频数据无效。
InvalidParameterValue.ErrorVoicedataTooLong 音频时长超过限制。
目录