Custom_Vision_Training_2.2

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

(optional)
number

Format - float. The threshold used to determine true predictions

(optional)
number

Format - float. If applicable, the bounding box overlap threshold used to determine true predictions

Request headers

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

Request body

Response 200

OK

{
  "perTagPerformance": [
    {
      "id": "string",
      "name": "string",
      "precision": 0.0,
      "precisionStdDeviation": 0.0,
      "recall": 0.0,
      "recallStdDeviation": 0.0,
      "averagePrecision": 0.0
    }
  ],
  "precision": 0.0,
  "precisionStdDeviation": 0.0,
  "recall": 0.0,
  "recallStdDeviation": 0.0,
  "averagePrecision": 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": {
          "id": {
            "format": "uuid",
            "type": "string",
            "readOnly": true,
            "x-nullable": false
          },
          "name": {
            "type": "string",
            "readOnly": true,
            "x-nullable": true
          },
          "precision": {
            "format": "float",
            "description": "Gets the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "precisionStdDeviation": {
            "format": "float",
            "description": "Gets the standard deviation for the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "recall": {
            "format": "float",
            "description": "Gets the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "recallStdDeviation": {
            "format": "float",
            "description": "Gets the standard deviation for the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "averagePrecision": {
            "format": "float",
            "description": "Gets the average precision when applicable",
            "type": "number",
            "readOnly": true,
            "x-nullable": true
          }
        },
        "x-nullable": true
      },
      "readOnly": true,
      "x-nullable": true
    },
    "precision": {
      "format": "float",
      "description": "Gets the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "precisionStdDeviation": {
      "format": "float",
      "description": "Gets the standard deviation for the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "recall": {
      "format": "float",
      "description": "Gets the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "recallStdDeviation": {
      "format": "float",
      "description": "Gets the standard deviation for the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "averagePrecision": {
      "format": "float",
      "description": "Gets the average precision when applicable",
      "type": "number",
      "readOnly": true,
      "x-nullable": true
    }
  },
  "x-nullable": true
}
{
  "perTagPerformance": [
    {
      "id": "string",
      "name": "string",
      "precision": 0.0,
      "precisionStdDeviation": 0.0,
      "recall": 0.0,
      "recallStdDeviation": 0.0,
      "averagePrecision": 0.0
    }
  ],
  "precision": 0.0,
  "precisionStdDeviation": 0.0,
  "recall": 0.0,
  "recallStdDeviation": 0.0,
  "averagePrecision": 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": {
          "id": {
            "format": "uuid",
            "type": "string",
            "readOnly": true,
            "x-nullable": false
          },
          "name": {
            "type": "string",
            "readOnly": true,
            "x-nullable": true
          },
          "precision": {
            "format": "float",
            "description": "Gets the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "precisionStdDeviation": {
            "format": "float",
            "description": "Gets the standard deviation for the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "recall": {
            "format": "float",
            "description": "Gets the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "recallStdDeviation": {
            "format": "float",
            "description": "Gets the standard deviation for the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "averagePrecision": {
            "format": "float",
            "description": "Gets the average precision when applicable",
            "type": "number",
            "readOnly": true,
            "x-nullable": true
          }
        },
        "x-nullable": true
      },
      "readOnly": true,
      "x-nullable": true
    },
    "precision": {
      "format": "float",
      "description": "Gets the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "precisionStdDeviation": {
      "format": "float",
      "description": "Gets the standard deviation for the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "recall": {
      "format": "float",
      "description": "Gets the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "recallStdDeviation": {
      "format": "float",
      "description": "Gets the standard deviation for the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "averagePrecision": {
      "format": "float",
      "description": "Gets the average precision when applicable",
      "type": "number",
      "readOnly": true,
      "x-nullable": true
    }
  },
  "x-nullable": true
}
<IterationPerformance>
  <perTagPerformance>
    <id>string</id>
    <name>string</name>
    <precision>0</precision>
    <precisionStdDeviation>0</precisionStdDeviation>
    <recall>0</recall>
    <recallStdDeviation>0</recallStdDeviation>
    <averagePrecision>0</averagePrecision>
  </perTagPerformance>
  <precision>0</precision>
  <precisionStdDeviation>0</precisionStdDeviation>
  <recall>0</recall>
  <recallStdDeviation>0</recallStdDeviation>
  <averagePrecision>0</averagePrecision>
