人脸搜索
更新时间: 2025/03/05 16:07:31接口说明
用于在指定的人脸集合中找到最相似的人脸。如果图中存在多张人脸,只会选择最大的那张进行搜索。
搜索成功时返回一个用户及其匹配的分数;搜索失败时返回相应的错误码。
接口URL
https://sdk.cloudroom.com/CLOUDMEETING-API/v1/face/search
请求方式:POST
请求参数
Header
| 名称 | 参数值 | 是否必传 | 说明 |
|---|---|---|---|
| Content-Type | multipart/form-data | 是 | 请求头 |
Body
接口参数
| 参数名称 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| GroupId | String | 是 | 用户组id,从指定的组中进行查找 |
| Image | File | 是 | 人脸图片,人脸必须是正面无遮挡人脸,大小不可超过5M,分辨率小于4000*2000,支持 PNG、JPG、JPEG 格式; |
| MatchThreshold | Double | 否 | 分数匹配阈值,范围【0~100】,设置阈值后出参Score低于此阈值的用户信息将不会返回,推荐使用阈值70分 |
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| RspCode | Integer | 错误码 |
| RspDesc | String | 描述 |
| Data | Map | 数据集合 |
Data参数说明:
| 名称 | 类型 | 说明 |
|---|---|---|
| FaceId | String | 人脸图片id |
| GroupId | String | 用户组id |
| PersonId | String | 用户id |
| PersonInfo | String | 用户信息 |
| Score | Double | 用户的匹配得分,范围【0~100】 |
示例
请求示例
curl -X POST https://sdk.cloudroom.com/CLOUDMEETING-API/v1/face/search \
-H "Content-Type: multipart/form-data" \
-F "RequestId=2d95a5fe-a384-5dea-0d84-db153b10ee0f" \
-F "AppId=demo" \
-F "CompID=1" \
-F "SecretKey=a7febff6a21c36fb50150f88c95ef641" \
-F "GroupId=test_group_1" \
-F "Image=@face.jpg"
返回示例
{
"RspCode":0,
"RspDesc":"请求成功",
"Data":{
"FaceId":"fid1",
"GroupId":"group1",
"PersonId":"1001",
"PersonInfo":"张三",
"Score":97.83
}
}
错误码
上述接口在 Body 中返回请求的错误码,详情请参见 错误码