Custom_Vision_Training_2.2
GetTaggedImages
This API supports batching and range selection. By default it will only return first 50 images matching images. Use the and parameters to control how many images to return in a given batch. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned
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 EUAPRequest URL
Request parameters
string
Format - uuid. The project id
(optional)
string
Format - uuid. The iteration id. Defaults to workspace
(optional)
array
A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20
(optional)
string
The ordering. Defaults to newest
(optional)
integer
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256
(optional)
integer
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0
Request headers
string
Request body
Response 200
OK
[
{
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
]{
"type": "array",
"items": {
"description": "Image model to be sent as JSON",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"width": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"height": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"imageUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"thumbnailUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true
},
"readOnly": true,
"x-nullable": true
},
"regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"regionId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"left": {
"format": "float",
"type": "number",
"x-nullable": false
},
"top": {
"format": "float",
"type": "number",
"x-nullable": false
},
"width": {
"format": "float",
"type": "number",
"x-nullable": false
},
"height": {
"format": "float",
"type": "number",
"x-nullable": false
}
},
"x-nullable": true
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"x-nullable": true
}[
{
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
]{
"type": "array",
"items": {
"description": "Image model to be sent as JSON",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"width": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"height": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"imageUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"thumbnailUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true
},
"readOnly": true,
"x-nullable": true
},
"regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"regionId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"left": {
"format": "float",
"type": "number",
"x-nullable": false
},
"top": {
"format": "float",
"type": "number",
"x-nullable": false
},
"width": {
"format": "float",
"type": "number",
"x-nullable": false
},
"height": {
"format": "float",
"type": "number",
"x-nullable": false
}
},
"x-nullable": true
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"x-nullable": true
}<ImageArray>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<imageUri>string</imageUri>
<thumbnailUri>string</thumbnailUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageArray>{
"type": "array",
"items": {
"description": "Image model to be sent as JSON",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"width": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"height": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"imageUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"thumbnailUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true
},
"readOnly": true,
"x-nullable": true
},
"regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"regionId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"left": {
"format": "float",
"type": "number",
"x-nullable": false
},
"top": {
"format": "float",
"type": "number",
"x-nullable": false
},
"width": {
"format": "float",
"type": "number",
"x-nullable": false
},
"height": {
"format": "float",
"type": "number",
"x-nullable": false
}
},
"x-nullable": true
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"x-nullable": true
}<ImageArray>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<imageUri>string</imageUri>
<thumbnailUri>string</thumbnailUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageArray>{
"type": "array",
"items": {
"description": "Image model to be sent as JSON",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"width": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"height": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"imageUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"thumbnailUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true
},
"readOnly": true,
"x-nullable": true
},
"regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"regionId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"left": {
"format": "float",
"type": "number",
"x-nullable": false
},
"top": {
"format": "float",
"type": "number",
"x-nullable": false
},
"width": {
"format": "float",
"type": "number",
"x-nullable": false
},
"height": {
"format": "float",
"type": "number",
"x-nullable": false
}
},
"x-nullable": true
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"x-nullable": true
}Code samples
@ECHO OFF
curl -v -X GET "https://centralindia.api.cognitive.microsoft.com/customvision/v2.2/Training/projects/{projectId}/images/tagged?iterationId={string}&tagIds={array}&orderBy={string}&take=50&skip=0"
-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["iterationId"] = "{string}";
queryString["tagIds"] = "{array}";
queryString["orderBy"] = "{string}";
queryString["take"] = "50";
queryString["skip"] = "0";
var uri = "https://centralindia.api.cognitive.microsoft.com/customvision/v2.2/Training/projects/{projectId}/images/tagged?" + 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://centralindia.api.cognitive.microsoft.com/customvision/v2.2/Training/projects/{projectId}/images/tagged");
builder.setParameter("iterationId", "{string}");
builder.setParameter("tagIds", "{array}");
builder.setParameter("orderBy", "{string}");
builder.setParameter("take", "50");
builder.setParameter("skip", "0");
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
"iterationId": "{string}",
"tagIds": "{array}",
"orderBy": "{string}",
"take": "50",
"skip": "0",
};
$.ajax({
url: "https://centralindia.api.cognitive.microsoft.com/customvision/v2.2/Training/projects/{projectId}/images/tagged?" + $.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://centralindia.api.cognitive.microsoft.com/customvision/v2.2/Training/projects/{projectId}/images/tagged";
NSArray* array = @[
// Request parameters
@"entities=true",
@"iterationId={string}",
@"tagIds={array}",
@"orderBy={string}",
@"take=50",
@"skip=0",
];
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://centralindia.api.cognitive.microsoft.com/customvision/v2.2/Training/projects/{projectId}/images/tagged');
$url = $request->getUrl();
$headers = array(
// Request headers
'Training-Key' => '',
'Training-key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'iterationId' => '{string}',
'tagIds' => '{array}',
'orderBy' => '{string}',
'take' => '50',
'skip' => '0',
);
$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
'iterationId': '{string}',
'tagIds': '{array}',
'orderBy': '{string}',
'take': '50',
'skip': '0',
})
try:
conn = httplib.HTTPSConnection('centralindia.api.cognitive.microsoft.com')
conn.request("GET", "/customvision/v2.2/Training/projects/{projectId}/images/tagged?%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
'iterationId': '{string}',
'tagIds': '{array}',
'orderBy': '{string}',
'take': '50',
'skip': '0',
})
try:
conn = http.client.HTTPSConnection('centralindia.api.cognitive.microsoft.com')
conn.request("GET", "/customvision/v2.2/Training/projects/{projectId}/images/tagged?%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://centralindia.api.cognitive.microsoft.com/customvision/v2.2/Training/projects/{projectId}/images/tagged')
uri.query = URI.encode_www_form({
# Request parameters
'iterationId' => '{string}',
'tagIds' => '{array}',
'orderBy' => '{string}',
'take' => '50',
'skip' => '0'
})
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