语音识别一句话识别-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口用于对60秒之内的短音频文件进行识别。
• 支持中文普通话、英语、粤语、日语、越南语、马来语、印度尼西亚语、菲律宾语、泰语、葡萄牙语、土耳其语、阿拉伯语、印地语、法语、德语、上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话。
• 支持本地语音文件上传和语音URL上传两种请求方式，音频时长不能超过60s，音频文件大小不能超过3MB。推荐使用腾讯云COS 来存储音频、生成URL并提交请求，此种方式会走内网下载音频，极大降低整体请求时延；并且不会产生外网和流量下行费用，可节约成本（COS桶权限需要设置公有读私有写，或URL设置时效访问签名）
• 音频格式支持wav、pcm、ogg-opus、speex、silk、mp3、m4a、aac、 amr。
• 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8"
• 签名方法参考公共参数中签名方法v3。
• 默认接口请求频率限制：30次/秒，如您有提高请求频率限制的需求，请前往购买。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：SentenceRecognition。
Version	是	String	公共参数，本接口取值：2019-06-14。
Region	否	String	公共参数，本接口不需要传递此参数。
EngSerViceType	是	String	引擎模型类型。电话场景： • 8k_zh：中文电话通用； • 8k_en：英文电话通用；非电话场景： • 16k_zh：中文通用； • 16k_zh-PY：中英粤; • 16k_zh_medical：中文医疗； • 16k_en：英语； • 16k_yue：粤语； • 16k_ja：日语； • 16k_ko：韩语； • 16k_vi：越南语； • 16k_ms：马来语； • 16k_id：印度尼西亚语； • 16k_fil：菲律宾语； • 16k_th：泰语； • 16k_pt：葡萄牙语； • 16k_tr：土耳其语； • 16k_ar：阿拉伯语； • 16k_es：西班牙语； • 16k_hi：印地语； • 16k_fr：法语； • 16k_de：德语； • 16k_zh_dialect：多方言，支持23种方言（上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话）；示例值：16k_en
SourceType	是	Integer	语音数据来源。0：语音 URL；1：语音数据（post body）。示例值：1
VoiceFormat	是	String	识别音频的音频格式，支持wav、pcm、ogg-opus、speex、silk、mp3、m4a、aac、amr。示例值：wav
Url	否	String	语音的URL地址，需要公网环境浏览器可下载。当 SourceType 值为 0时须填写该字段，为 1 时不填。音频时长不能超过60s，音频文件大小不能超过3MB。注意：推荐使用腾讯云COS 来存储音频、生成URL并提交请求，此种方式会走内网下载音频，极大降低整体请求时延；并且不会产生外网和流量下行费用，可节约成本（COS桶权限需要设置公有读私有写，或URL设置时效访问签名）示例值：http://test.voice.com/test.wav
Data	否	String	语音数据，当SourceType 值为1（本地语音数据上传）时必须填写，当SourceType 值为0（语音 URL上传）可不写。要使用base64编码(采用python语言时注意读取文件应该为string而不是byte，以byte格式读取后要decode()。编码后的数据不可带有回车换行符)。音频时长不能超过60s，音频文件大小不能超过3MB（Base64后）。
DataLen	否	Integer	数据长度，单位为字节。当 SourceType 值为1（本地语音数据上传）时必须填写，当 SourceType 值为0（语音 URL上传）可不写（此数据长度为数据未进行base64编码时的数据长度）。示例值：6400
WordInfo	否	Integer	是否显示词级别时间戳。0：不显示；1：显示，不包含标点时间戳，2：显示，包含标点时间戳。默认值为 0。示例值：0
FilterDirty	否	Integer	是否过滤脏词（目前支持中文普通话引擎）。0：不过滤脏词；1：过滤脏词；2：将脏词替换为 * 。默认值为 0。示例值：0
FilterModal	否	Integer	是否过滤语气词（目前支持中文普通话引擎）。0：不过滤语气词；1：部分过滤；2：严格过滤。默认值为 0。示例值：0
FilterPunc	否	Integer	是否过滤标点符号（目前支持中文普通话引擎）。 0：不过滤，1：过滤句末标点，2：过滤所有标点。默认值为 0。示例值：0
ConvertNumMode	否	Integer	是否进行阿拉伯数字智能转换。0：不转换，直接输出中文数字，1：根据场景智能转换为阿拉伯数字。默认值为1。示例值：0
HotwordId	否	String	热词id。用于调用对应的热词表，如果在调用语音识别服务时，不进行单独的热词id设置，自动生效默认热词；如果进行了单独的热词id设置，那么将生效单独设置的热词id。示例值：966ecea2abd537c8
CustomizationId	否	String	自学习模型 id。如设置了该参数，将生效对应的自学习模型。示例值：966ecea2abd537c8
HotwordList	否	String	临时热词表：该参数用于提升识别准确率。单个热词限制："热词\|权重"，单个热词不超过30个字符（最多10个汉字），权重1-11或者100，如：“腾讯云\|5” 或 “ASR\|11”；临时热词表限制：多个热词用英文逗号分割，最多支持128个热词，如：“腾讯云\|10,语音识别\|5,ASR\|11”；参数 hotword_list（临时热词表）与 hotword_id（热词表）区别： hotword_id：热词表。需要先在控制台或接口创建热词表，获得对应hotword_id传入参数来使用热词功能； hotword_list：临时热词表。每次请求时直接传入临时热词表来使用热词功能，云端不保留临时热词表。适用于有极大量热词需求的用户；注意： • 如果同时传入了 hotword_id 和 hotword_list，会优先使用 hotword_list； • 热词权重设置为11时，当前热词将升级为超级热词，建议仅将重要且必须生效的热词设置到11，设置过多权重为11的热词将影响整体字准率。 • 热词权重设置为100时，当前热词开启热词增强同音替换功能（仅支持8k_zh,16k_zh），举例：热词配置“蜜制\|100”时，与“蜜制”同拼音（mizhi）的“秘制”的识别结果会被强制替换成“蜜制”。因此建议客户根据自己的实际情况开启该功能。建议仅将重要且必须生效的热词设置到100，设置过多权重为100的热词将影响整体字准率。
InputSampleRate	否	Integer	支持pcm格式的8k音频在与引擎采样率不匹配的情况下升采样到16k后识别，能有效提升识别准确率。仅支持：8000。如：传入 8000 ，则pcm音频采样率为8k，当引擎选用16k_zh，那么该8k采样率的pcm音频可以在16k_zh引擎下正常识别。注：此参数仅适用于pcm格式音频，不传入值将维持默认状态，即默认调用的引擎采样率等于pcm音频采样率。示例值：0

