# 描述

此接口提供在指定人脸库中进行1比N人脸比对功能。

调用URL：

https://api-sgp.yljz.com/finauth/search/group/search

# 请求参数

是否必选	参数名	类型	参数说明
必选	sign	String	调用此API客户的签名，具体的签名产生方式请查阅”鉴权说明“文档
必选	sign_version	String	签名算法版本，请传递：hmac_sha1
必选	group_id	String	用户自定义的人脸库标识
必选二选一	image	String	图片 base64 数据若图片中包含多张人脸，只选取其中人脸面积最大的人脸。支持PNG、JPG、JPEG、BMP、jfif，不支持 GIF 图片
	file	File	图片文件，支持PNG、JPG、JPEG、BMP、jfif，不支持 GIF 图片
选填	limit	int	限制返回结果的数量，取比对分数最高的前limit个默认值为1，最大100
选填	threshold	Float	出参中，只有超过threshold值的结果才会返回。默认为0。示例值：阈值建议待补充 0-10w人脸库范围 1e-3：误识率为千分之一的置信度阈值阈值建议75 1e-4：误识率为万分之一的置信度阈值阈值建议80 1e-5：误识率为十万分之一的置信度阈值；阈值建议85 1e-6：误识率为百万分之一的置信度阈值；阈值建议 90 10w-500w人脸库范围 1e-3：误识率为千分之一的置信度阈值；80 1e-4：误识率为万分之一的置信度阈值；85 1e-5：误识率为十万分之一的置信度阈值；90 1e-6：误识率为百万分之一的置信度阈值；95
可选	multi_oriented_detection	String	对image参数启用图片旋转检测功能。当image参数中传入的图片未检测到人脸时，是否对图片尝试旋转90度、180度、270度后再检测人脸。本参数取值只能是 "1"或 "0" （缺省值为"0"）: "1"：启用旋转检测（启用旋转检测后，会增加API的调用时间） "0"：不启用旋转检测其他值：返回错误码400（BAD_ARGUMENTS）注意：设置此参数为1可能会轻微增加误检人脸的概率，如果您明确您的业务场景里不存在非正向的人脸图片、或概率极低，建议勿设置此参数

# 返回值说明

API返回的为一个JSON字符串。

字段	类型	说明
time_used	Int	整个请求所花费的时间，单位为毫秒。
request_id	String	用于区分每一次请求的唯一的字符串。
error	String	当请求失败时才会返回此字符串，具体返回内容见后续错误信息章节。否则此字段不存在。
result	array	搜索结果
face_token	string	人脸token
group_id	string	用户ID
score	float	得分

返回值示例

正确请求返回示例

{
    "request_id": "1769742796,8628c588-244c-434e-a423-5fa8d3c5a74a",
    "time_used": 705,
    "result": [
        {
            "face_token": "0b25c78e8c62976767d190b0c5490af0",
            "user_id": "test_002",
            "score": 97.80590807301392
        }，
        {
            "face_token": "0b25c78e8c62976767d190b0c5490af0",
            "user_id": "test_002",
            "score": 96.80590807301392
        }
    ]
}

错误返回示例

{
    "request_id": "1769684828,e483ae63-913b-4e32-9068-3719cce59570",
    "time_used": 15,
    "error": "INVALID_GROUP_ID"
}

# error_message错误信息

当前API特有ERROR_MESSAGE

HTTP状态码	错误信息	说明
400	INVALID_OUTER_ID	人脸库不存在
400	NO_FACE_FOUND	未找到人脸