本文提供了调用图片同步检测任务进行图片标签识别的具体接口和参数说明,旨在帮助您编写程序构建HTTP调用请求。

使用说明

业务接口:/green/image/scan

提交图片同步检测任务,识别并返回图片中的主体标签内容,识别到的标签将按照置信度由高到低返回Top N个结果。关于如何构造HTTP请求,请参见请求结构;您也可以直接选用已构造好的HTTP请求,更多信息,请参见SDK概览

该接口为收费接口。关于计费方式,请参见内容安全产品定价

关于检测时长

同步检测允许的最长检测时间是6秒,如果检测在该时间限制内没有完成,系统会强制返回超时错误码。如果您对实时性要求不高,可以选择异步检测;其它情况下,请选择同步检测,同步检测接口的调用相对简单些。对于同步检测接口的调用,建议您将超时时间设置为6秒。

关于图片的限制
  • 图片链接支持以下协议:HTTP和HTTPS。
  • 图片支持以下格式:PNG、JPG、JPEG、BMP、GIF、WEBP。
  • 图片大小限制为20 MB以内(适用于同步和异步调用),高度或者宽度不能超过30,000像素(px),且图像总像素不超过2.5亿(px)
  • 图片下载时间限制为3秒内,如果下载时间超过3秒,返回下载超时。
  • 图片像素建议不低于256*256(px),像素过低可能会影响识别效果。
  • 图片检测接口的响应时间依赖图片的下载时间。请保证被检测图片所在的存储服务稳定可靠,建议您使用阿里云OSS存储或者CDN缓存等。

QPS限制

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

请求参数

关于在请求中必须包含的公共请求参数,请参见公共参数

请求body是一个JSON对象,字段说明如下:
名称 类型 是否必选 示例值 描述
bizType String default 该字段用于标识您的业务场景。您可以通过内容安全控制台创建业务场景(具体操作,请参见自定义机审标准)。
scenes StringArray ["tag"] 指定图片检测的应用场景,取值:tag
tasks JSONArray 指定检测对象,JSON数组中的每个元素是一个检测任务结构体。最多支持100个元素,即每次提交100条内容进行检测,支持100个元素的前提是需要将并发任务调整到100个以上。关于每个元素的具体结构描述,请参见task
表 1. task
名称 类型 是否必选 示例值 描述
dataId String test35T5XhMsXfV4xKwUv8Ob74-1poXxF 数据ID。需要保证在一次请求中所有的ID不重复。
url String http://www.aliyundoc.com/2015/0826/2015082612403321.jpg 待检测图像的URL。

返回数据

返回结果说明,参见返回结果

返回body中的data字段是JSON数组,每一个元素包含如下字段:
名称 类型 示例值 描述
code Integer 200 错误码,和HTTP状态码一致。

更多信息,请参见公共错误码

msg String OK 请求消息的响应信息。
dataId String test35T5XhMsXfV4xKwUv8Ob74-1poXxF 对应请求中的dataId
taskId String vi636L2Z$Q43i6LRrWdITWhq-1poXxF 该检测任务的ID。
url String http://www.aliyundoc.com/2015/0826/2015082612403321.jpg 对应请求中的URL。
extras Map xxx 额外调用参数。
说明 该参数可能会被调整,目前请勿依赖该参数的返回值。
results Array 返回结果。调用成功时(code=200),返回结果中包含一个或多个元素。每个元素是个结构体,关于结构的描述,请参见result
表 2. result
名称 类型 示例值 描述
scene String tag 图片检测场景,取值:tag
label String tag 检测结果的分类,取值:
  • normal:正常图片,无标签
  • tag:含标签的图片
suggestion String review 建议用户执行的操作,取值:
  • pass:图片不含标签,无需进行其余操作
  • review:图片含标签,建议执行后续操作
rate Float 99.91 结果为该分类的概率,取值范围为[0.00-100.00]。值越高,表示越有可能属于该分类。
tagData Object 标签识别发现标签时(label=tag),返回的标签数据信息。关于结构的描述,请参见tagData
表 3. tagData
名称 类型 示例值 描述
summary Array 标签概要信息。关于结构的描述,请参见summary
表 4. summary
名称 类型 示例值 描述
tgCnName String 飞行器 标签中文名称。
tgEnName String Aircraft 标签英文名称。
cnCategory String xxx 标签所属的分类中文名称。
enCategory String xxx 标签所属的分类英文名称。
rate Float 99.91 结果为标签的概率,取值范围[0,100]。取值越大,则越有可能属于标签。

示例

请求示例
{
  "scenes": ["tag"],
  "tasks": [
    {
      "dataId": "test35T5XhMsXfV4xKwUv8Ob74-1poXxF",
      "url": "http://www.aliyundoc.com/2015/0826/2015082612403321.jpg"
    }
  ]
}
返回示例
{
  "msg": "OK",
  "code": 200,
  "data": [
    {
      "msg": "OK",
      "code": 200,
      "dataId": "test35T5XhMsXfV4xKwUv8Ob74-1poXxF",
      "results": [
        {
          "tagData": {
            "summary": [
              {
                "rate": 37.72,
                "tagEnName": "Aircraft",
                "tagCnName": "飞行器"
              },
              {
                "rate": 31.93,
                "tagEnName": "Hotel",
                "tagCnName": "旅馆"
              }
            ],
          },
          "rate": 99.91,
          "suggestion": "review",
          "label": "tag",
          "scene": "tag"
        }
      ],
      "taskId": "vi636L2Z$Q43i6LRrWdITWhq-1poXxF",
      "url": "http://www.aliyundoc.com/2015/0826/2015082612403321.jpg"
    }
  ],
  "requestId": "5CAED310-CC31-4E34-9EB5-3C2E741BB870"
}