有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

该接口用于根据应用场景、关键词、标签,分页查询关键词样本信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeWordSamples。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
示例值:1490012345
Usages.N Array of String 关键词应用场景过滤条件,可选值:
1. Recognition.Ocr:通过光学字符识别技术,进行内容识别;
2. Recognition.Asr:通过音频识别技术,进行内容识别;
3. Review.Ocr:通过光学字符识别技术,进行不适宜的内容识别;
4. Review.Asr:通过音频识别技术,进行不适宜的内容识别;
可合并简写为:
5. Recognition:通过光学字符识别技术、音频识别技术,进行内容识别,等价于 1+2;
6. Review:通过光学字符识别技术、音频识别技术,进行不适宜的内容识别,等价于 3+4;
可多选,元素间关系为 or,即关键词的应用场景包含该字段集合中任意元素的记录,均符合该条件。
示例值:["Recognition","Review"]
Keywords.N Array of String 关键词过滤条件,数组长度限制:100 个词。
示例值:[]
Tags.N Array of String 标签过滤条件,数组长度限制:20 个词。
示例值:[]
Offset Integer 分页偏移量,默认值:0。
示例值:0
Limit Integer 返回记录条数,默认值:100,最大值:100。
示例值:10

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的记录总数。
示例值:2
WordSet Array of AiSampleWord 关键词信息。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取关键词样本列表-无条件

不带任何条件,遍历关键词列表。

输入示例

https://vod.tencentcloudapi.com/?Action=DescribeWordSamples
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 2,
        "WordSet": [
            {
                "Keyword": "张三",
                "TagSet": [
                    "明星",
                    "艺人"
                ],
                "UsageSet": [
                    "Recognition.Ocr",
                    "Recognition.Asr"
                ],
                "CreateTime": "2018-10-01T10:00:00Z",
                "UpdateTime": "2018-10-01T10:00:00Z"
            },
            {
                "Keyword": "李四",
                "TagSet": [
                    "总统"
                ],
                "UsageSet": [
                    "Review.Ocr",
                    "Review.Asr"
                ],
                "CreateTime": "2018-10-01T10:00:00Z",
                "UpdateTime": "2018-10-01T10:00:00Z"
            }
        ],
        "RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
    }
}

示例2 获取关键词样本列表-有条件

限定应用场景等条件的关键词查询。

输入示例

https://vod.tencentcloudapi.com/?Action=DescribeWordSamples
&Usages.0=Recognition
&Usages.1=Review.Ocr
&Keywords.0=张三
&Tags.0=明星
&Offset=0
&Limit=20
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "WordSet": [
            {
                "Keyword": "张三",
                "TagSet": [
                    "明星",
                    "艺人"
                ],
                "UsageSet": [
                    "Recognition.Ocr",
                    "Recognition.Asr"
                ],
                "CreateTime": "2018-10-01T10:00:00Z",
                "UpdateTime": "2018-10-01T10:00:00Z"
            }
        ],
        "RequestId": "46311b39-10ce-47eb-b2b6-7ce82bb4476d"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
UnauthorizedOperation 未授权操作。