媒资图像标签(检测)
功能介绍
对用户传入的图像可以返回图像中物体的坐标位置、物体名称、所属类别及置信度信息。
与媒资图像标签(分类)相比,媒资图像标签(检测)还能返回图像的坐标位置。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/image/media-tagging-det
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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路径,目前支持:
说明:
|
language |
否 |
String |
zh:返回标签的语言类型为中文。 en:返回标签的语言类型为英文。 默认值为zh。 |
threshold |
否 |
Float |
置信度的阈值(0~100),默认值为20,最大值为100,最小值为0。 |
limit |
否 |
Integer |
最多返回的标签数(最多50个,最少为1个),默认值为10。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
result |
result object |
调用成功时为图像标签内容。 调用失败时无此字段。 |
参数 |
参数类型 |
描述 |
---|---|---|
confidence |
String |
置信度,将Float型置信度转为String类型返回,取值范围:0-100。 |
type |
String |
标签的类别。返回的标签类型,包含二十种大类,具体可以参考图像标签。 |
tag |
String |
标签名称。 |
i18n_tag |
i18n_tag object |
标签的多种语言输出。 |
instances |
Array of ImageMediaTaggingDetInstance objects |
目标检测框信息,为空则表示没有目标检测框。 |
参数 |
参数类型 |
描述 |
---|---|---|
bounding_box |
BoundingBox Object |
目标检测框位置信息。 |
confidence |
String |
检测标签的置信度,将Float型置信度转为String类型返回,Float取值范围(0~100)。 |
参数 |
参数类型 |
描述 |
---|---|---|
width |
Integer |
检测框区域宽度。 |
height |
Integer |
检测框区域高度。 |
top_left_x |
Integer |
检测框左上角到垂直轴距离。 |
top_left_y |
Integer |
检测框左上角到水平轴距离。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
调用失败时的错误码,具体请参见错误码。 调用成功时无此字段。 |
error_msg |
String |
调用失败时的错误信息。 调用成功时无此字段。 |
请求示例
- 方式一:使用图片的BASE64编码,对于用户传入的图像中物体的坐标位置、物体名称、所属类别及置信度信息,返回标签的语言类型为中文,最多返回的标签数为5。
POST https://{endpoint}/v2/{project_id}/image/media-tagging-det { "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgEbAA...", "url" : "", "language" : "zh", "limit" : 10, "threshold" : 30 }
- 方式二:使用图片URL,对于用户传入的图像中物体的坐标位置、物体名称、所属类别及置信度信息,返回标签的语言类型为中文,最多返回的标签数为5。
POST https://{endpoint}/v2/{project_id}/image/media-tagging-det { "image" : "", "url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName", "language" : "en", "limit" : 5, "threshold" : 40 }
响应示例
状态码: 200
成功响应结果
{ "result" : { "tags" : [ { "confidence" : "75.74", "instances" : [ { "confidence" : "75.74", "bounding_box" : { "height" : 453, "top_left_x" : 513, "top_left_y" : 764, "width" : 123 } } ], "i18n_tag" : { "en" : "tie", "zh" : "领带" }, "tag" : "领带", "type" : "服饰穿戴类" } ] } }
状态码: 400
失败响应结果
{ "error_code" : "AIS.0005", "error_msg" : "The service does not exist." }
状态码
状态码 |
描述 |
---|---|
200 |
成功响应结果。 |
400 |
失败响应结果。 |
错误码
请参见错误码。