Custom_Vision_Training_3.0
QueryPredictions
Get images that were sent to your prediction endpoint.
Select the testing console in the region where you created your resource:
West US 2 East US East US 2 South Central US West Europe North Europe Southeast Asia Australia East Central India UK South Japan East North Central US Central US EUAPRequest URL
Request parameters
string
Format - uuid. The project id.
Request headers
string
API key.
string
Media type of the body sent to the API.
Request body
Parameters used to query the predictions. Limited to combining 2 tags.
{
"session": "string",
"continuation": "string",
"maxCount": 0,
"orderBy": "Newest",
"tags": [
{
"id": "string",
"minThreshold": 0.0,
"maxThreshold": 0.0
}
],
"iterationId": "string",
"startTime": "string",
"endTime": "string",
"application": "string"
}{
"type": "object",
"properties": {
"session": {
"type": "string",
"readOnly": false,
"x-nullable": false
},
"continuation": {
"type": "string",
"readOnly": false,
"x-nullable": false
},
"maxCount": {
"format": "int32",
"type": "integer",
"readOnly": false,
"x-nullable": false
},
"orderBy": {
"enum": [
"Newest",
"Oldest",
"Suggested"
],
"type": "string",
"readOnly": false,
"x-nullable": false,
"x-ms-enum": {
"name": "OrderBy",
"modelAsString": true
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"minThreshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"maxThreshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": false
},
"readOnly": false
},
"iterationId": {
"format": "uuid",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"startTime": {
"format": "date-time",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"endTime": {
"format": "date-time",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"application": {
"type": "string",
"readOnly": false,
"x-nullable": false
}
}
}<PredictionQueryToken>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>string</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>string</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</PredictionQueryToken>{
"type": "object",
"properties": {
"session": {
"type": "string",
"readOnly": false,
"x-nullable": false
},
"continuation": {
"type": "string",
"readOnly": false,
"x-nullable": false
},
"maxCount": {
"format": "int32",
"type": "integer",
"readOnly": false,
"x-nullable": false
},
"orderBy": {
"enum": [
"Newest",
"Oldest",
"Suggested"
],
"type": "string",
"readOnly": false,
"x-nullable": false,
"x-ms-enum": {
"name": "OrderBy",
"modelAsString": true
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"minThreshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"maxThreshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": false
},
"readOnly": false
},
"iterationId": {
"format": "uuid",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"startTime": {
"format": "date-time",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"endTime": {
"format": "date-time",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"application": {
"type": "string",
"readOnly": false,
"x-nullable": false
}
}
}<PredictionQueryToken>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>string</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>string</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</PredictionQueryToken>{
"type": "object",
"properties": {
"session": {
"type": "string",
"readOnly": false,
"x-nullable": false
},
"continuation": {
"type": "string",
"readOnly": false,
"x-nullable": false
},
"maxCount": {
"format": "int32",
"type": "integer",
"readOnly": false,
"x-nullable": false
},
"orderBy": {
"enum": [
"Newest",
"Oldest",
"Suggested"
],
"type": "string",
"readOnly": false,
"x-nullable": false,
"x-ms-enum": {
"name": "OrderBy",
"modelAsString": true
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"minThreshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"maxThreshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": false
},
"readOnly": false
},
"iterationId": {
"format": "uuid",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"startTime": {
"format": "date-time",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"endTime": {
"format": "date-time",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"application": {
"type": "string",
"readOnly": false,
"x-nullable": false
}
}
}Response 200
OK
{
"token": {
"session": "string",
"continuation": "string",
"maxCount": 0,
"orderBy": "Newest",
"tags": [
{
"id": "string",
"minThreshold": 0.0,
"maxThreshold": 0.0
}
],
"iterationId": "string",
"startTime": "string",
"endTime": "string",
"application": "string"
},
"results": [
{
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"domain": "string",
"id": "string",
"project": "string",
"iteration": "string",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
}
]
}{
"type": "object",
"properties": {
"token": {
"type": "object",
"properties": {
"session": {
"type": "string",
"readOnly": false,
"x-nullable": false
},
"continuation": {
"type": "string",
"readOnly": false,
"x-nullable": false
},
"maxCount": {
"format": "int32",
"type": "integer",
"readOnly": false,
"x-nullable": false
},
"orderBy": {
"enum": [
"Newest",
"Oldest",
"Suggested"
],
"type": "string",
"readOnly": false,
"x-nullable": false,
"x-ms-enum": {
"name": "OrderBy",
"modelAsString": true
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"minThreshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"maxThreshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": false
},
"readOnly": false
},
"iterationId": {
"format": "uuid",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"startTime": {
"format": "date-time",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"endTime": {
"format": "date-time",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"application": {
"type": "string",
"readOnly": false,
"x-nullable": false
}
},
"readOnly": true,
"x-nullable": false
},
"results": {
"type": "array",
"items": {
"description": "result of an image classification request.",
"type": "object",
"properties": {
"resizedImageUri": {
"description": "The URI to the (resized) prediction image.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"thumbnailUri": {
"description": "The URI to the thumbnail of the original prediction image.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"originalImageUri": {
"description": "The URI to the original prediction image.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"domain": {
"format": "uuid",
"description": "Domain used for the prediction.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"id": {
"format": "uuid",
"description": "Prediction Id.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"project": {
"format": "uuid",
"description": "Project Id.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"iteration": {
"format": "uuid",
"description": "Iteration Id.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"description": "Date this prediction was created.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"predictions": {
"description": "List of predictions.",
"type": "array",
"items": {
"description": "Prediction result.",
"type": "object",
"properties": {
"probability": {
"format": "float",
"description": "Probability of the tag.",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"description": "Id of the predicted tag.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagName": {
"description": "Name of the predicted tag.",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"boundingBox": {
"description": "Bounding box of the prediction.",
"required": [
"left",
"top",
"width",
"height"
],
"type": "object",
"properties": {
"left": {
"format": "float",
"description": "Coordinate of the left boundary.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"top": {
"format": "float",
"description": "Coordinate of the top boundary.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"width": {
"format": "float",
"description": "Width.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"height": {
"format": "float",
"description": "Height.",
"type": "number",
"readOnly": false,
"x-nullable": false
}
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": false
},
"readOnly": true
}
},
"x-nullable": false
},
"readOnly": true
}
}
}<PredictionQueryResult>
<token>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>string</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>string</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</token>
<results>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>string</domain>
<id>string</id>
<project>string</project>
<iteration>string</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
</results>
</PredictionQueryResult>{
"type": "object",
"properties": {
"token": {
"type": "object",
"properties": {
"session": {
"type": "string",
"readOnly": false,
"x-nullable": false
},
"continuation": {
"type": "string",
"readOnly": false,
"x-nullable": false
},
"maxCount": {
"format": "int32",
"type": "integer",
"readOnly": false,
"x-nullable": false
},
"orderBy": {
"enum": [
"Newest",
"Oldest",
"Suggested"
],
"type": "string",
"readOnly": false,
"x-nullable": false,
"x-ms-enum": {
"name": "OrderBy",
"modelAsString": true
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"minThreshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"maxThreshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": false
},
"readOnly": false
},
"iterationId": {
"format": "uuid",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"startTime": {
"format": "date-time",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"endTime": {
"format": "date-time",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"application": {
"type": "string",
"readOnly": false,
"x-nullable": false
}
},
"readOnly": true,
"x-nullable": false
},
"results": {
"type": "array",
"items": {
"description": "result of an image classification request.",
"type": "object",
"properties": {
"resizedImageUri": {
"description": "The URI to the (resized) prediction image.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"thumbnailUri": {
"description": "The URI to the thumbnail of the original prediction image.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"originalImageUri": {
"description": "The URI to the original prediction image.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"domain": {
"format": "uuid",
"description": "Domain used for the prediction.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"id": {
"format": "uuid",
"description": "Prediction Id.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"project": {
"format": "uuid",
"description": "Project Id.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"iteration": {
"format": "uuid",
"description": "Iteration Id.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"description": "Date this prediction was created.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"predictions": {
"description": "List of predictions.",
"type": "array",
"items": {
"description": "Prediction result.",
"type": "object",
"properties": {
"probability": {
"format": "float",
"description": "Probability of the tag.",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"description": "Id of the predicted tag.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagName": {
"description": "Name of the predicted tag.",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"boundingBox": {
"description": "Bounding box of the prediction.",
"required": [
"left",
"top",
"width",
"height"
],
"type": "object",
"properties": {
"left": {
"format": "float",
"description": "Coordinate of the left boundary.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"top": {
"format": "float",
"description": "Coordinate of the top boundary.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"width": {
"format": "float",
"description": "Width.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"height": {
"format": "float",
"description": "Height.",
"type": "number",
"readOnly": false,
"x-nullable": false
}
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": false
},
"readOnly": true
}
},
"x-nullable": false
},
"readOnly": true
}
}
}<PredictionQueryResult>
<token>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>string</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>string</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</token>
<results>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>string</domain>
<id>string</id>
<project>string</project>
<iteration>string</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
</results>
</PredictionQueryResult>{
"type": "object",
"properties": {
"token": {
"type": "object",
"properties": {
"session": {
"type": "string",
"readOnly": false,
"x-nullable": false
},
"continuation": {
"type": "string",
"readOnly": false,
"x-nullable": false
},
"maxCount": {
"format": "int32",
"type": "integer",
"readOnly": false,
"x-nullable": false
},
"orderBy": {
"enum": [
"Newest",
"Oldest",
"Suggested"
],
"type": "string",
"readOnly": false,
"x-nullable": false,
"x-ms-enum": {
"name": "OrderBy",
"modelAsString": true
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"minThreshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"maxThreshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": false
},
"readOnly": false
},
"iterationId": {
"format": "uuid",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"startTime": {
"format": "date-time",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"endTime": {
"format": "date-time",
"type": "string",
"readOnly": false,
"x-nullable": true
},
"application": {
"type": "string",
"readOnly": false,
"x-nullable": false
}
},
"readOnly": true,
"x-nullable": false
},
"results": {
"type": "array",
"items": {
"description": "result of an image classification request.",
"type": "object",
"properties": {
"resizedImageUri": {
"description": "The URI to the (resized) prediction image.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"thumbnailUri": {
"description": "The URI to the thumbnail of the original prediction image.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"originalImageUri": {
"description": "The URI to the original prediction image.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"domain": {
"format": "uuid",
"description": "Domain used for the prediction.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"id": {
"format": "uuid",
"description": "Prediction Id.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"project": {
"format": "uuid",
"description": "Project Id.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"iteration": {
"format": "uuid",
"description": "Iteration Id.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"description": "Date this prediction was created.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"predictions": {
"description": "List of predictions.",
"type": "array",
"items": {
"description": "Prediction result.",
"type": "object",
"properties": {
"probability": {
"format": "float",
"description": "Probability of the tag.",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"description": "Id of the predicted tag.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagName": {
"description": "Name of the predicted tag.",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"boundingBox": {
"description": "Bounding box of the prediction.",
"required": [
"left",
"top",
"width",
"height"
],
"type": "object",
"properties": {
"left": {
"format": "float",
"description": "Coordinate of the left boundary.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"top": {
"format": "float",
"description": "Coordinate of the top boundary.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"width": {
"format": "float",
"description": "Width.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"height": {
"format": "float",
"description": "Height.",
"type": "number",
"readOnly": false,
"x-nullable": false
}
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": false
},
"readOnly": true
}
},
"x-nullable": false
},
"readOnly": true
}
}
}Response 500
Error response
{
"code": "NoError",
"message": "string"
}{
"required": [
"code",
"message"
],
"type": "object",
"properties": {
"code": {
"description": "The error code.",
"enum": [
"NoError",
"BadRequest",
"BadRequestExceededBatchSize",
"BadRequestNotSupported",
"BadRequestInvalidIds",
"BadRequestProjectName",
"BadRequestProjectNameNotUnique",
"BadRequestProjectDescription",
"BadRequestProjectUnknownDomain",
"BadRequestProjectUnknownClassification",
"BadRequestProjectUnsupportedDomainTypeChange",
"BadRequestProjectUnsupportedExportPlatform",
"BadRequestIterationName",
"BadRequestIterationNameNotUnique",
"BadRequestIterationDescription",
"BadRequestIterationIsNotTrained",
"BadRequestWorkspaceCannotBeModified",
"BadRequestWorkspaceNotDeletable",
"BadRequestTagName",
"BadRequestTagNameNotUnique",
"BadRequestTagDescription",
"BadRequestTagType",
"BadRequestMultipleNegativeTag",
"BadRequestImageTags",
"BadRequestImageRegions",
"BadRequestNegativeAndRegularTagOnSameImage",
"BadRequestRequiredParamIsNull",
"BadRequestIterationIsPublished",
"BadRequestInvalidPublishName",
"BadRequestInvalidPublishTarget",
"BadRequestUnpublishFailed",
"BadRequestIterationNotPublished",
"BadRequestSubscriptionApi",
"BadRequestExceedProjectLimit",
"BadRequestExceedIterationPerProjectLimit",
"BadRequestExceedTagPerProjectLimit",
"BadRequestExceedTagPerImageLimit",
"BadRequestExceededQuota",
"BadRequestCannotMigrateProjectWithName",
"BadRequestNotLimitedTrial",
"BadRequestImageBatch",
"BadRequestImageStream",
"BadRequestImageUrl",
"BadRequestImageFormat",
"BadRequestImageSizeBytes",
"BadRequestImageExceededCount",
"BadRequestTrainingNotNeeded",
"BadRequestTrainingNotNeededButTrainingPipelineUpdated",
"BadRequestTrainingValidationFailed",
"BadRequestClassificationTrainingValidationFailed",
"BadRequestMultiClassClassificationTrainingValidationFailed",
"BadRequestMultiLabelClassificationTrainingValidationFailed",
"BadRequestDetectionTrainingValidationFailed",
"BadRequestTrainingAlreadyInProgress",
"BadRequestDetectionTrainingNotAllowNegativeTag",
"BadRequestInvalidEmailAddress",
"BadRequestDomainNotSupportedForAdvancedTraining",
"BadRequestExportPlatformNotSupportedForAdvancedTraining",
"BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining",
"BadRequestExportValidationFailed",
"BadRequestExportAlreadyInProgress",
"BadRequestPredictionIdsMissing",
"BadRequestPredictionIdsExceededCount",
"BadRequestPredictionTagsExceededCount",
"BadRequestPredictionResultsExceededCount",
"BadRequestPredictionInvalidApplicationName",
"BadRequestPredictionInvalidQueryParameters",
"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",
"ErrorProjectInvalidWorkspace",
"ErrorProjectInvalidPipelineConfiguration",
"ErrorProjectInvalidDomain",
"ErrorProjectTrainingRequestFailed",
"ErrorProjectExportRequestFailed",
"ErrorFeaturizationServiceUnavailable",
"ErrorFeaturizationQueueTimeout",
"ErrorFeaturizationInvalidFeaturizer",
"ErrorFeaturizationAugmentationUnavailable",
"ErrorFeaturizationUnrecognizedJob",
"ErrorFeaturizationAugmentationError",
"ErrorExporterInvalidPlatform",
"ErrorExporterInvalidFeaturizer",
"ErrorExporterInvalidClassifier",
"ErrorPredictionServiceUnavailable",
"ErrorPredictionModelNotFound",
"ErrorPredictionModelNotCached",
"ErrorPrediction",
"ErrorPredictionStorage",
"ErrorRegionProposal",
"ErrorInvalid"
],
"type": "string",
"x-ms-enum": {
"name": "CustomVisionErrorCodes",
"modelAsString": true
}
},
"message": {
"description": "A message explaining the error reported by the service.",
"type": "string"
}
}
}<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>{
"required": [
"code",
"message"
],
"type": "object",
"properties": {
"code": {
"description": "The error code.",
"enum": [
"NoError",
"BadRequest",
"BadRequestExceededBatchSize",
"BadRequestNotSupported",
"BadRequestInvalidIds",
"BadRequestProjectName",
"BadRequestProjectNameNotUnique",
"BadRequestProjectDescription",
"BadRequestProjectUnknownDomain",
"BadRequestProjectUnknownClassification",
"BadRequestProjectUnsupportedDomainTypeChange",
"BadRequestProjectUnsupportedExportPlatform",
"BadRequestIterationName",
"BadRequestIterationNameNotUnique",
"BadRequestIterationDescription",
"BadRequestIterationIsNotTrained",
"BadRequestWorkspaceCannotBeModified",
"BadRequestWorkspaceNotDeletable",
"BadRequestTagName",
"BadRequestTagNameNotUnique",
"BadRequestTagDescription",
"BadRequestTagType",
"BadRequestMultipleNegativeTag",
"BadRequestImageTags",
"BadRequestImageRegions",
"BadRequestNegativeAndRegularTagOnSameImage",
"BadRequestRequiredParamIsNull",
"BadRequestIterationIsPublished",
"BadRequestInvalidPublishName",
"BadRequestInvalidPublishTarget",
"BadRequestUnpublishFailed",
"BadRequestIterationNotPublished",
"BadRequestSubscriptionApi",
"BadRequestExceedProjectLimit",
"BadRequestExceedIterationPerProjectLimit",
"BadRequestExceedTagPerProjectLimit",
"BadRequestExceedTagPerImageLimit",
"BadRequestExceededQuota",
"BadRequestCannotMigrateProjectWithName",
"BadRequestNotLimitedTrial",
"BadRequestImageBatch",
"BadRequestImageStream",
"BadRequestImageUrl",
"BadRequestImageFormat",
"BadRequestImageSizeBytes",
"BadRequestImageExceededCount",
"BadRequestTrainingNotNeeded",
"BadRequestTrainingNotNeededButTrainingPipelineUpdated",
"BadRequestTrainingValidationFailed",
"BadRequestClassificationTrainingValidationFailed",
"BadRequestMultiClassClassificationTrainingValidationFailed",
"BadRequestMultiLabelClassificationTrainingValidationFailed",
"BadRequestDetectionTrainingValidationFailed",
"BadRequestTrainingAlreadyInProgress",
"BadRequestDetectionTrainingNotAllowNegativeTag",
"BadRequestInvalidEmailAddress",
"BadRequestDomainNotSupportedForAdvancedTraining",
"BadRequestExportPlatformNotSupportedForAdvancedTraining",
"BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining",
"BadRequestExportValidationFailed",
"BadRequestExportAlreadyInProgress",
"BadRequestPredictionIdsMissing",
"BadRequestPredictionIdsExceededCount",
"BadRequestPredictionTagsExceededCount",
"BadRequestPredictionResultsExceededCount",
"BadRequestPredictionInvalidApplicationName",
"BadRequestPredictionInvalidQueryParameters",
"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",
"ErrorProjectInvalidWorkspace",
"ErrorProjectInvalidPipelineConfiguration",
"ErrorProjectInvalidDomain",
"ErrorProjectTrainingRequestFailed",
"ErrorProjectExportRequestFailed",
"ErrorFeaturizationServiceUnavailable",
"ErrorFeaturizationQueueTimeout",
"ErrorFeaturizationInvalidFeaturizer",
"ErrorFeaturizationAugmentationUnavailable",
"ErrorFeaturizationUnrecognizedJob",
"ErrorFeaturizationAugmentationError",
"ErrorExporterInvalidPlatform",
"ErrorExporterInvalidFeaturizer",
"ErrorExporterInvalidClassifier",
"ErrorPredictionServiceUnavailable",
"ErrorPredictionModelNotFound",
"ErrorPredictionModelNotCached",
"ErrorPrediction",
"ErrorPredictionStorage",
"ErrorRegionProposal",
"ErrorInvalid"
],
"type": "string",
"x-ms-enum": {
"name": "CustomVisionErrorCodes",
"modelAsString": true
}
},
"message": {
"description": "A message explaining the error reported by the service.",
"type": "string"
}
}
}<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>{
"required": [
"code",
"message"
],
"type": "object",
"properties": {
"code": {
"description": "The error code.",
"enum": [
"NoError",
"BadRequest",
"BadRequestExceededBatchSize",
"BadRequestNotSupported",
"BadRequestInvalidIds",
"BadRequestProjectName",
"BadRequestProjectNameNotUnique",
"BadRequestProjectDescription",
"BadRequestProjectUnknownDomain",
"BadRequestProjectUnknownClassification",
"BadRequestProjectUnsupportedDomainTypeChange",
"BadRequestProjectUnsupportedExportPlatform",
"BadRequestIterationName",
"BadRequestIterationNameNotUnique",
"BadRequestIterationDescription",
"BadRequestIterationIsNotTrained",
"BadRequestWorkspaceCannotBeModified",
"BadRequestWorkspaceNotDeletable",
"BadRequestTagName",
"BadRequestTagNameNotUnique",
"BadRequestTagDescription",
"BadRequestTagType",
"BadRequestMultipleNegativeTag",
"BadRequestImageTags",
"BadRequestImageRegions",
"BadRequestNegativeAndRegularTagOnSameImage",
"BadRequestRequiredParamIsNull",
"BadRequestIterationIsPublished",
"BadRequestInvalidPublishName",
"BadRequestInvalidPublishTarget",
"BadRequestUnpublishFailed",
"BadRequestIterationNotPublished",
"BadRequestSubscriptionApi",
"BadRequestExceedProjectLimit",
"BadRequestExceedIterationPerProjectLimit",
"BadRequestExceedTagPerProjectLimit",
"BadRequestExceedTagPerImageLimit",
"BadRequestExceededQuota",
"BadRequestCannotMigrateProjectWithName",
"BadRequestNotLimitedTrial",
"BadRequestImageBatch",
"BadRequestImageStream",
"BadRequestImageUrl",
"BadRequestImageFormat",
"BadRequestImageSizeBytes",
"BadRequestImageExceededCount",
"BadRequestTrainingNotNeeded",
"BadRequestTrainingNotNeededButTrainingPipelineUpdated",
"BadRequestTrainingValidationFailed",
"BadRequestClassificationTrainingValidationFailed",
"BadRequestMultiClassClassificationTrainingValidationFailed",
"BadRequestMultiLabelClassificationTrainingValidationFailed",
"BadRequestDetectionTrainingValidationFailed",
"BadRequestTrainingAlreadyInProgress",
"BadRequestDetectionTrainingNotAllowNegativeTag",
"BadRequestInvalidEmailAddress",
"BadRequestDomainNotSupportedForAdvancedTraining",
"BadRequestExportPlatformNotSupportedForAdvancedTraining",
"BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining",
"BadRequestExportValidationFailed",
"BadRequestExportAlreadyInProgress",
"BadRequestPredictionIdsMissing",
"BadRequestPredictionIdsExceededCount",
"BadRequestPredictionTagsExceededCount",
"BadRequestPredictionResultsExceededCount",
"BadRequestPredictionInvalidApplicationName",
"BadRequestPredictionInvalidQueryParameters",
"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",
"ErrorProjectInvalidWorkspace",
"ErrorProjectInvalidPipelineConfiguration",
"ErrorProjectInvalidDomain",
"ErrorProjectTrainingRequestFailed",
"ErrorProjectExportRequestFailed",
"ErrorFeaturizationServiceUnavailable",
"ErrorFeaturizationQueueTimeout",
"ErrorFeaturizationInvalidFeaturizer",
"ErrorFeaturizationAugmentationUnavailable",
"ErrorFeaturizationUnrecognizedJob",
"ErrorFeaturizationAugmentationError",
"ErrorExporterInvalidPlatform",
"ErrorExporterInvalidFeaturizer",
"ErrorExporterInvalidClassifier",
"ErrorPredictionServiceUnavailable",
"ErrorPredictionModelNotFound",
"ErrorPredictionModelNotCached",
"ErrorPrediction",
"ErrorPredictionStorage",
"ErrorRegionProposal",
"ErrorInvalid"
],
"type": "string",
"x-ms-enum": {
"name": "CustomVisionErrorCodes",
"modelAsString": true
}
},
"message": {
"description": "A message explaining the error reported by the service.",
"type": "string"
}
}
}Code samples
@ECHO OFF
curl -v -X POST "https://northcentralus.api.cognitive.microsoft.com/customvision/v3.0/training/projects/{projectId}/predictions/query"
-H "Training-Key: "
-H "Content-Type: application/json"
-H "Training-key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Training-Key", "");
client.DefaultRequestHeaders.Add("Training-key", "{subscription key}");
var uri = "https://northcentralus.api.cognitive.microsoft.com/customvision/v3.0/training/projects/{projectId}/predictions/query?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://northcentralus.api.cognitive.microsoft.com/customvision/v3.0/training/projects/{projectId}/predictions/query");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Training-Key", "");
request.setHeader("Content-Type", "application/json");
request.setHeader("Training-key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://northcentralus.api.cognitive.microsoft.com/customvision/v3.0/training/projects/{projectId}/predictions/query?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Training-Key","");
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Training-key","{subscription key}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://northcentralus.api.cognitive.microsoft.com/customvision/v3.0/training/projects/{projectId}/predictions/query";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"Training-Key"];
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Training-key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://northcentralus.api.cognitive.microsoft.com/customvision/v3.0/training/projects/{projectId}/predictions/query');
$url = $request->getUrl();
$headers = array(
// Request headers
'Training-Key' => '',
'Content-Type' => 'application/json',
'Training-key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Training-Key': '',
'Content-Type': 'application/json',
'Training-key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('northcentralus.api.cognitive.microsoft.com')
conn.request("POST", "/customvision/v3.0/training/projects/{projectId}/predictions/query?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Training-Key': '',
'Content-Type': 'application/json',
'Training-key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('northcentralus.api.cognitive.microsoft.com')
conn.request("POST", "/customvision/v3.0/training/projects/{projectId}/predictions/query?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://northcentralus.api.cognitive.microsoft.com/customvision/v3.0/training/projects/{projectId}/predictions/query')
uri.query = URI.encode_www_form({
})
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Training-Key'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Training-key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body