提交視頻理解任務
介面說明
該介面為非同步介面,提交任務後返回任務 ID(此時任務尚未完成,任務將進入後台排隊非同步執行),最終結果將通過回調通知,也可通過查詢智能內容理解任務主動查詢任務狀態。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ice:SubmitVideoCognitionJob |
create |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Title |
string |
否 |
視頻標題,支援中英文、數字、中劃線(-),不能以特殊符號開頭,長度不能超過 256B。 |
example-title-**** |
| Params |
string |
否 |
額外的請求參數,使用 JSON 字串表示。支援自然語言處理,分鏡,自訂標籤,動作識別等運算元的額外參數。 |
{ "nlpParams": { "sourceLanguage": "cn", "diarizationEnabled": true, "speakerCount": 2, "summarizationEnabled": true, "summarizationTypes": "Paragraph,Conversational,QuestionsAnswering,MindMap", "translationEnabled": true, "targetLanguages": "en", "autoChaptersEnabled": true, "meetingAssistanceEnabled": true } } |
| UserData |
string |
否 |
使用者自訂資料,擷取結果時原樣返回。長度不超過 1024 位元組。 |
{"test":1} |
| Input |
object |
否 |
輸入媒體結構 |
|
| Type |
string |
否 |
媒體類型,支援以下三種類型:
|
Media |
| Media |
string |
否 |
上述 Type 參數設定為 OSS 時,寫 OSS 地址,例如:OSS://test-bucket/video/202208/test.mp4 Type 為 Media 時寫 mediaId:c5c62d8f0361337cab312dce8e77dc6d Type 為 URL 時寫 http url,例如:https://zc-test.oss-cn-shanghai.aliyuncs.com/test/unknowFace.mp4 |
c5c62d8f03613************c6d |
| TemplateId |
string |
否 |
|
39f8e0bc00*************** |
| TemplateConfig |
string |
否 |
nlpParams 說明
| 功能 | 名稱 | 類型 | 必填 | 描述 | 樣本值 |
| nlpParams | object | 是 | 該參數包含了所有 nlp 處理的相關參數,template 分析類型包含 nlp 的時候必填,否則任務失敗。 | {"sourceLanguage":"cn"} | |
| 轉錄 | sourceLanguage | string | 是 | 轉寫使用的源語言模型,可選:cn(中文)、en(英文)、yue(粵語)、fspk(中英文自由說)。 | "cn" |
| diarizationEnabled | boolean | 否 | 是否開啟說話人分離功能,預設 false。 | true | |
| speakerCount | integer | 否 | 設定說話人分離參數。不設定:不使用說話人角色區分。0:說話人角色區分結果為不定人數。2:說話人角色區分結果為 2 人。 | 2 | |
| 摘要 | summarizationEnabled | boolean | 否 | 是否啟用摘要功能,開啟後會可以產生全文摘要、發言人總結等結果。 | true |
| summarizationTypes | string | 否 | 開啟摘要功能時,需傳入期望的摘要類型:Paragraph(全文摘要)、Conversational(發言人總結)、QuestionsAnswering(問答摘要)、MindMap(思維導圖)。 | "Paragraph,Conversational,QuestionsAnswering,MindMap" | |
| 翻譯 | translationEnabled | boolean | 否 | 是否啟用翻譯功能。 | true |
| targetLanguages | string | 否 | 開啟翻譯功能後的目標語言,可選:cn(中文)、en(英文)、yue(粵語)、fspk(中英文自由說)。 | "en,cn" | |
| 章節識別 | autoChaptersEnabled | boolean | 否 | 是否啟用章節預覽功能,結果包含章區段標頭、章節摘要。 | true |
| 智能紀要 | meetingAssistanceEnabled | boolean | 否 | 是否開啟會議協助功能,結果包含分類、關鍵詞、關鍵句、待辦事項。 | true |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 Id |
******11-DB8D-4A9A-875B-275798****** |
| JobId |
string |
任務 Id。 |
****20b48fb04483915d4f2cd8ac**** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"JobId": "****20b48fb04483915d4f2cd8ac****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。