Iterations - List Performance Images
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/imagesGET {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. |
|
iteration
|
path | True |
string (uuid) |
The iteration id. Defaults to workspace. |
|
project
|
path | True |
string (uuid) |
The project id. |
|
order
|
query |
string |
The ordering. Defaults to newest. |
|
|
skip
|
query |
integer (int32) |
Number of images to skip before beginning the image batch. Defaults to 0. |
|
|
tag
|
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) minimum: 0maximum: 256 |
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 |
OK Media Types: "application/json", "application/xml", "text/xml" |
|
| Other Status Codes |
Error response Media Types: "application/json", "application/xml", "text/xml" |
Security
Training-Key
Type:
apiKey
In:
header
Examples
Successful GetImagePerformances request
Sample request
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
[
{
"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 |
|---|---|
|
Bounding |
Bounding box that defines a region of an image. |
|
Custom |
|
|
Custom |
The error code. |
|
Image |
Image performance model. |
|
Image |
|
|
Image |
|
| Prediction |
Prediction result. |
|
Tag |
Type of the predicted tag. |
BoundingBox
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
| Name | Type | Description |
|---|---|---|
| code |
The error code. |
|
| message |
string |
A message explaining the error reported by the service. |
CustomVisionErrorCodes
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 |
ImagePerformance
Image performance model.
| Name | Type | Description |
|---|---|---|
| created |
string (date-time) |
|
| height |
integer (int32) |
|
| id |
string (uuid) |
|
| imageUri |
string |
|
| predictions |
Prediction result. |
|
| regions | ||
| tags |
Image |
|
| thumbnailUri |
string |
|
| width |
integer (int32) |
ImageRegion
| Name | Type | Description |
|---|---|---|
| created |
string (date-time) |
|
| height |
number (float) |
Height. |
| left |
number (float) |
Coordinate of the left boundary. |
| regionId |
string (uuid) |
|
| tagId |
string (uuid) |
Id of the tag associated with this region. |
| tagName |
string |
|
| top |
number (float) |
Coordinate of the top boundary. |
| width |
number (float) |
Width. |
ImageTag
| Name | Type | Description |
|---|---|---|
| created |
string (date-time) |
|
| tagId |
string (uuid) |
|
| tagName |
string |
Prediction
Prediction result.
| Name | Type | Description |
|---|---|---|
| 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 |
Type of the predicted tag. |
TagType
Type of the predicted tag.
| Value | Description |
|---|---|
| Regular | |
| Negative | |
| GeneralProduct |