Object Detector - Analyze Image

Služba:: Azure AI Services

Verze rozhraní API:: 3.1

Rozpozná objekty na obrázku a uloží výsledek.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
imageData	formData	True	file	Binární data obrázku. Podporované formáty jsou JPEG, GIF, PNG a BMP. Podporuje obrázky až 4 MB.
Endpoint	path	True	string	Podporované koncové body služeb Cognitive Services
projectId	path	True	string (uuid)	ID projektu.
publishedName	path	True	string	Určuje název modelu, který se má vyhodnotit.
application	query		string	Volitelný. Určuje název aplikace používající koncový bod.

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
Prediction-Key	True	string

Odpovědi

Name	Typ	Description
200 OK	ImagePrediction	OK Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Chybová odpověď Media Types: "application/json", "application/xml", "text/xml"

Name

Typ

Description

200 OK

ImagePrediction

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

Other Status Codes

CustomVisionError

Chybová odpověď

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

Zabezpečení

Prediction-Key

Typ: apiKey
V: header

Příklady

Successful DetectImage request

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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
      }
    }
  ]
}

Definice

Name	Description
BoundingBox	Ohraničující rámeček, který definuje oblast obrázku.
CustomVisionError
CustomVisionErrorCodes	Kód chyby.
ImagePrediction	Výsledek požadavku na predikci obrázku
Prediction	Výsledek předpovědi.
TagType	Typ předpovězené značky

BoundingBox

Objekt

Ohraničující rámeček, který definuje oblast obrázku.

Name	Typ	Description
height	number (float)	Výška.
left	number (float)	Souřadnice levé hranice.
top	number (float)	Souřadnice horní hranice
width	number (float)	Šířka.

CustomVisionError

Objekt

Name	Typ	Description
code	CustomVisionErrorCodes	Kód chyby.
message	string	Zpráva s vysvětlením chyby hlášené službou

CustomVisionErrorCodes

Výčet

Kód chyby.

Hodnota	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

Objekt

Výsledek požadavku na predikci obrázku

Name	Typ	Description
created	string (date-time)	Datum vytvoření této předpovědi
id	string (uuid)	ID předpovědi.
iteration	string (uuid)	ID iterace.
predictions	Prediction[]	Seznam předpovědí
project	string (uuid)	ID projektu.

Prediction

Objekt

Výsledek předpovědi.

Name	Typ	Description
boundingBox	BoundingBox	Ohraničující rámeček předpovědi.
probability	number (float)	Pravděpodobnost značky
tagId	string (uuid)	ID předpovězené značky.
tagName	string	Název předpovězené značky
tagType	TagType	Typ předpovězené značky

TagType

Výčet

Typ předpovězené značky

Hodnota	Description
Regular
Negative
GeneralProduct

Sdílet prostřednictvím

Object Detector - Analyze Image

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

Prediction-Key

Příklady

Successful DetectImage request

Ukázkový požadavek

Ukázková odpověď

Definice

BoundingBox

CustomVisionError

CustomVisionErrorCodes

ImagePrediction

Prediction

TagType