Custom_Vision_Training_1.0

CreateImagesFromData

Adds the provided images to the current project iteration

Open API testing console

Request URL

Request parameters

string

Format - uuid. The project id.

(optional)
array

The tags ids to associate with the image batch.

Request headers

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Profile.

Request body

Response 200

OK

{
  "IsBatchSuccessful": true,
  "Images": [
    {
      "SourceUrl": "string",
      "Image": {
        "Id": "string",
        "Created": "string",
        "Width": 0,
        "Height": 0,
        "ImageUri": "string",
        "ThumbnailUri": "string",
        "Labels": [
          {
            "LabelId": "string",
            "Created": "string",
            "TagId": "string"
          }
        ],
        "Predictions": [
          {
            "TagId": "string",
            "Tag": "string",
            "Probability": 0.0
          }
        ]
      },
      "Status": "OK"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "IsBatchSuccessful": {
      "type": "boolean",
      "x-nullable": false
    },
    "Images": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "SourceUrl": {
            "type": "string",
            "readOnly": true,
            "x-nullable": true
          },
          "Image": {
            "description": "Image model to be sent as JSON",
            "type": "object",
            "properties": {
              "Id": {
                "format": "uuid",
                "type": "string",
                "readOnly": true,
                "x-nullable": false
              },
              "Created": {
                "format": "date-time",
                "type": "string",
                "readOnly": true,
                "x-nullable": false
              },
              "Width": {
                "format": "int32",
                "type": "integer",
                "readOnly": true,
                "x-nullable": false
              },
              "Height": {
                "format": "int32",
                "type": "integer",
                "readOnly": true,
                "x-nullable": false
              },
              "ImageUri": {
                "type": "string",
                "readOnly": true,
                "x-nullable": true
              },
              "ThumbnailUri": {
                "type": "string",
                "readOnly": true,
                "x-nullable": true
              },
              "Labels": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "LabelId": {
                      "format": "uuid",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    },
                    "Created": {
                      "format": "date-time",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    },
                    "TagId": {
                      "format": "uuid",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    }
                  },
                  "x-nullable": true
                },
                "readOnly": true,
                "x-nullable": true
              },
              "Predictions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "TagId": {
                      "format": "uuid",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    },
                    "Tag": {
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": true
                    },
                    "Probability": {
                      "format": "float",
                      "type": "number",
                      "readOnly": true,
                      "x-nullable": false
                    }
                  },
                  "x-nullable": true
                },
                "x-nullable": true
              }
            },
            "x-nullable": true,
            "readOnly": true
          },
          "Status": {
            "enum": [
              "OK",
              "OKDuplicate",
              "ErrorSource",
              "ErrorImageFormat",
              "ErrorImageSize",
              "ErrorStorage",
              "ErrorLimitExceed",
              "ErrorUnknown"
            ],
            "type": "string",
            "readOnly": true,
            "x-nullable": false
          }
        },
        "x-nullable": true
      },
      "x-nullable": true
    }
  },
  "x-nullable": true
}
{
  "IsBatchSuccessful": true,
  "Images": [
    {
      "SourceUrl": "string",
      "Image": {
        "Id": "string",
        "Created": "string",
        "Width": 0,
        "Height": 0,
        "ImageUri": "string",
        "ThumbnailUri": "string",
        "Labels": [
          {
            "LabelId": "string",
            "Created": "string",
            "TagId": "string"
          }
        ],
        "Predictions": [
          {
            "TagId": "string",
            "Tag": "string",
            "Probability": 0.0
          }
        ]
      },
      "Status": "OK"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "IsBatchSuccessful": {
      "type": "boolean",
      "x-nullable": false
    },
    "Images": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "SourceUrl": {
            "type": "string",
            "readOnly": true,
            "x-nullable": true
          },
          "Image": {
            "description": "Image model to be sent as JSON",
            "type": "object",
            "properties": {
              "Id": {
                "format": "uuid",
                "type": "string",
                "readOnly": true,
                "x-nullable": false
              },
              "Created": {
                "format": "date-time",
                "type": "string",
                "readOnly": true,
                "x-nullable": false
              },
              "Width": {
                "format": "int32",
                "type": "integer",
                "readOnly": true,
                "x-nullable": false
              },
              "Height": {
                "format": "int32",
                "type": "integer",
                "readOnly": true,
                "x-nullable": false
              },
              "ImageUri": {
                "type": "string",
                "readOnly": true,
                "x-nullable": true
              },
              "ThumbnailUri": {
                "type": "string",
                "readOnly": true,
                "x-nullable": true
              },
              "Labels": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "LabelId": {
                      "format": "uuid",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    },
                    "Created": {
                      "format": "date-time",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    },
                    "TagId": {
                      "format": "uuid",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    }
                  },
                  "x-nullable": true
                },
                "readOnly": true,
                "x-nullable": true
              },
              "Predictions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "TagId": {
                      "format": "uuid",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    },
                    "Tag": {
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": true
                    },
                    "Probability": {
                      "format": "float",
                      "type": "number",
                      "readOnly": true,
                      "x-nullable": false
                    }
                  },
                  "x-nullable": true
                },
                "x-nullable": true
              }
            },
            "x-nullable": true,
            "readOnly": true
          },
          "Status": {
            "enum": [
              "OK",
              "OKDuplicate",
              "ErrorSource",
              "ErrorImageFormat",
              "ErrorImageSize",
              "ErrorStorage",
              "ErrorLimitExceed",
              "ErrorUnknown"
            ],
            "type": "string",
            "readOnly": true,
            "x-nullable": false
          }
        },
        "x-nullable": true
      },
      "x-nullable": true
    }
  },
  "x-nullable": true
}
<CreateImageSummaryModel>
  <IsBatchSuccessful>true</IsBatchSuccessful>
  <Images>
    <SourceUrl>string</SourceUrl>
    <Image>
      <Id>string</Id>
      <Created>string</Created>
      <Width>0</Width>
      <Height>0</Height>
      <ImageUri>string</ImageUri>
      <ThumbnailUri>string</ThumbnailUri>
      <Labels>
        <LabelId>string</LabelId>
        <Created>string</Created>
        <TagId>string</TagId>
      </Labels>
      <Predictions>
        <TagId>string</TagId>
        <Tag>string</Tag>
        <Probability>0</Probability>
      </Predictions>
    </Image>
    <Status>OK</Status>
  </Images>
