文档

SubmitSmarttagJob - 提交智能标签作业

更新时间:

提交智能标签作业。

接口说明

  • 通过本接口提交智能标签作业时,需要先通过模板配置分析类型。具体操作请参见添加模板
  • 智能标签功能,目前开通的地域为华北 2(北京)、华东 2(上海)、华东 1(杭州),其他地域暂不支持。
  • 目前智能标签管道默认并发数为 2,如有更高需求,请提交工单联系阿里云客服进行评估配置。

QPS 限制

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

管道 ID,用于区分业务,绑定消息通知。可以通过 MPS 控制台 > 全局设置 > 管道获取。可以为空(空格),表示默认管道。默认管道并发为 2,需要提升并发数请提交工单

说明 管道目前仅支持后台创建,相关查询、更新接口请参见更新管道
2
Titlestring

视频标题,支持中英文、数字、中划线(-),不能以特殊符号开头,长度不能超过 256B。

example-title-****
Contentstring

视频内容描述,支持中英文、数字、中划线(-),不能以特殊符号开头,长度不能超过 1KB。

example content ****
ContentTypestring

已废弃

application/zip
ContentAddrstring

已废弃

http://exampleBucket.oss-cn-shanghai.aliyuncs.com/mps-test/ai-tag.mp4
Paramsstring

额外的请求参数,使用 JSON 字符串表示,例如:{"needAsrData":true, "needOcrData":false}。字段说明:

  • needAsrData:boolean 值,分析结果中是否需要包含原始 ASR 结果,默认 false(不包含),可选 true(包含)

  • needOcrData:boolean 值,分析结果中是否需要包含原始 OCR 结果,默认 false(不包含),可选 true(包含)

  • needMetaData:boolean 值,分析结果中是否需要包含 Meta 信息,默认 false(不包含),可选 true(包含)

false
NotifyUrlstring

Callback 路径,目前仅支持 HTTP、HTTPS 地址。

https://example.com/endpoint/aliyun/ai?id=76401125000***
UserDatastring

通过回调透传回来的信息,长度不能超过 1KB。

{"key":"value"}
Inputstring

需要分析的视频或图片文件的地址,图片文件支持 jpg、jpeg、png 三种类型(按文件后缀名校验)。智能标签接口输入支持 OSS 地址、HTTP 地址、视频点播(VoD)媒资地址等形式。

说明 请确认您的文件名正确且所在 Bucket 与接口调用地域一致,否则可能导致找不到文件或接口调用失败。
  • OSS 地址:oss://[Bucket 名称]/[文件路径],例如oss://[example-bucket-****]/[object_path-****]

  • HTTP 地址:公网可下载的地址,例如http://example-test-****.mp4

  • 视频点播(VoD)媒资地址:vod://[VoD 媒资 MediaId],例如vod://MediaId

举例如下:

  • oss://mybucket-****/example-****.mp4

  • oss://testbucket-****/videos-****/1-****.mp4

  • http://example-label-****.oss-cn-beijing.aliyuncs.com/example-****.mp4

  • vod://181d739404a3419ba1c22b957ad2****

说明 注意 OSS Bucket 所在区域必须与调用 OpenAPI 所在的区域相同,MPS 从用户 Bucket 拉取视频或图片免流量费用。
oss://mybucket-****/example-****.mp4
TemplateIdstring

模板 ID 用于指定分析算法,模板相关操作参见添加模板查询模板更新模板删除模板

39f8e0bc005e4f309379701645f4****
Prioritystring

任务在其对应管道内的优先级。最高优先级:0,最低优先级:9。默认值:5。

5

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

7B117AF5-2A16-412C-B127-FA6175ED1AD0
JobIdstring

智能标签作业 ID。建议您保存此 ID 便于后续调用其他接口时使用。

39f8e0bc005e4f309379701645f4****

示例

正常返回示例

JSON格式

{
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
  "JobId": "39f8e0bc005e4f309379701645f4****"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-05OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Priority
  • 本页导读 (1)
文档反馈