Custom_Vision_Training_3.3
CreateImagesFromPredictions
This API creates a batch of images from predicted images specified. There is a limit of 64 images and 20 tags. If all images are successful created, 200(OK) status code will be returned. Otherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.
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
Media type of the body sent to the API.
Request body
Image, tag ids, and metadata. Limited to 64 images and 20 tags per batch.
{
"images": [
{
"id": "00000000-0000-0000-0000-000000000000",
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"regions": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"metadata": {}
}{
"type": "object",
"properties": {
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Id of the image.",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"readOnly": false
},
"regions": {
"type": "array",
"items": {
"required": [
"tagId",
"left",
"top",
"width",
"height"
],
"type": "object",
"properties": {
"tagId": {
"format": "uuid",
"description": "Id of the tag associated with this region.",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"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
}
},
"x-nullable": false
},
"readOnly": false
}
},
"x-nullable": false
},
"readOnly": false
},
"tagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"readOnly": false
},
"metadata": {
"description": "The metadata of image. Limited to 10 key-value pairs per image. The length of key is limited to 128. The length of value is limied to 256.",
"type": "object",
"additionalProperties": {
"type": "string"
},
"readOnly": false,
"x-nullable": true
}
}
}<ImageIdCreateBatch>
<images>
<id>00000000-0000-0000-0000-000000000000</id>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageIdCreateBatch>{
"type": "object",
"properties": {
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Id of the image.",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"readOnly": false
},
"regions": {
"type": "array",
"items": {
"required": [
"tagId",
"left",
"top",
"width",
"height"
],
"type": "object",
"properties": {
"tagId": {
"format": "uuid",
"description": "Id of the tag associated with this region.",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"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
}
},
"x-nullable": false
},
"readOnly": false
}
},
"x-nullable": false
},
"readOnly": false
},
"tagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"readOnly": false
},
"metadata": {
"description": "The metadata of image. Limited to 10 key-value pairs per image. The length of key is limited to 128. The length of value is limied to 256.",
"type": "object",
"additionalProperties": {
"type": "string"
},
"readOnly": false,
"x-nullable": true
}
}
}<ImageIdCreateBatch>
<images>
<id>00000000-0000-0000-0000-000000000000</id>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageIdCreateBatch>{
"type": "object",
"properties": {
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Id of the image.",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"readOnly": false
},
"regions": {
"type": "array",
"items": {
"required": [
"tagId",
"left",
"top",
"width",
"height"
],
"type": "object",
"properties": {
"tagId": {
"format": "uuid",
"description": "Id of the tag associated with this region.",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"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
}
},
"x-nullable": false
},
"readOnly": false
}
},
"x-nullable": false
},
"readOnly": false
},
"tagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"readOnly": false
},
"metadata": {
"description": "The metadata of image. Limited to 10 key-value pairs per image. The length of key is limited to 128. The length of value is limied to 256.",
"type": "object",
"additionalProperties": {
"type": "string"
},
"readOnly": false,
"x-nullable": true
}
}
}Response 200
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}{
"type": "object",
"properties": {
"isBatchSuccessful": {
"description": "True if all of the images in the batch were created successfully, otherwise false.",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"images": {
"description": "List of the image creation results.",
"type": "array",
"items": {
"type": "object",
"properties": {
"sourceUrl": {
"description": "Source URL of the image.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"status": {
"description": "Status of the image creation.",
"enum": [
"OK",
"OKDuplicate",
"ErrorSource",
"ErrorImageFormat",
"ErrorImageSize",
"ErrorStorage",
"ErrorLimitExceed",
"ErrorTagLimitExceed",
"ErrorRegionLimitExceed",
"ErrorUnknown",
"ErrorNegativeAndRegularTagOnSameImage"
],
"type": "string",
"readOnly": true,
"x-nullable": false,
"x-ms-enum": {
"name": "ImageCreateStatus",
"modelAsString": true
}
},
"image": {
"description": "The image.",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Id of the image.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"created": {
"format": "date-time",
"description": "Date the image was created.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"width": {
"format": "int32",
"description": "Width of the image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"height": {
"format": "int32",
"description": "Height of the image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"resizedImageUri": {
"description": "The URI to the (resized) image used for training. 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 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 uploaded 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
},
"tags": {
"description": "Tags associated with this image.",
"type": "array",
"items": {
"type": "object",
"properties": {
"tagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
}
}
},
"readOnly": true,
"x-nullable": true
},
"regions": {
"description": "Regions associated with this image.",
"type": "array",
"items": {
"required": [
"tagId",
"left",
"top",
"width",
"height"
],
"type": "object",
"properties": {
"regionId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"description": "Id of the tag associated with this region.",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"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
},
"metadata": {
"description": "Metadata associated with this image.",
"type": "object",
"additionalProperties": {
"type": "string"
},
"readOnly": true,
"x-nullable": true
}
},
"readOnly": true
}
},
"x-nullable": false
},
"readOnly": true
}
}
}<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>{
"type": "object",
"properties": {
"isBatchSuccessful": {
"description": "True if all of the images in the batch were created successfully, otherwise false.",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"images": {
"description": "List of the image creation results.",
"type": "array",
"items": {
"type": "object",
"properties": {
"sourceUrl": {
"description": "Source URL of the image.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"status": {
"description": "Status of the image creation.",
"enum": [
"OK",
"OKDuplicate",
"ErrorSource",
"ErrorImageFormat",
"ErrorImageSize",
"ErrorStorage",
"ErrorLimitExceed",
"ErrorTagLimitExceed",
"ErrorRegionLimitExceed",
"ErrorUnknown",
"ErrorNegativeAndRegularTagOnSameImage"
],
"type": "string",
"readOnly": true,
"x-nullable": false,
"x-ms-enum": {
"name": "ImageCreateStatus",
"modelAsString": true
}
},
"image": {
"description": "The image.",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Id of the image.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"created": {
"format": "date-time",
"description": "Date the image was created.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"width": {
"format": "int32",
"description": "Width of the image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"height": {
"format": "int32",
"description": "Height of the image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"resizedImageUri": {
"description": "The URI to the (resized) image used for training. 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 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 uploaded 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
},
"tags": {
"description": "Tags associated with this image.",
"type": "array",
"items": {
"type": "object",
"properties": {
"tagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
}
}
},
"readOnly": true,
"x-nullable": true
},
"regions": {
"description": "Regions associated with this image.",
"type": "array",
"items": {
"required": [
"tagId",
"left",
"top",
"width",
"height"
],
"type": "object",
"properties": {
"regionId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"description": "Id of the tag associated with this region.",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"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
},
"metadata": {
"description": "Metadata associated with this image.",
"type": "object",
"additionalProperties": {
"type": "string"
},
"readOnly": true,
"x-nullable": true
}
},
"readOnly": true
}
},
"x-nullable": false
},
"readOnly": true
}
}
}<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>{
"type": "object",
"properties": {
"isBatchSuccessful": {
"description": "True if all of the images in the batch were created successfully, otherwise false.",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"images": {
"description": "List of the image creation results.",
"type": "array",
"items": {
"type": "object",
"properties": {
"sourceUrl": {
"description": "Source URL of the image.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"status": {
"description": "Status of the image creation.",
"enum": [
"OK",
"OKDuplicate",
"ErrorSource",
"ErrorImageFormat",
"ErrorImageSize",
"ErrorStorage",
"ErrorLimitExceed",
"ErrorTagLimitExceed",
"ErrorRegionLimitExceed",
"ErrorUnknown",
"ErrorNegativeAndRegularTagOnSameImage"
],
"type": "string",
"readOnly": true,
"x-nullable": false,
"x-ms-enum": {
"name": "ImageCreateStatus",
"modelAsString": true
}
},
"image": {
"description": "The image.",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Id of the image.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"created": {
"format": "date-time",
"description": "Date the image was created.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"width": {
"format": "int32",
"description": "Width of the image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"height": {
"format": "int32",
"description": "Height of the image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"resizedImageUri": {
"description": "The URI to the (resized) image used for training. 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 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 uploaded 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
},
"tags": {
"description": "Tags associated with this image.",
"type": "array",
"items": {
"type": "object",
"properties": {
"tagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
}
}
},
"readOnly": true,
"x-nullable": true
},
"regions": {
"description": "Regions associated with this image.",
"type": "array",
"items": {
"required": [
"tagId",
"left",
"top",
"width",
"height"
],
"type": "object",
"properties": {
"regionId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"description": "Id of the tag associated with this region.",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"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
},
"metadata": {
"description": "Metadata associated with this image.",
"type": "object",
"additionalProperties": {
"type": "string"
},
"readOnly": true,
"x-nullable": true
}
},
"readOnly": true
}
},
"x-nullable": false
},
"readOnly": true
}
}
}Response 207
207
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}{
"type": "object",
"properties": {
"isBatchSuccessful": {
"description": "True if all of the images in the batch were created successfully, otherwise false.",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"images": {
"description": "List of the image creation results.",
"type": "array",
"items": {
"type": "object",
"properties": {
"sourceUrl": {
"description": "Source URL of the image.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"status": {
"description": "Status of the image creation.",
"enum": [
"OK",
"OKDuplicate",
"ErrorSource",
"ErrorImageFormat",
"ErrorImageSize",
"ErrorStorage",
"ErrorLimitExceed",
"ErrorTagLimitExceed",
"ErrorRegionLimitExceed",
"ErrorUnknown",
"ErrorNegativeAndRegularTagOnSameImage"
],
"type": "string",
"readOnly": true,
"x-nullable": false,
"x-ms-enum": {
"name": "ImageCreateStatus",
"modelAsString": true
}
},
"image": {
"description": "The image.",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Id of the image.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"created": {
"format": "date-time",
"description": "Date the image was created.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"width": {
"format": "int32",
"description": "Width of the image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"height": {
"format": "int32",
"description": "Height of the image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"resizedImageUri": {
"description": "The URI to the (resized) image used for training. 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 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 uploaded 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
},
"tags": {
"description": "Tags associated with this image.",
"type": "array",
"items": {
"type": "object",
"properties": {
"tagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
}
}
},
"readOnly": true,
"x-nullable": true
},
"regions": {
"description": "Regions associated with this image.",
"type": "array",
"items": {
"required": [
"tagId",
"left",
"top",
"width",
"height"
],
"type": "object",
"properties": {
"regionId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"description": "Id of the tag associated with this region.",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"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
},
"metadata": {
"description": "Metadata associated with this image.",
"type": "object",
"additionalProperties": {
"type": "string"
},
"readOnly": true,
"x-nullable": true
}
},
"readOnly": true
}
},
"x-nullable": false
},
"readOnly": true
}
}
}<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>{
"type": "object",
"properties": {
"isBatchSuccessful": {
"description": "True if all of the images in the batch were created successfully, otherwise false.",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"images": {
"description": "List of the image creation results.",
"type": "array",
"items": {
"type": "object",
"properties": {
"sourceUrl": {
"description": "Source URL of the image.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"status": {
"description": "Status of the image creation.",
"enum": [
"OK",
"OKDuplicate",
"ErrorSource",
"ErrorImageFormat",
"ErrorImageSize",
"ErrorStorage",
"ErrorLimitExceed",
"ErrorTagLimitExceed",
"ErrorRegionLimitExceed",
"ErrorUnknown",
"ErrorNegativeAndRegularTagOnSameImage"
],
"type": "string",
"readOnly": true,
"x-nullable": false,
"x-ms-enum": {
"name": "ImageCreateStatus",
"modelAsString": true
}
},
"image": {
"description": "The image.",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Id of the image.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"created": {
"format": "date-time",
"description": "Date the image was created.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"width": {
"format": "int32",
"description": "Width of the image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"height": {
"format": "int32",
"description": "Height of the image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"resizedImageUri": {
"description": "The URI to the (resized) image used for training. 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 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 uploaded 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
},
"tags": {
"description": "Tags associated with this image.",
"type": "array",
"items": {
"type": "object",
"properties": {
"tagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
}
}
},
"readOnly": true,
"x-nullable": true
},
"regions": {
"description": "Regions associated with this image.",
"type": "array",
"items": {
"required": [
"tagId",
"left",
"top",
"width",
"height"
],
"type": "object",
"properties": {
"regionId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"description": "Id of the tag associated with this region.",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"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
},
"metadata": {
"description": "Metadata associated with this image.",
"type": "object",
"additionalProperties": {
"type": "string"
},
"readOnly": true,
"x-nullable": true
}
},
"readOnly": true
}
},
"x-nullable": false
},
"readOnly": true
}
}
}<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>{
"type": "object",
"properties": {
"isBatchSuccessful": {
"description": "True if all of the images in the batch were created successfully, otherwise false.",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"images": {
"description": "List of the image creation results.",
"type": "array",
"items": {
"type": "object",
"properties": {
"sourceUrl": {
"description": "Source URL of the image.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"status": {
"description": "Status of the image creation.",
"enum": [
"OK",
"OKDuplicate",
"ErrorSource",
"ErrorImageFormat",
"ErrorImageSize",
"ErrorStorage",
"ErrorLimitExceed",
"ErrorTagLimitExceed",
"ErrorRegionLimitExceed",
"ErrorUnknown",
"ErrorNegativeAndRegularTagOnSameImage"
],
"type": "string",
"readOnly": true,
"x-nullable": false,
"x-ms-enum": {
"name": "ImageCreateStatus",
"modelAsString": true
}
},
"image": {
"description": "The image.",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Id of the image.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"created": {
"format": "date-time",
"description": "Date the image was created.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"width": {
"format": "int32",
"description": "Width of the image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"height": {
"format": "int32",
"description": "Height of the image.",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"resizedImageUri": {
"description": "The URI to the (resized) image used for training. 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 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 uploaded 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
},
"tags": {
"description": "Tags associated with this image.",
"type": "array",
"items": {
"type": "object",
"properties": {
"tagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
}
}
},
"readOnly": true,
"x-nullable": true
},
"regions": {
"description": "Regions associated with this image.",
"type": "array",
"items": {
"required": [
"tagId",
"left",
"top",
"width",
"height"
],
"type": "object",
"properties": {
"regionId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"description": "Id of the tag associated with this region.",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"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
},
"metadata": {
"description": "Metadata associated with this image.",
"type": "object",
"additionalProperties": {
"type": "string"
},
"readOnly": true,
"x-nullable": true
}
},
"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",
"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://northcentralus.api.cognitive.microsoft.com/customvision/v3.3/Training/projects/{projectId}/images/predictions"
-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://northcentralus.api.cognitive.microsoft.com/customvision/v3.3/Training/projects/{projectId}/images/predictions?" + 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.3/Training/projects/{projectId}/images/predictions");
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://northcentralus.api.cognitive.microsoft.com/customvision/v3.3/Training/projects/{projectId}/images/predictions?" + $.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://northcentralus.api.cognitive.microsoft.com/customvision/v3.3/Training/projects/{projectId}/images/predictions";
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://northcentralus.api.cognitive.microsoft.com/customvision/v3.3/Training/projects/{projectId}/images/predictions');
$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('northcentralus.api.cognitive.microsoft.com')
conn.request("POST", "/customvision/v3.3/Training/projects/{projectId}/images/predictions?%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('northcentralus.api.cognitive.microsoft.com')
conn.request("POST", "/customvision/v3.3/Training/projects/{projectId}/images/predictions?%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.3/Training/projects/{projectId}/images/predictions')
uri.query = URI.encode_www_form({
})
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