Projects - Quick Test Image Url

Service:: Azure AI Services

API Version:: 3.3

Quick test an image url.

POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/quicktest/url

With optional parameters:

POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/quicktest/url?iterationId={iterationId}&store={store}

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoints.
projectId	path	True	string (uuid)	The project to evaluate against.
iterationId	query		string (uuid)	Optional. Specifies the id of a particular iteration to evaluate against. `The default iteration for the project will be used when not specified.`
store	query		boolean	Optional. Specifies whether or not to store the result of this prediction. The default is true, to store.

Request Header

Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Name	Required	Type	Description
Training-Key	True	string

Request Body

Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Name	Required	Type	Description
url	True	string	Url of the image.

Responses

Name	Type	Description
200 OK	ImagePrediction	OK Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Error response Media Types: "application/json", "application/xml", "text/xml"

Name

Type

Description

200 OK

ImagePrediction

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

Other Status Codes

CustomVisionError

Error response

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

Security

Training-Key

Type: apiKey
In: header

Examples

Successful QuickTestImageUrl request

Sample request

HTTP

POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/64b822c5-8082-4b36-a426-27225f4aa18c/quicktest/url?iterationId=fe1e83c4-6f50-4899-9544-6bb08cf0e15a


{
  "url": "{Image URL}"
}

Sample response

Status code:: 200

{
  "id": "951098b2-9b69-427b-bddb-d5cb618874e3",
  "project": "64b822c5-8082-4b36-a426-27225f4aa18c",
  "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
  "created": "2017-12-19T14:21:41Z",
  "predictions": [
    {
      "tagId": "e31ff107-5505-4753-be42-b369b21b026c",
      "tagName": "Hemlock",
      "probability": 0.05149666
    },
    {
      "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
      "tagName": "Japanese Cherry",
      "probability": 0
    }
  ]
}

Definitions

Name	Description
BoundingBox	Bounding box that defines a region of an image.
CustomVisionError
CustomVisionErrorCodes	The error code.
ImagePrediction	Result of an image prediction request.
ImageUrl	Image url.
Prediction	Prediction result.
TagType	Type of the predicted tag.

BoundingBox

Object

Bounding box that defines a region of an image.

Name	Type	Description
height	number (float)	Height.
left	number (float)	Coordinate of the left boundary.
top	number (float)	Coordinate of the top boundary.
width	number (float)	Width.

CustomVisionError

Object

Name	Type	Description
code	CustomVisionErrorCodes	The error code.
message	string	A message explaining the error reported by the service.

CustomVisionErrorCodes

Enumeration

The error code.

Value	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

Result of an image prediction request.

Name	Type	Description
created	string (date-time)	Date this prediction was created.
id	string (uuid)	Prediction Id.
iteration	string (uuid)	Iteration Id.
predictions	Prediction[]	List of predictions.
project	string (uuid)	Project Id.

ImageUrl

Object

Image url.

Name	Type	Description
url	string	Url of the image.

Prediction

Object

Prediction result.

Name	Type	Description
boundingBox	BoundingBox	Bounding box of the prediction.
probability	number (float)	Probability of the tag.
tagId	string (uuid)	Id of the predicted tag.
tagName	string	Name of the predicted tag.
tagType	TagType	Type of the predicted tag.

TagType

Enumeration

Type of the predicted tag.

Value	Description
Regular
Negative
GeneralProduct

Share via

Projects - Quick Test Image Url

URI Parameters

Request Header

Request Body

Responses

Security

Training-Key

Examples

Successful QuickTestImageUrl request

Sample request

Sample response

Definitions

BoundingBox

CustomVisionError

CustomVisionErrorCodes

ImagePrediction

ImageUrl

Prediction

TagType