1.业务场景

1.1.分组管理

1.1.1.新增分组

接口调用顺序：2.1.1

1.1.2.编辑分组

接口调用顺序：2.1.2

1.1.3.查询分组

接口调用顺序：2.1.3

1.1.4.删除分组

接口调用顺序：2.1.4

1.2.人脸底库

1.2.1.添加人脸分组内的人脸

人脸管理前端示例代码（点击此处跳转）
接口调用顺序：2.1.3 -> 2.2.1 ->2.2.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.2.1：新增人脸信息
2.2.5：对新增的人脸绑定图片

1.2.2.修改人脸分组内的人脸

接口调用顺序：2.1.3 -> 2.2.3 -> 2.2.2 -> 2.2.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.2.3：查询人脸信息，获取人脸信息ID
2.2.2：修改人脸结构化信息
2.2.5：修改人脸图片信息

1.2.3.查询人脸分组内的人脸

接口调用顺序：2.1.3 -> 2.2.3
说明：
2.1.3：查询分组信息，获取分组ID
2.2.3：查询人脸信息列表

1.2.4.删除人脸分组内的人脸

接口调用顺序：2.1.3 -> 2.2.3 -> 2.2.4
说明：
2.1.3：查询分组信息，获取当前分组ID
2.2.3：查询人脸信息，获取人脸信息ID
2.2.4：删除人脸

1.2.5.批量导入人脸

接口调用顺序：2.1.3 -> 2.2.7
说明：
2.1.3：查询分组信息，获取分组ID
2.2.7：导入人脸包

1.2.6.批量导出人脸

接口调用顺序：2.1.3 -> 2.2.8
说明：
2.1.3：查询分组信息，获取分组ID
2.2.8 ：导出人脸包

1.3.工服底库

1.3.1.添加工服分组内的工服

接口调用顺序：2.1.3 -> 2.3.1 -> 2.3.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.3.1：新增工服信息
2.3.5：对新增的工服绑定图片

1.3.2.修改工服分组内的工服

接口调用顺序：2.1.3 -> 2.3.3 -> 2.3.2 -> 2.3.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.3.3：查询工服信息，获取工服信息ID
2.3.2：修改工服结构化信息
2.3.5：修改工服图片信息

1.3.3.查询工服分组内的工服

接口调用顺序：2.1.3 -> 2.3.3
说明：
2.1.3：查询分组信息，获取分组ID
2.3.3：查询工服信息列表

1.3.4.删除工服分组内的工服

接口调用顺序：2.1.3 -> 2.3.3 -> 2.3.4
说明：
2.1.3：查询分组信息，获取当前分组ID
2.3.3：查询工服信息，获取工服信息ID
2.3.4：删除工服

1.3.5.批量导入工服

接口调用顺序：2.1.3 -> 2.3.7
说明：
2.1.3：查询分组信息，获取分组ID
2.3.7：导入工服包

1.3.6.批量导出工服

接口调用顺序：2.1.3 -> 2.3.8
说明：
2.1.3：查询分组信息，获取分组ID
2.3.8 ：导出工服包

1.4.PPE底库

1.4.1.添加PPE分组内的PPE

接口调用顺序：2.1.3 -> 2.4.1 -> 2.4.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.4.1：新增PPE信息
2.4.5：对新增的PPE绑定图片

1.4.2.修改PPE分组内的PPE

接口调用顺序：2.1.3 -> 2.4.3 -> 2.4.2 -> 2.4.5
说明：
2.1.3：查询分组信息，获取当前分组ID
2.4.3：查询PPE信息，获取工服信息ID
2.4.2：修改PPE结构化信息
2.4.5：修改PPE图片信息

1.4.3.查询PPE分组内的PPE

接口调用顺序：2.1.3 -> 2.4.3
说明：
2.1.3：查询分组信息，获取分组ID
2.4.3：查询PPE信息列表

1.4.4.删除PPE分组内的PPE

接口调用顺序：2.1.3 -> 2.4.3 -> 2.4.4
说明：
2.1.3：查询分组信息，获取当前分组ID
2.4.3：查询PPE信息，获取PPE信息ID
2.4.4：删除PPE

1.4.5.批量导入PPE

接口调用顺序：2.1.3 -> 2.4.7
说明：
2.1.3：查询分组信息，获取分组ID
2.4.7：导入PPE包

1.4.6.批量导出PPE

接口调用顺序：2.1.3 -> 2.4.8
说明：
2.1.3：查询分组信息，获取分组ID
2.4.8 ：导出PPE包

2.原子接口

2.1 分组管理

2.1.1. 添加分组

• 接口功能描述：添加人脸等底库前，先添加分组，使底库能以分组形式管理

