管理与支持产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>媒体处理>媒体AI-热词库相关接口>查询智能字幕热词库详情

查询智能字幕热词库详情

最近更新时间：2025-04-25 01:47:12

我的收藏

本页目录：

1. 接口描述

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

查询智能字幕热词库

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeAsrHotwords。
Version 是 String 公共参数，本接口取值：2019-06-12。
Region 否 String 公共参数，本接口不需要传递此参数。
HotwordsId 否 String 需要查询的热词库 id
注意：HotwordsId 与 Name 必须选择填写一个，如果同时填写，HotwordsId 优先级高于 Name
示例值：hwd-aexxxxxxxxxx1481
Name 否 String 热词库名称，
注意：HotwordsId 与 Name 必须选择填写一个，如果同时填写，HotwordsId 优先级高于 Name
示例值：热词1
Offset 否 Integer 分页偏移量，默认值：0。

示例值：0
Limit 否 Integer 返回记录条数，默认值：10，最大值：100。
示例值：10
OrderBy 否 String 热词排序字段，目前可选值为

- Default：默认文件中的顺序
- Weight：权重排序
- Lexical：热词文本排序
示例值：Default
OrderType 否 Integer 热词排序顺序 0：升序（默认） 1：降序
示例值：0

3. 输出参数

参数名称 类型 描述
HotwordsId String 需要查询的热词库 id
示例值：hwd-0bda6ac8d24411ef9ab0446a2eb5fd98
Status Integer 当前热词库 id 状态，为 0 表示查询的时刻，没有模板绑定这个热词库，可以删除
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
Name String 热词库的名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：HotwordsNameExample
Type Integer 临时热词库为 0，返回创建时候的字符串
文件热词库为 1，返回创建是上传的文件内容


注意：此字段可能返回 null，表示取不到有效值。
示例值：0
FileName String 热词文件上传时的文件名
注意：此字段可能返回 null，表示取不到有效值。
示例值：example.txt
HotWords Array of AsrHotwordsSetItem 查询返回的热词库列表
示例值：[{"Id":1,"Text":"腾讯云","Weight":10},{"Id":2,"Text":"语音识别","Weight":5},{"Id":3,"Text":"ASR","Weight":10}]
Content String 热词库文本，根据 Type 区分
如果 Type 为 0，是热词库字符串
如果 Type 是 1，是热词库文本文件的文件内容 base64 编码
注意：此字段可能返回 null，表示取不到有效值。
示例值：腾讯云|10,语音识别|5,ASR|10
WordCount Integer 当前热词库包含的词语数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：3
Offset Integer 分页偏移量，默认值：0。
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
Limit Integer 返回记录条数，默认值：10，最大值：100。
注意：此字段可能返回 null，表示取不到有效值。
示例值：10
CreateTime String 热词库创建时间 ISOUTC 格式 "2006-01-02T15:04:05Z"
注意：此字段可能返回 null，表示取不到有效值。
示例值：2025-01-14T06:51:57Z
UpdateTime String 热词库修改时间 ISOUTC 格式 "2006-01-02T15:04:05Z"
注意：此字段可能返回 null，表示取不到有效值。
示例值：2025-01-21T08:46:11Z
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeAsrHotwords

输入示例

POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAsrHotwords
<公共请求参数>

{
    "HotwordsId": "hwd-aexxxxxxxxxxxxxx1481"
}

输出示例

{
    "Response": {
        "Content": "腾讯云|10,语音识别|5,ASR|10",
        "CreateTime": "2025-03-19T03:29:06Z",
        "FileName": "",
        "HotWords": [
            {
                "Id": 1,
                "Text": "腾讯云",
                "Weight": 10
            },
            {
                "Id": 2,
                "Text": "语音识别",
                "Weight": 5
            },
            {
                "Id": 3,
                "Text": "ASR",
                "Weight": 10
            }
        ],
        "HotwordsId": "hwd-aexxxxxxxxxxxxxx1481",
        "Limit": 0,
        "Name": "HotwordsNameExample",
        "Offset": 0,
        "RequestId": "bad606d3-8a49-427f-a6a6-26c9f1fe1dc3",
        "Status": 0,
        "Type": 0,
        "UpdateTime": "2025-03-19T03:29:06Z",
        "WordCount": 3
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.AccessDBError 数据错误。
InvalidParameterValue 参数取值错误。
中国站
目录