Custom_Vision_Training_1.1

GetIterationPerformance

Get detailed performance information about an iteration

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

Format - uuid. The id of the project the iteration belongs to

string

Format - uuid. The id of the iteration to get

number

Format - float. The threshold threshold used to determine positive predictions

Request headers

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

Request body

Response 200

OK

{
  "PerTagPerformance": [
    {
      "TagId": "string",
      "TagName": "string",
      "Precision": 0.0,
      "PrecisionStdDeviation": 0.0,
      "Recall": 0.0,
      "RecallStdDeviation": 0.0
    }
  ],
  "Precision": 0.0,
  "PrecisionStdDeviation": 0.0,
  "Recall": 0.0,
  "RecallStdDeviation": 0.0
}
{
  "description": "Represents the detailed performance data for a trained iteration",
  "type": "object",
  "properties": {
    "PerTagPerformance": {
      "description": "Gets the per-tag performance details for this iteration",
      "type": "array",
      "items": {
        "description": "Represents performance data for a particular tag in a trained iteration",
        "type": "object",
        "properties": {
          "TagId": {
            "format": "uuid",
            "type": "string",
            "readOnly": true,
            "x-nullable": false
          },
          "TagName": {
            "type": "string",
            "readOnly": true,
            "x-nullable": true
          },
          "Precision": {
            "format": "double",
            "description": "Gets the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "PrecisionStdDeviation": {
            "format": "double",
            "description": "Gets the standard deviation for the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "Recall": {
            "format": "double",
            "description": "Gets the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "RecallStdDeviation": {
            "format": "double",
            "description": "Gets the standard deviation for the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          }
        },
        "x-nullable": true
      },
      "readOnly": true,
      "x-nullable": true
    },
    "Precision": {
      "format": "double",
      "description": "Gets the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "PrecisionStdDeviation": {
      "format": "double",
      "description": "Gets the standard deviation for the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "Recall": {
      "format": "double",
      "description": "Gets the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "RecallStdDeviation": {
      "format": "double",
      "description": "Gets the standard deviation for the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    }
  },
  "x-nullable": true
}
{
  "PerTagPerformance": [
    {
      "TagId": "string",
      "TagName": "string",
      "Precision": 0.0,
      "PrecisionStdDeviation": 0.0,
      "Recall": 0.0,
      "RecallStdDeviation": 0.0
    }
  ],
  "Precision": 0.0,
  "PrecisionStdDeviation": 0.0,
  "Recall": 0.0,
  "RecallStdDeviation": 0.0
}
{
  "description": "Represents the detailed performance data for a trained iteration",
  "type": "object",
  "properties": {
    "PerTagPerformance": {
      "description": "Gets the per-tag performance details for this iteration",
      "type": "array",
      "items": {
        "description": "Represents performance data for a particular tag in a trained iteration",
        "type": "object",
        "properties": {
          "TagId": {
            "format": "uuid",
            "type": "string",
            "readOnly": true,
            "x-nullable": false
          },
          "TagName": {
            "type": "string",
            "readOnly": true,
            "x-nullable": true
          },
          "Precision": {
            "format": "double",
            "description": "Gets the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "PrecisionStdDeviation": {
            "format": "double",
            "description": "Gets the standard deviation for the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "Recall": {
            "format": "double",
            "description": "Gets the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "RecallStdDeviation": {
            "format": "double",
            "description": "Gets the standard deviation for the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          }
        },
        "x-nullable": true
      },
      "readOnly": true,
      "x-nullable": true
    },
    "Precision": {
      "format": "double",
      "description": "Gets the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "PrecisionStdDeviation": {
      "format": "double",
      "description": "Gets the standard deviation for the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "Recall": {
      "format": "double",
      "description": "Gets the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "RecallStdDeviation": {
      "format": "double",
      "description": "Gets the standard deviation for the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    }
  },
  "x-nullable": true
}
<IterationPerformanceModel>
  <PerTagPerformance>
    <TagId>string</TagId>
    <TagName>string</TagName>
    <Precision>0</Precision>
    <PrecisionStdDeviation>0</PrecisionStdDeviation>
    <Recall>0</Recall>
    <RecallStdDeviation>0</RecallStdDeviation>
  </PerTagPerformance>
  <Precision>0</Precision>
  <PrecisionStdDeviation>0</PrecisionStdDeviation>
  <Recall>0</Recall>
  <RecallStdDeviation>0</RecallStdDeviation>
</IterationPerformanceModel>
{
  "description": "Represents the detailed performance data for a trained iteration",
  "type": "object",
  "properties": {
    "PerTagPerformance": {
      "description": "Gets the per-tag performance details for this iteration",
      "type": "array",
      "items": {
        "description": "Represents performance data for a particular tag in a trained iteration",
        "type": "object",
        "properties": {
          "TagId": {
            "format": "uuid",
            "type": "string",
            "readOnly": true,
            "x-nullable": false
          },
          "TagName": {
            "type": "string",
            "readOnly": true,
            "x-nullable": true
          },
          "Precision": {
            "format": "double",
            "description": "Gets the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "PrecisionStdDeviation": {
            "format": "double",
            "description": "Gets the standard deviation for the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "Recall": {
            "format": "double",
            "description": "Gets the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "RecallStdDeviation": {
            "format": "double",
            "description": "Gets the standard deviation for the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          }
        },
        "x-nullable": true
      },
      "readOnly": true,
      "x-nullable": true
    },
    "Precision": {
      "format": "double",
      "description": "Gets the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "PrecisionStdDeviation": {
      "format": "double",
      "description": "Gets the standard deviation for the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "Recall": {
      "format": "double",
      "description": "Gets the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "RecallStdDeviation": {
      "format": "double",
      "description": "Gets the standard deviation for the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    }
  },
  "x-nullable": true
}
<IterationPerformanceModel>
  <PerTagPerformance>
    <TagId>string</TagId>
    <TagName>string</TagName>
    <Precision>0</Precision>
    <PrecisionStdDeviation>0</PrecisionStdDeviation>
    <Recall>0</Recall>
    <RecallStdDeviation>0</RecallStdDeviation>
  </PerTagPerformance>
  <Precision>0</Precision>
  <PrecisionStdDeviation>0</PrecisionStdDeviation>
  <Recall>0</Recall>
  <RecallStdDeviation>0</RecallStdDeviation>
</IterationPerformanceModel>
{
  "description": "Represents the detailed performance data for a trained iteration",
  "type": "object",
  "properties": {
    "PerTagPerformance": {
      "description": "Gets the per-tag performance details for this iteration",
      "type": "array",
      "items": {
        "description": "Represents performance data for a particular tag in a trained iteration",
        "type": "object",
        "properties": {
          "TagId": {
            "format": "uuid",
            "type": "string",
            "readOnly": true,
            "x-nullable": false
          },
          "TagName": {
            "type": "string",
            "readOnly": true,
            "x-nullable": true
          },
          "Precision": {
            "format": "double",
            "description": "Gets the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "PrecisionStdDeviation": {
            "format": "double",
            "description": "Gets the standard deviation for the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "Recall": {
            "format": "double",
            "description": "Gets the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "RecallStdDeviation": {
            "format": "double",
            "description": "Gets the standard deviation for the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          }
        },
        "x-nullable": true
      },
      "readOnly": true,
      "x-nullable": true
    },
    "Precision": {
      "format": "double",
      "description": "Gets the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "PrecisionStdDeviation": {
      "format": "double",
      "description": "Gets the standard deviation for the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "Recall": {
      "format": "double",
      "description": "Gets the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "RecallStdDeviation": {
      "format": "double",
      "description": "Gets the standard deviation for the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    }
  },
  "x-nullable": true
}

Code samples

@ECHO OFF

curl -v -X GET "https://uaenorth.api.cognitive.microsoft.com/customvision/v1.1/Training/projects/{projectId}/iterations/{iterationId}/performance?threshold={threshold}"
-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://uaenorth.api.cognitive.microsoft.com/customvision/v1.1/Training/projects/{projectId}/iterations/{iterationId}/performance?threshold={threshold}&" + 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://uaenorth.api.cognitive.microsoft.com/customvision/v1.1/Training/projects/{projectId}/iterations/{iterationId}/performance?threshold={threshold}");


            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
        };
      
        $.ajax({
            url: "https://uaenorth.api.cognitive.microsoft.com/customvision/v1.1/Training/projects/{projectId}/iterations/{iterationId}/performance?threshold={threshold}&" + $.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://uaenorth.api.cognitive.microsoft.com/customvision/v1.1/Training/projects/{projectId}/iterations/{iterationId}/performance?threshold={threshold}";
    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:@"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://uaenorth.api.cognitive.microsoft.com/customvision/v1.1/Training/projects/{projectId}/iterations/{iterationId}/performance?threshold={threshold}');
$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_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({
})

try:
    conn = httplib.HTTPSConnection('uaenorth.api.cognitive.microsoft.com')
    conn.request("GET", "/customvision/v1.1/Training/projects/{projectId}/iterations/{iterationId}/performance?threshold={threshold}&%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('uaenorth.api.cognitive.microsoft.com')
    conn.request("GET", "/customvision/v1.1/Training/projects/{projectId}/iterations/{iterationId}/performance?threshold={threshold}&%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://uaenorth.api.cognitive.microsoft.com/customvision/v1.1/Training/projects/{projectId}/iterations/{iterationId}/performance?threshold={threshold}')


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