</CreateImageSummaryModel>
{
  "type": "object",
  "properties": {
    "IsBatchSuccessful": {
      "type": "boolean",
      "x-nullable": false
    },
    "Images": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "SourceUrl": {
            "type": "string",
            "readOnly": true,
            "x-nullable": true
          },
          "Image": {
            "description": "Image model to be sent as JSON",
            "type": "object",
            "properties": {
              "Id": {
                "format": "uuid",
                "type": "string",
                "readOnly": true,
                "x-nullable": false
              },
              "Created": {
                "format": "date-time",
                "type": "string",
                "readOnly": true,
                "x-nullable": false
              },
              "Width": {
                "format": "int32",
                "type": "integer",
                "readOnly": true,
                "x-nullable": false
              },
              "Height": {
                "format": "int32",
                "type": "integer",
                "readOnly": true,
                "x-nullable": false
              },
              "ImageUri": {
                "type": "string",
                "readOnly": true,
                "x-nullable": true
              },
              "ThumbnailUri": {
                "type": "string",
                "readOnly": true,
                "x-nullable": true
              },
              "Labels": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "LabelId": {
                      "format": "uuid",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    },
                    "Created": {
                      "format": "date-time",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    },
                    "TagId": {
                      "format": "uuid",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    }
                  },
                  "x-nullable": true
                },
                "readOnly": true,
                "x-nullable": true
              },
              "Predictions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "TagId": {
                      "format": "uuid",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    },
                    "Tag": {
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": true
                    },
                    "Probability": {
                      "format": "float",
                      "type": "number",
                      "readOnly": true,
                      "x-nullable": false
                    }
                  },
                  "x-nullable": true
                },
                "x-nullable": true
              }
            },
            "x-nullable": true,
            "readOnly": true
          },
          "Status": {
            "enum": [
              "OK",
              "OKDuplicate",
              "ErrorSource",
              "ErrorImageFormat",
              "ErrorImageSize",
              "ErrorStorage",
              "ErrorLimitExceed",
              "ErrorUnknown"
            ],
            "type": "string",
            "readOnly": true,
            "x-nullable": false
          }
        },
        "x-nullable": true
      },
      "x-nullable": true
    }
  },
  "x-nullable": true
}
<CreateImageSummaryModel>
  <IsBatchSuccessful>true</IsBatchSuccessful>
  <Images>
    <SourceUrl>string</SourceUrl>
    <Image>
      <Id>string</Id>
      <Created>string</Created>
      <Width>0</Width>
      <Height>0</Height>
      <ImageUri>string</ImageUri>
      <ThumbnailUri>string</ThumbnailUri>
      <Labels>
        <LabelId>string</LabelId>
        <Created>string</Created>
        <TagId>string</TagId>
      </Labels>
      <Predictions>
        <TagId>string</TagId>
        <Tag>string</Tag>
        <Probability>0</Probability>
      </Predictions>
    </Image>
    <Status>OK</Status>
  </Images>
