文档

SubmitAIJob - 提交智能标签或视频DNA作业

更新时间:

调用SubmitAIJob提交智能标签或视频DNA作业。

接口说明

  • 请确保在使用该接口前,已充分了解视频点播产品的收费方式和价格。智能标签和视频 DNA 为付费功能,计费详情,请参见视频 AI 计费
  • 视频 DNA 支持的服务地域:华北 2(北京)华东 2(上海)新加坡;智能标签支持的服务地域:华北 2(北京)华东 2(上海)
  • 您需要先开通视频 DNA 或智能标签服务后,才能调用此接口提交 AI 作业。开通详情,请参见视频 AI
  • 初次使用视频 DNA 时,您需提供 uid 及地域信息,提交工单申请免费开通 DNA 指纹库,否则将影响后续视频 DNA 的功能使用。关于如何提交工单,请参见联系我们
  • AI 作业在提交成功后会异步执行,不保证接口返回时 AI 作业已处理完成。建议您配置事件通知功能,指定回调事件为视频 AI 处理完成,当接收到视频 AI 处理完成的事件通知回调后,再获取 AI 作业的结果。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vod:SubmitAIJobWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
MediaIdstring

视频 ID。可通过以下方式获取:

  • 通过控制台上传的视频,可登录点播控制台,选择媒资库 > 音/视频查看视频 ID。
  • 通过获取视频上传地址和凭证接口获取上传地址和凭证时,视频 ID 为返回参数 VideoId 的值。
  • 视频上传后,可通过搜索媒体信息接口查询视频 ID,为请求后返回参数 VideoId 的值。
3D3D12340d9401fab46a0b847****
Typesstring

AI 作业类型。多个作业类型之间用半角逗号(,)分隔。取值:

  • AIMediaDNA:视频 DNA。
  • AIVideoTag:智能标签。
AIVideoTag
Configstring

AI 作业配置,JSON 格式。

  • Types设置为AIVideoTag时,Config支持配置AnalyseTypes,设置智能标签作业分析算法的类型,取值如下:
    • ASR:语音识别,从视频的⾳频语⾳中识别出标签 。
    • OCR:图文识别,从视频的图像⽂字中识别出标签 。
  • Types设置为AIMediaDNA时,Config支持配置DNADBId,设置 DNA 指纹库 ID,用于指定视频 DNA 作业的指纹库。
{"AIVideoTag": {"AnalyseTypes": "ASR"} }
UserDatastring

自定义设置,为 JSON 字符串。参数结构详情参考 UserData

{"Extend":{"localId":"***","test":"www"}}

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

25818875-5F78-4A13-BEF6-D73936****
AIJobListobject []

AI 作业信息列表。

Typestring

AI 作业类型。取值:

  • AIMediaDNA:视频 DNA。
  • AIVideoTag:智能标签。
AIVideoTag
JobIdstring

AI 作业 ID。

9e82640c85114bf5af23edfaf****
MediaIdstring

视频 ID。

3D3D12340d92c641401fab46a0b847****

示例

正常返回示例

JSON格式

{
  "RequestId": "25818875-5F78-4A13-BEF6-D73936****",
  "AIJobList": {
    "AIJob": [
      {
        "Type": "AIVideoTag",
        "JobId": "9e82640c85114bf5af23edfaf****",
        "MediaId": "3D3D12340d92c641401fab46a0b847****"
      }
    ]
  }
}

错误码

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

  • 本页导读 (1)