您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

Detect Objects - Detect Objects

对指定的图像执行对象检测。 支持两种输入方法 -- (1) 上传图像或 (2) 指定图像 URL。 成功响应将以 JSON 格式返回。 如果请求失败,响应将包含错误代码和一条消息,以帮助了解错误的原因。

POST {Endpoint}/vision/v3.1/detect

URI 参数

Name In Required Type Description
Endpoint
path True
  • string

支持的认知服务终结点。

请求头

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

请求正文

Name Required Type Description
url True
  • string

图像的可公开访问 URL。

响应

Name Type Description
200 OK

响应包括 JSON 格式的检测到的对象。

Other Status Codes

错误响应。

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

示例

Successful DetectObjects request

Sample Request

POST https://westus.api.cognitive.microsoft.com/vision/v3.1/detect
Ocp-Apim-Subscription-Key: {API key}
{
  "url": "{url}"
}

Sample Response

{
  "objects": [
    {
      "rectangle": {
        "x": 0,
        "y": 0,
        "w": 50,
        "h": 50
      },
      "object": "tree",
      "confidence": 0.9,
      "parent": {
        "object": "plant",
        "confidence": 0.95
      }
    }
  ],
  "requestId": "1ad0e45e-b7b4-4be3-8042-53be96103337",
  "metadata": {
    "width": 100,
    "height": 100,
    "format": "Jpeg"
  }
}

定义

BoundingRect

图像内区域边界框。

ComputerVisionError

有关 API 请求错误的详细信息。

ComputerVisionErrorCodes

错误代码。

DetectedObject

在图像中检测到的对象。

DetectResult

DetectImage 调用的结果。

ImageMetadata

图像元数据。

ImageUrl
ObjectHierarchy

在图像中检测到的对象。

BoundingRect

图像内区域边界框。

Name Type Description
h
  • integer

从区域左上方点测量的高度(以像素为单位)。

w
  • integer

从区域左上方点测量的宽度(以像素为单位)。

x
  • integer

区域左上方点的 X 坐标(以像素为单位)。

y
  • integer

区域左上方的 Y 坐标(以像素为单位)。

ComputerVisionError

有关 API 请求错误的详细信息。

Name Type Description
code

错误代码。

message
  • string

一条消息,说明服务报告的错误。

requestId
  • string

唯一的请求标识符。

ComputerVisionErrorCodes

错误代码。

Name Type Description
BadArgument
  • string
CancelledRequest
  • string
DetectFaceError
  • string
FailedToProcess
  • string
InternalServerError
  • string
InvalidDetails
  • string
InvalidImageFormat
  • string
InvalidImageSize
  • string
InvalidImageUrl
  • string
InvalidModel
  • string
InvalidThumbnailSize
  • string
NotSupportedFeature
  • string
NotSupportedImage
  • string
NotSupportedLanguage
  • string
NotSupportedVisualFeature
  • string
StorageException
  • string
Timeout
  • string
Unspecified
  • string
UnsupportedMediaType
  • string

DetectedObject

在图像中检测到的对象。

Name Type Description
confidence
  • number

观察到图像中的对象的置信度分数,其值为 0 到 1。

object
  • string

对象的标签。

parent

从分类的角度来看,父对象。 父对象是此 对象的更通用形式。 例如,"bulldog"的父级为"dog"。

rectangle

检测到对象的大致位置。

DetectResult

DetectImage 调用的结果。

Name Type Description
metadata

图像元数据。

objects

检测到的对象的数组。

requestId
  • string

请求的REST API ID。

ImageMetadata

图像元数据。

Name Type Description
format
  • string

图像格式。

height
  • integer

图像高度(以像素为单位)。

width
  • integer

图像宽度(以像素为单位)。

ImageUrl

Name Type Description
url
  • string

图像的可公开访问 URL。

ObjectHierarchy

在图像中检测到的对象。

Name Type Description
confidence
  • number

观察到图像中的对象的置信度分数,其值为 0 到 1。

object
  • string

对象的标签。

parent

从分类的角度来看,父对象。 父对象是此 对象的更通用形式。 例如,"bulldog"的父级为"dog"。