提交智能标签作业。
接口说明
通过本接口提交智能标签作业时,需要先通过模板配置分析类型。具体操作请参见添加模板。
智能标签功能,目前开通的地域为华北 2(北京)、华东 2(上海)、华东 1(杭州),其他地域暂不支持。
该接口为异步接口,提交任务后返回任务 ID(此时任务尚未完成,任务将进入后台排队异步执行),最终结果将通过回调通知,也可通过查询智能标签作业主动查询任务状态。
目前智能标签管道默认并发数为 2,如有更高需求,请提交工单联系阿里云客服进行评估配置。
智能标签任务和相关结果保留 180 天,超过会自动清理。
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
mts:SubmitSmarttagJob |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PipelineId |
string |
是 |
管道 ID,用于区分业务,绑定消息通知。可以通过 MPS 控制台 > 全局设置 > 管道获取。可以为空(空格),表示默认管道。默认管道并发为 10,需要提升并发数请提交工单。 说明
管道目前仅支持后台创建,相关查询、更新接口请参见更新管道。 |
2 |
| Title |
string |
是 |
视频标题,支持中英文、数字、中划线(-),不能以特殊符号开头,长度不能超过 256B。 |
example-title-**** |
| Content |
string |
否 |
视频内容描述,支持中英文、数字、中划线(-),不能以特殊符号开头,长度不能超过 1KB。 |
example content **** |
| ContentType |
string |
否 |
已废弃 |
application/zip |
| ContentAddr |
string |
否 |
已废弃 |
http://exampleBucket.oss-cn-shanghai.aliyuncs.com/mps-test/ai-tag.mp4 |
| Params |
string |
否 |
额外的请求参数,使用 JSON 字符串表示,例如:
|
{"needAsrData":true, "needOcrData":false, "nlpParams":{"sourceLanguage":"cn"}} |
| NotifyUrl |
string |
否 |
Callback 路径,目前仅支持 HTTP、HTTPS 地址。 |
https://example.com/endpoint/aliyun/ai?id=76401125000*** |
| UserData |
string |
否 |
通过回调透传回来的信息,长度不能超过 1KB。 |
{"key":"value"} |
| Input |
string |
否 |
需要分析的视频或图片文件的地址,图片文件支持 jpg、jpeg、png 三种类型(按文件后缀名校验)。智能标签接口输入支持 OSS 地址、HTTP 地址、视频点播(VoD)媒资地址等形式。 说明
请确认您的文件名正确且所在 Bucket 与接口调用地域一致,否则可能导致找不到文件或接口调用失败。
举例如下:
说明
注意 OSS Bucket 所在区域必须与调用 OpenAPI 所在的区域相同,MPS 从用户 Bucket 拉取视频或图片免流量费用。 |
oss://mybucket-****/example-****.mp4 |
| TemplateId |
string |
否 |
模板 ID 用于指定分析算法,模板相关操作参见添加模板,查询模板,更新模板,删除模板。 也可使用公共模版:
|
39f8e0bc005e4f309379701645f4**** |
| Priority |
string |
否 |
任务在其对应管道内的优先级。最高优先级:0,最低优先级:9。默认值:5。 |
5 |
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(问答摘要)。 | "Paragraph,Conversational,QuestionsAnswering" | |
| 翻译 | translationEnabled | boolean | 否 | 是否启用翻译功能。 | true |
| targetLanguages | string | 否 | 开启翻译功能后的目标语言,可选:cn(中文)、en(英文)、 ja(日文)。 | "en" | |
| 章节识别 | autoChaptersEnabled | boolean | 否 | 是否启用章节速览功能,结果包含章节标题、章节摘要。 | true |
| 智能纪要 | meetingAssistanceEnabled | boolean | 否 | 是否开启会议协助功能,结果包含分类、关键词、关键句、待办事项。若启用 MeetingAssistanceEnabled 但未通过 MeetingAssistance 设置算法类型,则默认都进行调用和返回。 | true |
| meetingAssistanceTypes | string | 否 | 开启智能功能时,需传入期望的功能参数类型,支持待办(Actions)、关键信息(KeyInformation)。其中关键信息包含关键词和重点内容(关键句)。 | "Actions,KeyInformation" |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数。 |
||
| RequestId |
string |
请求 ID。 |
7B117AF5-2A16-412C-B127-FA6175ED1AD0 |
| JobId |
string |
智能标签作业 ID。建议您保存此 ID 便于后续调用其他接口时使用。 |
39f8e0bc005e4f309379701645f4**** |
示例
正常返回示例
JSON格式
{
"RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
"JobId": "39f8e0bc005e4f309379701645f4****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。