Custom_Vision_Training_2.2

CreateProject

Create a project

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 EUAP

Request URL

Request parameters

string

Name of the project

(optional)
string

The description of the project

(optional)
string

Format - uuid. The id of the domain to use for this project. Defaults to General

(optional)
string

The type of classifier to create for this project

Request headers

string
string
Subscription key which provides access to this API. Found in your Profile.

Request body

Response 200

OK

{
  "id": "string",
  "name": "string",
  "description": "string",
  "settings": {
    "domainId": "string",
    "classificationType": "Multiclass"
  },
  "created": "string",
  "lastModified": "string",
  "thumbnailUri": "string"
}
{
  "description": "Represents a project",
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "Gets the project id",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "name": {
      "description": "Gets or sets the name of the project",
      "type": "string",
      "x-nullable": true
    },
    "description": {
      "description": "Gets or sets the description of the project",
      "type": "string",
      "x-nullable": true
    },
    "settings": {
      "description": "Gets or sets the project settings",
      "type": "object",
      "properties": {
        "domainId": {
          "format": "uuid",
          "description": "Gets or sets the id of the Domain to use with this project",
          "type": "string",
          "x-nullable": false
        },
        "classificationType": {
          "description": "Gets or sets the classification type of the project",
          "enum": [
            "Multiclass",
            "Multilabel"
          ],
          "type": "string",
          "x-nullable": true,
          "x-ms-enum": {
            "name": "Classifier",
            "modelAsString": true
          }
        }
      },
      "x-nullable": true
    },
    "created": {
      "format": "date-time",
      "description": "Gets the date this project was created",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "lastModified": {
      "format": "date-time",
      "description": "Gets the date this project was last modifed",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "thumbnailUri": {
      "description": "Gets the thumbnail url representing the project",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    }
  },
  "x-nullable": true
}
{
  "id": "string",
  "name": "string",
  "description": "string",
  "settings": {
    "domainId": "string",
    "classificationType": "Multiclass"
  },
  "created": "string",
  "lastModified": "string",
  "thumbnailUri": "string"
}
{
  "description": "Represents a project",
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "Gets the project id",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "name": {
      "description": "Gets or sets the name of the project",
      "type": "string",
      "x-nullable": true
    },
    "description": {
      "description": "Gets or sets the description of the project",
      "type": "string",
      "x-nullable": true
    },
    "settings": {
      "description": "Gets or sets the project settings",
      "type": "object",
      "properties": {
        "domainId": {
          "format": "uuid",
          "description": "Gets or sets the id of the Domain to use with this project",
          "type": "string",
          "x-nullable": false
        },
        "classificationType": {
          "description": "Gets or sets the classification type of the project",
          "enum": [
            "Multiclass",
            "Multilabel"
          ],
          "type": "string",
          "x-nullable": true,
          "x-ms-enum": {
            "name": "Classifier",
            "modelAsString": true
          }
        }
      },
      "x-nullable": true
    },
    "created": {
      "format": "date-time",
      "description": "Gets the date this project was created",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "lastModified": {
      "format": "date-time",
      "description": "Gets the date this project was last modifed",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "thumbnailUri": {
      "description": "Gets the thumbnail url representing the project",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    }
  },
  "x-nullable": true
}
<Project>
  <id>string</id>
  <name>string</name>
  <description>string</description>
  <settings>
    <domainId>string</domainId>
    <classificationType>Multiclass</classificationType>
  </settings>
  <created>string</created>
  <lastModified>string</lastModified>
  <thumbnailUri>string</thumbnailUri>
</Project>
{
  "description": "Represents a project",
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "Gets the project id",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "name": {
      "description": "Gets or sets the name of the project",
      "type": "string",
      "x-nullable": true
    },
    "description": {
      "description": "Gets or sets the description of the project",
      "type": "string",
      "x-nullable": true
    },
    "settings": {
      "description": "Gets or sets the project settings",
      "type": "object",
      "properties": {
        "domainId": {
          "format": "uuid",
          "description": "Gets or sets the id of the Domain to use with this project",
          "type": "string",
          "x-nullable": false
        },
        "classificationType": {
          "description": "Gets or sets the classification type of the project",
          "enum": [
            "Multiclass",
            "Multilabel"
          ],
          "type": "string",
          "x-nullable": true,
          "x-ms-enum": {
            "name": "Classifier",
            "modelAsString": true
          }
        }
      },
      "x-nullable": true
    },
    "created": {
      "format": "date-time",
      "description": "Gets the date this project was created",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "lastModified": {
      "format": "date-time",
      "description": "Gets the date this project was last modifed",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "thumbnailUri": {
      "description": "Gets the thumbnail url representing the project",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    }
  },
  "x-nullable": true
}
<Project>
  <id>string</id>
  <name>string</name>
  <description>string</description>
  <settings>
    <domainId>string</domainId>
    <classificationType>Multiclass</classificationType>
  </settings>
  <created>string</created>
  <lastModified>string</lastModified>
  <thumbnailUri>string</thumbnailUri>
</Project>
{
  "description": "Represents a project",
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "Gets the project id",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "name": {
      "description": "Gets or sets the name of the project",
      "type": "string",
      "x-nullable": true
    },
    "description": {
      "description": "Gets or sets the description of the project",
      "type": "string",
      "x-nullable": true
    },
    "settings": {
      "description": "Gets or sets the project settings",
      "type": "object",
      "properties": {
        "domainId": {
          "format": "uuid",
          "description": "Gets or sets the id of the Domain to use with this project",
          "type": "string",
          "x-nullable": false
        },
        "classificationType": {
          "description": "Gets or sets the classification type of the project",
          "enum": [
            "Multiclass",
            "Multilabel"
          ],
          "type": "string",
          "x-nullable": true,
          "x-ms-enum": {
            "name": "Classifier",
            "modelAsString": true
          }
        }
      },
      "x-nullable": true
    },
    "created": {
      "format": "date-time",
      "description": "Gets the date this project was created",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "lastModified": {
      "format": "date-time",
      "description": "Gets the date this project was last modifed",
      "type": "string",
      "readOnly": true,
      "x-nullable": false
    },
    "thumbnailUri": {
      "description": "Gets the thumbnail url representing the project",
      "type": "string",
      "readOnly": true,
      "x-nullable": true
    }
  },
  "x-nullable": true
}

Code samples

@ECHO OFF

curl -v -X POST "https://australiaeast.api.cognitive.microsoft.com/customvision/v2.2/Training/projects?name={name}?description={string}&domainId={string}&classificationType={string}"
-H "Training-Key: "
-H "Training-key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Training-Key", "");
            client.DefaultRequestHeaders.Add("Training-key", "{subscription key}");

            // Request parameters
            queryString["description"] = "{string}";
            queryString["domainId"] = "{string}";
            queryString["classificationType"] = "{string}";
            var uri = "https://australiaeast.api.cognitive.microsoft.com/customvision/v2.2/Training/projects?name={name}&" + 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://australiaeast.api.cognitive.microsoft.com/customvision/v2.2/Training/projects?name={name}");

            builder.setParameter("description", "{string}");
            builder.setParameter("domainId", "{string}");
            builder.setParameter("classificationType", "{string}");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Training-Key", "");
            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
            "description": "{string}",
            "domainId": "{string}",
            "classificationType": "{string}",
        };
      
        $.ajax({
            url: "https://australiaeast.api.cognitive.microsoft.com/customvision/v2.2/Training/projects?name={name}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Training-Key","");
                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://australiaeast.api.cognitive.microsoft.com/customvision/v2.2/Training/projects?name={name}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"description={string}",
                         @"domainId={string}",
                         @"classificationType={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Training-Key"];
    [_request setValue:@"{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://australiaeast.api.cognitive.microsoft.com/customvision/v2.2/Training/projects?name={name}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Training-Key' => '',
    'Training-key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'description' => '{string}',
    'domainId' => '{string}',
    'classificationType' => '{string}',
);

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

params = urllib.urlencode({
    # Request parameters
    'description': '{string}',
    'domainId': '{string}',
    'classificationType': '{string}',
})

try:
    conn = httplib.HTTPSConnection('australiaeast.api.cognitive.microsoft.com')
    conn.request("POST", "/customvision/v2.2/Training/projects?name={name}&%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': '',
    'Training-key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'description': '{string}',
    'domainId': '{string}',
    'classificationType': '{string}',
})

try:
    conn = http.client.HTTPSConnection('australiaeast.api.cognitive.microsoft.com')
    conn.request("POST", "/customvision/v2.2/Training/projects?name={name}&%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://australiaeast.api.cognitive.microsoft.com/customvision/v2.2/Training/projects?name={name}')
uri.query = URI.encode_www_form({
    # Request parameters
    'description' => '{string}',
    'domainId' => '{string}',
    'classificationType' => '{string}'
})

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Training-Key'] = ''
# 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