本文提供了调用图片同步敏感人脸检测的具体接口和参数说明，旨在帮助您编写程序构建HTTP调用请求。

使用说明

业务接口：/green/image/scan

您通过调用该接口提交图片同步检测任务，识别图片中的一个或多个敏感人脸信息。关于如何构造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对象，字段说明如下：
名称类型是否必选示例值描述
bizTypeString否default该字段用于标识您的业务场景。您可以通过内容安全控制台创建业务场景（具体操作，请参见自定义机审标准）。
scenesStringArray是["sface"]指定图片检测的应用场景，取值：sface。
tasksJSONArray是指定检测对象，JSON数组中的每个元素是一个检测任务结构体。最多支持100个元素，即每次提交100条内容进行检测，支持100个元素的前提是需要将并发任务调整到100个以上。关于每个元素的具体结构描述，请参见task。
表 1. task
名称类型是否必选示例值描述
dataIdString否68b531a8-9568-423b-957e-43b1c5119fac数据ID。需要保证在一次请求中所有的ID不重复。
urlString是https://example.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png
检测对象的URL。
  • 公网HTTP/HTTPS URL，且长度不超过2048个字符。
  • 阿里云OSS提供的文件路径。您需要先授权内容安全访问OSS存储空间，仅限相同区域的OSS空间。更多信息，请参见授权内容安全访问OSS存储空间。

    文件路径格式：oss://<bucket-name>.<endpoint>/<object-name>

返回数据

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

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

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

msgString200请求信息的响应消息。
dataIdString68b531a8-9568-423b-957e-43b1c5119fac对应请求中的dataId。
taskIdStringimg1U9a2gbpHCt78wbKnoi1iq-1pxDhy该检测任务的ID。
urlStringhttps://example.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png
检测对象的URL。
  • 公网HTTP/HTTPS URL，且长度不超过2048个字符。
  • 阿里云OSS提供的文件路径。您需要先授权内容安全访问OSS存储空间，仅限相同区域的OSS空间。更多信息，请参见授权内容安全访问OSS存储空间。

    文件路径格式：oss://<bucket-name>.<endpoint>/<object-name>

extrasMapxxx额外调用参数。
说明 该参数可能会被调整，目前请勿依赖该参数的返回值。
resultsArray返回结果。调用成功时（code=200），返回结果中包含一个或多个元素。每个元素是个结构体，具体结构描述，请参见result。
表 2. result
名称类型示例值描述
sceneStringsface图片检测场景，取值：sface。
labelStringsface检测结果的分类，取值：
  • normal：正常图片，不含敏感人脸
  • sface：含敏感人脸的图片
suggestionStringreview建议用户执行的操作，取值：
  • pass：图片正常，无需进行其余操作
  • review：检测结果不确定，需要进行人工审核
  • block：图片违规，建议执行进一步操作（如直接删除或做限制处理）
rateFloat97.03结果为该分类的概率，取值范围为[0.00-100.00]。值越高，表示越有可能属于该分类。
sfaceDataArray识别出来的人脸信息列表，具体结构描述，请参见sfaceData。
表 3. sfaceData
名称类型示例值描述
xFloat444以图片左上角为坐标原点，人脸区域左上角到y轴距离。
yFloat174以图片左上角为坐标原点，人脸区域左上角到x轴距离。
wFloat467人脸区域宽度。
hFloat467人脸区域高度。
smileRateFloat0微笑的概率。
glassesBooleanfalse是否戴眼镜。
facesArray[{"id":"AliFace_0018177","name":"xxxx","rate":97.03}]识别出的人脸信息，具体结构如下：
  • name：字符串类型，相似人物的名称。
  • rate：浮点数类型，置信度分数，取值范围：0（表示置信度最低）~100（表示置信度最高）。置信度越高表示人物识别结果的可信度越高。
  • id：字符串类型，人脸ID。
表 4. face
名称类型示例值描述
nameStringxxxx相似人物的名称。
rateFloat97.03相似概率。
idStringAliFace_0018177人脸ID。

示例

请求示例
http(s)://[Endpoint]/green/image/scan
&<公共请求参数>
{
  "scenes": ["sface"],
  "tasks": [
    {
      "dataId": "68b531a8-9568-423b-957e-43b1c5119fac",
      "url": "https://example.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://example.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png" 
    }
  ],
   "msg":   "OK" ,
   "requestId":   "D03E3DD6-756C-44D1-813C-E2775A711A34" 
}