Detect Objects In Stream - Detect Objects In Stream

Служба:

Azure AI Services

Версия API:

3.2

Выполняет обнаружение объектов на указанном изображении. Поддерживаются два метода ввода: (1) Отправка изображения или (2) с указанием URL-адреса изображения. Успешный ответ будет возвращен в формате JSON. Если запрос завершился сбоем, ответ будет содержать код ошибки и сообщение, чтобы понять, что произошло неправильно.

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

С использованием необязательных параметров:

POST {Endpoint}/vision/v3.2/detect?overload=stream&model-version={model-version}

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services.
model-version	query		string pattern: ^(latest|\d{4}-\d{2}-\d{2})(-preview)?$	Необязательный параметр, указывающий версию модели ИИ. Допустимые значения: "latest", "2021-04-01", "2021-05-01". По умолчанию используется значение "последняя".

Заголовок запроса

Media Types: "application/octet-stream", "multipart/form-data"

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string

Текст запроса

Media Types: "application/octet-stream", "multipart/form-data"

Имя	Тип	Описание
Image	object (file)	Поток изображения.

Ответы

Имя	Тип	Описание
200 OK	DetectResult	Ответ включает обнаруженные объекты в формате JSON.
Other Status Codes	ComputerVisionErrorResponse	Ответ на ошибку.

Безопасность

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Successful DetectObjects request

Образец запроса

HTTP

POST https://westus.api.cognitive.microsoft.com/vision/v3.2/detect?overload=stream


"{binary}"

Пример ответа

Код состояния:

200

{
  "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"
  },
  "modelVersion": "2021-04-01"
}

Определения

Имя	Описание
BoundingRect	Ограничивающий прямоугольник для области внутри изображения.
ComputerVisionError	Ошибка запроса API.
ComputerVisionErrorCodes	Код ошибки.
ComputerVisionErrorResponse	Ответ об ошибке API.
ComputerVisionInnerError	Сведения об ошибке запроса API.
ComputerVisionInnerErrorCodeValue	Код ошибки.
DetectedObject	Объект, обнаруженный на изображении.
DetectResult	Результат вызова DetectImage.
ImageMetadata	Метаданные изображения.
ObjectHierarchy	Объект, обнаруженный внутри изображения.

BoundingRect

Object

Ограничивающий прямоугольник для области внутри изображения.

Имя	Тип	Описание
h	integer (int32)	Высота, измеряемая от левой верхней точки области в пикселях.
w	integer (int32)	Ширина, измеряемая из левой верхней точки области в пикселях.
x	integer (int32)	Координата X верхней левой точки области в пикселях.
y	integer (int32)	Координата Y верхней левой точки области в пикселях.

ComputerVisionError

Object

Ошибка запроса API.

Имя	Тип	Описание
code	ComputerVisionErrorCodes	Код ошибки.
innererror	ComputerVisionInnerError	Внутренняя ошибка содержит более конкретные сведения.
message	string	Сообщение, объясняющее ошибку, сообщаемую службой.

ComputerVisionErrorCodes

Перечисление

Код ошибки.

Значение	Описание
InvalidRequest
InvalidArgument
InternalServerError
ServiceUnavailable

ComputerVisionErrorResponse

Object

Ответ об ошибке API.

Имя	Тип	Описание
error	ComputerVisionError	Содержимое ошибки.

ComputerVisionInnerError

Object

Сведения об ошибке запроса API.

Имя	Тип	Описание
code	ComputerVisionInnerErrorCodeValue	Код ошибки.
message	string	Сообщение об ошибке.

ComputerVisionInnerErrorCodeValue

Перечисление

Код ошибки.

Значение	Описание
InvalidImageFormat
UnsupportedMediaType
InvalidImageUrl
NotSupportedFeature
NotSupportedImage
Timeout
InternalServerError
InvalidImageSize
BadArgument
DetectFaceError
NotSupportedLanguage
InvalidThumbnailSize
InvalidDetails
InvalidModel
CancelledRequest
NotSupportedVisualFeature
FailedToProcess
Unspecified
StorageException

DetectedObject

Object

Объект, обнаруженный на изображении.

Имя	Тип	Описание
confidence	number (double)	Оценка достоверности наблюдаемого объекта в изображении в качестве значения от 0 до 1.
object	string	Метка объекта.
parent	ObjectHierarchy	Родительский объект с точки зрения таксономии. Родительский объект является более универсальной формой этого объекта. Например, у "бульдога" будет родитель "собака".
rectangle	BoundingRect	Приблизительное расположение обнаруженного объекта.

DetectResult

Object

Результат вызова DetectImage.

Имя	Тип	Описание
metadata	ImageMetadata	Метаданные изображения.
modelVersion	string pattern: ^(latest|\d{4}-\d{2}-\d{2})(-preview)?$	Версия модели ИИ.
objects	DetectedObject[]	Массив обнаруженных объектов.
requestId	string	Идентификатор запроса REST API.

ImageMetadata

Object

Метаданные изображения.

Имя	Тип	Описание
format	string	Формат изображения.
height	integer (int32)	Высота изображения в пикселях.
width	integer (int32)	Ширина изображения в пикселях.

ObjectHierarchy

Object

Объект, обнаруженный внутри изображения.

Имя	Тип	Описание
confidence	number (double)	Оценка достоверности наблюдаемого объекта в изображении в качестве значения от 0 до 1.
object	string	Метка объекта.
parent	ObjectHierarchy	Родительский объект с точки зрения таксономии. Родительский объект является более универсальной формой этого объекта. Например, у "бульдога" будет родитель "собака".