有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

用户通过本接口进行热词表的创建。

• 默认最多可创建30个热词表。

• 每个热词表最多可添加1000个词,每个词最长10个汉字或30个英文字符,不能超出限制。

• 热词表可以通过数组或者本地文件形式上传。

• 本地文件必须为UTF-8编码格式,每行仅添加一个热词且不能包含标点和特殊字符。

• 热词权重取值范围为[1,11]之间的整数或者100,权重越大代表该词被识别出来的概率越大。

• 注意: 热词权重设置为11时,当前热词将升级为超级热词,建议仅将重要且必须生效的热词设置到11,设置过多权重为11的热词将影响整体字准率。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateAsrVocab。
Version String 公共参数,本接口取值:2019-06-14。
Region String 公共参数,本接口不需要传递此参数。
Name String 热词表名称,长度在1-255之间
示例值:避风港
Description String 热词表描述,长度在0-1000之间
示例值:热词
WordWeights.N Array of HotWord 词权重数组,包含全部的热词和对应的权重。每个热词的长度不大于10个汉字或30个英文字符,权重为[1,11]之间整数或者100,数组长度不大于1000
注意:
- 热词权重设置为11时,当前热词将升级为超级热词,建议仅将重要且必须生效的热词设置到11,设置过多权重为11的热词将影响整体字准率。
- 热词权重设置为100时,当前热词开启热词增强同音替换功能(仅支持8k_zh,16k_zh),举例:热词配置“蜜制|100”时,与“蜜制”同拼音(mizhi)的“秘制”的识别结果会被强制替换成“蜜制”。因此建议客户根据自己的实际情况开启该功能。建议仅将重要且必须生效的热词设置到100,设置过多权重为100的热词将影响整体字准率。
示例值:1
WordWeightStr String 词权重文件(纯文本文件)的二进制base64编码,以行分隔,每行的格式为word|weight,即以英文符号|为分割,左边为词,右边为权重,如:你好|5。
当用户传此参数(参数长度大于0),即以此参数解析词权重,WordWeights会被忽略
示例值:避风港|10 (进行bas64编码)

3. 输出参数

参数名称 类型 描述
VocabId String 词表ID,可用于获取词表信息
示例值:adsdadsdsad
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建热词表

用户通过上传词权重数组方式创建热词表

输入示例

https://asr.tencentcloudapi.com/?Action=CreateAsrVocab
&Name=词表名称
&Description=词表描述
&WordWeights.0.Word=智聆
&WordWeights.0.Weight=1
&WordWeights.1.Word=滨海大厦
&WordWeights.1.Weight=6
&WordWeights.2.Word=存储桶
&WordWeights.2.Weight=8
&WordWeights.3.Word=核保
&WordWeights.3.Weight=10
&<公共请求参数>

输出示例

{
    "Response": {
        "VocabId": "aa6f402f263f12ea856fc81fbecfd0sd",
        "RequestId": "b3808ad3-d8dd-4b65-96c9-7d6f1f81b6b6"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.ServiceIsolate 账号因为欠费停止服务,请在腾讯云账户充值。
InternalError 内部错误。
InternalError.FailAccessDatabase 访问数据库失败。
InvalidParameter 参数错误。
InvalidParameter.ErrorContentlength 请求数据长度无效。
InvalidParameter.ErrorParamsMissing 参数不全。
InvalidParameter.ErrorParsequest 解析请求数据失败。
InvalidParameter.InvalidVocabState 非法的词表状态。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.ErrorInvalidAppid AppId无效。
InvalidParameterValue.ErrorInvalidClientip ClientIp无效。
InvalidParameterValue.InvalidParameterLength 非法的参数长度。
InvalidParameterValue.InvalidVocabId 非法的VocabId。
InvalidParameterValue.InvalidWordWeight 词权重不合法。
InvalidParameterValue.InvalidWordWeightStr 非法的WordWeightStr。
LimitExceeded 超过配额限制。
LimitExceeded.VocabFull 热词表数量已到账号限制。
MissingParameter 缺少参数错误。
UnknownParameter 未知参数错误。