Object Detector - Analyze Image

Служба:: Azure AI Services

Версия API:: 3.1

Обнаружение объектов на изображении и сохранение результата.

POST {Endpoint}/customvision/v3.1/prediction/{projectId}/detect/iterations/{publishedName}/image

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

POST {Endpoint}/customvision/v3.1/prediction/{projectId}/detect/iterations/{publishedName}/image?application={application}

Параметры URI

Имя	В	Обязательно	Тип	Описание
imageData	formData	True	file	Двоичные данные изображения. Поддерживаются форматы JPEG, GIF, PNG и BMP. Поддерживает изображения до 4 МБ.
Endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services.
projectId	path	True	string (uuid)	Идентификатор проекта.
publishedName	path	True	string	Указывает имя модели для вычисления.
application	query		string	Необязательно. Указывает имя приложения с помощью конечной точки.

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

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

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

Ответы

Имя	Тип	Описание
200 OK	ImagePrediction	ХОРОШО Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Ответ на ошибку Media Types: "application/json", "application/xml", "text/xml"

Имя

Тип

Описание

200 OK

ImagePrediction

ХОРОШО

Media Types: "application/json", "application/xml", "text/xml"

Other Status Codes

CustomVisionError

Ответ на ошибку

Media Types: "application/json", "application/xml", "text/xml"

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

Prediction-Key

Тип: apiKey
В: header

Примеры

Successful DetectImage request

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

HTTP

POST https://westus.api.cognitive.microsoft.com/customvision/v3.1/prediction/64b822c5-8082-4b36-a426-27225f4aa18c/detect/iterations/MyModel1/image

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

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

{
  "id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1",
  "project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1",
  "iteration": "45c79472-7198-46e1-8ed7-bad2ca111957",
  "created": "2019-03-10T06:10:28Z",
  "predictions": [
    {
      "tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75",
      "tagName": "Tag 1",
      "probability": 0.05149666,
      "boundingBox": {
        "left": 0.955476165,
        "top": 0,
        "width": 0.0412225723,
        "height": 0.156851858
      }
    },
    {
      "tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8",
      "tagName": "Tag 2",
      "probability": 0.000193528482,
      "boundingBox": {
        "left": 0.062178582,
        "top": 0,
        "width": 0.9378114,
        "height": 0.6830492
      }
    }
  ]
}

Определения

Имя	Описание
BoundingBox	Ограничивающий прямоугольник, определяющий область изображения.
CustomVisionError
CustomVisionErrorCodes	Код ошибки.
ImagePrediction	Результат запроса на прогнозирование изображений.
Prediction	Результат прогнозирования.
TagType	Тип прогнозируемого тега.

BoundingBox

Object

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

Имя	Тип	Описание
height	number (float)	Высота.
left	number (float)	Координата левой границы.
top	number (float)	Координата верхней границы.
width	number (float)	Ширина.

CustomVisionError

Object

Имя	Тип	Описание
code	CustomVisionErrorCodes	Код ошибки.
message	string	Сообщение, объясняющее ошибку, сообщаемую службой.

CustomVisionErrorCodes

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

Код ошибки.

