文档首页/ 图像识别 Image/ API参考/ API/ 媒资图像标签(检测)
更新时间:2023-08-03 GMT+08:00
分享

媒资图像标签(检测)

功能介绍

对用户传入的图像可以返回图像中物体的坐标位置、物体名称、所属类别及置信度信息。

与媒资图像标签(分类)相比,媒资图像标签(检测)还能返回图像的坐标位置。

前提条件

  • 在使用媒资图像标签服务之前需要您完成服务申请认证鉴权
  • 图像识别服务属于公有云服务,线上用户资源共享,如果需要多并发请求,请提前联系我们

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/image/media-tagging-det

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户的项目ID。获取方法请参见获取项目ID和名称

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

image

String

与url二选一。

图像数据,base64编码,要求base64编码后大小不超过10M,最短边至少1px,最长边最大10000px,支持JPEG/PNG/BMP/WEBP格式。

url

String

与image二选一。

图片的URL路径,目前支持:

  • 公网HTTP/HTTPS URL
  • OBS提供的URL,使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权。详情参见配置OBS服务的访问权限
说明:
  • 接口响应时间依赖于图片的下载时间,如果图片下载时间过长,会返回接口调用失败。
  • 请保证被检测图片所在的存储服务稳定可靠,推荐使用OBS服务存储图片数据。
  • lmage不支持跨区域OBS,OBS的区域需要和服务保持一致。

language

String

zh:返回标签的语言类型为中文。

en:返回标签的语言类型为英文。

默认值为zh。

threshold

Float

置信度的阈值(0~100),默认值为20,最大值为100,最小值为0。

limit

Integer

最多返回的标签数(最多50个,最少为1个),默认值为10。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

result

result object

调用成功时为图像标签内容。

调用失败时无此字段。

表5 result

参数

参数类型

描述

tags

Array of ImageMediaTaggingDetItemBody objects

标签列表集合。

表6 ImageMediaTaggingDetItemBody

参数

参数类型

描述

confidence

String

置信度,将Float型置信度转为String类型返回,取值范围:0-100。

type

String

标签的类别。返回的标签类型,包含二十种大类,具体可以参考图像标签

tag

String

标签名称。

i18n_tag

i18n_tag object

标签的多种语言输出。

instances

Array of ImageMediaTaggingDetInstance objects

目标检测框信息,为空则表示没有目标检测框。

表7 i18n_tag

参数

参数类型

描述

zh

String

中文标签。

en

String

英文标签。

表8 ImageMediaTaggingDetInstance

参数

参数类型

描述

bounding_box

BoundingBox Object

目标检测框位置信息。

confidence

String

检测标签的置信度,将Float型置信度转为String类型返回,Float取值范围(0~100)。

表9 BoundingBox

参数

参数类型

描述

width

Integer

检测框区域宽度。

height

Integer

检测框区域高度。

top_left_x

Integer

检测框左上角到垂直轴距离。

top_left_y

Integer

检测框左上角到水平轴距离。

状态码: 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码,具体请参见错误码

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

请求示例

  • “endpoint”即调用API的请求地址,不同服务不同区域的“endpoint”不同,具体请参见终端节点

    例如,服务部署在“华北-北京四”区域的“endpoint”“image.cn-north-4.myhuaweicloud.com”,请求URL为“https://image.cn-north-4.myhuaweicloud.com/v2/{project_id}}/image/media-tagging-det”“project_id”为项目ID,获取方法请参见获取项目ID和名称

  • 方式一:使用图片的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

失败响应结果。

错误码

请参见错误码

相关文档