主体识别
功能介绍
用户传入图片通过后台算法判断图片主体,并返回主体坐标,具体识别的主体请参考应用场景。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v3/{project_id}/image/main-object-detection
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
用户的项目ID。获取方法请参见获取项目ID和名称。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
image |
否 |
String |
与url二选一 图像数据,base64编码,要求base64编码后大小不超过10M,最短边至少1px,最长边最大10000px,支持JPEG/PNG/BMP/WEBP格式。 |
|
url |
否 |
String |
与image二选一 图片的URL路径,目前支持:
|
|
threshold |
否 |
Float |
置信度的阈值(0~100),低于此置信数的检测结果,将不会返回。 默认值:30,最小值:0,最大值:100。 |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
Array of ImageMainObjectDetectionInstance objects |
主体列表集合。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
label |
String |
主体的类别,现阶段分为:main_object_box(主要主体)和bounding_box(边缘主体)。 |
|
location |
location object |
目标检测框位置信息,包括4个值:
|
|
confidence |
String |
主体框的置信度。将Float型置信度转为String类型返回,Float取值范围(0~100)。 |
状态码: 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
调用失败时的错误码,具体请参见错误码。 调用成功时无此字段。 |
|
error_msg |
String |
调用失败时的错误信息。 调用成功时无此字段。 |
请求示例
- 方式一:使用图片的BASE64编码,判断图片主体并返回主体坐标,置信度的阈值为30。
POST https://{endpoint}/v3/{project_id}image/main-object-detection { "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgEbAA...", "url" : "", "threshold" : 30 } - 方式二:使用图片URL,判断图片主体并返回主体坐标,置信度的阈值为30。
POST https://{endpoint}/v3/{project_id}image/main-object-detection { "image" : "", "url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName", "threshold" : 30 }
响应示例
状态码: 200
成功响应结果
{
"result" : [ {
"label" : "bounding_box",
"location" : {
"height" : 133.32,
"top_left_x" : 53.13,
"top_left_y" : 254.21,
"width" : 117.58
},
"confidence" : "92.38"
}, {
"label" : "main_object_box",
"location" : {
"height" : 261.32,
"top_left_x" : 256.13,
"top_left_y" : 85.21,
"width" : 139.58
},
"confidence" : "66.38"
} ]
}
状态码: 400
失败响应结果
{
"error_code" : "AIS.0005",
"error_msg" : "The service does not exist."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功响应结果。 |
|
400 |
失败响应结果。 |
错误码
请参见错误码。