API Path
/aipaas/cv/v2/image/chefHatCheck
请求协议
HTTPS
请求方法
POST
请求头部 :
| 头部标签 | 必填 | 说明 | 类型 | 数据字典 | 限制 | 头部内容 | 示例 |
|---|---|---|---|---|---|---|---|
| Content-Type | 是 | application/json | [string] | application/json | application/json | ||
| X-APP-ID | 是 | 控制台-应用管理-创建应用-AppID,公网鉴权,公网调用时必传 | [string] | ||||
| Device-Uuid | 是 | 设备管理-设备uuid,公网鉴权,公网调用时必传 | [string] | ||||
| Authorization | 是 | 公网鉴权,公网调用时必传 | [string] |
请求参数 Json
Object
| 参数名 | 说明 | 必填 | 类型 | 数据字典 | 限制 | 示例 |
|---|---|---|---|---|---|---|
| code | 请求状态码,固定1019 | 是 | [int] | 1019 | ||
| data | 算法参数 | 是 | [object] | |||
| data>>task_id | 算法任务id | 是 | [string] | 0d04322bee08401a9c15a5ef8643e64f | ||
| data>>camera_id | 设备编码 | 是 | [string] | A15414521025 | ||
| data>>algo_tasks | 算法参数数组 | 是 | [array] | |||
| data>>algo_tasks>>algo_config | 单个参数信息 | 是 | [object] | |||
| data>>algo_tasks>>algo_config>>version | 参数版本号,本业务不使用 | 否 | [string] | 1.0.0 | ||
| data>>algo_tasks>>algo_config>>algo_roi | roi区域配置【如果算法不支持roi,忽略此参数解析】 | 是 | [object] | |||
| data>>algo_tasks>>algo_config>>algo_roi>>roi_type | roi坐标类型,1-绝对坐标,2-相对坐标【is_full_region为true时为非必填】 | 是 | [int] | 1:绝对坐标,2:相对坐标 | 1 | |
| data>>algo_tasks>>algo_config>>algo_roi>>roi_list | 设定区域列表【is_full_region为false时为必填】 | 否 | [array] | |||
| data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>name | 区域id,需全局唯一 | 是 | [string] | 61b3a095eb0bc49 | ||
| data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>point_list | 区域坐标点集【由算法内部判断,画线至少需要2个点,画多边形区域至少需要3个点】 | 是 | [array] | |||
| data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>point_list>>x | X轴坐标 | 是 | [float] | 0.0 | ||
| data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>point_list>>y | Y轴坐标 | 是 | [float] | 1.0 | ||
| data>>algo_tasks>>algo_config>>algo_roi>>is_full_region | 是否全景图,true-是,false-否 | 是 | [boolean] | true:是,false:否 | true | |
| data>>algo_tasks>>algo_config>>algo_roi>>region_mode | 区域模式,1 中心点在区域内 其他报错 | 是 | [int] | 1:检测框中心点在区域内即代表检测目标在区域内,2:检测框脚点在区域内即代表检测目标在区域内,3:检测框中心点与脚点同时在区域内即代表检测目标在区域内,4:检测框中心点或脚点在区域内即代表检测目标在区域内 | 1 | |
| data>>algo_tasks>>algo_config>>extra_params | 额外参数,见详细说明 | 否 | [array] | |||
| data>>algo_tasks>>algo_config>>extra_params>>key | 参数名 | 是 | [string] | |||
| data>>algo_tasks>>algo_config>>extra_params>>value | 参数值 | 是 | [string] | |||
| data>>image | 图片Base64(jpeg格式base64编码)【和image二选一,优先使用image字段】 | 是 | [string] | iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAAFVBMVEX////7ODj+z8/9eHj9m5v9s7P7TEwZgBMVAAAACXBIWXMAAAsTAAALEwEAmpwYAAAATklEQVQokd2NQQqAQAzEMjNd//9kUXEXFw8eBMEcCiUlha9p8lspC6ukwDZHeBcBNcvUJICkAjwVheV2k4pUkMvzWo5U307kLiSNkz+wAvF5AMTthEMUAAAAAElFTkSuQmCC |
响应内容 :
返回结果
> 成功 (200)
> Json
> Object
| 参数名 | 说明 | 必填 | 类型 | 数据字典 | 限制 | 示例 |
|---|---|---|---|---|---|---|
| code | 算法类型,固定1020 | 是 | [int] | 1020 | ||
| data | 算法调用结果 | 是 | [object] | |||
| data>>error_code | 错误码,值为APP_ERR_OK则为成功 | 是 | [string] | APP_ERR_OK | ||
| data>>display_image | 图片jpeg编码,图片流为空 | 是 | [string] | |||
| data>>error_message | 错误描述 | 是 | [string] | 正常状态 | ||
| data>>camera_id | 创建任务时传入的设备编码 | 是 | [string] | A15414521025 | ||
| data>>task_id | 创建任务时传入的算法任务id | 是 | [string] | 0d04322bee08401a9c15a5ef8643e64f | ||
| data>>frame_id | 视频帧id | 是 | [string] | 0d04322bee08401a9c15a5ef8sldufj8 | ||
| data>>frame_width | 图片宽度 | 是 | [string] | 1920 | ||
| data>>frame_height | 图片高度 | 是 | [string] | 1080 | ||
| data>>pull_pts_ms | 拉流的时间戳;图片流为无效值,不用取值 | 是 | [string] | |||
| data>>send_pts_ms | 告警推送时的时间戳;图片流为无效值,不用取值 | 是 | [string] | |||
| data>>algo_outputs | 算法处理结果数组 | 是 | [array] | |||
| data>>algo_outputs>>roi_message | 设定区域信息 | 否 | [object] | |||
| data>>algo_outputs>>roi_message>>name | 创建任务时传入的区域id | 是 | [string] | 61b3a095eb0bc49 | ||
| data>>algo_outputs>>roi_message>>point_list | 创建任务时传入的区域坐标点集 | 是 | [array] | |||
| data>>algo_outputs>>roi_message>>point_list>>x | 创建任务时传入的X轴坐标 | 是 | [float] | 0.0 | ||
| data>>algo_outputs>>roi_message>>point_list>>y | 创建任务时传入的Y轴坐标 | 是 | [float] | 1.0 | ||
| data>>algo_outputs>>roi_message>>extra_params | 创建任务时传入的区域其他参数,此业务未使用 | 否 | [array] | |||
| data>>algo_outputs>>roi_message>>extra_params>>key | 创建任务时传入的参数名 | 是 | [string] | alarm | ||
| data>>algo_outputs>>roi_message>>extra_params>>value | 创建任务时传入的参数值 | 是 | [string] | 1 | ||
| data>>algo_outputs>>objectinfo | 检测到的目标对象数组 | 是 | [array] | |||
| data>>algo_outputs>>objectinfo>>class_name | 目标类别名称;见详细说明 | 是 | [string] | 目标类别名称 | ||
| data>>algo_outputs>>objectinfo>>class_id | 当前目标类别id; 见详细说明 | 是 | [int] | 1 | ||
| data>>algo_outputs>>objectinfo>>rect | 对象位置坐标 | 是 | [object] | |||
| data>>algo_outputs>>objectinfo>>rect>>x0 | 左上X轴坐标 | 是 | [float] | 0.0 | ||
| data>>algo_outputs>>objectinfo>>rect>>y0 | 左上Y轴坐标 | 是 | [float] | 0.0 | ||
| data>>algo_outputs>>objectinfo>>rect>>x1 | 右下X轴坐标 | 是 | [float] | 100.0 | ||
| data>>algo_outputs>>objectinfo>>rect>>y1 | 右下Y轴坐标 | 是 | [float] | 100.0 | ||
| data>>algo_outputs>>objectinfo>>confidence | 目标置信度(0~1),未知为-1 | 是 | [float] | 0.99 | ||
| data>>algo_outputs>>objectinfo>>track_id | 目标追踪ID(图片流任务不存在跟踪) | 否 | [string] | 0d04322bee0 | ||
| data>>algo_outputs>>objectinfo>>score | 目标得分,此业务未使用,值为-1 | 否 | [float] | 0.99 | ||
| data>>algo_outputs>>objectinfo>>feature | 特征值,此业务未使用 | 否 | [array] | [0.0620517209172249, 0.0471773408353329] | ||
| data>>algo_outputs>>objectinfo>>attribute | 属性值,此业务未使用 | 否 | [array] | |||
| data>>algo_outputs>>objectinfo>>attribute>>key | 属性名称 | 是 | [string] | sex | ||
| data>>algo_outputs>>objectinfo>>attribute>>value | 属性值 | 是 | [string] | 1 | ||
| data>>algo_outputs>>objectinfo>>attribute>>score | 属性置信度(0~1),未知为-1 | 是 | [float] | 0.99 | ||
| data>>algo_outputs>>objectinfo>>extra_message | 目标额外信息,见详细说明 | 否 | [array] | |||
| data>>algo_outputs>>objectinfo>>extra_message>>key | 参数名 | 是 | [string] | |||
| data>>algo_outputs>>objectinfo>>extra_message>>value | 参数值 | 是 | [string] | |||
| data>>algo_outputs>>objectinfo>>image_message | 目标图片信息,此业务未使用 | 否 | [array] | |||
| data>>algo_outputs>>objectinfo>>image_message>>key | 图片名称 | 是 | [string] | xxx.jpg | ||
| data>>algo_outputs>>objectinfo>>image_message>>value | 图片Base64【jpeg格式base64编码】 | 是 | [string] | iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAAFVBMVEX////7ODj+z8/9eHj9m5v9s7P7TEwZgBMVAAAACXBIWXMAAAsTAAALEwEAmpwYAAAATklEQVQokd2NQQqAQAzEMjNd//9kUXEXFw8eBMEcCiUlha9p8lspC6ukwDZHeBcBNcvUJICkAjwVheV2k4pUkMvzWo5U307kLiSNkz+wAvF5AMTthEMUAAAAAElFTkSuQmCC | ||
| data>>extra_message | 额外信息,本业务未使用 | 否 | [array] | |||
| data>>image_message | 图片流值为空 | 否 | [array] |
成功示例[Mock API] :
{
"code": 1020,
"data": {
"error_code": "APP_ERR_OK",
"error_message": "",
"camera_id": "A15414521025",
"task_id": "0d04322bee08401a9c15a5ef8643e64f",
"frame_id": "40",
"frame_width": "1920",
"frame_height": "1080",
"send_pts_ms": "1744079325405",
"pull_pts_ms": "0",
"display_image": "",
"algo_outputs": [{
"roi_message": {
"name": "position_0",
"point_list": [{
"x": 0,
"y": 0
}, {
"x": 1920,
"y": 0
}, {
"x": 1920,
"y": 1080
}, {
"x": 0,
"y": 1080
}],
"extra_params": []
},
"objectinfo": [{
"class_name": "white_cap",
"rect": {
"x0": 97.5625,
"y0": 240.375,
"x1": 258,
"y1": 589
},
"track_id": "",
"extra_message": [{
"key": "alarm",
"value": "0"
}],
"image_message": [],
"feature": [],
"attribute": [],
"class_id": 1,
"confidence": 0.9375,
"score": -1
}, {
"class_name": "white_cap",
"rect": {
"x0": 446.25,
"y0": 111.1875,
"x1": 649,
"y1": 385.5
},
"track_id": "",
"extra_message": [{
"key": "alarm",
"value": "0"
}],
"image_message": [],
"feature": [],
"attribute": [],
"class_id": 1,
"confidence": 0.935546875,
"score": -1
}, {
"class_name": "white_cap",
"rect": {
"x0": 1069,
"y0": 139.25,
"x1": 1194,
"y1": 384
},
"track_id": "",
"extra_message": [{
"key": "alarm",
"value": "0"
}],
"image_message": [],
"feature": [],
"attribute": [],
"class_id": 1,
"confidence": 0.934570312,
"score": -1
}]
}],
"extra_message": [],
"image_message": []
}
}
| 版本 | 算法总集版本号 | 备注 |
|---|---|---|
| 厨师帽(8000110004)- (v1.0.1.0_v2.0.0) | 初始版本 |
1.服务接口调用时需要严格遵循服务鉴权规则。
公网服务调用鉴权规则请参见:开发指南 - 接口签名认证。
1、 支持绝对坐标区域, roi_type为1。取值范围 x [0, frame_width], y [0, frame_height]
2、 支持归一化后的按比例要求区域,roi_type为2。取值范围 x,y分别为 [0,1]
3、 支持画多个区域(最多个数见pipeline_config.json配置),区域点数(支持点数见见pipeline_config.json配置)
4、 点的顺序要为逆时针或者顺时针,不能乱序。
5、支持任意边数多边形,不限凹凸,不支持有孔多边形,不支持自相交多边形,一个区域不允许它的点在本区域的其他边上,两个区域的范围不能重叠,区域的点坐标不能超出图片的大小范围,区域个数不能超过设定的最大值(最多5个)
6、 检测目标在区域内的判断逻辑
针对此算法而言,检测框底边中点在区域内即检测目标在区域内。
7、 全图检测与区域检测的传参设置
全图检测:is_full_region=true
区域检测:is_full_region=false且roi_list传相应坐标值
8、本业务默认区域设置为:最多支持5个区域,每个区域要求3-11个点
9、region_mode为1,只支持1
10、objecinfo中目标检出类别及名称
| class_id | class_name | 说明 |
|---|---|---|
| 0 | black_cap | 黑色厨师帽 |
| 1 | white_cap | 白色厨师帽 |
| 2 | blue_cap | 蓝色厨师帽 |
| 3 | red_cap | 红色厨师帽 |
| 4 | yellow_cap | 黄色厨师帽 |
| 5 | head | 未戴帽子 |
| 6 | other_color_cap | 其他色厨师帽 |
11、入参中extra_message对应key及value表(选填):
| extra_message | Array | 备注 | |
|---|---|---|---|
| "key":"sensitivity_level“ | string | 灵敏度 | |
| value": "1" | string | 代表灵敏度等级,0低,1中,2高;其他值报错无效可以省略,不填默认为1; |
12、出参中extra_message对应key及value表
| extra_message | Array | 备注 | |
|---|---|---|---|
| "key":"alarm“ | string | 该目标是否告警 | |
| value": "1" | string | 1为告警,0为不告警;class_id=5或6时,value=1告警,其他情况value=0 |
{
"data": {
"camera_id": "0",
"task_id": "perf_bllj_20230507_0601_000071.jpg",
"algo_tasks": [{
"algo_config": {
"version": "",
"algo_roi": {
"is_full_region": false,
"roi_type": 1,
"region_mode": 1,
"roi_list": [{
"name": "position_1",
"point_list": [{
"x": 0,
"y": 0
},
{
"x": 1920,
"y": 0
},
{
"x": 1920,
"y": 540
},
{
"x": 0,
"y": 540
}
]
},
{
"name": "position_2",
"point_list": [{
"x": 0,
"y": 540
},
{
"x": 0,
"y": 1080
},
{
"x": 1920,
"y": 1080
},
{
"x": 1920,
"y": 540
}
]
}
]
},
"extra_params": [{
"key": "sensitivity_level",
"value": "1"
}]
}
}],
"image": "base64"
},
"code": 1019
}
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
public class HttpUtils {
public static void sendPostRequest() {
HttpURLConnection connection = null;
try {
String code = "code";
String url = "url路径";
String appId = "appid";
String deviceUuid = "deviceUuid";
URL urlObj = new URL(url);
connection = ((HttpURLConnection) (urlObj.openConnection()));
connection.setRequestMethod("POST");
connection.setRequestProperty("Content-Type", "application/json");
connection.setRequestProperty("X-APP-ID", appId);
connection.setRequestProperty("Device-Uuid", deviceUuid);
connection.setRequestProperty("Authorization", "yourAuthorization");
connection.setDoOutput(true);
ObjectMapper objectMapper = new ObjectMapper();
ObjectNode requestBody = objectMapper.createObjectNode();
requestBody.put("code", 0);
requestBody.put("llm_check", 0);
ObjectNode dataNode = requestBody.putObject("data");
dataNode.put("task_id", "0d04322bee08401a9c15a5ef8643e64f");
dataNode.put("camera_id", "A15414521025");
ArrayNode algoTasksArray = dataNode.putArray("algo_tasks");
ObjectNode algoTaskNode = algoTasksArray.addObject();
ObjectNode algoConfigNode = algoTaskNode.putObject("algo_config");
algoConfigNode.put("version", "1.0.0");
ObjectNode algoRoiNode = algoConfigNode.putObject("algo_roi");
algoRoiNode.put("roi_type", 1);
ArrayNode roiListArray = algoRoiNode.putArray("roi_list");
ObjectNode roiListNode = roiListArray.addObject();
roiListNode.put("name", "61b3a095eb0bc49");
ArrayNode pointListArray = roiListNode.putArray("point_list");
ObjectNode pointNode = pointListArray.addObject();
pointNode.put("x", 0.0);
pointNode.put("y", 1.0);
ArrayNode extraParamsArray = roiListNode.putArray("extra_params");
ObjectNode extraParamNode = extraParamsArray.addObject();
extraParamNode.put("key", "type");
extraParamNode.put("value", "1");
algoRoiNode.put("is_full_region", true);
algoRoiNode.put("region_mode", 1);
ArrayNode extraParamsAlgoArray = algoConfigNode.putArray("extra_params");
ObjectNode extraAlgoParamNode = extraParamsAlgoArray.addObject();
extraAlgoParamNode.put("key", "");
extraAlgoParamNode.put("value", "");
dataNode.put(
"image",
"iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAAFVBMVEX////7ODj+z8/9eHj9m5v9s7P7TEwZgBMVAAAACXBIWXMAAAsTAAALEwEAmpwYAAAATklEQVQokd2NQQqAQAzEMjNd//9kUXEXFw8eBMEcCiUlha9p8lspC6ukwDZHeBcBNcvUJICkAjwVheV2k4pUkMvzWo5U307kLiSNkz+wAvF5AMTthEMUAAAAAElFTkSuQmCC");
dataNode.put(
"image_url",
"http://10.127.156.152:8081/bucket/f7884c2f-0efc-42ae-0372-e30eddddc53b.jpg");
try (OutputStream os = connection.getOutputStream()) {
byte[] input = requestBody.toString().getBytes("utf-8");
os.write(input, 0, input.length);
}
int responseCode = connection.getResponseCode();
if (responseCode == HttpURLConnection.HTTP_OK) {
try (BufferedReader br =
new BufferedReader(new InputStreamReader(connection.getInputStream(), "utf-8"))) {
StringBuilder response = new StringBuilder();
String responseLine;
while ((responseLine = br.readLine()) != null) {
response.append(responseLine.trim());
}
String responseString = response.toString();
JsonNode jsonResponse = objectMapper.readTree(responseString);
JsonNode data = jsonResponse.get("data");
}
} else {
System.out.println("POST request not worked");
}
} catch (Exception e) {
e.printStackTrace();
} finally {
if (connection != null) {
connection.disconnect();
}
}
}
}
import requests
import json
def send_post_request():
try:
# 配置参数
url = "url路径" # 替换为实际URL
app_id = "appid"
device_uuid = "deviceUuid"
authorization = "yourAuthorization"
# 构建请求头
headers = {
"Content-Type": "application/json",
"X-APP-ID": app_id,
"Device-Uuid": device_uuid,
"Authorization": authorization
}
# 构建复杂的嵌套JSON请求体
request_body = {
"code": 0,
"llm_check": 0,
"data": {
"task_id": "0d04322bee08401a9c极长Base64字符串...(此处省略完整字符串)",
"camera_id": "A15414521025",
"algo_tasks": [
{
"algo_config": {
"version": "1.0.0",
"algo_roi": {
"roi_type": 1,
"roi_list": [
{
"name": "61b3a095eb0bc49",
"point_list": [
{"x": 0.0, "y": 1.0}
],
"extra_params": [
{"key": "type", "value": "1"}
]
}
],
"is_full_region": True,
"region_mode": 1
},
"extra_params": [
{"key": "", "value": ""}
]
}
}
],
"image": "iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAAFVBMVEX////7ODj+z8/9eHj9m5v9s7P7TEwZgBM极长Base64字符串...(此处省略完整字符串)",
"image_url": "http://10.127.156.152:8081/bucket/f7884c2f-0efc-42ae-0372-e30eddddc53b.jpg"
}
}
# 发送POST请求
response = requests.post(
url=url,
headers=headers,
json=request_body, # 自动序列化为JSON
timeout=30
)
# 处理响应
if response.status_code == 200:
response_data = response.json()
# 提取data字段
data = response_data.get("data", {})
print("请求成功")
print("响应数据:", data)
return data
else:
print(f"POST请求失败,状态码: {response.status_code}")
print("响应内容:", response.text)
return None
except requests.exceptions.RequestException as e:
print(f"网络请求异常: {e}")
except json.JSONDecodeError as e:
print(f"JSON解析异常: {e}")
except Exception as e:
print(f"其他异常: {e}")
# 调用函数
if __name__ == "__main__":
send_post_request()