AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

SubmitVideoCognitionJob - 提交视频智能内容理解任务

更新时间：
复制为 MD 格式
产品详情
我的收藏

提交视频理解任务

接口说明

该接口为异步接口，提交任务后返回任务 ID（此时任务尚未完成，任务将进入后台排队异步执行），最终结果将通过回调通知，也可通过查询智能内容理解任务主动查询任务状态。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

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

否

媒体类型，支持以下三种类型：

  • OSS

  • Media

  • URL

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

否

模板 ID 用于指定分析算法，模板相关操作参见创建用户自定义模板和智能标签模版

39f8e0bc00***************
TemplateConfig

string

否

nlpParams 说明

功能名称类型必填描述示例值
nlpParamsobject是该参数包含了所有 nlp 处理的相关参数，template 分析类型包含 nlp 的时候必填，否则任务失败。{"sourceLanguage":"cn"}
转录sourceLanguagestring是转写使用的源语言模型，可选：cn（中文）、en（英文）、yue（粤语）、fspk（中英文自由说）。"cn"
diarizationEnabledboolean否是否开启说话人分离功能，默认 false。true
speakerCountinteger否设置说话人分离参数。不设置：不使用说话人角色区分。0：说话人角色区分结果为不定人数。2：说话人角色区分结果为 2 人。2
摘要summarizationEnabledboolean否是否启用摘要功能，开启后会可以生成全文摘要、发言人总结等结果。true
summarizationTypesstring否开启摘要功能时，需传入期望的摘要类型：Paragraph（全文摘要）、Conversational（发言人总结）、QuestionsAnswering（问答摘要）、MindMap（思维导图）。"Paragraph,Conversational,QuestionsAnswering,MindMap"
翻译translationEnabledboolean否是否启用翻译功能。true
targetLanguagesstring否开启翻译功能后的目标语言，可选：cn（中文）、en（英文）、yue（粤语）、fspk（中英文自由说）。"en,cn"
章节识别autoChaptersEnabledboolean否是否启用章节速览功能，结果包含章节标题、章节摘要。true
智能纪要meetingAssistanceEnabledboolean否是否开启会议协助功能，结果包含分类、关键词、关键句、待办事项。true

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 Id

******11-DB8D-4A9A-875B-275798******
JobId

string

任务 Id。

****20b48fb04483915d4f2cd8ac****

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****20b48fb04483915d4f2cd8ac****"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：任务接口下一篇：QueryVideoCognitionJob - 查询智能内容理解任务