调用SubmitAIJob提交AI作业。

使用说明

  • AI作业内容包含智能标签作业和视频DNA作业。只有先开通相关的AI服务后,才能调用此接口提交AI作业。更多详情,请参见视频AI
  • 初次使用视频DNA时,需提供uid及地域信息,通过提交工单申请免费开通DNA指纹库,否则将影响后续视频DNA的功能使用。
  • AI作业在提交成功后会异步执行,不保证接口返回时AI作业已处理完成。

QPS限制

本接口的单用户QPS限制为30次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String SubmitAIJob

系统规定参数。取值:SubmitAIJob

MediaId String 3D3D12340d9401fab46a0b847****

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

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

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

  • AIMediaDNA:视频DNA。
  • AIVideoTag:智能标签。
Config String {"AIVideoTag": {"AnalyseTypes": "Face,ASR"} }

AI作业配置,JSON格式。具体结构定义,请参见视频AI参数说明。当Types设置为AIVideoTag时,支持的智能标签类型根据地域有所差异,具体如下:

  • 视频存储在上海地域的,Face、ASR、OCR、Category、Annotation五种类型都支持。
  • 视频存储在北京地域的,暂时只支持Face。
  • 视频存储在其他地域的,暂不支持该服务。
说明 关于存储地域的说明,请参见点播地域标识
UserData String {"Extend":{"localId":"***","test":"www"}}

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

返回数据

名称 类型 示例值 描述
RequestId String 25818875-5F78-4A13-BEF6-D73936****

请求ID。

AIJobList Array of AIJob

AI作业信息列表。

AIJob
Type String AIVideoTag

AI作业类型。取值:

  • AIMediaDNA:视频DNA。
  • AIVideoTag:智能标签。
JobId String 9e82640c85114bf5af23edfaf****

AI作业ID。

MediaId String 3D3D12340d92c641401fab46a0b847****

视频ID。

示例

请求示例

http(s)://[Endpoint]/?Action=SubmitAIJob
&MediaId=3D3D12340d9401fab46a0b847****
&Types=AIVideoTag
&Config={"AIVideoTag": {"AnalyseTypes": "Face,ASR"} }
&UserData={"Extend":{"localId":"***","test":"www"}}
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SubmitAIJobResponse>
    <RequestId>25818875-5F78-4A13-BEF6-D73936****</RequestId>
    <AIJobList>
        <Type>AIVideoTag</Type>
        <JobId>9e82640c85114bf5af23edfaf****</JobId>
        <MediaId>3D3D12340d92c641401fab46a0b847****</MediaId>
    </AIJobList>
</SubmitAIJobResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

SDK示例

建议使用服务端SDK来调用API,此API各语言调用的示例代码,请参见: