Face API - v1.0

This API is currently available in:

  • Australia East - australiaeast.api.cognitive.microsoft.com
  • Brazil South - brazilsouth.api.cognitive.microsoft.com
  • Canada Central - canadacentral.api.cognitive.microsoft.com
  • Central India - centralindia.api.cognitive.microsoft.com
  • Central US - centralus.api.cognitive.microsoft.com
  • East Asia - eastasia.api.cognitive.microsoft.com
  • East US - eastus.api.cognitive.microsoft.com
  • East US 2 - eastus2.api.cognitive.microsoft.com
  • France Central - francecentral.api.cognitive.microsoft.com
  • Germany West Central - germanywestcentral.api.cognitive.microsoft.com
  • Italy North - italynorth.api.cognitive.microsoft.com
  • Japan East - japaneast.api.cognitive.microsoft.com
  • Japan West - japanwest.api.cognitive.microsoft.com
  • Jio India West - jioindiawest.api.cognitive.microsoft.com
  • Korea Central - koreacentral.api.cognitive.microsoft.com
  • North Central US - northcentralus.api.cognitive.microsoft.com
  • North Europe - northeurope.api.cognitive.microsoft.com
  • Norway East - norwayeast.api.cognitive.microsoft.com
  • Qatar Central - qatarcentral.api.cognitive.microsoft.com
  • South Africa North - southafricanorth.api.cognitive.microsoft.com
  • South Central US - southcentralus.api.cognitive.microsoft.com
  • Southeast Asia - southeastasia.api.cognitive.microsoft.com
  • Sweden Central - swedencentral.api.cognitive.microsoft.com
  • Switzerland North - switzerlandnorth.api.cognitive.microsoft.com
  • Switzerland West - switzerlandwest.api.cognitive.microsoft.com
  • UAE North - uaenorth.api.cognitive.microsoft.com
  • UK South - uksouth.api.cognitive.microsoft.com
  • West Central US - westcentralus.api.cognitive.microsoft.com
  • West Europe - westeurope.api.cognitive.microsoft.com
  • West US - westus.api.cognitive.microsoft.com
  • West US 2 - westus2.api.cognitive.microsoft.com
  • West US 3 - westus3.api.cognitive.microsoft.com

PersonGroup - List

List person groups’s personGroupId, name, userData and recognitionModel.

  • Person groups are stored in alphabetical order of personGroupId.
  • "start" parameter (string, optional) is a user-provided personGroupId value that returned entries have larger ids by string comparison. "start" set to empty to indicate return from the first item.
  • "top" parameter (int, optional) specifies the number of entries to return. A maximal of 1000 entries can be returned in one call. To fetch more, you can specify "start" with the last retuned entry’s Id of the current call.
For example, total 5 person groups: "group1", ..., "group5".
"start=&top=" will return all 5 groups.
"start=&top=2" will return "group1", "group2".
"start=group2&top=3" will return "group3", "group4", "group5".

Http Method

GET

Select the testing console in the region where you created your resource:

Australia East Brazil South Canada Central Central India Central US East Asia East US East US 2 France Central Germany West Central Japan East Japan West Jio India West Korea Central North Central US North Europe Norway East Qatar Central South Africa North South Central US Southeast Asia Sweden Central Switzerland North Switzerland West UAE North UK South West Central US West Europe West US West US 2 West US 3

Request URL

Request parameters

(optional)
string

List person groups from the least personGroupId greater than the "start". It contains no more than 64 characters. Default is empty.

(optional)
integer

The number of person groups to list, ranging in [1, 1000]. Default is 1000.

(optional)
boolean

Return 'recognitionModel' or not. The default value is false.

Request headers

string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

Response 200

A successful call returns an array of person groups and their information (personGroupId, name and userData).

JSON fields in response body:

FieldsTypeDescription
personGroupIdStringpersonGroupId of the existing person groups, created in PersonGroup - Create.
nameStringPerson group's display name.
userDataStringUser-provided data attached to this person group.
recognitionModelStringThe 'recognitionModel' associated with this person group. This is only returned when 'returnRecognitionModel' is explicitly set as true.
 

[
    {
        "personGroupId": "sample_group",
        "name": "group1",
        "userData": "User-provided data attached to the person group.",
        "recognitionModel": "recognition_01"
    },
    {
        "personGroupId": "sample_group2",
        "name": "group2",
        "userData": "User-provided data attached to the person group.",
        "recognitionModel": "recognition_03"
    }
]

Response 400

Error code and message returned in JSON:

Error CodeError Message Description
BadArgumentParameter top is invalid. Valid range is [1, 1000].
 

{
    "error": {
        "statusCode": 400,
        "message": "Parameter top is invalid."
    }
}

Response 401

Error code and message returned in JSON:

Error CodeError Message Description
UnspecifiedInvalid subscription Key or user/plan is blocked.
 

{
    "error": {
        "code": "Unspecified",
        "message": "Access denied due to invalid subscription key. Make sure you are subscribed to an API you are trying to call and provide the right key."
    }
}

Response 403

{
    "error": {
        "statusCode": 403,
        "message": "Out of call volume quota. Quota will be replenished in 2 days."
    }
}

Response 409

{
    "error": {
        "code": ConcurrentOperationConflict,
        "message": "There is a conflict operation on requested resource, please try later."
    }
}

Response 429

{
    "error": {
        "statusCode": 429,
        "message": "Rate limit is exceeded. Try again in 26 seconds."
    }
}

Code samples

@ECHO OFF

curl -v -X GET "https://northeurope.api.cognitive.microsoft.com/face/v1.0/persongroups?start={string}&top=1000&returnRecognitionModel=false"
-H "Ocp-Apim-Subscription-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("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["start"] = "{string}";
            queryString["top"] = "1000";
            queryString["returnRecognitionModel"] = "false";
            var uri = "https://northeurope.api.cognitive.microsoft.com/face/v1.0/persongroups?" + 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://northeurope.api.cognitive.microsoft.com/face/v1.0/persongroups");

            builder.setParameter("start", "{string}");
            builder.setParameter("top", "1000");
            builder.setParameter("returnRecognitionModel", "false");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-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
            "start": "{string}",
            "top": "1000",
            "returnRecognitionModel": "false",
        };
      
        $.ajax({
            url: "https://northeurope.api.cognitive.microsoft.com/face/v1.0/persongroups?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-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://northeurope.api.cognitive.microsoft.com/face/v1.0/persongroups";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"start={string}",
                         @"top=1000",
                         @"returnRecognitionModel=false",
                      ];
    
    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:@"Ocp-Apim-Subscription-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://northeurope.api.cognitive.microsoft.com/face/v1.0/persongroups');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'start' => '{string}',
    'top' => '1000',
    'returnRecognitionModel' => 'false',
);

$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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'start': '{string}',
    'top': '1000',
    'returnRecognitionModel': 'false',
})

try:
    conn = httplib.HTTPSConnection('northeurope.api.cognitive.microsoft.com')
    conn.request("GET", "/face/v1.0/persongroups?%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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'start': '{string}',
    'top': '1000',
    'returnRecognitionModel': 'false',
})

try:
    conn = http.client.HTTPSConnection('northeurope.api.cognitive.microsoft.com')
    conn.request("GET", "/face/v1.0/persongroups?%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://northeurope.api.cognitive.microsoft.com/face/v1.0/persongroups')
uri.query = URI.encode_www_form({
    # Request parameters
    'start' => '{string}',
    'top' => '1000',
    'returnRecognitionModel' => 'false'
})

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-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