本文提供了调用相似图检索接口的具体内容,旨在帮助您编写程序构建HTTP调用请求。

  • 关于如何构造HTTP请求,请参考请求结构
  • 您也可以直接选用已构造好的HTTP请求,具体请参考SDK参考

描述

业务接口/green/image/scan

调用本接口检测指定图片和相似图库中的样本图片的相似度。

您可以调用以下接口来维护相似图库:
关于图片的限制
  • 图片链接支持以下协议:HTTP和HTTPS。
  • 图片支持以下格式:PNG、JPG、JPEG、BMP、GIF、WEBP。
  • 图片大小限制为10MB以内(适用于同步和异步调用)。如您有特殊需求(大图片),可以提工单进行调整。
  • 图片下载时间限制为3s内,如果下载时间超过3s,返回下载超时。
  • 图片像素建议不低于256*256,像素过低可能会影响识别效果。
  • 图片检测接口响应时间依赖图片的下载时间。请保证被检测图片所在的存储服务稳定可靠,建议您使用阿里云OSS存储或者CDN缓存等。

请求参数

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

请求body是一个JSON对象,字段说明如下:
名称 类型 是否必需 描述
bizType String 相似图检索业务下,该参数无需设置。
scenes String 相似图检索业务下,该参数取值为:similarity
tasks 数组 待检测图片的相关信息。具体结构描述见task
表 1. task
名称 类型 是否必需 描述
dataId 字符串 待检测图片在您的业务系统中的唯一ID。
url 字符串 待检测图片的URL。

返回参数

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

返回body中的data字段是JSON数组,每一个元素包含如下字段:
名称 类型 是否必需 描述
code 整型 错误码,和HTTP的status code一致。
msg 字符串 错误描述信息。
results 字符串 返回结果。调用成功时(code=200),返回结果中包含一个或多个元素。每个元素是个结构体,具体结构描述见result
表 2. result
名称 类型 是否必需 描述
scene 字符串 图片检测场景,和调用请求的场景对应。相似图检索业务下,该参数取值为:similarity
label 字符串 检测结果分类,和调用请求的scene对应。相似图检索业务下,该参数取值为:
  • normal:未命中相似图
  • similarity:命中相似图
suggestion 字符串 建议用户执行的操作,取值范围:
  • pass:未命中相似图
  • review:命中相似图
rate 浮点数 与所有命中的样本图片的相似度的最大值,取值范围为[0.00-100.00]。值越高,表示越有可能命中样本图片。
similarityImage 数组 命中的相似图结果。返回被检测图片与样本图库中所有图片比对后,相似度高的结果记录。每个记录的具体结构描述见similarityImageData
表 3. similarityImageData
名称 类型 是否必需 描述
dataId 字符串 命中的样本图片在您的业务系统里的唯一ID。
url 字符串 命中的样本图片的URL。
tags JSON数组 命中的样本图片的标签值。
rate 浮点数 被检测图片与命中的样本图片的相似度,取值范围为[0.00-100.00]。值越高,表示越有可能命中该样本图片。

示例

请求示例
{
  "scenes":["similarity"],
  "tasks":[
    {
      "url":"http://www.foo.bar/test.jpg"
    }
  ]
}
返回示例
{
  "requestId":"7B932A87-65EB-423A-A4BF-BDA65E29FCEE",
  "code":200,
  "msg":"OK",
  "data":[
    {
      "code":200,
      "msg":"OK",
      "results":[
        {
          "label":"normal",
          "rate":99.9,
          "scene":"similarity",
          "suggestion":"review",
          "similarityImageData":[
            "url": "http://www.foo.bar/testb.jpg",
            "dataId": "test6HPBmBm8AM46zcu30bRNq0-1p8xDK",
            "rate": 99.9,
            "tags":["涉黄"]
          ]
        }
      ],
      "taskId":"img3IpdHbwwbv05pvXD8ud7F0-1p8xDC",
      "url":"http://www.foo.bar/test.jpg"
    }
  ]
}