Images - List Suggested

Service:

Azure AI Services

API Version:

3.3

This API will fetch untagged images filtered by suggested tags Ids. It returns an empty array if no images are found.

POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/images/suggested?iterationId={iterationId}

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoints.
projectId	path	True	string uuid	The project id.
iterationId	query	True	string uuid	IterationId to use for the suggested tags and regions.

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	Type	Description
continuation	string	Continuation Id for database pagination. Initially null but later used to paginate.
maxCount	integer	Maximum number of results you want to be returned in the response.
session	string	SessionId for database query. Initially set to null but later used to paginate.
sortBy	SortBy	OrderBy. Ordering mechanism for your results.
tagIds	string[]	Existing TagIds in project to filter suggested tags on.
threshold	number	Confidence threshold to filter suggested tags on.

Responses

Name	Type	Description
200 OK	SuggestedTagAndRegionQuery	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 QuerySuggestedImages request

Sample request

HTTP

POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/bc3f7dad-5544-468c-8573-3ef04d55463e/images/suggested?iterationId=b7b9d99c-a2c6-4658-9900-a98d2ff5bc66


{
  "tagIds": [
    "b5f7e6a2-a481-49a6-afec-a7cef1af3544"
  ]
}

Sample response

Status code:

200

{
  "results": [
    {
      "id": "dfd2d346-3ed5-4e1e-857d-af4e32cec042",
      "project": "8988643a-ae70-447d-9a22-15c4255e5ecb",
      "iteration": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66",
      "created": "2018-01-31T20:18:26Z",
      "predictions": [
        {
          "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544",
          "tagName": "Tag 1",
          "probability": 1
        },
        {
          "tagId": "45619cda-d1c9-4bc8-a3e1-87c5d81adbc3",
          "tagName": "Tag 2",
          "probability": 3.60627153E-12
        }
      ],
      "originalImageUri": "<image uri>",
      "thumbnailUri": "<thumbnail uri>",
      "resizedImageUri": "<resized image uri>",
      "domain": "b30a91ae-e3c1-4f73-a81e-c270bff27c39"
    }
  ],
  "token": {
    "session": "1:286613",
    "continuation": "",
    "maxCount": 0,
    "sortBy": "Newest",
    "tagIds": [
      "b5f7e6a2-a481-49a6-afec-a7cef1af3544"
    ]
  }
}

Definitions

Name	Description
BoundingBox	Bounding box that defines a region of an image.
CustomVisionError
CustomVisionErrorCodes	The error code.
Prediction	Prediction result.
SortBy	OrderBy. Ordering mechanism for your results.
StoredSuggestedTagAndRegion	Result of a suggested tags and regions request of the untagged image.
SuggestedTagAndRegionQuery	The array of result images and token containing session and continuation Ids for the next query.
SuggestedTagAndRegionQueryToken	Contains properties we need to fetch suggested tags for. For the first call, Session and continuation set to null. Then on subsequent calls, uses the session/continuation from the previous SuggestedTagAndRegionQuery result to fetch additional results.
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

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.

SortBy

Enumeration

OrderBy. Ordering mechanism for your results.

Value	Description
UncertaintyAscending
UncertaintyDescending

StoredSuggestedTagAndRegion

Object

Result of a suggested tags and regions request of the untagged image.

Name	Type	Description
created	string	Date this prediction was created.
domain	string	Domain used for the prediction.
height	integer	Height of the resized image.
id	string	Prediction Id.
iteration	string	Iteration Id.
originalImageUri	string	The URI to the original prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.
predictionUncertainty	number	Uncertainty (entropy) of suggested tags or regions per image.
predictions	Prediction[]	List of predictions.
project	string	Project Id.
resizedImageUri	string	The URI to the (resized) prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.
thumbnailUri	string	The URI to the thumbnail of the original prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.
width	integer	Width of the resized image.

SuggestedTagAndRegionQuery

Object

The array of result images and token containing session and continuation Ids for the next query.

Name	Type	Description
results	StoredSuggestedTagAndRegion[]	Result of a suggested tags and regions request of the untagged image.
token	SuggestedTagAndRegionQueryToken	Contains properties we need to fetch suggested tags for.

SuggestedTagAndRegionQueryToken

Object

Contains properties we need to fetch suggested tags for. For the first call, Session and continuation set to null. Then on subsequent calls, uses the session/continuation from the previous SuggestedTagAndRegionQuery result to fetch additional results.

Name	Type	Description
continuation	string	Continuation Id for database pagination. Initially null but later used to paginate.
maxCount	integer	Maximum number of results you want to be returned in the response.
session	string	SessionId for database query. Initially set to null but later used to paginate.
sortBy	SortBy	OrderBy. Ordering mechanism for your results.
tagIds	string[]	Existing TagIds in project to filter suggested tags on.
threshold	number	Confidence threshold to filter suggested tags on.

TagType

Enumeration

Type of the predicted tag.

Value	Description
GeneralProduct
Negative
Regular