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

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

描述

业务接口/green/image/scan

根据您输入的待识别人脸图片(face),在指定人脸库(group)中查找并返回最相似的Top5个体(person),返回的Top5个体按照相似度从大到小排序。
参数 描述
person 个体,标识一个自然人。用户提供其personId(必选)、name(可选)、remarks(可选)。您可以通过以下接口进行操作:
face 人脸,个体的人脸图片信息。一个个体可以设置多个人脸,用户提供人脸图片信息URL(必选)。您可以通过以下接口进行操作:
group 组。一个个体可以属于多个组,一个组也可以包含多个个体,根据用户上传的人脸图片在一个组内识别出相似度Top5的个体。您可以通过以下接口进行操作:

请求参数

公共请求参数,参见公共参数

请求body是一个JSON对象,字段说明如下:
名称 类型 是否必需 描述
bizType String 自定义人脸检索业务下,该参数无需设置。
scenes String 自定义人脸检索业务下,该参数取值为:sface-n
tasks 数组 待识别人脸相关信息。具体结构描述见task
表 1. task
名称 类型 是否必需 描述
dataId 字符串 数据Id。需要保证在一次请求中所有的Id不重复。
url 字符串 待检测图像的URL。
extras Map 附加信息,需要传入groupId

返回参数

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

自定义人脸检索返回结果中的data字段说明如下:
名称 类型 是否必需 描述
code 整型 错误码,和HTTP的status code一致。
results 字符串 返回结果。调用成功时(code=200),返回结果中包含一个或多个元素。每个元素是个结构体,具体结构描述见result
表 2. result
名称 类型 是否必需 描述
scene 字符串 图片检测场景,和调用请求的scene对应。自定义人脸检索业务下,该参数取值为:sface-n
label 字符串 检测结果分类,和调用请求的scene对应。自定义人脸检索业务下,该参数取值为:sface-n
suggestion 字符串 建议用户执行的操作,取值范围:
  • pass:图片正常,无需进行其余操作,或者未识别出目标对象
  • review:需要进行人工审核,或识别出目标对象
rate 浮点数 结果为该分类的概率,取值范围为[0.00-100.00]。值越高,表示越有可能属于该分类。
topPersons 对象 人脸1-N检索结果-Top5人脸信息。具体结构描述见topPersons
表 3. topPersons
名称 类型 是否必需 描述
persons 数组 匹配Top5个体信息列表。具体结构描述见person
faceItem 字符串 检索图片的人脸属性。具体结构描述见faceItem
表 4. person
名称 类型 是否必需 描述
personId 字符串 匹配个体的Id。
faceId 字符串 匹配个体的人脸Id。
rate 浮点数 个体匹配概率。
表 5. faceItem
名称 类型 是否必需 描述
x 浮点数 x轴坐标。
y 浮点数 y轴坐标。
width 浮点数 人脸宽度。
height 浮点数 人脸高度。

示例

请求示例
{
  "scenes": ["sface-n"],
  "tasks": [
    {
      "dataId": "test2NInmO$tAON6qYUrtCRgLo-1mwxdi",
      "url": "https://img.alicdn.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png",
      "extras":{"groupId":"group"}
    }
  ]
}
返回示例
{
    "code": 200,
    "data": [
    {
        "code": 200,
        "dataId": "test2NInmO$tAON6qYUrtCRgLo-1mwxdi",
        "msg": "调用成功。",
        "results": [
            {
                "topPersons": {
                    "faceItem": {
                        "height": 422,
                        "width": 422,
                        "x": 467,
                        "y": 199
                    },
                    "persons": [
                        {
                            "faceId": "14736649593638",
                            "personId": "person1",
                            "rate": "0.999"
                        },
                        {
                            "faceId": "14736649593637",
                            "personId": "person2",
                            "rate": "0.998"
                        }
                    ]
                },
                "label": "sface-n",
                "rate": 0.999,
                "scene": "sface-n",
                "suggestion": "review"
            }
        ],
        "taskId": "img2MVcKPU1QGD64LoAb4cK6w-1mwxdi",
        "url": "https://img.alicdn.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png"
    }
    ],
    "msg": "OK",
    "requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16"
}