Speaker Recognition API

Speaker Recognition - Get Operation Status

Get operation status or result. The operation should be created by Speaker Recognition - Identification or Identification Profile - Create Enrollment. And the URL should be retrieved from Operation-Location header of initial POST 202 response

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

Open API testing console

Request URL

Request parameters

string

The operation Id, created by Speaker Recognition - Identification or Identification Profile - Create Enrollment.

Request headers

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

Request body

Response 200

Request processed successfully by the service. Details can be found in the returned JSON.
The service will retain this operation for 24 hours only, after that it will be deleted from the service.

Description of the fields in the returned JSON response,

Fields Description
status The status of the operation.
  • notstarted: The operation is not started.
  • running: The operation is running.
  • failed: The operation is finished and failed.
  • succeeded: The operation is finished and succeeded.
createdDateTime Created date of the operation.
lastActionDateTime Last date of usage for this operation.
message Detail message returned by this operation. Used in operations with failed status to show detail failure message.
processingResult An Json Object contains the processing result. This object exists only when the operation status is succeeded.
EnrollmentStatus Speaker identification profile enrollment status:
  • Enrolling: profile is currently enrolling and is not ready for identification.
  • Training: profile is currently training and is not ready for identification.
  • Enrolled: profile is currently enrolled and is ready for identification.
enrollmentSpeechTime Speaker identification profile enrollment length in seconds of speech.
remainingEnrollmentSpeechTime Remaining number of speech seconds to complete minimum enrollment.
speechTime Seconds of useful speech in enrollment audio.
identifiedProfileId The identified speaker identification profile id. If this value is 00000000-0000-0000-0000-000000000000, it means there's no speaker identification profile identified and the audio file to be identified belongs to none of the provided speaker identification profiles.
confidence The confidence value of the identification.
  • Low: The confidence of the identification is low.
  • Normal: The confidence of the identification is normal.
  • High: The confidence of the identification is high.
 

Case 1 - not started 
HTTP/1.1 200 Ok
Content-Type: application/json
{
  "status": "notstarted",
  "createdDateTime":  "2015-09-30T01:28:23Z",
  "lastActionDateTime": "2015-09-30T01:29:23Z"
}

Case 3 - running
HTTP/1.1 200 Ok
Content-Type: application/json
{
  "status": "running",
  "createdDateTime":  "2015-09-30T01:28:23Z",
  "lastActionDateTime": "2015-09-30T01:32:23Z",
}

Case 4 - failed
HTTP/1.1 200 Ok
Content-Type: application/json
{
  "status": "failed",
  "createdDateTime":  "2015-09-30T01:28:23Z"
  "lastActionDateTime": "2015-09-30T01:35:23Z"
  "message":  "Some failure info"
}

Case 5 - succeeded
Case 5.1: Enrollment Result: in this case, the enrollment result would be returned inline in "processingResult" field.
HTTP/1.1 200 Ok
Content-Type: application/json
{
  "status": "succeeded",
  "createdDateTime":  "2015-09-30T01:28:23Z", 
  "lastActionDateTime": "2015-09-30T01:37:23Z",
  "processingResult": 
  {
    "enrollmentStatus" : "Enrolled", // [Enrolled|Enrolling|Training]
    "remainingEnrollmentSpeechTime" : 0.0,
    "speechTime" : 0.0,
    "enrollmentSpeechTime":0.0
  }
}

Case 5.2.1: Identification Result: in this case, the identification result would be returned inline in "processingResult" field. It successfully identified one of the provided profiles.
HTTP/1.1 200 Ok
Content-Type: application/json
{
  "status": "succeeded",
  "createdDateTime":  "2015-09-30T01:28:23Z", 
  "lastActionDateTime": "2015-09-30T01:37:23Z",
  "processingResult": 
  {
    "identifiedProfileId" : "111f427c-3791-468f-b709-fcef7660fff9", 
    "confidence" : "Normal" //[Low | Normal | High]
  }
}

Case 5.2.2: Identification Result: in this case, the identification result would be returned inline in "processingResult" field. It cannot identify the audio among the provided profiles.
HTTP/1.1 200 Ok
Content-Type: application/json
{
  "status": "succeeded",
  "createdDateTime":  "2015-09-30T01:28:23Z", 
  "lastActionDateTime": "2015-09-30T01:37:23Z",
  "processingResult": 
  {
    "identifiedProfileId" : "00000000-0000-0000-0000-000000000000", 
    "confidence" : "Normal" //[Low | Normal | High]
  }
}

Response 404

Can't find operation.

{
  "error":{
    "code" : "NotFound",
    "message" : "No operation id found", 
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://westus.api.cognitive.microsoft.com/spid/v1.0/operations/{operationId}"
-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}");

            var uri = "https://westus.api.cognitive.microsoft.com/spid/v1.0/operations/{operationId}?" + 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://westus.api.cognitive.microsoft.com/spid/v1.0/operations/{operationId}");


            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
        };
      
        $.ajax({
            url: "https://westus.api.cognitive.microsoft.com/spid/v1.0/operations/{operationId}?" + $.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://westus.api.cognitive.microsoft.com/spid/v1.0/operations/{operationId}";
    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:@"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://westus.api.cognitive.microsoft.com/spid/v1.0/operations/{operationId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("GET", "/spid/v1.0/operations/{operationId}?%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({
})

try:
    conn = http.client.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("GET", "/spid/v1.0/operations/{operationId}?%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://westus.api.cognitive.microsoft.com/spid/v1.0/operations/{operationId}')
uri.query = URI.encode_www_form({
})

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