csair_visual_project/API_Docs/安检行为检测接口文档 .md

115 lines
3.1 KiB
Markdown
Raw Normal View History

2025-03-06 11:15:51 +08:00
# 安检行为检测接口文档
## 一、接口概述
本接口旨在对视频源进行安检行为检测,可精准定位检测时间与空间范围,明确需检测的行为种类及相关量化阈值,同时支持模型参数调整,以适配不同应用场景的安检需求。
## 二、接口信息
### 1. 接口地址
`http://{ip:port}/security_inspection_behavior_detection`
### 2. 请求方法
`POST`
### 3. 请求头
```
Content-Type: application/json
```
## 三、请求参数
| 参数名 | 类型 | 是否必填 | 描述 |
| ----------- | ------ | -------- | ------------------------------------------------------------ |
| input\_type | String | 是 | 输入类型,取值为`mp4、`rtsp |
| input\_data | String | 是 | 若`input_type`为`mp4`,则为视频文件的本地路径或 URL若为`rtsp`,则为 RTSP 流地址 |
| camera\_id | String | 是 | 摄像头的唯一标识符,用于关联特定的监控设备 |
| start\_time | String | 是 | 检测起始时间,格式为`YYYY-MM-DD HH:MM:SS` |
| info | Object | 否 | 预留字段,用于传递额外信息,如模型参数等,以字典形式存储 |
### 请求参数示例
```markdown
{
"input_type": "rtsp",
"input_data": "rtsp://security_camera_01.com/stream",
"camera_id": "SEC_CAM_001",
"start_time": "2024-10-01 08:00:00",
"info": {
"detection_threshold": 0.8
}
}
```
## 四、响应参数
2025-03-06 16:41:30 +08:00
| 参数名 | 类型 | 描述 |
| ------------- | ------- | ----------------------------------------------------- |
| status | Integer | 响应状态码200 表示成功,其他表示失败 |
| message | String | 状态描述信息,如 "Success" 或 "Input parameter error" |
| inspection_id | Integer | 检测序号 |
| is_compliant | Boolean | 是否合规true 表示合规false 表示不合规 |
2025-03-06 11:15:51 +08:00
### 响应参数示例
```markdown
{
2025-03-06 16:41:30 +08:00
"code": 200,
"res":{
"message": "发起检测成功",
}
2025-03-06 11:15:51 +08:00
}
```
## 五、错误处理
| 状态码 | 描述 |
| --- | -------------------------------------------------- |
| 400 | 输入参数错误,如参数缺失、格式不正确、`behavior_types`中行为类型不存在于预定义列表等 |
| 404 | 未找到指定的视频文件、无法连接到 RTSP 流或摄像头设备 |
| 500 | 服务器内部错误,如模型加载失败、计算资源不足、检测过程中出现异常 |
### 错误响应示例
```markdown
{
"status": 400,
"message": "输入参数错误start_time格式不正确应为YYYY-MM-DD HH:MM:SS",
}
```
2025-03-06 16:41:30 +08:00
## 六、结果写入
2025-03-06 11:15:51 +08:00
```markdown
{
2025-03-06 16:41:30 +08:00
"code": 200,
"res": {
"message": "读取结果成功",
"data": {
"inspection_id": 1
"is_compliant": true,
}
}
2025-03-06 11:15:51 +08:00
}
```