• 接口路径：[POST] http://盒子IP:9092/ks/feat_lib/group

• Header请求参数说明；

• Body请求参数说明；

{
    // alg为face时
    "quality": 0.65,   // 人脸质量
    "confidence": 0.5   // 人脸检测置信度
// alg为work_clothes时ext不传

// alg为ppe时ext不传

// alg为open_lib且需要绘制ROI时
"alg": "open_lib",
"name": "111",
"ext": {
    "roi": [
        {
            "id": "7a9065e6-0b20-4f94-b459-7fe5dafdfa17",
            "name": "",
            "coord": [
                [0,0],
                [1269,0],
                [1269,790],
                [0,790]
            ]
        }
    ],
    "imgInfo": {
        "width": 1269,
        "height": 790,
        "mapWidth": 640,
        "mapHeight": 398
    },
    "image": "data:image/png;base64,iVBO..."
}

}

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.1.2. 修改分组

• 接口功能描述：修改分组信息；

• 接口路径：[PUT] http://盒子IP:9092/ks/feat_lib/group；

• Header请求参数说明；

• Body请求参数说明；

{
    // alg为face时
    "quality": 0.65,   // 人脸质量
    "confidence": 0.5  // 人脸检测置信度
// alg为work_clothes时ext不传

// alg为ppe时ext不传

// alg为open_lib且需要绘制ROI时
"roi": [
    {
        "id": "8c6696ff-e89d-4e40-bbd5-d67a8eaed10a",
        "name": "",
        "coord": [
            [273,176],
            [908,170],
            [848,477],
            [133,479]
        ]
    }
],
"imgInfo": {  // 仅用于显示，可以不传
    "width": 1280,
    "height": 720,
    "mapWidth": 642,
    "mapHeight": 361
}

// alg为open_lib不需要绘制ROI时，ext不传

}

• 请求示例；

• 响应参数说明；

• 响应示例。

2.1.3. 查询分组

• 接口功能描述：查询分组；

• 接口路径：[GET] http://盒子IP:9092/ks/feat_lib/group；

• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

{
    "error_code": 0,
    "message": "查询底库分组成功！",
    "data": [
        {
            "id": "6911aabceb712e0ca052f6ba",
            "name": "111",
            "alg": "open_lib",
            "ext": {
                "roi": [
                    {
                        "id": "b36ff490-2982-4440-9c7e-ad9cb41522f8",
                        "name": "",
                        "coord": [
                            [755,317],
                            [1135,291],
                            [1135,246]
                        ]
                    }
                ],
                "image": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/==",
                "imgInfo": {
                    "width": 1422,
                    "height": 800,
                    "mapWidth": 640,
                    "mapHeight": 360
                }
            },
            "update_time": 1762765500
        }
    ]
}

• 接口功能描述：删除分组；

• 接口路径：[DELETE] http://盒子IP:9092/ks/feat_lib/group；

• Header请求参数说明；

• Body请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.2 人脸底库

2.2.1. 添加人脸分组中的人脸信息

• 接口功能描述：添加人脸姓名、性别等至底库，最多1000个人脸；

• 接口路径：[POST] http://盒子IP:9092/ks/feat_lib/face

• Header请求参数说明；

• Body请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.2.2 修改人脸分组中的人脸信息

• 接口功能描述：修改人脸库信息；

• 接口路径：[PUT] http://盒子IP:9092/ks/feat_lib/face；

• Header请求参数说明；

• Body请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.2.3. 查询人脸分组中的人脸信息

• 接口功能描述：查询人脸（按设备、姓名、外部id、更新时间查询）；

• 接口路径：[GET] http://盒子IP:9092/ks/feat_lib/face；

• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

{
    "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
    }
}

2.2.4. 删除人脸分组中的人脸信息

• 接口功能描述：删除人脸；

• 接口路径：[DELETE] http://盒子IP:9092/ks/feat_lib/face；

• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.2.5. 添加或修改人脸图像

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

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.2.6. 下载人脸导入模板

• 接口功能描述：下载模板；
• 接口路径：[GET] http://盒子IP:9092/ks/feat_lib/face/xlsx；
• Header请求参数说明；

表. 请求参数

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

• 请求示例；

• 响应参数说明；

• 响应示例。

2.2.7. 批量导入人脸

• 接口功能描述：批量导入；

• 接口路径：[POST] http://盒子IP:9092/ks/feat_lib/face/xlsx；

• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.2.8. 批量导出人脸

• 接口功能描述：批量导出人脸底库；
• 接口路径：[GET] http://盒子IP:9092/ks/feat_lib/face/xlsx；
• Header请求参数说明；

