Object Detector - Analyze Image

Servicio:

Azure AI Services

Versión de la API:

3.1

Detecta objetos en una imagen y guarda el resultado.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
imageData	formData	True	file	Datos de imágenes binarias. Los formatos admitidos son JPEG, GIF, PNG y BMP. Admite imágenes de hasta 4 MB.
Endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos.
projectId	path	True	string (uuid)	Identificador del proyecto.
publishedName	path	True	string	Especifica el nombre del modelo en el que se va a evaluar.
application	query		string	Opcional. Especifica el nombre de la aplicación mediante el punto de conexión.

Encabezado de la solicitud

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

Nombre	Requerido	Tipo	Description
Prediction-Key	True	string

Respuestas

Nombre	Tipo	Description
200 OK	ImagePrediction	De acuerdo Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Respuesta de error Media Types: "application/json", "application/xml", "text/xml"

Seguridad

Prediction-Key

Tipo: apiKey
En: header

Ejemplos

Successful DetectImage request

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
BoundingBox	Rectángulo de límite que define una región de una imagen.
CustomVisionError
CustomVisionErrorCodes	Código de error.
ImagePrediction	Resultado de una solicitud de predicción de imagen.
Prediction	Resultado de la predicción.
TagType	Tipo de la etiqueta predicha.

BoundingBox

Object

Rectángulo de límite que define una región de una imagen.

Nombre	Tipo	Description
height	number (float)	Altura.
left	number (float)	Coordenada del límite izquierdo.
top	number (float)	Coordenada del límite superior.
width	number (float)	Ancho.

CustomVisionError

Object

Nombre	Tipo	Description
code	CustomVisionErrorCodes	Código de error.
message	string	Mensaje que explica el error notificado por el servicio.

CustomVisionErrorCodes

Enumeración

Código de error.

Valor	Description
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

Resultado de una solicitud de predicción de imagen.

Nombre	Tipo	Description
created	string (date-time)	Fecha en que se creó esta predicción.
id	string (uuid)	Identificador de predicción.
iteration	string (uuid)	Identificador de iteración.
predictions	Prediction[]	Lista de predicciones.
project	string (uuid)	Identificador del proyecto.

Prediction

Object

Resultado de la predicción.

Nombre	Tipo	Description
boundingBox	BoundingBox	Rectángulo delimitador de la predicción.
probability	number (float)	Probabilidad de la etiqueta.
tagId	string (uuid)	Identificador de la etiqueta predicha.
tagName	string	Nombre de la etiqueta de predicción.
tagType	TagType	Tipo de la etiqueta predicha.

TagType

Enumeración

Tipo de la etiqueta predicha.

Valor	Description
Regular
Negative
GeneralProduct