字幕提取_视频点播(VOD)-阿里云帮助中心

微短剧解决方案提供通过API进行字幕提取的能力。通过阅读本文，您可以了解微短剧字幕提取作业的基本API调用方法。

说明

微短剧解决方案字幕提取作业的前提条件为：开通、订阅IMS。

字幕提取

接口说明

调用SubmitIProductionJob进行字幕提取作业是异步执行方式。详情参见提交智能生产任务。

参数说明

名称	类型	必填	描述	示例值
Name	string	否	任务名称，长度不超过 100 字符。	测试任务
FunctionName	string	是	字幕提取：CaptionExtraction	CaptionExtraction
Input	object	是	输入媒体，支持 OSS。
Type	string	是	媒体类型： OSS：OSS 路径	OSS
Media	string	是	输入媒体。OSS 地址规则为 oss://bucket/object http(s)://bucket.oss-[regionId].aliyuncs.com/object 其中 bucket 为和当前项目处于同一区域的 oss bucket 名称，object 为文件路径。	oss://example-bucket/example-object.mp4
Output	object	是	输出媒体，支持 OSS。
Type	string	是	媒体类型： OSS：OSS 路径	OSS
Media	string	是	输出媒体。OSS 地址规则为： oss://bucket/object http(s)://bucket.oss-[RegionId].aliyuncs.com/object 其中 bucket 为和当前项目处于同一区域的 oss bucket 名称，object 为文件路径。	oss://example-bucket/output.srt
TemplateId	string	否	模板 ID	**20b48fb04483915d4f2cd8ac**
JobParams	string	否	算法作业参数，JSON 对象，不同算法对应参数内容不同。详见补充说明。	{fps:10,sep:false,roi:[[0.5, 1], [0, 1]]}
ScheduleConfig	object	否	任务调度配置信息
PipelineId	string	否	管道 ID	5246********c3dc
Priority	integer	否	取值范围为 1 到 10，数值越小优先级越高。	6
UserData	string	否	用户自定义数据，获取结果时原样返回。长度不超过 1024 字节。	{"test":1}

JobParams 补充说明

名称	类型	必填	描述	示例值
fps	Int	否	采样帧率（可选），整数，取值范围为[2,10]，默认5。	10
roi	List	否	字幕框选区域。如果输入框选区域，则只对区域内的字幕进行提取，区域外的文字忽略。如果不填该参数，默认识别视频底部1/4区域。格式：[[top, bottom], [left, right]]。默认：无。	[[0.5, 1], [0, 1]]
sep	Boolean	否	是否中英文分离输出两个srt文件，可选，默认False。
formatter	String	否	srt的字幕格式字符串（可选），例如："{\an8}"，默认无。

图示

lQLPKGcE1cH3dxfNBFfNAyCwIv7L_7b8h34G2SBvzL5wAA_800_1111.png

示例

场景：

字幕提取功能
算法作业参数：设置采样帧率10、字幕框选区域为下半区域
输入：OSS 地址
输出：OSS 地址

{
  "functionName": "CaptionExtraction",
  "jobParams": "{fps:10,sep:false,roi:[[0.5, 1], [0, 1]]}",
  "input":{
    "type": "OSS",
    "media": "oss://example-bucket/example-object.mp4"
  },
  "output":{
    "type": "OSS",
    "media": "oss://example-bucket/output.srt"
  }
}

回调

{
  "jobId":"270d****0d1a",
  "requestId":"********-****-****-****-************"
}

字幕提取结果查询

接口说明

调用QueryIProductionJob查询字幕提取任务状态与结果。详情参见查询智能生产任务。

参数说明

请求参数

名称	类型	必填	描述	示例值
JobId	string	否	需要查询的智能生产作业 ID。从 SubmitIProductionJob 返回参数中获取。	270d****0d1a

返回参数

名称	类型	描述	示例值
RequestId	string	请求 ID
JobId	string	任务 ID	**20b48fb04483915d4f2cd8ac**
Name	string	任务名称	测试任务
FunctionName	string	字幕提取：CaptionExtraction	Cover
Input	object	输入媒体。
Type	string	媒体类型。	OSS
Media	string	输入媒体路径。	oss://example-bucket/example-object.mp4
Output	object	输出媒体。
Type	string	媒体类型。	OSS
Media	string	输出媒体路径。	oss://example-bucket/output.srt
TemplateId	string	模板 ID	**96e8864746a0b6f3**
JobParams	string	算法作业参数，JSON 对象，不同算法对应参数内容不同。	{"Model":"gif"}
ScheduleConfig	object	任务配置信息
PipelineId	string	管道 ID	a54f********5e86
Priority	integer	任务在其对应管道内的优先级。最高优先级：10。默认值：6。	6
UserData	string	用户自定义数据，获取结果时原样返回	{"test":1}
Result	string	算法输出的结果信息，不同 FunctionName 的输出不同，以 JSON 格式输出，详见下面的补充说明	{}
CreateTime	string	创建时间，GMT 时间	2022-07-07T07:16:11Z
FinishTime	string	完成时间，GMT 时间	2021-11-26T14:50:25Z
Status	string	作业状态。取值： Queuing：排队中。 Analysing：分析中。 Fail：失败。 Success：成功。	Success
OutputFiles	array	输出文件数组
	string	生成的文件路径与名称	output.srt
OutputUrls	array	输出文件 URL 数组
	string	生成的文件可访问 URL 路径	http://xxx

回调示例

{
  "createTime": "2024-09-24T06:17:09Z",
  "finishTime": "2024-09-24T06:17:31Z",
  "functionName": "CaptionExtraction",
  "input":{
    "type": "OSS",
    "media": "oss://example-bucket/example-object.mp4"
  },
  "jobId": "270d****0d1a",
  "jobParams": "{\"fps\":10,\"roi\":[[0.5,1],[0,1]],\"sep\":false}",
  "output":{
    "type": "OSS",
    "media": "oss://example-bucket/output.srt"
  },
  "outputFiles": [
    "output.srt"
  ],
  "outputUrls": [
    "http://example-bucket.oss-region.aliyuncs.com/output.srt"
  ],
  "requestId": "********-****-****-****-************",
  "result": "{}",
  "status": "Success"
}