人体检测 API使用文档
本文档主要针对HTTP API调用者,创迹AI开放平台需注册后申请服务授权调用API。本文以“人体检测”能力为例,指引您开启开发之旅。
1、能力介绍
检测给定图片中的人体,获取图片中人体位置,支持多人。
2、调用方式
该接口主要用于HTTP API调用,服务授权请参考[接入指南-API接入指南],根据指南进行服务授权,授权后进行API使用。
3、请求说明
HTTP方法:POST
接口请求域名:service.trial-power.com
请求URL: https://service.trial-power.com/aiop_oauth/oauth/service
Headers:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Content-Type | 是 | String | application/json |
Authorization | 是 | String | 访问token:可通过控制台服务的appKey,secretkey和servicekey生成,具体方式请参考:“API token获取”注意:有效期为30天,切记需要每30天进行定期更换,或者每次请求都拉取新token; |
Query:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
action | 是 | String | 公共参数,本接口取值:aiservice-person-detect |
version | 是 | String | API版本号,当前版本号:1 |
Body:
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
image | 是 | String | 图片的base64数据,base64编码后大小不可超过5M。需要注意的是,图片的base64编码不包含图片头, 如data:image/jpg;base64,图片格式:现支持PNG、JPG、JPEG、BMP,不支持GIF图片。 |
minConfidence | 否 | Float | 最小置信度,默认:0.5 例如:置信度=0.8,返回结果数据置信度 >=0.8 |
4、返回结果
名称 | 说明 |
---|---|
code | 返回结果信息码 |
data | 识别结果数据 |
msg | 描述信息 |
status | API状态 |
data详细:
名称 | 说明 |
---|---|
left | 人体位置:左上角坐标x |
top | 人体位置:左上角坐标y |
right | 人体位置:右下角坐标x |
bottom | 人体位置:右下角坐标y |
confidence | 结果置信度(人检测分数例如:0.932,满分为1) |
例如:
{ "code": 200, "data": [ { "bottom": 204, "confidence": 0.932361364364624, "left": 10, "right": 216, "top": 44 }, { "bottom": 360, "confidence": 0.9172011613845825, "left": 68, "right": 256, "top": 137 } ], "msg": "RequestId:5394f3a983c240d3bd90d69eef86edc4 Success", "status": 200 }
5、信息码
信息码 | 描述信息 | 描述 | 处理建议 |
---|---|---|---|
100 | nvalid appKey,secretkeyor servicekey | Key 非法 | 控制台检查申请token时设定的key |
101 | Invalid Token | 非法token | 重新申请token,或确认token是否正确 |
102 | Open api total request limit reached | 访问超过限额 | 控制台确认购买的授权服务剩余次数 |
103 | no permission to access data | 未授权操作 | 控制台确认服务是否购买授权 |
104 | Service Expiration | token过期 | 重新申请token |
105 | Resource Unavailable | 资源不可用 | 详细确认接口说明,确认action是否正确 |
106 | Token Acquisition failed | Token获取失败 | 检查设定的key,重新获取 |
107 | Token Null | Token为空 | 确认token是否添加 |
200 | Success | 成功 | |
201 | Failed Operation | 操作失败 | 确认请求参数或重新请求 |
300 | param is null | 必要参数未传入 | 检查必须的请求参数xx是否设定 |
301 | param format error | 参数格式错误 | 检查请求参数xx的数据格式,是否符合要求 |
-300 | System busy | 系统繁忙 | 稍后重新访问 |