同步检测 - 内容安全

关于如何构造HTTP请求，请参见请求结构。
您也可以直接选用已构造好的HTTP请求，具体请参见SDK概览。

描述

业务接口：/green/image/scan

提交图片同步检测任务，识别图片中的一个或多个敏感人脸信息。

该接口不支持对您设置的自定义人脸进行检测，如果需要从自定义人脸库中检索人脸，使用自定义人脸检索功能。

关于检测时长

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

关于图片的限制

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

请求参数

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

请求body是一个JSON对象，字段说明如下：


名称	类型	是否必需	描述
bizType	String	否	该字段用于标识您的业务场景。您可以通过内容安全控制台创建业务场景（具体操作，请参见自定义机审标准），或者提交工单联系我们帮助您创建业务场景。
scenes	StringArray	是	指定图片检测的应用场景，取值：sface。
tasks	JSONArray	是	指定检测对象，JSON数组中的每个元素是一个检测任务结构体。最多支持100个元素，即每次提交100条内容进行检测，支持100个元素的前提是需要将并发任务调整到100个以上。关于每个元素的具体结构描述，请参见task。

表 1. task
名称	类型	是否必需	描述
dataId	String	否	数据Id。需要保证在一次请求中所有的Id不重复。
url	String	是	待检测图像的URL。

返回参数

返回结果说明，参见返回结果。

返回body中的data字段是JSON数组，每一个元素包含如下字段：


名称	类型	是否必需	描述
code	Integer	是	错误码，和HTTP的status code一致。
msg	String	是	错误描述信息。
dataId	String	否	对应请求中的dataId。
taskId	String	是	该检测任务的ID。
url	String	是	对应请求中的URL。
extras	Map	否	额外调用参数。说明该参数可能会被调整，目前请勿依赖该参数的返回值。
results	Array	否	返回结果。调用成功时（code=200），返回结果中包含一个或多个元素。每个元素是个结构体，具体结构描述，请参见result。

表 2. result
名称	类型	是否必需	描述
scene	String	是	图片检测场景，取值：sface。
label	String	是	检测结果的分类，取值： normal：正常图片，不含敏感人脸 sface：含敏感人脸的图片
suggestion	String	是	建议用户执行的操作，取值： pass：图片正常，无需进行其余操作 review：检测结果不确定，需要进行人工审核 block：图片违规，建议执行进一步操作（如直接删除或做限制处理）
rate	Float	是	结果为该分类的概率，取值范围为[0.00-100.00]。值越高，表示越有可能属于该分类。
sfaceData	Array	否	识别出来的人脸信息列表，具体结构描述，请参见sfaceData。

表 3. sfaceData
名称	类型	是否必需	描述
x	Float	是	以图片左上角为坐标原点，人脸区域左上角到y轴距离。
y	Float	是	以图片左上角为坐标原点，人脸区域左上角到x轴距离。
w	Float	是	人脸区域宽度。
h	Float	是	人脸区域高度。
smileRate	Float	否	微笑的概率。
glasses	Boolean	否	是否戴眼镜。
faces	Array	否	识别出的人脸信息，具体结构描述，请参见face。

表 4. face
名称	类型	是否必选	描述
name	String	否	相似人物的名称。
rate	Float	否	相似概率。
id	String	是	人脸id。

示例

请求示例

{
  "scenes": ["sface"],
  "tasks": [
    {
      "dataId": "68b531a8-9568-423b-957e-43b1c5119fac",
      "url": "https://img.alicdn.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png"
    }
  ]
}

返回示例

{
   "code":   200 ,
   "data":  [
    {
       "code":   200 ,
       "dataId":   "68b531a8-9568-423b-957e-43b1c5119fac" ,
       "extras":  {},
       "msg":   "OK" ,
       "results":  [
        {
           "label":   "sface" ,
           "rate":   97.03 ,
           "scene":   "sface" ,
           "sfaceData":  [
            {
               "faces":  [
                {
                   "id":   "AliFace_0018177" ,
                   "name":   "xxxx" ,
                   "rate":   97.03 
                }
              ],
               "glasses":   false ,
               "h":   467 ,
               "smileRate":   0 ,
               "w":   467 ,
               "x":   444 ,
               "y":   174 
            }
          ],
           "suggestion":   "review" 
        }
      ],
       "taskId":   "img1U9a2gbpHCt78wbKnoi1iq-1pxDhy" ,
       "url":   "https://img.alicdn.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png" 
    }
  ],
   "msg":   "OK" ,
   "requestId":   "D03E3DD6-756C-44D1-813C-E2775A711A34" 
}