调用AddSmarttagTemplate添加一个智能标签作业的分析模板。

使用说明

本接口添加的模板用于指定智能标签作业中的分析算法，可根据您的实际业务需求组合不同参数。

QPS限制

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

调试

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

请求参数

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

操作接口名，系统规定参数。取值：AddSmarttagTemplate。

TemplateName String 是 template-example-****

自定义模板名称，字符串内容中英文不限，最长120字符。
Industry String 是 common

待分析文件所处行业。默认值：common（通用行业）。请选择合适的行业，用于后台匹配适用于行业的算法组合。取值：

  • microVideo：小视频行业。
  • common：通用行业。
Scene String 是 search

待分析文件使用场景。请选择合适的使用场景，用于后台匹配适用的算法组合。取值：

  • search：搜索场景。
  • recommend：推荐场景。
  • 默认值：search。
AnalyseTypes String 是 ocr

分析类型，可多选，⽤半角逗号（,）分隔。当前有以下类型：

说明 请确保您的待分析文件中包含所选分析类型的结果，否则可能导致查询结果为空。例如：选择的分析类型为ocr，但上传的图片中没有ocr结果，则查询时返回结果为空。
  • ocr：从图像⽂字中识别出标签 。
  • asr：从⾳频语⾳中识别出标签 。
  • classification：视频分类 。
  • shows：视频识别节⽬ 。
  • face：视频或图片识别⼈脸 。
  • role：视频识别⼈物⻆⾊ 。
  • object：视频识别物体 。
  • tvstation：视频识别台标。
  • action：视频识别动作事件 。
  • emotion：视频识别表情 。
  • landmark：视频识别地标 。
  • scene：视频识别场景。
  • movieIp：视频识别影视IP，目前仅支持华北2（北京）地域使用。
  • subtitle：字幕提取功能。

分析类型与计费项的对应关系如下：

说明 通过本接口配置智能标签功能开启的分析类型，将会产生费用，收费标准请参见计费项。
  • 视频分类+结构化标签：除face，ocr，asr外的分析类型均属于此计费项，不叠加计费。
  • 视频人脸识别：开启face。
  • 视频文字识别标签：开启ocr。
  • 视频语音识别标签：开启asr。
FaceCategoryIds String 否 celebrity

参与识别的⼈脸库ID列表，可多选，⽤半角逗号（,）分隔。可填⼊系统⼈脸库ID和⾃定义⼈脸库ID。其中系统⼈脸库ID如下：
FaceCustomParamsConfig String 否 { "faceDetThreshold":0.999, "faceRegThreshold":0.9 }

人脸算法的参数，JSON String形式，目前支持人脸检测阈值和人脸识别阈值调整。

  • faceDetThreshold：人脸检测阈值，默认阈值0.999，只对陌生人脸分析有效。
  • faceRegThreshold：人脸识别阈值，默认阈值0.9。
ObjectGroupIds String 否 general,item,weapon,animal

参与识别的物体库ID列表，可多选，⽤半角逗号（,）分隔。可填⼊系统物体库ID和⾃定义物体库ID。其中系统物体库ID如下：

  • general：通用。
  • item：商品。
  • weapon：武器。
  • animal：动物。
  • ⾃定义物体库ID请参见注册自定义实体接口说明。
LandmarkGroupIds String 否 common

参与识别的地域库ID列表，可多选，⽤半角逗号（,）分隔。可填⼊系统地域库ID和⾃定义地域库ID。其中系统地域库ID如下：
IsDefault Boolean 否 true

是否设置为默认模板（设置为默认模板后，如果转码时不指定转码模板则使用默认模板进行转码）。取值：true（是）、false（否），默认false。⼀个阿里云账号下只能有⼀个默认模板，如果重复设置则会报错。

LabelType String 否 hmi

标注类型，目前支持类型：

  • auto：机器打标。
  • hmi：人机协同。
LabelVersion String 否 1.0

指定智能标签版本，默认为"1.0"。

  • 1.0：智能标签1.0
  • 2.0：智能标签2.0（CPV标签）
  • 2.0-custom：智能标签2.0-custom（CPV标签定制模型）
KnowledgeConfig String 否 { "movie":"name,alias,chnl,genre", "music":"songName,artistName", "person":"name,gender" }

智能标签2.0和2.0-custom模式下，设置返回标签结果中识别到知识图谱信息字段范围。更多知识图谱信息请参见智能标签接口知识图谱字段说明。不填写或者knowledgeConfig为空或者knowledgeConfig非法（不为JSON String）时，默认输出以下字段：

  • movie：
    • name：IP名称
    • alias：IP别名
    • chnl：类别
    • genre：类型
    • country：制片国家、地区
    • language：语言
    • releaseYear：发布年份
  • music：
    • songName：歌曲名称
    • artistName：歌手姓名
    • artistArea：歌手所属地区，华语/日本/韩国/欧美/其他
    • albumName：专辑名称
  • person：
    • name：姓名
    • gender：性别
    • citizenship：国籍
    • occupation：职业
    • classification：类型
    • nationality：民族
    • birthPlace：出生地
    • birthDate：出生日期
  • landmark
    • name：名称
    • nameEn：英文名
    • description：描述
    • address：地址
  • item
    • brandName：品牌
    • finegrainName：细粒度描述
KeywordConfig String 否 "type": "name,location,organization,other" }

关键词标签配置。type代表词性类别选择，可多选，用半角逗号（,）分隔，当前支持以下类别：

  • name：人名
  • location：地名
  • organization：机构名
  • other：其他
说明 当不传KeywordConfig时或者Keyword字段非法（不为JSON String）或者KeywordsConfig不包含type字段或者type字段非法时默认返回type全部类型关键词。

返回数据

名称 类型 示例值 描述
RequestId String 7B117AF5-2A16-412C-B127-FA6175EDAS3Q

请求ID。
TemplateId String 05de22f255284c7a8d2aab535dde****

模板ID。建议您保存此ID便于后续调用其他相关接口时使用。

示例

请求示例

http(s)://mts.cn-shanghai.aliyuncs.com/?Action=AddSmarttagTemplate
&TemplateName=template-example-****
&Industry=common
&Scene=search
&AnalyseTypes=ocr
&FaceCategoryIds=celebrity
&FaceCustomParamsConfig={ "faceDetThreshold":0.999, "faceRegThreshold":0.9 }
&ObjectGroupIds=general,item,weapon,animal
&LandmarkGroupIds=common
&IsDefault=true
&LabelType=hmi
&LabelVersion=1.0
&KnowledgeConfig={ "movie":"name,alias,chnl,genre", "music":"songName,artistName", "person":"name,gender" }
&KeywordConfig="type": "name,location,organization,other" }
&<公共请求参数>

正常返回示例

XML格式 

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

<AddSmarttagTemplateResponse>
    <RequestId>7B117AF5-2A16-412C-B127-FA6175EDAS3Q</RequestId>
    <TemplateId>05de22f255284c7a8d2aab535dde****</TemplateId>
</AddSmarttagTemplateResponse>

JSON格式 

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

{
  "RequestId" : "7B117AF5-2A16-412C-B127-FA6175EDAS3Q",
  "TemplateId" : "05de22f255284c7a8d2aab535dde****"
}

错误码

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

SDK示例