3. 输出参数

参数名称	类型	描述
Result	String	识别结果。示例值：测试输出结果
AudioDuration	Integer	请求的音频时长，单位为ms 示例值：1500
WordSize	Integer	词时间戳列表的长度注意：此字段可能返回 null，表示取不到有效值。示例值：4
WordList	Array of SentenceWord	词时间戳列表注意：此字段可能返回 null，表示取不到有效值。示例值：array
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

用户通过语音Url的方式（SourceType为0）请求一句话识别服务，请求模型为电话 8k中文（EngSerViceType = 8k_zh），音频格式为wav

输入示例

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=************************************************************/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": {
        "RequestId": "41ed9283-0c09-46fb-917b-0b83fa95f0be",
        "Result": "腾讯云语音识别欢迎您。",
        "AudioDuration": 2430,
        "WordSize": 4,
        "WordList": [
            {
                "Word": "腾讯云",
                "StartTime": 120,
                "EndTime": 810
            },
            {
                "Word": "语音识别",
                "StartTime": 810,
                "EndTime": 1530
            },
            {
                "Word": "欢迎",
                "StartTime": 1530,
                "EndTime": 1890
            },
            {
                "Word": "您",
                "StartTime": 1890,
                "EndTime": 2250
            }
        ]
    }
}

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

用户通过上传语音数据（Data）的方式（SourceType为1）请求一句话识别服务，请求模型为电话 8k中文（EngSerViceType = 8k_zh），音频格式为wav

输入示例

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=************************************************************/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": {
        "RequestId": "41ed9283-0c09-46fb-917b-0b83fa95f0be",
        "Result": "腾讯云语音识别欢迎您。",
        "AudioDuration": 2430,
        "WordSize": 4,
        "WordList": [
            {
                "Word": "腾讯云",
                "StartTime": 120,
                "EndTime": 810
            },
            {
                "Word": "语音识别",
                "StartTime": 810,
                "EndTime": 1530
            },
            {
                "Word": "欢迎",
                "StartTime": 1530,
                "EndTime": 1890
            },
            {
                "Word": "您",
                "StartTime": 1890,
                "EndTime": 2250
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.ErrorRecognize	识别失败。
FailedOperation.ServiceIsolate	账号因为欠费停止服务，请在腾讯云账户充值。
FailedOperation.UserHasNoAmount	资源包耗尽，请购买资源包或开通后付费
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	音频时长超过限制。

一句话识别

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

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

输入示例

输出示例

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

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码