文档

AddSmarttagTemplate - 添加模板

更新时间:

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

接口说明

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

QPS 限制

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

调试

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

授权信息

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

请求参数

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

自定义模板名称,字符串内容中英文不限,最长 120 字符。

template-example-****
Industrystring

待分析文件所处行业。默认值:common(通用行业)。请选择合适的行业,用于后台匹配适用于行业的算法组合。取值:

  • microVideo:小视频行业。
  • common:通用行业。
common
Scenestring

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

  • search:搜索场景。

  • recommend:推荐场景。

  • 默认值:search

search
AnalyseTypesstring

分析类型,可多选,⽤半角逗号(,)分隔。当前有以下类型:

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

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

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

参与识别的⼈脸库 ID 列表,可多选,⽤半角逗号(,)分隔。可填⼊系统⼈脸库 ID 和⾃定义⼈脸库 ID。其中系统⼈脸库 ID 如下:

celebrity
FaceCustomParamsConfigstring

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

  • faceDetThreshold:人脸检测阈值,默认阈值 0.999,只对陌生人脸分析有效。

  • faceRegThreshold:人脸识别阈值,默认阈值 0.9。

{ "faceDetThreshold":0.999, "faceRegThreshold":0.9 }
ObjectGroupIdsstring

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

  • general:通用。

  • item:商品。

  • weapon:武器。

  • animal:动物。

  • ⾃定义物体库 ID 请参见注册自定义实体接口说明。

general,item,weapon,animal
LandmarkGroupIdsstring

参与识别的地域库 ID 列表,可多选,⽤半角逗号(,)分隔。可填⼊系统地域库 ID 和⾃定义地域库 ID。其中系统地域库 ID 如下:

common
IsDefaultboolean

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

true
LabelTypestring

标注类型,目前支持类型:

  • auto:机器打标。

  • hmi:人机协同。

hmi
LabelVersionstring

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

  • 1.0:智能标签 1.0

  • 2.0:智能标签 2.0(CPV 标签)

  • 2.0-custom:智能标签 2.0-custom(CPV 标签定制模型)

1.0
KnowledgeConfigstring

智能标签 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:细粒度描述
{ "movie":"name,alias,chnl,genre", "music":"songName,artistName", "person":"name,gender" }
KeywordConfigstring

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

  • name:人名

  • location:地名

  • organization:机构名

  • other:其他

说明 当不传 KeywordConfig 时或者 Keyword 字段非法(不为 JSON String)或者 KeywordsConfig 不包含 type 字段或者 type 字段非法时默认返回 type 全部类型关键词。
"type": "name,location,organization,other" }

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

7B117AF5-2A16-412C-B127-FA6175EDAS3Q
TemplateIdstring

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

05de22f255284c7a8d2aab535dde****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2022-09-06OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ObjectGroupIds
    新增入参:LandmarkGroupIds
  • 本页导读 (1)