調用智能生產API進行視頻字幕提取-ApsaraVideo for VOD-阿里雲

微短劇解決方案提供通過API進行字幕提取的能力。通過閱讀本文，您可以瞭解微短劇字幕提取作業的基本API調用方法。

說明

微短劇解決方案字幕提取作業的前提條件為：開通。

字幕提取

介面說明

調用SubmitIProductionJob進行字幕提取作業是非同步執行方式。詳情參見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查詢字幕提取任務狀態與結果。詳情參見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"
}