Get Image Performances - Get Image Performances

Service:

Cognitive Services - Custom Vision

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=&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

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

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

CustomVisionErrorCodes

The error code.

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

ImagePerformance

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

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

Name	Type	Description
created	string
tagId	string
tagName	string

Prediction

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

Type of the predicted tag.

Name	Type	Description
GeneralProduct	string
Negative	string
Regular	string