1.业务场景
1.1 算法仓库管理

1.1.1 查询算法列表
接口调用顺序:2.2
1.1.2 导入算法
接口调用顺序:2.1
1.1.3 删除算法
接口调用顺序:2.3
2. 原子接口
2.1. 算法导入
- 接口功能描述:算法导入;
- 接口路径:[POST] http://设备IP:9092/ks/alg;
- Header 请求参数说明:
| 参数名称 | 数据类型 | 是否必须 | 说明 |
|---|---|---|---|
| Authorization | String | 是 | 'Bearer ' + token; token通过获取token接口获取 |
| 参数名称 | 数据类型 | 是否必须 | 说明 |
|---|---|---|---|
| package | File | 是 | 算法包,应为.bin类型文件 |
表. 请求参数
- 请求示例;
| 项目 | 详情 |
|---|---|
| 请求格式 | Form Data |
| package | (binary) |
- 响应参数说明;
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| error_code | Int | 返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误 |
| message | String | 返回响应信息 |
| data | Null/Object | null |
- 响应示例。
| 项目 | 详情 |
|---|---|
| 报文格式 | JSON |
| 报文内容 |
2.2. 算法查询
- 接口功能描述:对盒子算法查询;
- 接口路径:[GET] http://盒子IP:9092/ks/alg;
- Header 请求参数说明:
| 参数名称 | 数据类型 | 是否必须 | 说明 |
|---|---|---|---|
| Authorization | String | 是 | 'Bearer ' + token; token通过获取token接口获取 |
| 项目 | 详情 |
|---|---|
| 请求格式 | Query String |
- 响应参数说明;
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| error_code | Int | 返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误 |
| message | String | 返回响应信息 |
| data | Object | 返回数据,具体字段看下发接口 |
- 响应示例。
| 项目 | 详情 |
|---|---|
| 报文格式 | JSON |
| 报文内容 | {
"error_code": 0,
"message": "查询算法成功!",
"data": [
{
"id": 1,
"name": "black_screen",
"config": {
"desc": "适用于医院、商场屏幕黑屏异常检测;需标定黑屏检测区域;识别距离小于15m最佳(200万@6mm);灵敏度值越大,检测越灵敏",
"model": {
"zql_black_screen": null
},
"group_name": "行业定制",
"alert_label": [],
"display_name": "黑屏检测",
"process_time": 10
},
"version": "ks968-20251027"
}
]
} |
2.3. 算法删除
- 接口功能描述:删除盒子设备算法;
- 接口路径:[DELETE] http://盒子IP:9092/ks/alg;
- Header 请求参数说明:
| 参数名称 | 数据类型 | 是否必须 | 说明 |
|---|---|---|---|
| Authorization | String | 是 | 'Bearer ' + token; token通过获取token接口获取 |
| 参数名称 | 数据类型 | 是否必须 | 说明 |
|---|---|---|---|
| name | String | 是 | 算法名,如helmet |
表. 请求参数
- 请求示例;
| 项目 | 详情 |
|---|---|
| 请求格式 | JSON |
| 报文内容 | { "name": "helmet" } |
- 响应参数说明;
| 参数名称 | 数据类型 | 说明 |
|---|---|---|
| error_code | Int | 返回响应码 0: 成功 -1: 客户端错误 -2: 服务端错误 |
| message | String | 返回响应信息 |
| data | Null/Object | null |
- 响应示例。
| 项目 | 详情 |
|---|---|
| 报文格式 | JSON |
| 报文内容 | { "data": null, "error_code": 0, "message": "删除算法成功!" } |
真诚点赞 诚不我欺
回复