SubmitSmarttagJob - 提交智能标签作业

提交智能标签作业。

接口说明

前提条件

通过本接口提交智能标签作业时,需要先通过模板配置分析类型。具体操作请参见 CreateCustomTemplate

使用限制

  • 智能标签功能,目前开通的地域为华北 2(北京)、华东 2(上海)、华东 1(杭州),其他地域暂不支持。

  • 目前智能标签管道默认并发数为 2,如有更高需求,请提交工单联系阿里云客服进行评估配置。

调试

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

授权信息

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

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

请求参数

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

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

example-title-****
Contentstring

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

example content ****
ContentTypestring

已废弃

ContentAddrstring

已废弃

Paramsstring

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

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

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

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

  • nlpParams: JsonObject 值,nlp 算子的输入参数,默认为空(不使用 nlp 算子),详见下方请求参数补充说明。

{"needAsrData":true, "needOcrData":false, "nlpParams":{"sourceLanguage":"cn"}}
NotifyUrlstring

Callback 路径,目前仅支持 http/https。

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

通过 MNS 回调时透传回来的信息,长度不能超过 1KB。如何设置 MNS 回调队列。

{“a”:"test"}
Inputobject

input

Typestring

媒体类型,一下两种类型二选一:

  • OSS

  • Media

  • URL

Media
Mediastring
  • 上述 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

c5c62d8f0361337cab312dce8e77dc6d
TemplateIdstring

模板 ID 用于指定分析算法,模板相关操作参见统一模版配置

39f8e0bc005e4f309379701645f4
ScheduleConfigobject

scheduleConfig

PipelineIdstring

管道 ID,用于区分业务,绑定消息通知。

未配置该参数时表示默认管道。默认管道并发为 2,需要提升并发数请提交工单。

acdbfe4323bcfdae
Prioritystring

优先级,暂时未实现,可以不填或随便填。

4

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
RequestIdstring

请求 ID。

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

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

****d80e4e4044975745c14b****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2022-08-25新增 OpenAPI查看变更详情

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