Custom_Vision_Training_1.0
GetPredictionResults
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request parameters
string
Format - uuid.
integer
Format - int32.
string
(optional)
string
Format - uuid.
(optional)
array
(optional)
number
Format - float.
(optional)
string
Format - date-time (as date-time in RFC3339).
(optional)
string
Format - date-time (as date-time in RFC3339).
(optional)
string
Request headers
Request body
Response 200
OK
{
"Results": [
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
],
"ImageUri": "string",
"ThumbnailUri": "string"
}
],
"Token": {
"Session": "string",
"Continuation": "string",
"MaxCount": 0,
"OrderBy": "Newest",
"IterationId": "string",
"TagIds": [
"string"
],
"Threshold": 0.0,
"StartTime": "string",
"EndTime": "string",
"Source": "string"
}
}
{
"type": "object",
"properties": {
"Results": {
"type": "array",
"items": {
"description": "result of an image classification request",
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Project": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Iteration": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"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
},
"readOnly": true,
"x-nullable": true
},
"ImageUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"ThumbnailUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"readOnly": true,
"x-nullable": true
},
"Token": {
"type": "object",
"properties": {
"Session": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Continuation": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"MaxCount": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"OrderBy": {
"enum": [
"Newest",
"Oldest",
"Suggested"
],
"type": "string",
"readOnly": true,
"x-nullable": false
},
"IterationId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"TagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"readOnly": true,
"x-nullable": true
},
"Threshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"StartTime": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"EndTime": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Source": {
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true,
"readOnly": true
}
},
"x-nullable": true
}
{
"Results": [
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
],
"ImageUri": "string",
"ThumbnailUri": "string"
}
],
"Token": {
"Session": "string",
"Continuation": "string",
"MaxCount": 0,
"OrderBy": "Newest",
"IterationId": "string",
"TagIds": [
"string"
],
"Threshold": 0.0,
"StartTime": "string",
"EndTime": "string",
"Source": "string"
}
}
{
"type": "object",
"properties": {
"Results": {
"type": "array",
"items": {
"description": "result of an image classification request",
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Project": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Iteration": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"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
},
"readOnly": true,
"x-nullable": true
},
"ImageUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"ThumbnailUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"readOnly": true,
"x-nullable": true
},
"Token": {
"type": "object",
"properties": {
"Session": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Continuation": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"MaxCount": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"OrderBy": {
"enum": [
"Newest",
"Oldest",
"Suggested"
],
"type": "string",
"readOnly": true,
"x-nullable": false
},
"IterationId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"TagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"readOnly": true,
"x-nullable": true
},
"Threshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"StartTime": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"EndTime": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Source": {
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true,
"readOnly": true
}
},
"x-nullable": true
}
<PredictionQueryModel>
<Results>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
</Results>
<Token>
<Session>string</Session>
<Continuation>string</Continuation>
<MaxCount>0</MaxCount>
<OrderBy>Newest</OrderBy>
<IterationId>string</IterationId>
<TagIds>string</TagIds>
<Threshold>0</Threshold>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Source>string</Source>
</Token>
</PredictionQueryModel>
{
"type": "object",
"properties": {
"Results": {
"type": "array",
"items": {
"description": "result of an image classification request",
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Project": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Iteration": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"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
},
"readOnly": true,
"x-nullable": true
},
"ImageUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"ThumbnailUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"readOnly": true,
"x-nullable": true
},
"Token": {
"type": "object",
"properties": {
"Session": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Continuation": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"MaxCount": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"OrderBy": {
"enum": [
"Newest",
"Oldest",
"Suggested"
],
"type": "string",
"readOnly": true,
"x-nullable": false
},
"IterationId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"TagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"readOnly": true,
"x-nullable": true
},
"Threshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"StartTime": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"EndTime": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Source": {
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true,
"readOnly": true
}
},
"x-nullable": true
}
<PredictionQueryModel>
<Results>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
</Results>
<Token>
<Session>string</Session>
<Continuation>string</Continuation>
<MaxCount>0</MaxCount>
<OrderBy>Newest</OrderBy>
<IterationId>string</IterationId>
<TagIds>string</TagIds>
<Threshold>0</Threshold>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Source>string</Source>
</Token>
</PredictionQueryModel>
{
"type": "object",
"properties": {
"Results": {
"type": "array",
"items": {
"description": "result of an image classification request",
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Project": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Iteration": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"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
},
"readOnly": true,
"x-nullable": true
},
"ImageUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"ThumbnailUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"readOnly": true,
"x-nullable": true
},
"Token": {
"type": "object",
"properties": {
"Session": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Continuation": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"MaxCount": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"OrderBy": {
"enum": [
"Newest",
"Oldest",
"Suggested"
],
"type": "string",
"readOnly": true,
"x-nullable": false
},
"IterationId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"TagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"readOnly": true,
"x-nullable": true
},
"Threshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"StartTime": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"EndTime": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Source": {
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true,
"readOnly": true
}
},
"x-nullable": true
}
Code samples
@ECHO OFF
curl -v -X GET "https://*.cognitiveservices.azure.us/customvision/v1.0/Training/projects/{projectId}/predictions?maxCount={maxCount}&orderBy={orderBy}?iterationId={string}&tagIds={array}&threshold={number}&startTime={string}&endTime={string}&source={string}"
-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["iterationId"] = "{string}";
queryString["tagIds"] = "{array}";
queryString["threshold"] = "{number}";
queryString["startTime"] = "{string}";
queryString["endTime"] = "{string}";
queryString["source"] = "{string}";
var uri = "https://*.cognitiveservices.azure.us/customvision/v1.0/Training/projects/{projectId}/predictions?maxCount={maxCount}&orderBy={orderBy}&" + queryString;
var response = await client.GetAsync(uri);
}
}
}
// // 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.us/customvision/v1.0/Training/projects/{projectId}/predictions?maxCount={maxCount}&orderBy={orderBy}");
builder.setParameter("iterationId", "{string}");
builder.setParameter("tagIds", "{array}");
builder.setParameter("threshold", "{number}");
builder.setParameter("startTime", "{string}");
builder.setParameter("endTime", "{string}");
builder.setParameter("source", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(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
"iterationId": "{string}",
"tagIds": "{array}",
"threshold": "{number}",
"startTime": "{string}",
"endTime": "{string}",
"source": "{string}",
};
$.ajax({
url: "https://*.cognitiveservices.azure.us/customvision/v1.0/Training/projects/{projectId}/predictions?maxCount={maxCount}&orderBy={orderBy}&" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Training-key","{subscription key}");
},
type: "GET",
// 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.us/customvision/v1.0/Training/projects/{projectId}/predictions?maxCount={maxCount}&orderBy={orderBy}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"iterationId={string}",
@"tagIds={array}",
@"threshold={number}",
@"startTime={string}",
@"endTime={string}",
@"source={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// 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.us/customvision/v1.0/Training/projects/{projectId}/predictions?maxCount={maxCount}&orderBy={orderBy}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Training-key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'iterationId' => '{string}',
'tagIds' => '{array}',
'threshold' => '{number}',
'startTime' => '{string}',
'endTime' => '{string}',
'source' => '{string}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// 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({
# Request parameters
'iterationId': '{string}',
'tagIds': '{array}',
'threshold': '{number}',
'startTime': '{string}',
'endTime': '{string}',
'source': '{string}',
})
try:
conn = httplib.HTTPSConnection('*.cognitiveservices.azure.us')
conn.request("GET", "/customvision/v1.0/Training/projects/{projectId}/predictions?maxCount={maxCount}&orderBy={orderBy}&%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({
# Request parameters
'iterationId': '{string}',
'tagIds': '{array}',
'threshold': '{number}',
'startTime': '{string}',
'endTime': '{string}',
'source': '{string}',
})
try:
conn = http.client.HTTPSConnection('*.cognitiveservices.azure.us')
conn.request("GET", "/customvision/v1.0/Training/projects/{projectId}/predictions?maxCount={maxCount}&orderBy={orderBy}&%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.us/customvision/v1.0/Training/projects/{projectId}/predictions?maxCount={maxCount}&orderBy={orderBy}')
uri.query = URI.encode_www_form({
# Request parameters
'iterationId' => '{string}',
'tagIds' => '{array}',
'threshold' => '{number}',
'startTime' => '{string}',
'endTime' => '{string}',
'source' => '{string}'
})
request = Net::HTTP::Get.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