</CreateImageSummaryModel>
{
  "type": "object",
  "properties": {
    "IsBatchSuccessful": {
      "type": "boolean",
      "x-nullable": false
    },
    "Images": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "SourceUrl": {
            "type": "string",
            "readOnly": true,
            "x-nullable": true
          },
          "Image": {
            "description": "Image model to be sent as JSON",
            "type": "object",
            "properties": {
              "Id": {
                "format": "uuid",
                "type": "string",
                "readOnly": true,
                "x-nullable": false
              },
              "Created": {
                "format": "date-time",
                "type": "string",
                "readOnly": true,
                "x-nullable": false
              },
              "Width": {
                "format": "int32",
                "type": "integer",
                "readOnly": true,
                "x-nullable": false
              },
              "Height": {
                "format": "int32",
                "type": "integer",
                "readOnly": true,
                "x-nullable": false
              },
              "ImageUri": {
                "type": "string",
                "readOnly": true,
                "x-nullable": true
              },
              "ThumbnailUri": {
                "type": "string",
                "readOnly": true,
                "x-nullable": true
              },
              "Labels": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "LabelId": {
                      "format": "uuid",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    },
                    "Created": {
                      "format": "date-time",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    },
                    "TagId": {
                      "format": "uuid",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    }
                  },
                  "x-nullable": true
                },
                "readOnly": true,
                "x-nullable": true
              },
              "Predictions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "TagId": {
                      "format": "uuid",
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": false
                    },
                    "Tag": {
                      "type": "string",
                      "readOnly": true,
                      "x-nullable": true
                    },
                    "Probability": {
                      "format": "float",
                      "type": "number",
                      "readOnly": true,
                      "x-nullable": false
                    }
                  },
                  "x-nullable": true
                },
                "x-nullable": true
              }
            },
            "x-nullable": true,
            "readOnly": true
          },
          "Status": {
            "enum": [
              "OK",
              "OKDuplicate",
              "ErrorSource",
              "ErrorImageFormat",
              "ErrorImageSize",
              "ErrorStorage",
              "ErrorLimitExceed",
              "ErrorUnknown"
            ],
            "type": "string",
            "readOnly": true,
            "x-nullable": false
          }
        },
        "x-nullable": true
      },
      "x-nullable": true
    }
  },
  "x-nullable": true
}

Code samples

@ECHO OFF

curl -v -X POST "https://southcentralus.api.cognitive.microsoft.com/customvision/v1.0/Training/projects/{projectId}/images/image?tagIds={array}"
-H "Content-Type: multipart/form-data"
-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}");

            // Request parameters
            queryString["tagIds"] = "{array}";
            var uri = "https://southcentralus.api.cognitive.microsoft.com/customvision/v1.0/Training/projects/{projectId}/images/image?" + 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://southcentralus.api.cognitive.microsoft.com/customvision/v1.0/Training/projects/{projectId}/images/image");

            builder.setParameter("tagIds", "{array}");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "multipart/form-data");
            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
            "tagIds": "{array}",
        };
      
        $.ajax({
            url: "https://southcentralus.api.cognitive.microsoft.com/customvision/v1.0/Training/projects/{projectId}/images/image?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","multipart/form-data");
                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://southcentralus.api.cognitive.microsoft.com/customvision/v1.0/Training/projects/{projectId}/images/image";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"tagIds={array}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"multipart/form-data" 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://southcentralus.api.cognitive.microsoft.com/customvision/v1.0/Training/projects/{projectId}/images/image');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'multipart/form-data',
    'Training-key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'tagIds' => '{array}',
);

$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': 'multipart/form-data',
    'Training-key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'tagIds': '{array}',
})

try:
    conn = httplib.HTTPSConnection('southcentralus.api.cognitive.microsoft.com')
    conn.request("POST", "/customvision/v1.0/Training/projects/{projectId}/images/image?%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': 'multipart/form-data',
    'Training-key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'tagIds': '{array}',
})

try:
    conn = http.client.HTTPSConnection('southcentralus.api.cognitive.microsoft.com')
    conn.request("POST", "/customvision/v1.0/Training/projects/{projectId}/images/image?%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://southcentralus.api.cognitive.microsoft.com/customvision/v1.0/Training/projects/{projectId}/images/image')
uri.query = URI.encode_www_form({
    # Request parameters
    'tagIds' => '{array}'
})

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'multipart/form-data'
# 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