API Path
/aipaas/cv/v2/image/crowdpiling
请求协议
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] | |||
| llm_check | (该算法不生效)是否调用大模型 | 否 | [int] | |||
| 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>>roi_list>>extra_params | 区域扩展参数 | 否 | [array] | |||
| data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>extra_params>>key | 参数名 | 是 | [string] | type | ||
| data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>extra_params>>value | 参数值 | 是 | [string] | 1 | ||
| 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 | 区域模式 | 是 | [int] | 1:检测框中心点在区域内即代表检测目标在区域内,2:检测框脚点在区域内即代表检测目标在区域内,3:检测框中心点与脚点同时在区域内即代表检测目标在区域内,4:检测框中心点或脚点在区域内即代表检测目标在区域内 | 1 | |
| data>>algo_tasks>>algo_config>>extra_params | 算法定制化参数 | 否 | [array] | [{"key":"algo_type","value":"7009"},{"key":"threshold","value":"0.65"},{"key":"warningCount","value":"2"}] | ||
| data>>algo_tasks>>algo_config>>extra_params>>key | 参数名【多算法算法标识key必须为algo_type,阈值为threshold,连续超过几次告警为warningCount】 | 是 | [string] | algo_type:多算法包算法标识,threshold:阈值,warningCount:连续超过几次告警 | ||
| data>>algo_tasks>>algo_config>>extra_params>>value | 参数值【key=algo_type时为具体算法标识,key=threshold时为0~1之间的小数,key=warningCount时为整数】 | 是 | [string] | |||
| data>>image | 图片Base64(jpeg格式base64编码)【和image二选一,优先使用image字段】 | 否 | [string] | iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAAFVBMVEX////7ODj+z8/9eHj9m5v9s7P7TEwZgBMVAAAACXBIWXMAAAsTAAALEwEAmpwYAAAATklEQVQokd2NQQqAQAzEMjNd//9kUXEXFw8eBMEcCiUlha9p8lspC6ukwDZHeBcBNcvUJICkAjwVheV2k4pUkMvzWo5U307kLiSNkz+wAvF5AMTthEMUAAAAAElFTkSuQmCC | ||
| data>>image_url | 图片地址【和image二选一,优先使用image字段】 | 否 | [string] | http://10.127.156.152:8081/bucket/f7884c2f-0efc-42ae-0372-e30eddddc53b.jpg |
响应内容 :
返回结果
成功 (200)
Json
Object
| 参数名 | 说明 | 必填 | 类型 | 数据字典 | 限制 | 示例 |
|---|---|---|---|---|---|---|
| code | 算法类型,固定1020 | 是 | [int] | 1020 | ||
| data | 算法调用结果 | 是 | [object] | |||
| data>>error_code | 错误码,值为APP_ERR_OK则为成功 | 是 | [string] | APP_ERR_OK | ||
| 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>>send_pts_ms | 算法结果告警时时间戳。距离1970-01-01毫秒数 | 是 | [string] | 1694078498549 | ||
| data>>pull_pts_ms | 算法拉流时间戳。距离1970-01-01毫秒数 | 是 | [string] | 1694078498549 | ||
| data>>display_image | 告警场景图Base64【jpeg格式base64编码】 | 是 | [string] | iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAAFVBMVEX////7ODj+z8/9eHj9m5v9s7P7TEwZgBMVAAAACXBIWXMAAAsTAAALEwEAmpwYAAAATklEQVQokd2NQQqAQAzEMjNd//9kUXEXFw8eBMEcCiUlha9p8lspC6ukwDZHeBcBNcvUJICkAjwVheV2k4pUkMvzWo5U307kLiSNkz+wAvF5AMTthEMUAAAAAElFTkSuQmCC | ||
| 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 | 创建任务时传入的参数名【是否告警参数名固定为alarm】 | 是 | [string] | alarm | ||
| data>>algo_outputs>>roi_message>>extra_params>>value | 创建任务时传入的参数值【是否告警固定为1或者0】 | 是 | [string] | 1 | ||
| data>>algo_outputs>>objectinfo | 检测到的目标对象数组 | 是 | [array] | |||
| data>>algo_outputs>>objectinfo>>class_name | 目标类别名称:a person who is fishing fishing rod fishing;第一类代表钓鱼,其他的代表未钓鱼 | 是 | [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) | 是 | [float] | 0.99 | ||
| data>>algo_outputs>>objectinfo>>track_id | 目标追踪ID | 是 | [string] | 0d04322bee0 | ||
| data>>algo_outputs>>objectinfo>>score | 目标得分(0~1) | 是 | [float] | 0.99 | ||
| data>>algo_outputs>>objectinfo>>feature | 特征值,float数组【特征提取算法必返回】 | 否 | [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) | 是 | [string] | 0.99 | ||
| data>>algo_outputs>>objectinfo>>extra_message | 目标额外信息 | 否 | [array] | |||
| data>>algo_outputs>>objectinfo>>extra_message>>key | 参数名 | 是 | [string] | type | ||
| data>>algo_outputs>>objectinfo>>extra_message>>value | 参数值 | 是 | [string] | 1 | ||
| 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>>extra_message>>key | 参数名【如果为多算法镜像,固定返回算法标识的key必须为algo_type】 | 是 | [string] | algo_type | ||
| data>>extra_message>>value | 参数值【如果为多算法镜像,值为具体算法标识】 | 是 | [string] | 7009 | ||
| data>>image_message | 额外图片信息 | 否 | [array] | |||
| data>>image_message>>key | 图片名称 | 是 | [string] | xxx.jpg | ||
| data>>image_message>>value | 图片Base64【jpeg格式base64编码】 | 是 | [string] | iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAAFVBMVEX////7ODj+z8/9eHj9m5v9s7P7TEwZgBMVAAAACXBIWXMAAAsTAAALEwEAmpwYAAAATklEQVQokd2NQQqAQAzEMjNd//9kUXEXFw8eBMEcCiUlha9p8lspC6ukwDZHeBcBNcvUJICkAjwVheV2k4pUkMvzWo5U307kLiSNkz+wAvF5AMTthEMUAAAAAElFTkSuQmCC |
成功示例[Mock API] :
{
"code": 1020,
"data": {
"error_code": "APP_ERR_OK",
"error_message": "",
"camera_id": "111",
"task_id": "task_1",
"frame_id": "0",
"frame_width": "1920",
"frame_height": "1080",
"send_pts_ms": "0",
"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": "head",
"class_id": 0,
"rect": {
"x0": 0,
"y0": 0,
"x1": 100,
"y1": 100
},
"confidence": 0.922851562,
"track_id": "",
"score": 0,
"extra_message": [{
"key": "group",
"value": "0"
}],
"image_message": [],
"feature": [],
"attribute": []
}, {
"class_name": "head",
"class_id": 0,
"rect": {
"x0": 100,
"y0": 100,
"x1": 200,
"y1": 200
},
"confidence": 0.774414062,
"track_id": "",
"score": 0,
"extra_message": [{
"key": "group",
"value": "1"
}],
"image_message": [],
"feature": [],
"attribute": []
}]
}],
"extra_message": []
}
}
详细说明 :
| 版本 | 算法总集版本号 | 备注 |
|---|---|---|
| 零代码-人群扎堆(2102501)-(v1.0.0_v1.0.0) |
1.服务接口调用时需要严格遵循服务鉴权规则,新老调用鉴权方式亦存在差异。
新调用鉴权规则请参见:开发指南 - 内网签名认证方式。
2.服务调用头信息
新的鉴权方式:调用时header头信息X-APP-ID,Device-Uuid,Authorization必传,
旧的鉴权方式:调用时header头信息X-APP-ID,X-APP-KEY,Order-Num,Device-Uuid必填
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 = "http://url:端口/aipass/aipassweb-api/openapi/openApi/v2/ai/2102501";
String appId = "appid";
String appKey = "appkey";
String orderNum = "orderNum";
String deviceUuid = "deviceUuid";
String seqid = "seqid";
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("X-APP-KEY", appKey);
connection.setRequestProperty("Order-Num", orderNum);
connection.setRequestProperty("Device-Uuid", deviceUuid);
//公网调用鉴权,与内网鉴权必传其一
connection.setRequestProperty("X-APP-ID", appId);
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();
}
}
}
}
针对图片检测、分类型算法通用接口参数定义,用于对图片内对象进行识别检测
此类算法的class_name字段用于标识目标的类别,会将算法返回结果透传给调用方
roi区域配置和算法能力对应,算法提供能力时需要在接口文档中声明是否支持roi区域,且roi区域支持的类型为画线或者画多边形区域
入参中的algo_roi区域配置解析逻辑如下:
区域条件:
1、 支持绝对坐标区域, roi_type为1。取值范围 x [0, frame_width], y [0, frame_height]
2、 支持归一化后的按比例要求区域,roi_type为2。取值范围 x,y分别为 [0,1]
3、 支持画最多三个区域,每个区域为多边形,点数支持3-11个点
4、 点的顺序要为逆时针或者顺时针,不能乱序。
5、支持任意边数多边形,不限凹凸,不支持有孔多边形,不支持自相交多边形,一个区域不允许它的点在本区域的其他边上,两个区域的范围不能重叠,区域的点坐标不能超出图片的大小范围,区域个数不能超过设定的最大值(最多3个)
6、 检测目标在区域内的判断逻辑
检测目标人头框中心点在区域内则认为目标在区域内
| region_mode | int | 本能力只能填1,其他值报错(20240911添加此说明) | 是 | 1表示检测框的中心点在区域就判定为在区域内 |
|---|---|---|---|---|
算法定制化参数:
{
"extra_params": [
{
"key": "conf_thresh",
"value": "0.45"
},
{
"key": "target_distance_level",
"value": "8"
},
{
"key": "deep_distance_level",
"value": "2"
}
]
}
| extra_params | Array | 是 | 额外参数 | |
|---|---|---|---|---|
| +key | string | "人头人体检测阈值" 参数名 | 否 | 只能填:conf_thresh |
| +value | string | 可转float的字符串,取值范围0不传使用默认值,传错误值返回报错(空字符串按错误处理) | 否 | 人头人体检测阈值 |
| +key | string | 额外参数“目标距离等级”参数名称 | 否 | 只能填:target_distance_level |
| +value | string | 可转float的字符串,取值范围1<=x<=20,默认为"8",值越大将距离大的目标分到同一组不传使用默认值,传错误值返回报错(空字符串按错误处理) | 否 | 目标距离等级:表示人与人之际的社交距离,不超过该值,说明存在扎堆现象,默认为6。该值取决于对于扎堆现象的业务需求。值越大,扎堆可接受的距离就越大,每个分组的人数越多 |
| +key | string | 额外参数“深度距离等级”参数名称 | 否 | 只能填:deep_distance_level |
| +value | string | 可转float的字符串,取值范围1<=x<=10,默认为"2",值越大越容易将深度不同的目标分到不同组不传使用默认值,传错误值返回报错(空字符串按错误处理) | 否 | 深度距离等级:主要考虑摄像头角度对人与人之间深度距离的影响,默认为2。深度信息影响扎堆判断,该值越大则接受的深度距离越大。如果摄像头角度如下(俯角较小),则深度距离较大,可根据实际分组效果,调大该值;如果摄像头角度如下(俯角较大),则深度距离较小,可根据实际分组效果,调小该值。 |