Custom_Vision_Training_1.2
TrainProject
Queues project for training
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
Request headers
Request body
Response 200
OK
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}{
"description": "Iteration model to be sent over JSON",
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"description": "Gets the id of the iteration",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Name": {
"description": "Gets or sets the name of the iteration",
"type": "string",
"x-nullable": true
},
"IsDefault": {
"description": "Gets or sets a value indicating whether the iteration is the default iteration for the project",
"type": "boolean",
"x-nullable": false
},
"Status": {
"description": "Gets the current iteration status",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Created": {
"format": "date-time",
"description": "Gets the time this iteration was completed",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"LastModified": {
"format": "date-time",
"description": "Gets the time this iteration was last modified",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"TrainedAt": {
"format": "date-time",
"description": "Gets the time this iteration was last modified",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"ProjectId": {
"format": "uuid",
"description": "Gets the project id of the iteration",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Exportable": {
"description": "Whether the iteration can be exported to another format for download",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"DomainId": {
"format": "uuid",
"description": "Get or sets a guid of the domain the iteration has been trained on",
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
}{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}{
"description": "Iteration model to be sent over JSON",
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"description": "Gets the id of the iteration",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Name": {
"description": "Gets or sets the name of the iteration",
"type": "string",
"x-nullable": true
},
"IsDefault": {
"description": "Gets or sets a value indicating whether the iteration is the default iteration for the project",
"type": "boolean",
"x-nullable": false
},
"Status": {
"description": "Gets the current iteration status",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Created": {
"format": "date-time",
"description": "Gets the time this iteration was completed",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"LastModified": {
"format": "date-time",
"description": "Gets the time this iteration was last modified",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"TrainedAt": {
"format": "date-time",
"description": "Gets the time this iteration was last modified",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"ProjectId": {
"format": "uuid",
"description": "Gets the project id of the iteration",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Exportable": {
"description": "Whether the iteration can be exported to another format for download",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"DomainId": {
"format": "uuid",
"description": "Get or sets a guid of the domain the iteration has been trained on",
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
}<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>{
"description": "Iteration model to be sent over JSON",
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"description": "Gets the id of the iteration",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Name": {
"description": "Gets or sets the name of the iteration",
"type": "string",
"x-nullable": true
},
"IsDefault": {
"description": "Gets or sets a value indicating whether the iteration is the default iteration for the project",
"type": "boolean",
"x-nullable": false
},
"Status": {
"description": "Gets the current iteration status",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Created": {
"format": "date-time",
"description": "Gets the time this iteration was completed",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"LastModified": {
"format": "date-time",
"description": "Gets the time this iteration was last modified",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"TrainedAt": {
"format": "date-time",
"description": "Gets the time this iteration was last modified",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"ProjectId": {
"format": "uuid",
"description": "Gets the project id of the iteration",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Exportable": {
"description": "Whether the iteration can be exported to another format for download",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"DomainId": {
"format": "uuid",
"description": "Get or sets a guid of the domain the iteration has been trained on",
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
}<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>{
"description": "Iteration model to be sent over JSON",
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"description": "Gets the id of the iteration",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Name": {
"description": "Gets or sets the name of the iteration",
"type": "string",
"x-nullable": true
},
"IsDefault": {
"description": "Gets or sets a value indicating whether the iteration is the default iteration for the project",
"type": "boolean",
"x-nullable": false
},
"Status": {
"description": "Gets the current iteration status",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Created": {
"format": "date-time",
"description": "Gets the time this iteration was completed",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"LastModified": {
"format": "date-time",
"description": "Gets the time this iteration was last modified",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"TrainedAt": {
"format": "date-time",
"description": "Gets the time this iteration was last modified",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"ProjectId": {
"format": "uuid",
"description": "Gets the project id of the iteration",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Exportable": {
"description": "Whether the iteration can be exported to another format for download",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"DomainId": {
"format": "uuid",
"description": "Get or sets a guid of the domain the iteration has been trained on",
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
}Code samples
@ECHO OFF
curl -v -X POST "https://*.cognitiveservices.azure.com/customvision/v1.2/Training/projects/{projectId}/train"
-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/v1.2/Training/projects/{projectId}/train?" + 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/v1.2/Training/projects/{projectId}/train");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
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/v1.2/Training/projects/{projectId}/train?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
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/v1.2/Training/projects/{projectId}/train";
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:@"{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/v1.2/Training/projects/{projectId}/train');
$url = $request->getUrl();
$headers = array(
// Request headers
'Training-key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Training-key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("POST", "/customvision/v1.2/Training/projects/{projectId}/train?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Training-key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("POST", "/customvision/v1.2/Training/projects/{projectId}/train?%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/v1.2/Training/projects/{projectId}/train')
uri.query = URI.encode_www_form({
})
request = Net::HTTP::Post.new(uri.request_uri)
# 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