上传文件至 API_Docs

This commit is contained in:
zhangpengju 2025-03-06 16:41:30 +08:00
parent 541a785955
commit 8b01a3d912
2 changed files with 54 additions and 63 deletions

View File

@ -28,8 +28,8 @@ Content-Type: application/json
| input\_data | String | 是 | 若`input_type`为`mp4`,则为视频文件的本地路径或 URL若为`rtsp`,则为 RTSP 流地址 |
| camera\_id | String | 是 | 摄像头的唯一标识符,用于关联特定的监控设备 |
| start\_time | String | 是 | 检测起始时间,格式为`YYYY-MM-DD HH:MM:SS` |
| intrusion\_direction | Integer | 是 | 入侵方向0 代表`右至左`1 代表`上至下`2 代表`左至右`3 代表`下至上` |
| risk\_area\_extension | Integer | 是 | 风险区域延长基准数值,默认为 100 像素点 |
| intrusion\_direction | Array | 是 | 入侵方向0 代表`右至左`1 代表`上至下`2 代表`左至右`3 代表`下至上` |
| risk\_area\_extension | Integer | 是 | 风险区域范围标尺值 |
| info | Object | 否 | 预留字段,用于传递额外信息,如模型参数等,以字典形式存储 |
### 请求参数示例
@ -56,14 +56,17 @@ Content-Type: application/json
| message | String | 状态描述信息 |
| is_intrusion | String | 是否存在围界入侵取值为true或false |
| intrusion_timestamp | String | 入侵发生的时间戳格式为YYYY-MM-DD HH:MM:SS。当is_intrusion为false时该字段可不填 |
| request_id | String | 当前请求的唯一标识符,用于与历史请求对齐 |
| result_file_path | String | 检测结果落盘的文件路径,用于对齐落盘文件 |
### 响应参数示例
```markdown
{
"status": 200,
"message": "检测成功",
"data": {}
"code": 200,
"res":{
"message": "发起检测成功",
}
}
```
@ -86,30 +89,42 @@ Content-Type: application/json
}
```
## 六、结果写入(待定)
## 六、结果写入
存在入侵情况
```
```markdown
{
"status": 200,
"message": "检测成功",
"data": {
"is_intrusion": true,
"intrusion_timestamp": "2024-01-01 10:02:30"
}
"code": 200,
"res": {
"message": "读取结果成功",
"data": {
"is_intrusion": true,
"intrusion_timestamp": "2024-01-01 10:02:30"
"request_id": "123456789",
"result_file_path": "/path/to/result/file.json"
}
}
}
```
不存在入侵情况
```
```markdown
{
"status": 200,
"message": "检测成功",
"data": {
"is_intrusion": false
}
"code": 200,
"res": {
"message": "读取结果成功",
"data": {
"is_intrusion": false,
"request_id": "123456789",
"result_file_path": "/path/to/result/file.json"
}
}
}
```

View File

@ -54,12 +54,12 @@ Content-Type: application/json
| 参数名 | 类型 | 描述 |
| ------------------------ | ------- | ------------------------------------------------------------ |
| status | Integer | 响应状态码200 表示成功,其他表示失败 |
| message | String | 状态描述信息,如 "Success" 或 "Input parameter error" |
| total\_inspected\_people | Integer | 安检总人数 |
| inspection\_details | Array | 每个人的安检详细信息列表,每个元素包含以下内容: - `person_id`: 人员唯一标识 -`front_*_inspected`和`back_*_inspected`身体正反面的各部位 是否经过安检经过安检为true未安检为false |
| 参数名 | 类型 | 描述 |
| ------------- | ------- | ----------------------------------------------------- |
| status | Integer | 响应状态码200 表示成功,其他表示失败 |
| message | String | 状态描述信息,如 "Success" 或 "Input parameter error" |
| inspection_id | Integer | 检测序号 |
| is_compliant | Boolean | 是否合规true 表示合规false 表示不合规 |
### 响应参数示例
@ -67,9 +67,10 @@ Content-Type: application/json
```markdown
{
"status": 200,
"message": "检测成功",
"data":{}
"code": 200,
"res":{
"message": "发起检测成功",
}
}
```
@ -94,44 +95,19 @@ Content-Type: application/json
}
```
## 六、结果写入(待定)
## 六、结果写入
```markdown
{
"status": 200,
"message": "检测成功",
"data":{
"total_inspected_people": 10,
"inspection_details": [
{
"person_id": 1,
"front_head_inspected": true,
"front_upper_body_inspected": true,
"front_arms_inspected": true,
"front_legs_inspected": true,
"front_shoes_inspected": true,
"back_head_inspected": true,
"back_upper_body_inspected": true,
"back_arms_inspected": true,
"back_legs_inspected": true,
"back_shoes_inspected": true
},
{
"person_id": 2,
"front_head_inspected": true,
"front_upper_body_inspected": true,
"front_arms_inspected": false,
"front_legs_inspected": false,
"front_shoes_inspected": true,
"back_head_inspected": true,
"back_upper_body_inspected": true,
"back_arms_inspected": false,
"back_legs_inspected": false,
"back_shoes_inspected": true
},
// 其他人员的安检信息
]
}
"code": 200,
"res": {
"message": "读取结果成功",
"data": {
"inspection_id": 1
"is_compliant": true,
}
}
}
```