Custom_Vision_Training_3.3
QuerySuggestedImages
This API will fetch untagged images filtered by suggested tags Ids. It returns an empty array if no images are found.
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request parameters
string
Format - uuid. The project id.
string
Format - uuid. IterationId to use for the suggested tags and regions.
Request headers
string
Media type of the body sent to the API.
Request body
Contains properties we need to query suggested images.
{
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"threshold": 0.0,
"session": "string",
"continuation": "string",
"maxCount": 0,
"sortBy": "UncertaintyAscending"
}{
"description": "Contains properties we need to fetch suggested tags for. For the first call, Session and continuation set to null.\r\nThen on subsequent calls, uses the session/continuation from the previous SuggestedTagAndRegionQuery result to fetch additional results.",
"type": "object",
"properties": {
"tagIds": {
"description": "Existing TagIds in project to filter suggested tags on.",
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"readOnly": false
},
"threshold": {
"format": "double",
"description": "Confidence threshold to filter suggested tags on.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"session": {
"description": "SessionId for database query. Initially set to null but later used to paginate.",
"type": "string",
"readOnly": false,
"x-nullable": false
},
"continuation": {
"description": "Continuation Id for database pagination. Initially null but later used to paginate.",
"type": "string",
"readOnly": false,
"x-nullable": false
},
"maxCount": {
"format": "int32",
"description": "Maximum number of results you want to be returned in the response.",
"type": "integer",
"readOnly": false,
"x-nullable": false
},
"sortBy": {
"description": "OrderBy. Ordering mechanism for your results.",
"enum": [
"UncertaintyAscending",
"UncertaintyDescending"
],
"type": "string",
"readOnly": false,
"x-nullable": false,
"x-ms-enum": {
"name": "SortBy",
"modelAsString": true
}
}
}
}<SuggestedTagAndRegionQueryToken>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</SuggestedTagAndRegionQueryToken>{
"description": "Contains properties we need to fetch suggested tags for. For the first call, Session and continuation set to null.\r\nThen on subsequent calls, uses the session/continuation from the previous SuggestedTagAndRegionQuery result to fetch additional results.",
"type": "object",
"properties": {
"tagIds": {
"description": "Existing TagIds in project to filter suggested tags on.",
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"readOnly": false
},
"threshold": {
"format": "double",
"description": "Confidence threshold to filter suggested tags on.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"session": {
"description": "SessionId for database query. Initially set to null but later used to paginate.",
"type": "string",
"readOnly": false,
"x-nullable": false
},
"continuation": {
"description": "Continuation Id for database pagination. Initially null but later used to paginate.",
"type": "string",
"readOnly": false,
"x-nullable": false
},
"maxCount": {
"format": "int32",
"description": "Maximum number of results you want to be returned in the response.",
"type": "integer",
"readOnly": false,
"x-nullable": false
},
"sortBy": {
"description": "OrderBy. Ordering mechanism for your results.",
"enum": [
"UncertaintyAscending",
"UncertaintyDescending"
],
"type": "string",
"readOnly": false,
"x-nullable": false,
"x-ms-enum": {
"name": "SortBy",
"modelAsString": true
}
}
}
}<SuggestedTagAndRegionQueryToken>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</SuggestedTagAndRegionQueryToken>{
"description": "Contains properties we need to fetch suggested tags for. For the first call, Session and continuation set to null.\r\nThen on subsequent calls, uses the session/continuation from the previous SuggestedTagAndRegionQuery result to fetch additional results.",
"type": "object",
"properties": {
"tagIds": {
"description": "Existing TagIds in project to filter suggested tags on.",
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"readOnly": false
},
"threshold": {
"format": "double",
"description": "Confidence threshold to filter suggested tags on.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"session": {
"description": "SessionId for database query. Initially set to null but later used to paginate.",
"type": "string",
"readOnly": false,
"x-nullable": false
},
"continuation": {
"description": "Continuation Id for database pagination. Initially null but later used to paginate.",
"type": "string",
"readOnly": false,
"x-nullable": false
},
"maxCount": {
"format": "int32",
"description": "Maximum number of results you want to be returned in the response.",
"type": "integer",
"readOnly": false,
"x-nullable": false
},
"sortBy": {
"description": "OrderBy. Ordering mechanism for your results.",
"enum": [
"UncertaintyAscending",
"UncertaintyDescending"
],
"type": "string",
"readOnly": false,
"x-nullable": false,
"x-ms-enum": {
"name": "SortBy",
"modelAsString": true
}
}
}
}Response 200
OK
{
"token": {
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"threshold": 0.0,
"session": "string",
"continuation": "string",
"maxCount": 0,
"sortBy": "UncertaintyAscending"
},
"results": [
{
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"domain": "00000000-0000-0000-0000-000000000000",
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
],
"predictionUncertainty": 0.0
}
]
}{
"description": "The array of result images and token containing session and continuation Ids for the next query.",
"type": "object",
"properties": {
"token": {
"description": "Contains properties we need to fetch suggested tags for.",
"type": "object",
"properties": {
"tagIds": {
"description": "Existing TagIds in project to filter suggested tags on.",
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"readOnly": false
},
"threshold": {
"format": "double",
"description": "Confidence threshold to filter suggested tags on.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"session": {
"description": "SessionId for database query. Initially set to null but later used to paginate.",
"type": "string",
"readOnly": false,
"x-nullable": false
},
"continuation": {
"description": "Continuation Id for database pagination. Initially null but later used to paginate.",
"type": "string",
"readOnly": false,
"x-nullable": false
},
"maxCount": {
"format": "int32",
"description": "Maximum number of results you want to be returned in the response.",
"type": "integer",
"readOnly": false,
"x-nullable": false
},
"sortBy": {
"description": "OrderBy. Ordering mechanism for your results.",
"enum": [
"UncertaintyAscending",
"UncertaintyDescending"
],
"type": "string",
"readOnly": false,
"x-nullable": false,
"x-ms-enum": {
"name": "SortBy",
"modelAsString": true
}
}
},
"readOnly": false
},
"results": {
"description": "Result of a suggested tags and regions request of the image.",
"type": "array",
"items": {
"description": "Result of a suggested tags and regions request of the image.",
"type": "object",
"properties": {
"width": {
"format": "int32",
"description": "Width of the resized image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"height": {
"format": "int32",
"description": "Height of the resized image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"resizedImageUri": {
"description": "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.",
"type": "string",
"readOnly": true
},
"thumbnailUri": {
"description": "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.",
"type": "string",
"readOnly": true
},
"originalImageUri": {
"description": "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.",
"type": "string",
"readOnly": true
},
"domain": {
"format": "uuid",
"description": "Domain used for the prediction.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"id": {
"format": "uuid",
"description": "Prediction Id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"project": {
"format": "uuid",
"description": "Project Id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"iteration": {
"format": "uuid",
"description": "Iteration Id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"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,
"example": "00000000-0000-0000-0000-000000000000",
"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
},
"tagType": {
"description": "Type of the predicted tag.",
"enum": [
"Regular",
"Negative",
"GeneralProduct"
],
"type": "string",
"readOnly": true,
"x-nullable": true,
"x-ms-enum": {
"name": "TagType",
"modelAsString": true
}
}
},
"x-nullable": false
},
"readOnly": true
},
"predictionUncertainty": {
"format": "double",
"description": "Uncertainty (entropy) of suggested tags or regions per image.",
"type": "number",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": false
},
"readOnly": true
}
}
}<SuggestedTagAndRegionQuery>
<token>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</token>
<results>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>00000000-0000-0000-0000-000000000000</domain>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<predictionUncertainty>0</predictionUncertainty>
</results>
</SuggestedTagAndRegionQuery>{
"description": "The array of result images and token containing session and continuation Ids for the next query.",
"type": "object",
"properties": {
"token": {
"description": "Contains properties we need to fetch suggested tags for.",
"type": "object",
"properties": {
"tagIds": {
"description": "Existing TagIds in project to filter suggested tags on.",
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"readOnly": false
},
"threshold": {
"format": "double",
"description": "Confidence threshold to filter suggested tags on.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"session": {
"description": "SessionId for database query. Initially set to null but later used to paginate.",
"type": "string",
"readOnly": false,
"x-nullable": false
},
"continuation": {
"description": "Continuation Id for database pagination. Initially null but later used to paginate.",
"type": "string",
"readOnly": false,
"x-nullable": false
},
"maxCount": {
"format": "int32",
"description": "Maximum number of results you want to be returned in the response.",
"type": "integer",
"readOnly": false,
"x-nullable": false
},
"sortBy": {
"description": "OrderBy. Ordering mechanism for your results.",
"enum": [
"UncertaintyAscending",
"UncertaintyDescending"
],
"type": "string",
"readOnly": false,
"x-nullable": false,
"x-ms-enum": {
"name": "SortBy",
"modelAsString": true
}
}
},
"readOnly": false
},
"results": {
"description": "Result of a suggested tags and regions request of the image.",
"type": "array",
"items": {
"description": "Result of a suggested tags and regions request of the image.",
"type": "object",
"properties": {
"width": {
"format": "int32",
"description": "Width of the resized image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"height": {
"format": "int32",
"description": "Height of the resized image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"resizedImageUri": {
"description": "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.",
"type": "string",
"readOnly": true
},
"thumbnailUri": {
"description": "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.",
"type": "string",
"readOnly": true
},
"originalImageUri": {
"description": "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.",
"type": "string",
"readOnly": true
},
"domain": {
"format": "uuid",
"description": "Domain used for the prediction.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"id": {
"format": "uuid",
"description": "Prediction Id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"project": {
"format": "uuid",
"description": "Project Id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"iteration": {
"format": "uuid",
"description": "Iteration Id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"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,
"example": "00000000-0000-0000-0000-000000000000",
"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
},
"tagType": {
"description": "Type of the predicted tag.",
"enum": [
"Regular",
"Negative",
"GeneralProduct"
],
"type": "string",
"readOnly": true,
"x-nullable": true,
"x-ms-enum": {
"name": "TagType",
"modelAsString": true
}
}
},
"x-nullable": false
},
"readOnly": true
},
"predictionUncertainty": {
"format": "double",
"description": "Uncertainty (entropy) of suggested tags or regions per image.",
"type": "number",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": false
},
"readOnly": true
}
}
}<SuggestedTagAndRegionQuery>
<token>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</token>
<results>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>00000000-0000-0000-0000-000000000000</domain>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<predictionUncertainty>0</predictionUncertainty>
</results>
</SuggestedTagAndRegionQuery>{
"description": "The array of result images and token containing session and continuation Ids for the next query.",
"type": "object",
"properties": {
"token": {
"description": "Contains properties we need to fetch suggested tags for.",
"type": "object",
"properties": {
"tagIds": {
"description": "Existing TagIds in project to filter suggested tags on.",
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"readOnly": false
},
"threshold": {
"format": "double",
"description": "Confidence threshold to filter suggested tags on.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"session": {
"description": "SessionId for database query. Initially set to null but later used to paginate.",
"type": "string",
"readOnly": false,
"x-nullable": false
},
"continuation": {
"description": "Continuation Id for database pagination. Initially null but later used to paginate.",
"type": "string",
"readOnly": false,
"x-nullable": false
},
"maxCount": {
"format": "int32",
"description": "Maximum number of results you want to be returned in the response.",
"type": "integer",
"readOnly": false,
"x-nullable": false
},
"sortBy": {
"description": "OrderBy. Ordering mechanism for your results.",
"enum": [
"UncertaintyAscending",
"UncertaintyDescending"
],
"type": "string",
"readOnly": false,
"x-nullable": false,
"x-ms-enum": {
"name": "SortBy",
"modelAsString": true
}
}
},
"readOnly": false
},
"results": {
"description": "Result of a suggested tags and regions request of the image.",
"type": "array",
"items": {
"description": "Result of a suggested tags and regions request of the image.",
"type": "object",
"properties": {
"width": {
"format": "int32",
"description": "Width of the resized image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"height": {
"format": "int32",
"description": "Height of the resized image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"resizedImageUri": {
"description": "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.",
"type": "string",
"readOnly": true
},
"thumbnailUri": {
"description": "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.",
"type": "string",
"readOnly": true
},
"originalImageUri": {
"description": "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.",
"type": "string",
"readOnly": true
},
"domain": {
"format": "uuid",
"description": "Domain used for the prediction.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"id": {
"format": "uuid",
"description": "Prediction Id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"project": {
"format": "uuid",
"description": "Project Id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"iteration": {
"format": "uuid",
"description": "Iteration Id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"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,
"example": "00000000-0000-0000-0000-000000000000",
"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
},
"tagType": {
"description": "Type of the predicted tag.",
"enum": [
"Regular",
"Negative",
"GeneralProduct"
],
"type": "string",
"readOnly": true,
"x-nullable": true,
"x-ms-enum": {
"name": "TagType",
"modelAsString": true
}
}
},
"x-nullable": false
},
"readOnly": true
},
"predictionUncertainty": {
"format": "double",
"description": "Uncertainty (entropy) of suggested tags or regions per image.",
"type": "number",
"readOnly": true,
"x-nullable": false
}
},
"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",
"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",
"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",
"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",
"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",
"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",
"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",
"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",
"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",
"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://*.cognitiveservices.azure.com/customvision/v3.3/Training/projects/{projectId}/images/suggested?iterationId={iterationId}"
-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", "{subscription key}");
var uri = "https://*.cognitiveservices.azure.com/customvision/v3.3/Training/projects/{projectId}/images/suggested?iterationId={iterationId}&" + 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://*.cognitiveservices.azure.com/customvision/v3.3/Training/projects/{projectId}/images/suggested?iterationId={iterationId}");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
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://*.cognitiveservices.azure.com/customvision/v3.3/Training/projects/{projectId}/images/suggested?iterationId={iterationId}&" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
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://*.cognitiveservices.azure.com/customvision/v3.3/Training/projects/{projectId}/images/suggested?iterationId={iterationId}";
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:@"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://*.cognitiveservices.azure.com/customvision/v3.3/Training/projects/{projectId}/images/suggested?iterationId={iterationId}');
$url = $request->getUrl();
$headers = array(
// Request headers
'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
'Content-Type': 'application/json',
'Training-key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("POST", "/customvision/v3.3/Training/projects/{projectId}/images/suggested?iterationId={iterationId}&%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
'Content-Type': 'application/json',
'Training-key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("POST", "/customvision/v3.3/Training/projects/{projectId}/images/suggested?iterationId={iterationId}&%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://*.cognitiveservices.azure.com/customvision/v3.3/Training/projects/{projectId}/images/suggested?iterationId={iterationId}')
request = Net::HTTP::Post.new(uri.request_uri)
# 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