智驱力社区

1. 添加人脸库

接口功能描述：添加人脸姓名、性别等至底库，最多1000个人脸；
接口路径：[POST] http://设备IP:9091/ks/face
接口说明：如需上传人脸图片，请参照9.3.8.6修改人脸图像接口。
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
external_id	String	否	外部id
name	String	是	姓名
sex	String	否	性别
age	String	否	年龄
desc	String	否	简介

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "group_id": "6593e3aa522e4b9ab8454f54", "external_id": "98", "name": "小明", "sex": "男", "age": "10" }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	String	id

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": "6593e3aa522e4b9ab8454f54", "error_code": 0, "message": { "zh": "新增人脸成功！", "en": "Add face successful!" } }

2. 修改人脸库

接口功能描述：修改人脸库信息；
接口路径：[PUT] http://设备IP:9091/ks/face；
请求参数说明；

参数名称	数据类型	是否必须	说明
id	String	否	人脸id
group_id	String	否	若同时存在group_id和external_id则忽略id
external_id	String	否
name	String	否	姓名
sex	String	否	性别
age	String	否	年龄
desc	String	否	简介

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "group_id": "6593e3aa522e4b9ab8454f54", "external_id": "98" }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "更新人脸成功！", "en": "Update face successful!" } }

3. 查询人脸库

接口功能描述：查询人脸（按设备、姓名、外部id、更新时间查询）；
接口路径：[GET] http://设备IP:9091/ks/face；
请求参数说明；

参数名称	数据类型	是否必须	说明
page	Int	是	页码
size	Int	是	每页数量
group_id	String	否	分组ID
external_id	String	否	外部id
name	String	否	姓名
start_time	Int	否	开始时间秒数
end_time	Int	否	结束时间秒数

表. 请求参数

请求示例；

项目	详情
请求格式	Query String
page	1
size	10
group_id	6593e3aa522e4b9ab8454f54
name	"1"

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目

详情

报文格式

JSON

报文内容

{
    "error_code": 0,
    "message": {
        "zh": "查询人脸成功！",
        "en": "Query face successful!"
    },
    "data": {
        "data": [
            {
                "id": "66f140cb5dc58a689059a3c2",
                "external_id": null,
                "group_id": "6593e3aa522e4b9ab8454f54",
               "name": "1",
                "age": 2,
                "sex": null,
                "desc": null,
                "feature": "[0.0016012939158827066,…]",
                "image": "/home/ema/ks/…… ",
                "update_time": 1727086969
            }
        ],
        "total": 1
    }
}

4. 删除人脸库

接口功能描述：删除人脸；
接口路径：[DELETE] http://设备IP:9091/ks/face；
请求参数说明；

参数名称	数据类型	是否必须	说明
ids	Array	否	人脸id数组
group_id	String	否	若存在group_id，或者同时存在group_id和external_ids，则忽略ids
external_ids	Array	否

表. 请求参数

请求示例；

项目	详情
请求格式	JSON
报文内容	{ "ids": ["6593e3aa522e4b9ab8454f54"] }

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": "删除人脸成功！" }

5. 载入底库

接口功能描述：增加、修改、删除后需要调用一次使其生效，为避免影响检测，此接口不能频繁调用，最好是一批操作结束后通知用户手动调用；
接口路径：[POST] http://设备IP:9091/ks/face/load；
请求参数说明：无；
响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "载入成功！", "en": "Successful loaded!" } }

6. 添加或修改人脸图像

接口功能描述：添加或者修改人脸图像；
接口路径：[PUT] http://设备IP:9091/ks/face/image；
请求参数说明；

参数名称	数据类型	是否必须	说明
id	String	否	人脸id
group_id	String	否	若同时存在group_id和external_id则忽略id
external_id	String	否
image	File	是	人脸图片

表. 请求参数

请求示例；

项目	详情
请求格式	Form Data
id	6593e3aa522e4b9ab8464f56
image	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "更新人脸成功！", "en": "Update face successful!" } }

7. 下载模板

接口功能描述：下载模板；
接口路径：[GET] http://设备IP:9091/ks/face/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
template	Bool	是	true

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Query String
group_id	6593e3aa522e4b9ab8454f54
template	true

响应参数说明；

参数名称	数据类型	说明
data	String	文件流

响应示例。

项目	详情
报文格式	文件流
报文内容	略

8. 批量导入

接口功能描述：批量导入；
接口路径：[POST] http://设备IP:9091/ks/face/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID
package	File	是	文件

表. 请求参数

请求示例；

项目	详情
请求格式	Form Data
group_id	6593e3aa522e4b9ab8454f54
package	(binary)

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": null, "error_code": 0, "message": { "zh": "导入人脸底库成功！", "en": "Import face library successful!" } }

9. 批量导出

接口功能描述：批量导出人脸底库；
接口路径：[GET] http://设备IP:9091/ks/face/xlsx；
请求参数说明；

参数名称	数据类型	是否必须	说明
group_id	String	是	分组ID

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Query String
group_id	6593e3aa522e4b9ab8454f54

响应参数说明；

参数名称	数据类型	说明
data	String	文件流

响应示例。

项目	详情
报文格式	文件流
报文内容	略

10. 提取人脸特征

接口功能描述：根据传入的人脸图片提取人脸特征；
接口路径：[POST] http://设备IP:9091/ks/face/feature；
请求参数说明；

参数名称	数据类型	是否必须	说明
image	File	是	人脸图片
quality	Float	否	人脸质量阈值（默认值：0.35），当小于此阈值时将不提取特征

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

请求示例；

项目	详情
请求格式	Form Data
Image	(binary)
quality	0.35

响应参数说明；

参数名称	数据类型	说明
error_code	Int	返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误
message	String	返回响应信息
data	Null/Object	null

响应示例。

项目	详情
报文格式	JSON
报文内容	{ "data": […], "error_code": 0, "message": { "zh": "提取人脸特征成功！", "en": "Extract face feature successful!" } }

1. 添加人脸库

2. 修改人脸库

3. 查询人脸库

4. 删除人脸库

5. 载入底库

6. 添加或修改人脸图像

7. 下载模板

8. 批量导入

9. 批量导出

10. 提取人脸特征

底库管理-人脸底库