表. 请求参数

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

• 请求示例；

• 响应参数说明；

• 响应示例。

2.2.9. 提取人脸特征

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

表. 请求参数

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

• 请求示例；

• 响应参数说明；

• 响应示例。

2.3 工服底库

2.3.1. 在工服分组中添加工服

• 接口功能描述：添加工服信息至底库，最多1000个工服；
• 接口路径：[POST] http://盒子IP:9092/ks/feat_lib/work_clothes；
• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.3.2. 修改工服组中的工服信息

• 接口功能描述：修改工服库信息；
• 接口路径：[PUT] http://盒子IP:9092/ks/feat_lib/work_clothes；
• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.3.3. 查询工服分组中的工服

• 接口功能描述：查询工服（按设备、名称、外部id、更新时间查询）；
• 接口路径：[GET] http://盒子IP:9092/ks/feat_lib/work_clothes；
• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.3.4. 删除工服组中的工服

• 接口功能描述：删除工服；
• 接口路径：[DELETE] http://盒子IP:9092/ks/feat_lib/work_clothes；
• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明

• 响应示例

2.3.5. 添加或修改工服图像

• 接口功能描述：添加或者修改工服图像；
• 接口路径：[PUT] http://盒子IP:9092/ks/feat_lib/work_clothes/image；
• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.3.6. 下载工服导入模板

• 接口功能描述：下载模板；
• 接口路径：[GET] http://盒子IP:9092/ks/feat_lib/work_clothes/xlsx；
• Header请求参数说明；

表. 请求参数

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

• 请求示例；

• 响应参数说明；

• 响应示例。

2.3.7. 批量导入工服

• 接口功能描述：批量导入；
• 接口路径：[POST] http://盒子IP:9092/ks/feat_lib/work_clothes/xlsx；
• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.3.8. 批量导出工服

• 接口功能描述：批量导出工服底库；
• 接口路径：[GET] http://盒子IP:9092/ks/feat_lib/work_clothes/xlsx；
• Header请求参数说明；

表. 请求参数

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

• 请求示例；

• 响应参数说明；

• 响应示例。

2.3.9. 提取工服特征

• 接口功能描述：根据传入的工服图片提取工服特征；
• 接口路径：[POST] http://盒子IP:9092/ks/feat_lib/work_clothes/feature；
• Header请求参数说明；

表. 请求参数

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

• 请求示例；

• 响应参数说明；

• 响应示例。

2.4 PPE底库

2.4.1. 添加PPE分组中的PPE信息

• 接口功能描述：添加PPE信息至底库，添加前判断限制最多1000个PPE信息；
• 接口路径：[POST] http://盒子IP:9092/ks/feat_lib/ppe；
• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.4.2. 修改PPE分组中的PPE信息

• 接口功能描述：修改PPE信息；
• 接口路径：[PUT] http://盒子IP:9092/ks/feat_lib/ppe；
• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.4.3. 查询PPE分组中的PPE信息

• 接口功能描述：查询PPE（按设备、分组、名称、外部id、更新时间查询）；
• 接口路径：[GET] http://盒子IP:9092/ks/feat_lib/ppe；
• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.4.4. 删除PPE分组中的PPE信息

• 接口功能描述：删除工服；
• 接口路径：[DELETE] http://盒子IP:9092/ks/feat_lib/ppe；
• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明

• 响应示例

2.4.5. 添加或修改PPE图像

• 接口功能描述：添加或者修改PPE图像；
• 接口路径：[PUT] http://盒子IP:9092/ks/feat_lib/ppe/image；
• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.4.6. 下载PPE导入模板

• 接口功能描述：下载模板；
• 接口路径：[GET] http://盒子IP:9092/ks/feat_lib/ppe/xlsx；
• Header请求参数说明；

表. 请求参数

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

• 请求示例；

• 响应参数说明；

• 响应示例。

2.4.7. 批量导入PPE

• 接口功能描述：批量导入；
• 接口路径：[POST] http://盒子IP:9092/ks/feat_lib/ppe/xlsx；
• Header请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2.4.8. 批量导出PPE

• 接口功能描述：批量导出ppe底库；
• 接口路径：[GET] http://盒子IP:9092/ks/feat_lib/ppe/xlsx；
• Header请求参数说明；

表. 请求参数

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

• 请求示例；

• 响应参数说明；

• 响应示例。

2.4.9. 提取PPE特征

• 接口功能描述：根据传入的PPE图片提取特征；
• 接口路径：[POST] http://盒子IP:9092/ks/feat_lib/ppe/feature；
• Header请求参数说明；

表. 请求参数

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

• 请求示例；

• 响应参数说明；

• 响应示例。