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

接口说明

业务接口:/green/image/scan

提交图片同步检测任务,进行人脸照片1:1比对,检测两张人脸照片的相似度。关于如何构造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,像素过低可能会影响识别效果。
  • 图片检测接口的响应时间依赖图片的下载时间。请保证被检测图片所在的存储服务稳定可靠,建议您使用阿里云OSS存储或者CDN缓存等。

请求参数

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

请求body是一个JSON对象,字段说明如下:
名称 类型 是否必选 示例值 描述
bizType String default 该字段用于标识您的业务场景。您可以通过内容安全控制台创建业务场景(具体操作,请参见自定义机审标准),或者提交工单联系我们帮助您创建业务场景。
scenes StringArray ["sface-1"] 指定图片检测的应用场景,取值:sface-1
tasks JSONArray 指定检测对象,JSON数组中的每个元素是一个检测任务结构体。最多支持100个元素,即每次提交100条内容进行检测,支持100个元素的前提是需要将并发任务调整到100个以上。关于每个元素的具体结构描述,请参见task
表 1. task
名称 类型 是否必选 示例值 描述
dataId String e6b080a8-a91a-11e8-bac4-6c96cfde2af9 数据Id。需要保证在一次请求中所有的Id不重复。
url String http://v2img.ifensi.com/2015/0826/2015082612403321.jpg 传入待比较图片中的第一张图片的URL。
extras Map xxx 传入待比较图片中的第二张图片。格式为{"faceUrl":"http://xxx.jpg"}。其中,faceUrl为第二张图片的URL。

返回数据

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

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

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

msg String OK 请求信息的响应消息。
dataId String e6b080a8-a91a-11e8-bac4-6c96cfde2af9 对应请求中的dataId
taskId String img2hsbmQeA4CU7l78$s8q5mW-1pnn7Z 该检测任务的ID。
url String http://v2img.ifensi.com/2015/0826/2015082612403321.jpg 对应请求中的URL,即第一张图片的URL。
extras Map xxx 额外调用参数。
说明 该参数可能会被调整,目前请勿依赖该参数的返回值。
results JSONArray 返回结果。调用成功时(code=200),返回结果中包含一个或多个元素。每个元素是个结构体,具体结构描述见result
表 2. result
名称 类型 示例值 描述
scene String sface-1 风险场景,取值:sface-1
label String sface-1 检测结果的分类,取值:
  • normal:第二张图片与第一张图片相似度低。
  • sface-1:第二张图片与第一张图片相似度高。
suggestion String review 建议用户执行的操作,取值范围:
  • pass:图片相似度低,无需进行其余操作
  • review:图片相似度高,建议执行后续操作
rate Float 97.0 结果为该分类的概率,取值范围:0~100。值越高,表示越有可能属于该分类。

示例

请求示例
{
  "scenes":["sface-1"],
  "tasks":[
    {
      "url":"http://v2img.ifensi.com/2015/0826/2015082612403321.jpg",
      "dataId":"e6b080a8-a91a-11e8-bac4-6c96cfde2af9",
      "extras":{
          "faceUrl":"http://img5.iqilu.com/c/u/2013/0313/1363136852136.jpg"
        },
      "time":949640
    }
  ]
}
返回示例
{
  "code":200,
  "msg":"OK",
  "requestId":"9EEF894F-A933-4830-97B1-EC1A9630A9D6"
  "data":[
    {
      "code":200,
      "dataId":"e6b080a8-a91a-11e8-bac4-6c96cfde2af9",
      "taskId":"img2hsbmQeA4CU7l78$s8q5mW-1pnn7Z",
      "url":"http://v2img.ifensi.com/2015/0826/2015082612403321.jpg"
      "extras":{}
      "msg":"OK",
      "results"
        {
          "label"sface-1",
          "rate":97.0,
          "scene:"sface-1",
          "suggestion":"review"
        }
      ]
    }
  ]
}