创建智能字幕模板

最近更新时间:2026-05-12 01:48:28

我的收藏

1. 接口描述

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

创建自定义智能字幕模板

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateSmartSubtitleTemplate。
Version String 公共参数,本接口取值:2019-06-12。
Region String 公共参数,本接口不需要传递此参数。
Name String

智能字幕模板名称
长度限制:64 个字符。


示例值:智能字幕模板
VideoSrcLanguage String

智能字幕视频源语言

ASR识别和纯字幕翻译取值参考文档:ASR 识别支持语种

下面列举部分常用取值

auto:自动识别,zh:简体中文,en:英语,ja:日语,ko:韩语,zh-PY:中英粤,zh_medical:中文医疗,vi:越南语,ms:马来语,id:印度尼西亚语,fil:菲律宾语,th:泰语,pt:葡萄牙语,tr:土耳其语,ar:阿拉伯语,es:西班牙语,hi:印地语,fr:法语,de:德语,it:意大利语,zh_dialect:中文方言,zh_en:中英,yue:粤语,ru:俄语,prime_zh:中英方言

OCR 识别仅支持以下取值:

zh_en:中英
multi:其他

不同取值支持的语种参考文档:OCR 识别支持语种


示例值:zh
SubtitleType Integer

智能字幕字幕语言类型
0: 源语言
1: 翻译语言
2: 源语言+翻译语言
当TranslateSwitch为OFF时仅支持取0
当TranslateSwitch为ON时仅支持取1或2


示例值:0
Comment String

智能字幕模板描述信息
长度限制:256 个字符。


示例值:模板2
SubtitleFormat String

智能字幕文件格式:

  • ASR识别翻译处理类型下:
    • vtt: WebVTT 格式字幕
    • srt: SRT 格式字幕
    • 不填或填空:不生成字幕文件
  • 纯字幕翻译处理类型下:
    • original:与源文件一致
    • vtt: WebVTT 格式字幕
    • srt: SRT 格式字幕
  • OCR识别翻译处理类型下:
    • vtt: WebVTT 格式字幕
    • srt: SRT 格式字幕

注意

  • ASR识别方式下,翻译大于等于2种语言时不允许传空或不传;
  • 纯字幕翻译方式下,不允许传空或不传
  • OCR类型的任务,在开启压制时,允许不传或传空

示例值:vtt
AsrHotWordsConfigure AsrHotWordsConfigure

ASR热词库参数

TranslateSwitch String

字幕翻译开关
ON: 开启翻译
OFF: 关闭翻译

注意:纯字幕翻译方式下,不传默认是打开的,不允许传空或OFF


示例值:ON
TranslateDstLanguage String

字幕翻译目标语言当TranslateSwitch为ON的时候生效,翻译语言列表:

ASR 提取翻译参考语种列表:ASR 翻译支持语种
OCR 提取翻译参考语种列表:OCR 翻译支持语种

注意:多语言方式,则使用 / 分割,如:en/ja,表示英语和日语。

部分常用语种示例:

ar:阿拉伯语
en:英语
fr:法语
it:意大利语
ja:日语
ko:韩语
ru:俄语
th:泰语
tr:土耳其语
vi:越南语
yue:粤语
zh:简体中文
zh-TW:繁体中文


示例值:en
ProcessType Integer

字幕处理类型:

  • 0:ASR识别字幕
  • 1:纯字幕翻译
  • 2:OCR识别字幕

注意:不传的情况下默认类型为 ASR识别字幕


示例值:0
SelectingSubtitleAreasConfig SelectingSubtitleAreasConfig

字幕OCR提取框选区域配置

SubtitleEmbedId Integer

压制模板id,只有ProcessType为0或2(任务类型为ASR或OCR)时才允许填写。开启多个翻译语言时,不允许填写。


示例值:1011
SpeakerMode Integer

说话人识别开关,可选值:
0:表示不开启说话人识别;
1:表示开启说话人识别;
默认不开启说话人识别。


示例值:0
SpeakerLabel Integer

说话人识别输出到字幕文件,可选值:
0:表示不输出到字幕文件;
1:表示输出到vtt字幕文件
注意:使用此参数SpeakerMode的值不能为0;
默认不输出到字幕文件。


示例值: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。

命令行工具

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 参数值错误:视频源语言错误