</IterationPerformance>
{
  "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": {
          "id": {
            "format": "uuid",
            "type": "string",
            "readOnly": true,
            "x-nullable": false
          },
          "name": {
            "type": "string",
            "readOnly": true,
            "x-nullable": true
          },
          "precision": {
            "format": "float",
            "description": "Gets the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "precisionStdDeviation": {
            "format": "float",
            "description": "Gets the standard deviation for the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "recall": {
            "format": "float",
            "description": "Gets the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "recallStdDeviation": {
            "format": "float",
            "description": "Gets the standard deviation for the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "averagePrecision": {
            "format": "float",
            "description": "Gets the average precision when applicable",
            "type": "number",
            "readOnly": true,
            "x-nullable": true
          }
        },
        "x-nullable": true
      },
      "readOnly": true,
      "x-nullable": true
    },
    "precision": {
      "format": "float",
      "description": "Gets the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "precisionStdDeviation": {
      "format": "float",
      "description": "Gets the standard deviation for the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "recall": {
      "format": "float",
      "description": "Gets the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "recallStdDeviation": {
      "format": "float",
      "description": "Gets the standard deviation for the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "averagePrecision": {
      "format": "float",
      "description": "Gets the average precision when applicable",
      "type": "number",
      "readOnly": true,
      "x-nullable": true
    }
  },
  "x-nullable": true
}
<IterationPerformance>
  <perTagPerformance>
    <id>string</id>
    <name>string</name>
    <precision>0</precision>
    <precisionStdDeviation>0</precisionStdDeviation>
    <recall>0</recall>
    <recallStdDeviation>0</recallStdDeviation>
    <averagePrecision>0</averagePrecision>
  </perTagPerformance>
  <precision>0</precision>
  <precisionStdDeviation>0</precisionStdDeviation>
  <recall>0</recall>
  <recallStdDeviation>0</recallStdDeviation>
  <averagePrecision>0</averagePrecision>
</IterationPerformance>
{
  "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": {
          "id": {
            "format": "uuid",
            "type": "string",
            "readOnly": true,
            "x-nullable": false
          },
          "name": {
            "type": "string",
            "readOnly": true,
            "x-nullable": true
          },
          "precision": {
            "format": "float",
            "description": "Gets the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "precisionStdDeviation": {
            "format": "float",
            "description": "Gets the standard deviation for the precision",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "recall": {
            "format": "float",
            "description": "Gets the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "recallStdDeviation": {
            "format": "float",
            "description": "Gets the standard deviation for the recall",
            "type": "number",
            "readOnly": true,
            "x-nullable": false
          },
          "averagePrecision": {
            "format": "float",
            "description": "Gets the average precision when applicable",
            "type": "number",
            "readOnly": true,
            "x-nullable": true
          }
        },
        "x-nullable": true
      },
      "readOnly": true,
      "x-nullable": true
    },
    "precision": {
      "format": "float",
      "description": "Gets the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "precisionStdDeviation": {
      "format": "float",
      "description": "Gets the standard deviation for the precision",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "recall": {
      "format": "float",
      "description": "Gets the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "recallStdDeviation": {
      "format": "float",
      "description": "Gets the standard deviation for the recall",
      "type": "number",
      "readOnly": true,
      "x-nullable": false
    },
    "averagePrecision": {
      "format": "float",
      "description": "Gets the average precision when applicable",
      "type": "number",
      "readOnly": true,
      "x-nullable": true
    }
  },
  "x-nullable": true
}

Code samples

@ECHO OFF

curl -v -X GET "https://switzerlandwest.api.cognitive.microsoft.com/customvision/v2.2/Training/projects/{projectId}/iterations/{iterationId}/performance?threshold={number}&overlapThreshold={number}"
-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["threshold"] = "{number}";
            queryString["overlapThreshold"] = "{number}";
            var uri = "https://switzerlandwest.api.cognitive.microsoft.com/customvision/v2.2/Training/projects/{projectId}/iterations/{iterationId}/performance?" + 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://switzerlandwest.api.cognitive.microsoft.com/customvision/v2.2/Training/projects/{projectId}/iterations/{iterationId}/performance");

            builder.setParameter("threshold", "{number}");
            builder.setParameter("overlapThreshold", "{number}");

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

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // 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://switzerlandwest.api.cognitive.microsoft.com/customvision/v2.2/Training/projects/{projectId}/iterations/{iterationId}/performance');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'threshold' => '{number}',
    'overlapThreshold' => '{number}',
);

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

params = urllib.urlencode({
    # Request parameters
    'threshold': '{number}',
    'overlapThreshold': '{number}',
})

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

try:
    conn = http.client.HTTPSConnection('switzerlandwest.api.cognitive.microsoft.com')
    conn.request("GET", "/customvision/v2.2/Training/projects/{projectId}/iterations/{iterationId}/performance?%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://switzerlandwest.api.cognitive.microsoft.com/customvision/v2.2/Training/projects/{projectId}/iterations/{iterationId}/performance')

query = URI.encode_www_form({
    # Request parameters
    'threshold' => '{number}',
    'overlapThreshold' => '{number}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.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