1. 接口描述
接口请求域名: mps.tencentcloudapi.com 。
创建自定义智能字幕模板
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateSmartSubtitleTemplate。 |
| Version | 是 | String | 公共参数,本接口取值:2019-06-12。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| Name | 是 | String | 智能字幕模板名称 示例值:智能字幕模板 |
| VideoSrcLanguage | 是 | String | 智能字幕视频源语言 ASR识别和纯字幕翻译取值参考文档:ASR 识别支持语种 下面列举部分常用取值
OCR 识别仅支持以下取值:
不同取值支持的语种参考文档:OCR 识别支持语种 示例值:zh |
| SubtitleType | 是 | Integer | 智能字幕字幕语言类型 示例值:0 |
| Comment | 否 | String | 智能字幕模板描述信息 示例值:模板2 |
| SubtitleFormat | 否 | String | 智能字幕文件格式:
注意:
示例值:vtt |
| AsrHotWordsConfigure | 否 | AsrHotWordsConfigure | ASR热词库参数 |
| TranslateSwitch | 否 | String | 字幕翻译开关 注意:纯字幕翻译方式下,不传默认是打开的,不允许传空或 示例值:ON |
| TranslateDstLanguage | 否 | String | 字幕翻译目标语言当TranslateSwitch为ON的时候生效,翻译语言列表: ASR 提取翻译参考语种列表:ASR 翻译支持语种 注意:多语言方式,则使用 部分常用语种示例:
示例值:en |
| ProcessType | 否 | Integer | 字幕处理类型:
注意:不传的情况下默认类型为 ASR识别字幕 示例值:0 |
| SelectingSubtitleAreasConfig | 否 | SelectingSubtitleAreasConfig | 字幕OCR提取框选区域配置 |
| SubtitleEmbedId | 否 | Integer | 压制模板id,只有ProcessType为0或2(任务类型为ASR或OCR)时才允许填写。开启多个翻译语言时,不允许填写。 示例值:1011 |
| SpeakerMode | 否 | Integer | 说话人识别开关,可选值: 示例值:0 |
| SpeakerLabel | 否 | Integer | 说话人识别输出到字幕文件,可选值: 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 智能字幕模板唯一标识。 示例值:200 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建智能字幕模板
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSmartSubtitleTemplate
<公共请求参数>
{
"Name": "智能字幕模板测试",
"VideoSrcLanguage": "zh",
"SubtitleType": 2,
"SubtitleFormat": "vtt",
"TranslateSwitch": "ON",
"TranslateDstLanguage": "en/ja",
"SubtitleEmbedId": 0
}
输出示例
{
"Response": {
"Definition": 304479,
"RequestId": "92b23ad2-452e-4887-927e-7b4cc9325538"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.AsrHotWordsConfigure | 参数值错误:热词库配置 |
| InvalidParameterValue.AsrHotWordsLibraryId | 参数值错误:热词库ID |
| InvalidParameterValue.AsrHotWordsSwitch | 参数值错误:热词库开关 |
| InvalidParameterValue.Comment | 参数错误:对该模板的描述。 |
| InvalidParameterValue.Name | 参数值错误:Name 超过长度限制。 |
| InvalidParameterValue.SubtitleEmbedId | 字幕压制id无效 |
| InvalidParameterValue.SubtitleFormat | 参数值错误:SubtitleFormat 参数非法。 |
| InvalidParameterValue.SubtitleType | 参数值错误:字幕语言类型 |
| InvalidParameterValue.TranslateDstLanguage | 参数值错误:翻译目标语言 |
| InvalidParameterValue.TranslateSwitch | 参数值错误:翻译开关 |
| InvalidParameterValue.VideoSrcLanguage | 参数值错误:视频源语言错误 |