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

1. 接口描述

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

该接口用于批量创建关键词样本,样本用于通过OCR、ASR技术,进行不适宜内容识别、内容识别等视频处理。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateWordSamples。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
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;
7. All:通过光学字符识别技术、音频识别技术,进行内容识别、不适宜内容识别,等价于 1+2+3+4。
示例值:["Recognition", "Review"]
Words.N Array of AiSampleWordInfo 关键词,数组长度限制:100。
SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
示例值:1490012345

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建关键词素材-Review

Usages=Review,则该关键词可用于通过 OCR 技术、ASR 技术,进行不适宜内容识别。

输入示例

https://vod.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=Review
&Words.0.Keyword=张三
&Words.0.Tags.0=政治
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

示例2 创建关键词素材-Recognition

Usages=["Recognition.Ocr","Review.Ocr"],则该关键词可用于通过 OCR 技术,进行内容识别、不适宜内容识别。

输入示例

https://vod.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=Recognition.Ocr
&Usages.1=Review.Ocr
&Words.0.Keyword=网红
&Words.0.Tags.0=娱乐
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

示例3 创建关键词素材-All

Usages=All,则该关键词可用于通过 OCR 技术、ASR 技术,进行内容识别、不适宜内容识别。

输入示例

https://vod.tencentcloudapi.com/?Action=CreateWordSamples
&Usages.0=All
&Words.0.Keyword=网红
&Words.0.Tags.0=娱乐
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
    }
}

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 未授权操作。