本文档介绍搜索人脸SearchFace的语法及示例。

功能描述

SearchFace根据输入图片，可以在数据库中搜索相似的人脸图片数据。

前提条件

请确保您已开通人脸人体服务，详情请参见服务开通。

输入限制

  • 图片格式：JPG、JPEG、PNG。
  • 图片大小：图片大小不超过5M。
  • 图片像素：大于5×5像素，小于4096×4096像素。人脸尺寸建议大于64×64像素。
  • URL地址中不能包含中文字符。
说明 支持图片中包含最多5个人脸，超过部分会被忽略。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 SearchFace

要执行的操作。取值：SearchFace。
DbName String 是 default

数据库名称。
ImageUrl String 是 https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/imgsearch/demo/1.png

图片URL地址。当前仅支持上海地域的OSS链接，如何生成URL请参见生成URL。

Limit Integer 是 2

搜索结果数量限制，取值范围1~1000。

返回数据

名称 类型 示例值 描述
Data Struct

返回的结果数据内容。
MatchList Array

匹配的结果列表，如果输入图像中多个人脸，则这里会返回多个数据。
FaceItems Array

匹配的人脸数据列表。
EntityId String U1

实体ID，用来标识用户的唯一性，如用户ID、员工ID等。每个用户下面会包含多张人脸图片。支持大小写字母、数字、下划线和减号的组合，长度为2~64。
ExtraData String 王小二

自定义信息（字符串）。支持字母、数字、标点符号和汉字。不超过512个字符。
FaceId String 001

人脸图片数据ID，需要全局唯一，不可重复。支持小写字母、数字和下划线的组合。长度为1~64。
Score Float 0.89

人脸的相似度，取值范围-1.0~1.0，数值越大相似度越高。
Location Struct

输入图像中的人脸坐标信息。
Height Integer 200

高度，单位像素。
Width Integer 200

宽度，单位像素。
X Integer 5

左上角x坐标。
Y Integer 6

左上角y坐标。
RequestId String 4159e64a-0fe8-436c-a8de-ee531555db3c

请求ID。

示例

请求示例

http(s)://facebody.cn-shanghai.aliyuncs.com/?Action=SearchFace
&DbName=default
&ImageUrl=https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/imgsearch/demo/1.png
&Limit=2
&<公共请求参数>

正常返回示例

XML 格式 

<RequestId>F7BF85AA-F705-4B89-A002-F23FF5FC9A05</RequestId>
<Data>
    <MatchList>
        <FaceItems>
            <FaceId>001</FaceId>
            <EntityId>U1</EntityId>
            <Score>0.8330709186044267</Score>
            <ExtraData>王小二</ExtraData>
        </FaceItems>
        <Location>
            <X>344</X>
            <Y>71</Y>
            <Height>115</Height>
            <Width>83</Width>
        </Location>
    </MatchList>
</Data>

JSON 格式 

{
  "RequestId": "F7BF85AA-F705-4B89-A002-F23FF5FC9A05",
  "Data": {
    "MatchList": [
      {
        "FaceItems": [
          {
            "FaceId": "001",
            "EntityId": "U1",
            "Score": "0.8330709186044267",
            "ExtraData": "王小二"
          }
        ],
        "Location": {
          "X": 344,
          "Y": 71,
          "Height": 115,
          "Width": 83
        }
      }
    ]
  }
}

错误码

关于搜索人脸的错误码，详情请参见常见错误码。