Значение	Описание
NoError
BadRequest
BadRequestExceededBatchSize
BadRequestNotSupported
BadRequestInvalidIds
BadRequestProjectName
BadRequestProjectNameNotUnique
BadRequestProjectDescription
BadRequestProjectUnknownDomain
BadRequestProjectUnknownClassification
BadRequestProjectUnsupportedDomainTypeChange
BadRequestProjectUnsupportedExportPlatform
BadRequestProjectImagePreprocessingSettings
BadRequestProjectDuplicated
BadRequestIterationName
BadRequestIterationNameNotUnique
BadRequestIterationDescription
BadRequestIterationIsNotTrained
BadRequestIterationValidationFailed
BadRequestWorkspaceCannotBeModified
BadRequestWorkspaceNotDeletable
BadRequestTagName
BadRequestTagNameNotUnique
BadRequestTagDescription
BadRequestTagType
BadRequestMultipleNegativeTag
BadRequestMultipleGeneralProductTag
BadRequestImageTags
BadRequestImageRegions
BadRequestNegativeAndRegularTagOnSameImage
BadRequestUnsupportedDomain
BadRequestRequiredParamIsNull
BadRequestIterationIsPublished
BadRequestInvalidPublishName
BadRequestInvalidPublishTarget
BadRequestUnpublishFailed
BadRequestIterationNotPublished
BadRequestSubscriptionApi
BadRequestExceedProjectLimit
BadRequestExceedIterationPerProjectLimit
BadRequestExceedTagPerProjectLimit
BadRequestExceedTagPerImageLimit
BadRequestExceededQuota
BadRequestCannotMigrateProjectWithName
BadRequestNotLimitedTrial
BadRequestImageBatch
BadRequestImageStream
BadRequestImageUrl
BadRequestImageFormat
BadRequestImageSizeBytes
BadRequestImageDimensions
BadRequestImageExceededCount
BadRequestTrainingNotNeeded
BadRequestTrainingNotNeededButTrainingPipelineUpdated
BadRequestTrainingValidationFailed
BadRequestClassificationTrainingValidationFailed
BadRequestMultiClassClassificationTrainingValidationFailed
BadRequestMultiLabelClassificationTrainingValidationFailed
BadRequestDetectionTrainingValidationFailed
BadRequestTrainingAlreadyInProgress
BadRequestDetectionTrainingNotAllowNegativeTag
BadRequestInvalidEmailAddress
BadRequestDomainNotSupportedForAdvancedTraining
BadRequestExportPlatformNotSupportedForAdvancedTraining
BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining
BadRequestExportValidationFailed
BadRequestExportAlreadyInProgress
BadRequestPredictionIdsMissing
BadRequestPredictionIdsExceededCount
BadRequestPredictionTagsExceededCount
BadRequestPredictionResultsExceededCount
BadRequestPredictionInvalidApplicationName
BadRequestPredictionInvalidQueryParameters
BadRequestInvalidImportToken
BadRequestExportWhileTraining
BadRequestImageMetadataKey
BadRequestImageMetadataValue
BadRequestOperationNotSupported
BadRequestInvalidArtifactUri
BadRequestCustomerManagedKeyRevoked
BadRequestInvalid
UnsupportedMediaType
Forbidden
ForbiddenUser
ForbiddenUserResource
ForbiddenUserSignupDisabled
ForbiddenUserSignupAllowanceExceeded
ForbiddenUserDoesNotExist
ForbiddenUserDisabled
ForbiddenUserInsufficientCapability
ForbiddenDRModeEnabled
ForbiddenInvalid
NotFound
NotFoundProject
NotFoundProjectDefaultIteration
NotFoundIteration
NotFoundIterationPerformance
NotFoundTag
NotFoundImage
NotFoundDomain
NotFoundApimSubscription
NotFoundInvalid
Conflict
ConflictInvalid
ErrorUnknown
ErrorIterationCopyFailed
ErrorPreparePerformanceMigrationFailed
ErrorProjectInvalidWorkspace
ErrorProjectInvalidPipelineConfiguration
ErrorProjectInvalidDomain
ErrorProjectTrainingRequestFailed
ErrorProjectImportRequestFailed
ErrorProjectExportRequestFailed
ErrorFeaturizationServiceUnavailable
ErrorFeaturizationQueueTimeout
ErrorFeaturizationInvalidFeaturizer
ErrorFeaturizationAugmentationUnavailable
ErrorFeaturizationUnrecognizedJob
ErrorFeaturizationAugmentationError
ErrorExporterInvalidPlatform
ErrorExporterInvalidFeaturizer
ErrorExporterInvalidClassifier
ErrorPredictionServiceUnavailable
ErrorPredictionModelNotFound
ErrorPredictionModelNotCached
ErrorPrediction
ErrorPredictionStorage
ErrorRegionProposal
ErrorUnknownBaseModel
ErrorInvalid

ImagePrediction

Object

Результат запроса на прогнозирование изображений.

Имя	Тип	Описание
created	string (date-time)	Дата создания прогноза.
id	string (uuid)	Идентификатор прогнозирования.
iteration	string (uuid)	Идентификатор итерации.
predictions	Prediction[]	Список прогнозов.
project	string (uuid)	Идентификатор проекта.

Prediction

Object

Результат прогнозирования.

Имя	Тип	Описание
boundingBox	BoundingBox	Ограничивающий прямоугольник прогноза.
probability	number (float)	Вероятность тега.
tagId	string (uuid)	Идентификатор прогнозируемого тега.
tagName	string	Имя прогнозируемого тега.
tagType	TagType	Тип прогнозируемого тега.

TagType

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

Тип прогнозируемого тега.

Значение	Описание
Regular
Negative
GeneralProduct

Поделиться через

Object Detector - Analyze Image

Параметры URI

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

Ответы

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

Prediction-Key

Примеры

Successful DetectImage request

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

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

Определения

BoundingBox

CustomVisionError

CustomVisionErrorCodes

ImagePrediction

Prediction

TagType