字幕提取
微短劇解決方案提供通過API進行字幕提取的能力。通過閱讀本文,您可以了解微短劇字幕提取作業(yè)的基本API調(diào)用方法。
字幕提取
接口說明
調(diào)用SubmitIProductionJob進行字幕提取作業(yè)是異步執(zhí)行方式。詳情參見提交智能生產(chǎn)任務(wù)。
參數(shù)說明
名稱 | 類型 | 必填 | 描述 | 示例值 |
Name | string | 否 | 任務(wù)名稱,長度不超過 100 字符。 | 測試任務(wù) |
FunctionName | string | 是 | 字幕提取:CaptionExtraction | CaptionExtraction |
Input | object | 是 | 輸入媒體,支持 OSS。 | |
Type | string | 是 | 媒體類型:
| OSS |
Media | string | 是 | 輸入媒體。OSS 地址規(guī)則為
| oss://example-bucket/example-object.mp4 |
Output | object | 是 | 輸出媒體,支持 OSS。 | |
Type | string | 是 | 媒體類型:
| OSS |
Media | string | 是 | 輸出媒體。OSS 地址規(guī)則為:
| oss://example-bucket/output.srt |
TemplateId | string | 否 | 模板 ID | ****20b48fb04483915d4f2cd8ac**** |
JobParams | string | 否 | 算法作業(yè)參數(shù),JSON 對象,不同算法對應(yīng)參數(shù)內(nèi)容不同。詳見補充說明。 | {fps:10,sep:false,roi:[[0.5, 1], [0, 1]]} |
ScheduleConfig | object | 否 | 任務(wù)調(diào)度配置信息 | |
PipelineId | string | 否 | 管道 ID | 5246********c3dc |
Priority | integer | 否 | 取值范圍為 1 到 10,數(shù)值越小優(yōu)先級越高。 | 6 |
UserData | string | 否 | 用戶自定義數(shù)據(jù),獲取結(jié)果時原樣返回。長度不超過 1024 字節(jié)。 | {"test":1} |
JobParams 補充說明
名稱 | 類型 | 必填 | 描述 | 示例值 |
fps | Int | 否 | 采樣幀率(可選),整數(shù),取值范圍為[2,10],默認(rèn)5。 | 10 |
roi | List | 否 | 字幕框選區(qū)域。
| [[0.5, 1], [0, 1]] |
sep | Boolean | 否 | 是否中英文分離輸出兩個srt文件,可選,默認(rèn)False。 | |
formatter | String | 否 | srt的字幕格式字符串(可選),例如:"{\an8}",默認(rèn)無。 |
圖示
示例
場景:
字幕提取功能
算法作業(yè)參數(shù):設(shè)置采樣幀率10、字幕框選區(qū)域為下半?yún)^(qū)域
輸入: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"
}
}
回調(diào)
{
"jobId":"270d****0d1a",
"requestId":"********-****-****-****-************"
}
字幕提取結(jié)果查詢
接口說明
調(diào)用QueryIProductionJob查詢字幕提取任務(wù)狀態(tài)與結(jié)果。詳情參見查詢智能生產(chǎn)任務(wù)。
參數(shù)說明
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
JobId | string | 否 | 需要查詢的智能生產(chǎn)作業(yè) ID。從 SubmitIProductionJob 返回參數(shù)中獲取。 | 270d****0d1a |
返回參數(shù)
名稱 | 類型 | 描述 | 示例值 |
RequestId | string | 請求 ID | |
JobId | string | 任務(wù) ID | ****20b48fb04483915d4f2cd8ac**** |
Name | string | 任務(wù)名稱 | 測試任務(wù) |
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 | 算法作業(yè)參數(shù),JSON 對象,不同算法對應(yīng)參數(shù)內(nèi)容不同。 | {"Model":"gif"} |
ScheduleConfig | object | 任務(wù)配置信息 | |
PipelineId | string | 管道 ID | a54f********5e86 |
Priority | integer | 任務(wù)在其對應(yīng)管道內(nèi)的優(yōu)先級。
| 6 |
UserData | string | 用戶自定義數(shù)據(jù),獲取結(jié)果時原樣返回 | {"test":1} |
Result | string | 算法輸出的結(jié)果信息,不同 FunctionName 的輸出不同,以 JSON 格式輸出,詳見下面的補充說明 | {} |
CreateTime | string | 創(chuàng)建時間,GMT 時間 | 2022-07-07T07:16:11Z |
FinishTime | string | 完成時間,GMT 時間 | 2021-11-26T14:50:25Z |
Status | string | 作業(yè)狀態(tài)。取值:
| Success |
OutputFiles | array | 輸出文件數(shù)組 | |
string | 生成的文件路徑與名稱 | output.srt | |
OutputUrls | array | 輸出文件 URL 數(shù)組 | |
string | 生成的文件可訪問 URL 路徑 | http://xxx |
回調(diào)示例
{
"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"
}