Iterations - List Performance Images

Service:

Azure AI Services

API Version:

3.3

Get image with its prediction for a given project iteration. This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned

GET {Endpoint}/customvision/v3.3/training/projects/{projectId}/iterations/{iterationId}/performance/images

With optional parameters:

GET {Endpoint}/customvision/v3.3/training/projects/{projectId}/iterations/{iterationId}/performance/images?tagIds={tagIds}&orderBy={orderBy}&take={take}&skip={skip}

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoints.
iterationId	path	True	string uuid	The iteration id. Defaults to workspace.
projectId	path	True	string uuid	The project id.
orderBy	query		string	The ordering. Defaults to newest.
skip	query		integer int32	Number of images to skip before beginning the image batch. Defaults to 0.
tagIds	query		string[]	A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
take	query		integer int32	Maximum number of images to return. Defaults to 50, limited to 256.

Request Header

Name	Required	Type	Description
Training-Key	True	string

Responses

Name	Type	Description
200 OK	ImagePerformance[]	OK 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 GetImagePerformances request

Sample request

HTTP

GET https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/bc3f7dad-5544-468c-8573-3ef04d55463e/iterations/b7b9d99c-a2c6-4658-9900-a98d2ff5bc66/performance/images?tagIds=65c1de9c-3ee9-4b46-941f-66199b64d155&orderBy=Newest

Sample response

Status code:

200

[
  {
    "id": "dfd2d346-3ed5-4e1e-857d-af4e32cec042",
    "created": "2018-01-31T20:18:26Z",
    "predictions": [
      {
        "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544",
        "tagName": "Tag 1",
        "probability": 1,
        "boundingBox": {
          "left": 0.25,
          "top": 0.25,
          "width": 0.25,
          "height": 0.25
        }
      }
    ],
    "width": 600,
    "height": 1600,
    "imageUri": "<image uri>",
    "thumbnailUri": "<thumbnail uri>",
    "tags": [],
    "regions": []
  }
]

Definitions

Name	Description
BoundingBox	Bounding box that defines a region of an image.
CustomVisionError
CustomVisionErrorCodes	The error code.
ImagePerformance	Image performance model.
ImageRegion
ImageTag
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	Height.
left	number	Coordinate of the left boundary.
top	number	Coordinate of the top boundary.
width	number	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
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

ImagePerformance

Object

Image performance model.

Name	Type	Description
created	string
height	integer
id	string
imageUri	string
predictions	Prediction[]	Prediction result.
regions	ImageRegion[]
tags	ImageTag[]
thumbnailUri	string
width	integer

ImageRegion

Object

Name	Type	Description
created	string
height	number	Height.
left	number	Coordinate of the left boundary.
regionId	string
tagId	string	Id of the tag associated with this region.
tagName	string
top	number	Coordinate of the top boundary.
width	number	Width.

ImageTag

Object

Name	Type	Description
created	string
tagId	string
tagName	string

Prediction

Object

Prediction result.

Name	Type	Description
boundingBox	BoundingBox	Bounding box of the prediction.
probability	number	Probability of the tag.
tagId	string	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
GeneralProduct
Negative
Regular