Microsoft Cognitive Language Service - 2022-02-01-preview

The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.0

Get text analysis status and results

Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are completed, the job will transition to the succeeded state and results will be available for each task.

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

Open API testing console

Request URL

Request parameters

string

Job ID for a text analysis job.

(optional)
boolean

(Optional) if set to true, response will contain request and record level statistics.

(optional)
integer

(Optional) Set the maximum number of results per task. When both top and skip are specified, skip is applied first.

(optional)
integer

(Optional) Set the number of elements to offset in the response. When both top and skip are specified, skip is applied first.

Request headers

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

Request body

Response 200

Analysis job status and metadata.

{
	"createdDateTime": "2020-10-01T15:00:45Z",
	"displayName": "Extracting Location & US Region",
	"expirationDateTime": "2020-10-03T15:01:03Z",
	"jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18",
	"lastUpdateDateTime": "2020-10-01T15:01:03Z",
	"status": "succeeded",
	"tasks": {
		"completed": 2,
		"failed": 0,
		"inProgress": 0,
		"total": 2,
		"items": [
		{
			"kind": "EntityRecognitionLROResults",
			"taskId": "Recognize Entities",
			"lastUpdateDateTime": "2020-10-01T15:01:03Z",
			"status": "succeeded",
			"results": {
			"documents": [
				{
				"entities": [
					{
					"category": "Event",
					"confidenceScore": 0.61,
					"length": 4,
					"offset": 18,
					"text": "trip"
					},
					{
					"category": "Location",
					"confidenceScore": 0.82,
					"length": 7,
					"offset": 26,
					"subcategory": "GPE",
					"text": "Seattle"
					},
					{
					"category": "DateTime",
					"confidenceScore": 0.8,
					"length": 9,
					"offset": 34,
					"subcategory": "DateRange",
					"text": "last week"
					}
				],
				"id": "1",
				"warnings": []
				},
				{
				"entities": [
					{
					"category": "Location",
					"confidenceScore": 0.52,
					"length": 3,
					"offset": 14,
					"subcategory": "GPE",
					"text": "NYC"
					},
					{
					"category": "DateTime",
					"confidenceScore": 0.8,
					"length": 8,
					"offset": 18,
					"subcategory": "Date",
					"text": "tomorrow"
					}
				],
				"id": "2",
				"warnings": []
				}
			],
			"errors": [],
			"modelVersion": "2020-04-01"
			}
		},
		{
			"kind": "CustomEntityRecognitionLROResults",
			"taskId": "Recognize US Regions",
			"lastUpdateDateTime": "2020-10-01T15:01:03Z",
			"status": "succeeded",
			"results": {
			"documents": [
				{
				"entities": [
					{
					"category": "USRegion",
					"confidenceScore": 0.85,
					"length": 17,
					"offset": 45,
					"text": "Pacific Northwest"
					}
				],
				"id": "1",
				"warnings": []
				},
				{
				"entities": [
					{
					"category": "USRegion",
					"confidenceScore": 0.88,
					"length": 10,
					"offset": 63,
					"text": "East Coast"
					}
				],
				"id": "2",
				"warnings": []
				}
			],
			"errors": [],
			"projectName": "MyProject",
			"deploymentName": "MyDeployment"
			}
		}
		]
	}
}

Response 404

Job ID not found.

{
	"error": {
		"code": "NotFound",
		"message": "Not Found",
		"innererror": {
			"code": "JobIdNotFound",
			"message": "Job ID not found."
		}
	}
}

Response 500

Unexpected error

{
	"error": {
		"code": "InternalServerError",
		"message": "Processing failed unexpectedly. Please try again later."
	}
}

Code samples

@ECHO OFF

curl -v -X GET "https://*.cognitiveservices.azure.com/language/analyze-text/jobs/{jobId}?api-version=2022-02-01-preview?showStats={boolean}&top=20&skip=0"
-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["showStats"] = "{boolean}";
            queryString["top"] = "20";
            queryString["skip"] = "0";
            var uri = "https://*.cognitiveservices.azure.com/language/analyze-text/jobs/{jobId}?api-version=2022-02-01-preview&" + 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://*.cognitiveservices.azure.com/language/analyze-text/jobs/{jobId}?api-version=2022-02-01-preview");

            builder.setParameter("showStats", "{boolean}");
            builder.setParameter("top", "20");
            builder.setParameter("skip", "0");

            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
            "showStats": "{boolean}",
            "top": "20",
            "skip": "0",
        };
      
        $.ajax({
            url: "https://*.cognitiveservices.azure.com/language/analyze-text/jobs/{jobId}?api-version=2022-02-01-preview&" + $.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://*.cognitiveservices.azure.com/language/analyze-text/jobs/{jobId}?api-version=2022-02-01-preview";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"showStats={boolean}",
                         @"top=20",
                         @"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:@"{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://*.cognitiveservices.azure.com/language/analyze-text/jobs/{jobId}?api-version=2022-02-01-preview');
$url = $request->getUrl();

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

$request->setHeader($headers);

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

params = urllib.urlencode({
    # Request parameters
    'showStats': '{boolean}',
    'top': '20',
    'skip': '0',
})

try:
    conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("GET", "/language/analyze-text/jobs/{jobId}?api-version=2022-02-01-preview&%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
    'showStats': '{boolean}',
    'top': '20',
    'skip': '0',
})

try:
    conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("GET", "/language/analyze-text/jobs/{jobId}?api-version=2022-02-01-preview&%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://*.cognitiveservices.azure.com/language/analyze-text/jobs/{jobId}?api-version=2022-02-01-preview')

query = URI.encode_www_form({
    # Request parameters
    'showStats' => '{boolean}',
    'top' => '20',
    'skip' => '0'
})
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['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