1. 接口描述
接口请求域名： mps.tencentcloudapi.com 。
创建自定义智能擦除模板
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateSmartEraseTemplate。 |
| Version | 是 | String | 公共参数，本接口取值：2019-06-12。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Name | 是 | String | 智能擦除模板名称长度限制：64 个字符。 示例值：智能擦除模板 |
| EraseType | 是 | String | 擦除类型 - subtitle 去字幕 - watermark 去水印 - privacy 隐私保护 示例值：subtitle |
| Comment | 否 | String | 智能擦除模板描述信息长度限制：256 个字符。 示例值：模板2 |
| EraseSubtitleConfig | 否 | SmartEraseSubtitleConfig | 字幕擦除配置，EraseType取subtitle时必填且仅此时生效。 |
| EraseWatermarkConfig | 否 | SmartEraseWatermarkConfig | 水印擦除配置，EraseType取watermark时必填且仅此时生效。 |
| ErasePrivacyConfig | 否 | SmartErasePrivacyConfig | 隐私保护配置，EraseType取privacy时必填且仅此时生效。 |
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: CreateSmartEraseTemplate
<公共请求参数>
{
"Name": "擦除字幕模板2",
"EraseType": "subtitle",
"EraseSubtitleConfig": {
"SubtitleEraseMethod": "auto",
"SubtitleModel": "standard",
"OcrSwitch": "ON",
"SubtitleLang": "zh_en",
"SubtitleFormat": "vtt",
"TransSwitch": "ON",
"TransDstLang": "en"
}
}输出示例
{
"Response": {
"Definition": 200409,
"RequestId": "ac14b422-1c7b-407d-9b95-530f1eea063d"
}
}示例2 创建同时具有自动擦除和区域擦除能力的擦除字幕模板
创建具有对预设区域检测文本并擦除，同时对指定时间段内指定区域直接擦除能力的擦除字幕模板
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSmartEraseTemplate
<公共请求参数>
{
"Name": "擦除字幕模板2",
"EraseType": "subtitle",
"EraseSubtitleConfig": {
"SubtitleEraseMethod": "auto",
"SubtitleModel": "standard",
"CustomAreas": [
{
"BeginMs": 200,
"EndMs": 3000,
"Areas": [
{
"LeftTopX": 0.05,
"LeftTopY": 0.1,
"RightBottomX": 0.75,
"RightBottomY": 0.9,
"Unit": 1
}
]
}
]
}
}输出示例
{
"Response": {
"Definition": 200410,
"RequestId": "835f2ecd-8666-4717-998b-02680437a8ef"
}
}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.AutoAreas | 擦除模板自动区域错误 |
| InvalidParameterValue.Comment | 参数错误：对该模板的描述。 |
| InvalidParameterValue.CustomAreas | 擦除模板指定区域错误 |
| InvalidParameterValue.ErasePrivacyConfig | 擦除模板隐私保护配置错误 |
| InvalidParameterValue.EraseSubtitleConfig | 擦除模板字幕擦除配置错误 |
| InvalidParameterValue.EraseType | 擦除模板擦除类型错误 |
| InvalidParameterValue.EraseWatermarkConfig | 擦除模板水印擦除配置错误 |
| InvalidParameterValue.Name | 参数值错误：Name 超过长度限制。 |
| InvalidParameterValue.PrivacyModel | 擦除模板隐私保护模型错误 |
| InvalidParameterValue.PrivacyTargets | 擦除模板隐私保护目标错误 |
| InvalidParameterValue.SubtitleEraseMethod | 擦除模板字幕擦除方式错误 |
| InvalidParameterValue.SubtitleLang | 擦除模板字幕擦除语种错误 |
| InvalidParameterValue.SubtitleModel | 擦除模板字幕擦除模型错误 |
| InvalidParameterValue.Switch | 参数值错误：Switch 参数取值非法。 |
| InvalidParameterValue.TransDstLang | 擦除模板字幕擦除翻译目标语种错误 |
| InvalidParameterValue.WatermarkEraseMethod | 擦除模板去水印擦除方式错误 |
| InvalidParameterValue.WatermarkModel | 擦除模板去水印擦除模型错误 |
