Microsoft Cognitive Language Service
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/language-service/overview.0
Submit text analysis job
Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request headers
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.
Request body
Collection of documents to analyze and one or more tasks to execute.
{
"displayName": "Extracting Location & US Region",
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "I had a wonderful trip to Seattle last week."
},
{
"id": "2",
"language": "en",
"text": "I'm flying to NYC tomorrow. See you there."
}
]
},
"tasks": [
{
"kind": "EntityLinking",
"taskName": "Linking Entities",
"parameters": {
"modelVersion": "latest"
}
},
{
"kind": "EntityRecognition",
"taskName": "Recognize Entities",
"parameters": {
"projectName": "MyProject",
"deploymentName": "MyDeployment"
}
},
{
"kind": "Healthcare",
"taskName": "Health care",
"parameters": {
"modelVersion": "latest"
}
},
{
"kind": "KeyPhraseExtraction",
"taskName": "Extracting Key Phrase",
"parameters": {
"modelVersion": "latest"
}
},
{
"kind": "PiiEntityRecognition",
"taskName": "Personal Entity Recognition",
"parameters": {
"modelVersion": "latest"
}
},
{
"kind": "SentimentAnalysis",
"taskName": "Anlyzing Document Sentiment",
"parameters": {
"modelVersion": "latest"
}
},
{
"kind": "CustomEntityRecognition",
"taskName": "Entity Recognition",
"parameters": {
"projectName": "88ee0f78-fbca-444d-98e2-7c4c8631e494",
"deploymentName": "88ee0f78-fbca-444d-98e2-7c4c8631e494"
}
},
{
"kind": "CustomSingleLabelClassification",
"taskName": "Single Classification Label",
"parameters": {
"projectName": "659c1851-be0b-4142-b12a-087da9785926",
"deploymentName": "659c1851-be0b-4142-b12a-087da9785926"
}
},
{
"kind": "CustomMultiLabelClassification",
"taskName": "Multi Label Classification",
"parameters": {
"projectName": "7cdace98-537b-494a-b69a-c19754718025",
"deploymentName": "7cdace98-537b-494a-b69a-c19754718025"
}
}
]
}{
"properties": {
"displayName": {
"description": "Optional display name for the analysis job.",
"type": "string"
},
"analysisInput": {
"properties": {
"documents": {
"type": "array",
"items": {
"type": "object",
"description": "Contains an input document to be analyzed by the service.",
"required": [
"id",
"text"
],
"properties": {
"id": {
"type": "string",
"description": "A unique, non-empty document identifier."
},
"text": {
"type": "string",
"description": "The input text to process."
},
"language": {
"type": "string",
"description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default."
}
}
}
}
}
},
"tasks": {
"description": "The set of tasks to execute on the input documents.",
"type": "array",
"items": {
"discriminator": "kind",
"required": [
"kind"
],
"properties": {
"kind": {
"type": "string",
"description": "Enumeration of supported long-running Text Analysis tasks.",
"enum": [
"SentimentAnalysis",
"EntityRecognition",
"PiiEntityRecognition",
"KeyPhraseExtraction",
"EntityLinking",
"Healthcare",
"CustomEntityRecognition",
"CustomSingleLabelClassification",
"CustomMultiLabelClassification"
],
"x-ms-enum": {
"name": "AnalyzeTextLROTaskKind",
"modelAsString": true
}
}
},
"allOf": [
{
"type": "object",
"description": "Base task object.",
"properties": {
"taskName": {
"type": "string"
}
}
}
]
}
}
},
"required": [
"analysisInput",
"tasks"
]
}Response 202
A successful call results with an Operation-Location header used to check the status of the analysis job.
Response 500
Error response.
Code samples
@ECHO OFF
curl -v -X POST "https://uaenorth.api.cognitive.microsoft.com/language/analyze-text/jobs?api-version=2022-05-01"
-H "Content-Type: application/json"
-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://uaenorth.api.cognitive.microsoft.com/language/analyze-text/jobs?api-version=2022-05-01&" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // 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://uaenorth.api.cognitive.microsoft.com/language/analyze-text/jobs?api-version=2022-05-01");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json");
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://uaenorth.api.cognitive.microsoft.com/language/analyze-text/jobs?api-version=2022-05-01&" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// 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://uaenorth.api.cognitive.microsoft.com/language/analyze-text/jobs?api-version=2022-05-01";
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:@"POST"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_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://uaenorth.api.cognitive.microsoft.com/language/analyze-text/jobs?api-version=2022-05-01');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// 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
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('uaenorth.api.cognitive.microsoft.com')
conn.request("POST", "/language/analyze-text/jobs?api-version=2022-05-01&%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
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('uaenorth.api.cognitive.microsoft.com')
conn.request("POST", "/language/analyze-text/jobs?api-version=2022-05-01&%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://uaenorth.api.cognitive.microsoft.com/language/analyze-text/jobs?api-version=2022-05-01')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# 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