Object Detector - Analyze Image

Serviço:

Azure AI Services

Versão da API:

3.1

Detectar objetos em uma imagem e salvar o resultado.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
imageData	formData	True	file	Dados de imagem binária. Os formatos com suporte são JPEG, GIF, PNG e BMP. Dá suporte a imagens de até 4 MB.
Endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte.
projectId	path	True	string (uuid)	A ID do projeto.
publishedName	path	True	string	Especifica o nome do modelo a ser avaliado.
application	query		string	Opcional. Especifica o nome do aplicativo usando o ponto de extremidade.

Cabeçalho da solicitação

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

Nome	Obrigatório	Tipo	Description
Prediction-Key	True	string

Respostas

Nome	Tipo	Description
200 OK	ImagePrediction	OKEY Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Resposta de erro Media Types: "application/json", "application/xml", "text/xml"

Segurança

Prediction-Key

Tipo: apiKey
Em: header

Exemplos

Successful DetectImage request

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

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
      }
    }
  ]
}

Definições

Nome	Description
BoundingBox	Caixa delimitadora que define uma região de uma imagem.
CustomVisionError
CustomVisionErrorCodes	O código de erro.
ImagePrediction	Resultado de uma solicitação de previsão de imagem.
Prediction	Resultado da previsão.
TagType	Tipo da marca prevista.

BoundingBox

Objeto

Caixa delimitadora que define uma região de uma imagem.

Nome	Tipo	Description
height	number (float)	Altura.
left	number (float)	Coordenada do limite esquerdo.
top	number (float)	Coordenada do limite superior.
width	number (float)	Largura.

CustomVisionError

Objeto

Nome	Tipo	Description
code	CustomVisionErrorCodes	O código de erro.
message	string	Uma mensagem explicando o erro relatado pelo serviço.

CustomVisionErrorCodes

Enumeração

O código de erro.

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

ImagePrediction

Objeto

Resultado de uma solicitação de previsão de imagem.

Nome	Tipo	Description
created	string (date-time)	Data em que essa previsão foi criada.
id	string (uuid)	ID de previsão.
iteration	string (uuid)	ID de iteração.
predictions	Prediction[]	Lista de previsões.
project	string (uuid)	ID do projeto.

Prediction

Objeto

Resultado da previsão.

Nome	Tipo	Description
boundingBox	BoundingBox	Caixa delimitadora da previsão.
probability	number (float)	Probabilidade da marca.
tagId	string (uuid)	ID da marca prevista.
tagName	string	Nome da marca prevista.
tagType	TagType	Tipo da marca prevista.

TagType

Enumeração

Tipo da marca prevista.

Valor	Description
GeneralProduct
Negative
Regular