接入文档
人脸搜索(海外版)
API接入
创建人脸库
创建人脸库
# 描述
创建一个人脸库集合,单个人脸库最多可以储存500W张人脸,最多建立10个库
调用URL:
https://api-sgp.yljz.com/finauth/search/group/create
# 请求参数
| 参数名 | 类型 | 参数说明 | |
|---|---|---|---|
| 必选 |
sign |
String | 调用此API客户的签名,具体的签名产生方式请查阅App-鉴权说明 |
| 必选 | sign_version | String | 签名算法版本,请传递:hmac_sha1 |
| 必填 | group_name |
String |
创建的人脸库名称,不能为空字符串,1-60个字符 |
| 必选 | group_id |
String | 人脸库 ID,不可修改,不可重复。支持英文、数字、-%@#&_,长度限制48B。 示例值:YuanliStudent_01 |
| 可选 | group_data | String | 人脸库信息,不超过128个字符 |
| 可选 | model_version | String | 模型版本,人脸识别服务所用的算法模型版本。默认"s21" |
# 返回值说明
| 字段路径 | 类型 | 说明 |
|---|---|---|
| requestid |
String | 用于区分每一次请求的唯一的字符串,此字符串可以用于后续数据反查。此字段必定返回 |
| model_version | String | 人脸识别所用的算法模型版本。 示例值:s21 |
| group_id |
String |
用户自定义的人脸库的唯一标识,如果未定义则返回值为空 |
| group_name | String | 人脸库名称 |
| group_data | String | 人脸库信息 |
| error |
String |
当出现错误时会返回此字符串,具体返回内容见后续错误信息章节。否则此字段不存在。 |
| time_used |
Int |
整个请求所花费的时间,单位为毫秒。除非发生404(API_NOT_FOUND )或403 (AUTHORIZATION_ERROR)错误,此字段必定返回 |
正确请求返回示例
{
"request_id": "1769683520,2e83e40d-9402-4a18-a1ed-bacd617865b2",
"time_used": 127,
"group_id": "YuanliStudent_01",
"group_name": "实习生库_01",
"group_data": "实习生人脸库,用户存放人脸信息",
"model_version": "s21"
}
错误返回示例
{
"request_id": "1769684042,e043ea9c-92c9-4c1e-8af4-8198da8ac6c1",
"time_used": 17,
"error": "GROUP_EXIST"
}
# error_message错误信息
当前 API 特有的 ERROR_MESSAGE
| HTTP状态码 | 错误信息 | 说明 |
|---|---|---|
| 400 | GROUP_EXIST | 想要创建的人脸库已经存在 |
| 400 | GROUP_EXCEEDED | 人脸库数量达到上限,不能继续创建,最多建立10个库 |