文档

QuerySmarttagTemplateList - 查询模板

更新时间:

查询智能标签作业的分析模板。

接口说明

本接口通过模板ID查询模板,如果不传入模板ID则默认查询当前RAM用户所有模板。

QPS限制

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

调试

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

调试

授权信息

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

请求参数

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

模板ID,可以从添加模板的返回参数中获取。若指定该参数,则只返回该模板的信息;否则返回当前RAM⽤户所有模板的信息。

05de22f255284c7a8d2aab535dde****

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求ID。

5210DBB0-E327-4D45-ADBC-0B83C8796E26
Templatesobject []

模板列表。

AnalyseTypesstring

分析类型,可能返回一个或多个。可取值:

  • ocr:从图像⽂字中识别出标签 。

  • asr:从⾳频语⾳中识别出标签 。

  • classification:视频分类 。

  • shows:视频识别节⽬ 。

  • face:视频识别⼈脸 。

  • role:视频识别⼈物⻆⾊ 。

  • object:视频识别物体 。

  • tvstation:视频识别台标。

  • action:视频识别动作事件 。

  • emotion:视频识别表情 。

  • landmark:视频识别地标 。

  • scene:视频识别场景。

  • movieIp:视频识别影视IP。

  • subtitle:字幕提取功能。

ocr,asr,classification,shows,face,role,object,tvstation,action,emotion,landmark,scene
Industrystring

⾏业。默认值:common(通用行业)。可取值:

  • microVideo:小视频行业。

  • common:通用行业。

common
IsDefaultboolean

是否为默认模板。可取值:

  • true:是

  • false:否

false
TemplateNamestring

模板名称。

example-****
TemplateIdstring

模板ID。

05de22f255284c7a8d2aab535dde****
FaceCategoryIdsstring

系统⼈脸库ID,可能返回一个或多个。可取值:

  • celebrity:明星⼈物。
  • politician:政治⼈物。
  • sensitive:敏感⼈物。
politician,sensitive,celebrity
FaceCustomParamsConfigstring

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

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

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

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

参与识别的物体库ID列表。

general,item,weapon,animal
LandmarkGroupIdsstring

参与识别的地域库ID列表。

common
Scenestring

场景,可取值:

  • search:搜索场景。
  • recommend:推荐场景。
search
LabelTypestring

标注类型,默认值auto。目前支持类型:

  • 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" }

示例

正常返回示例

JSON格式

{
  "RequestId": "5210DBB0-E327-4D45-ADBC-0B83C8796E26",
  "Templates": {
    "Template": [
      {
        "AnalyseTypes": "ocr,asr,classification,shows,face,role,object,tvstation,action,emotion,landmark,scene",
        "Industry": "common",
        "IsDefault": false,
        "TemplateName": "example-****",
        "TemplateId": "05de22f255284c7a8d2aab535dde****",
        "FaceCategoryIds": "politician,sensitive,celebrity",
        "FaceCustomParamsConfig": "{ \"faceDetThreshold\":0.999, \"faceRegThreshold\":0.9 }",
        "ObjectGroupIds": "general,item,weapon,animal",
        "LandmarkGroupIds": "common",
        "Scene": "search",
        "LabelType": "hmi",
        "LabelVersion": "1.0",
        "KnowledgeConfig": "{ \"movie\":\"name,alias,chnl,genre\", \"music\":\"songName,artistName\", \"person\":\"name,gender\" }",
        "KeywordConfig": "{ \"type\": \"name,location,organization,other\" }"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-09-06OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