Microsoft Cognitive Language Service - 2021-11-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
Submit text analysis job
Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed.
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 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": {
"entityRecognitionTasks": [
{
"parameters": {
"model-version": "latest"
}
}
],
"entityLinkingTasks": [
{
"parameters": {
"model-version": "latest"
}
}
],
"keyPhraseExtractionTasks": [
{
"parameters": {
"model-version": "latest"
}
}
],
"entityRecognitionPiiTasks": [
{
"parameters": {
"model-version": "latest"
}
}
],
"SentimentAnalysisTasks": [
{
"parameters": {
"model-version": "latest"
}
}
],
"extractiveSummarizationTasks": [
{
"parameters": {
"model-version": "latest"
}
}
],
"customEntityRecognitionTasks": [
{
"parameters": {
"project-name": "42a6c6d7-c90f-48f8-bd8e-a1ef982e47ee",
"deployment-name": "423c50a0-ec86-48da-8e52-0e4eddd4bbbf"
}
}
],
"customSingleClassificationTasks": [
{
"parameters": {
"project-name": "d0f811f8-3100-4054-9627-b258ff9d7c79",
"deployment-name": "f5c0ce91-d5e7-448f-845d-e36aa78b5e8f"
}
}
],
"customMultiClassificationTasks": [
{
"parameters": {
"project-name": "1c61fb1b-1e2d-459a-90dd-debec908046c",
"deployment-name": "1c61fb1b-1e2d-459a-90dd-debec908046c"
}
}
]
}
}{
"required": [
"analysisInput",
"tasks"
],
"properties": {
"displayName": {
"type": "string",
"description": "Optional display name for the analysis job."
},
"analysisInput": {
"required": [
"documents"
],
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"required": [
"id",
"text"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique, non-empty record 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."
}
},
"description": "Contains an input record to be analyzed by the service."
},
"description": "The set of documents to process as part of this batch."
}
},
"description": "Contains a set of input documents to be analyzed by the service."
},
"tasks": {
"type": "object",
"properties": {
"entityRecognitionTasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"taskName": {
"type": "string"
},
"parameters": {
"allOf": [
{
"type": "object",
"properties": {
"loggingOptOut": {
"type": "boolean",
"default": false
}
},
"description": "Base parameters object for a text analysis task."
},
{
"type": "object",
"properties": {
"modelVersion": {
"type": "string",
"default": "latest"
}
},
"description": "Parameters object for a text analysis task using pre-built models."
},
{
"type": "object",
"properties": {
"stringIndexType": {
"enum": [
"TextElements_v8",
"UnicodeCodePoint",
"Utf16CodeUnit"
],
"type": "string",
"description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.",
"default": "TextElements_v8",
"x-ms-enum": {
"name": "StringIndexType",
"modelAsString": true,
"values": [
{
"value": "TextElements_v8",
"description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo."
},
{
"value": "UnicodeCodePoint",
"description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python."
},
{
"value": "Utf16CodeUnit",
"description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript."
}
]
}
}
},
"description": "Parameters object for a Sentiment Analysis task."
}
]
}
},
"description": "An object representing the task definition for an Entities Recognition task."
}
},
"entityRecognitionPiiTasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"taskName": {
"type": "string"
},
"parameters": {
"allOf": [
{
"type": "object",
"properties": {
"loggingOptOut": {
"type": "boolean",
"default": false
}
},
"description": "Base parameters object for a text analysis task."
},
{
"type": "object",
"properties": {
"modelVersion": {
"type": "string",
"default": "latest"
}
},
"description": "Parameters object for a text analysis task using pre-built models."
},
{
"type": "object",
"properties": {
"domain": {
"enum": [
"phi",
"none"
],
"type": "string",
"default": "none"
},
"piiCategories": {
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"ABARoutingNumber",
"ARNationalIdentityNumber",
"AUBankAccountNumber",
"AUDriversLicenseNumber",
"AUMedicalAccountNumber",
"AUPassportNumber",
"AUTaxFileNumber",
"AUBusinessNumber",
"AUCompanyNumber",
"ATIdentityCard",
"ATTaxIdentificationNumber",
"ATValueAddedTaxNumber",
"AzureDocumentDBAuthKey",
"AzureIAASDatabaseConnectionAndSQLString",
"AzureIoTConnectionString",
"AzurePublishSettingPassword",
"AzureRedisCacheString",
"AzureSAS",
"AzureServiceBusString",
"AzureStorageAccountKey",
"AzureStorageAccountGeneric",
"BENationalNumber",
"BENationalNumberV2",
"BEValueAddedTaxNumber",
"BRCPFNumber",
"BRLegalEntityNumber",
"BRNationalIDRG",
"BGUniformCivilNumber",
"CABankAccountNumber",
"CADriversLicenseNumber",
"CAHealthServiceNumber",
"CAPassportNumber",
"CAPersonalHealthIdentification",
"CASocialInsuranceNumber",
"CLIdentityCardNumber",
"CNResidentIdentityCardNumber",
"CreditCardNumber",
"HRIdentityCardNumber",
"HRNationalIDNumber",
"HRPersonalIdentificationNumber",
"HRPersonalIdentificationOIBNumberV2",
"CYIdentityCard",
"CYTaxIdentificationNumber",
"CZPersonalIdentityNumber",
"CZPersonalIdentityV2",
"DKPersonalIdentificationNumber",
"DKPersonalIdentificationV2",
"DrugEnforcementAgencyNumber",
"EEPersonalIdentificationCode",
"EUDebitCardNumber",
"EUDriversLicenseNumber",
"EUGPSCoordinates",
"EUNationalIdentificationNumber",
"EUPassportNumber",
"EUSocialSecurityNumber",
"EUTaxIdentificationNumber",
"FIEuropeanHealthNumber",
"FINationalID",
"FINationalIDV2",
"FIPassportNumber",
"FRDriversLicenseNumber",
"FRHealthInsuranceNumber",
"FRNationalID",
"FRPassportNumber",
"FRSocialSecurityNumber",
"FRTaxIdentificationNumber",
"FRValueAddedTaxNumber",
"DEDriversLicenseNumber",
"DEPassportNumber",
"DEIdentityCardNumber",
"DETaxIdentificationNumber",
"DEValueAddedNumber",
"GRNationalIDCard",
"GRNationalIDV2",
"GRTaxIdentificationNumber",
"HKIdentityCardNumber",
"HUValueAddedNumber",
"HUPersonalIdentificationNumber",
"HUTaxIdentificationNumber",
"INPermanentAccount",
"INUniqueIdentificationNumber",
"IDIdentityCardNumber",
"InternationalBankingAccountNumber",
"IEPersonalPublicServiceNumber",
"IEPersonalPublicServiceNumberV2",
"ILBankAccountNumber",
"ILNationalID",
"ITDriversLicenseNumber",
"ITFiscalCode",
"ITValueAddedTaxNumber",
"JPBankAccountNumber",
"JPDriversLicenseNumber",
"JPPassportNumber",
"JPResidentRegistrationNumber",
"JPSocialInsuranceNumber",
"JPMyNumberCorporate",
"JPMyNumberPersonal",
"JPResidenceCardNumber",
"LVPersonalCode",
"LTPersonalCode",
"LUNationalIdentificationNumberNatural",
"LUNationalIdentificationNumberNonNatural",
"MYIdentityCardNumber",
"MTIdentityCardNumber",
"MTTaxIDNumber",
"NLCitizensServiceNumber",
"NLCitizensServiceNumberV2",
"NLTaxIdentificationNumber",
"NLValueAddedTaxNumber",
"NZBankAccountNumber",
"NZDriversLicenseNumber",
"NZInlandRevenueNumber",
"NZMinistryOfHealthNumber",
"NZSocialWelfareNumber",
"NOIdentityNumber",
"PHUnifiedMultiPurposeIDNumber",
"PLIdentityCard",
"PLNationalID",
"PLNationalIDV2",
"PLPassportNumber",
"PLTaxIdentificationNumber",
"PLREGONNumber",
"PTCitizenCardNumber",
"PTCitizenCardNumberV2",
"PTTaxIdentificationNumber",
"ROPersonalNumericalCode",
"RUPassportNumberDomestic",
"RUPassportNumberInternational",
"SANationalID",
"SGNationalRegistrationIdentityCardNumber",
"SKPersonalNumber",
"SITaxIdentificationNumber",
"SIUniqueMasterCitizenNumber",
"ZAIdentificationNumber",
"KRResidentRegistrationNumber",
"ESDNI",
"ESSocialSecurityNumber",
"ESTaxIdentificationNumber",
"SQLServerConnectionString",
"SENationalID",
"SENationalIDV2",
"SEPassportNumber",
"SETaxIdentificationNumber",
"SWIFTCode",
"CHSocialSecurityNumber",
"TWNationalID",
"TWPassportNumber",
"TWResidentCertificate",
"THPopulationIdentificationCode",
"TRNationalIdentificationNumber",
"UKDriversLicenseNumber",
"UKElectoralRollNumber",
"UKNationalHealthNumber",
"UKNationalInsuranceNumber",
"UKUniqueTaxpayerNumber",
"USUKPassportNumber",
"USBankAccountNumber",
"USDriversLicenseNumber",
"USIndividualTaxpayerIdentification",
"USSocialSecurityNumber",
"UAPassportNumberDomestic",
"UAPassportNumberInternational",
"Organization",
"Email",
"URL",
"Age",
"PhoneNumber",
"IPAddress",
"Date",
"Person",
"Address",
"All",
"Default"
],
"type": "string",
"x-ms-enum": {
"name": "PiiCategory",
"modelAsString": true
}
},
"description": "(Optional) describes the PII categories to return"
},
"stringIndexType": {
"enum": [
"TextElements_v8",
"UnicodeCodePoint",
"Utf16CodeUnit"
],
"type": "string",
"description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.",
"default": "TextElements_v8",
"x-ms-enum": {
"name": "StringIndexType",
"modelAsString": true,
"values": [
{
"value": "TextElements_v8",
"description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo."
},
{
"value": "UnicodeCodePoint",
"description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python."
},
{
"value": "Utf16CodeUnit",
"description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript."
}
]
}
}
},
"description": "Parameters object for a PII Entities Recognition task."
}
]
}
},
"description": "An object representing the task definition for a PII Entities Recognition task."
}
},
"keyPhraseExtractionTasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"taskName": {
"type": "string"
},
"parameters": {
"allOf": [
{
"type": "object",
"properties": {
"loggingOptOut": {
"type": "boolean",
"default": false
}
},
"description": "Base parameters object for a text analysis task."
},
{
"type": "object",
"properties": {
"modelVersion": {
"type": "string",
"default": "latest"
}
},
"description": "Parameters object for a text analysis task using pre-built models."
}
]
}
},
"description": "An object representing the task definition for a Key Phrase Extraction task."
}
},
"entityLinkingTasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"taskName": {
"type": "string"
},
"parameters": {
"allOf": [
{
"type": "object",
"properties": {
"loggingOptOut": {
"type": "boolean",
"default": false
}
},
"description": "Base parameters object for a text analysis task."
},
{
"type": "object",
"properties": {
"modelVersion": {
"type": "string",
"default": "latest"
}
},
"description": "Parameters object for a text analysis task using pre-built models."
},
{
"type": "object",
"properties": {
"stringIndexType": {
"enum": [
"TextElements_v8",
"UnicodeCodePoint",
"Utf16CodeUnit"
],
"type": "string",
"description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.",
"default": "TextElements_v8",
"x-ms-enum": {
"name": "StringIndexType",
"modelAsString": true,
"values": [
{
"value": "TextElements_v8",
"description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo."
},
{
"value": "UnicodeCodePoint",
"description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python."
},
{
"value": "Utf16CodeUnit",
"description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript."
}
]
}
}
},
"description": "Parameters object for a Sentiment Analysis task."
}
]
}
},
"description": "An object representing the task definition for an Entity Linking task."
}
},
"sentimentAnalysisTasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"taskName": {
"type": "string"
},
"parameters": {
"allOf": [
{
"type": "object",
"properties": {
"loggingOptOut": {
"type": "boolean",
"default": false
}
},
"description": "Base parameters object for a text analysis task."
},
{
"type": "object",
"properties": {
"modelVersion": {
"type": "string",
"default": "latest"
}
},
"description": "Parameters object for a text analysis task using pre-built models."
},
{
"type": "object",
"properties": {
"opinionMining": {
"type": "boolean",
"default": false
},
"stringIndexType": {
"enum": [
"TextElements_v8",
"UnicodeCodePoint",
"Utf16CodeUnit"
],
"type": "string",
"description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.",
"default": "TextElements_v8",
"x-ms-enum": {
"name": "StringIndexType",
"modelAsString": true,
"values": [
{
"value": "TextElements_v8",
"description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo."
},
{
"value": "UnicodeCodePoint",
"description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python."
},
{
"value": "Utf16CodeUnit",
"description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript."
}
]
}
}
},
"description": "Parameters object for a Sentiment Analysis task."
}
]
}
},
"description": "An object representing the task definition for a Sentiment Analysis task."
}
},
"extractiveSummarizationTasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"taskName": {
"type": "string"
},
"parameters": {
"allOf": [
{
"type": "object",
"properties": {
"loggingOptOut": {
"type": "boolean",
"default": false
}
},
"description": "Base parameters object for a text analysis task."
},
{
"type": "object",
"properties": {
"modelVersion": {
"type": "string",
"default": "latest"
}
},
"description": "Parameters object for a text analysis task using pre-built models."
},
{
"type": "object",
"properties": {
"sentenceCount": {
"type": "integer",
"default": 3
},
"sortBy": {
"enum": [
"Offset",
"Rank"
],
"type": "string",
"default": "Offset"
},
"stringIndexType": {
"enum": [
"TextElements_v8",
"UnicodeCodePoint",
"Utf16CodeUnit"
],
"type": "string",
"description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.",
"default": "TextElements_v8",
"x-ms-enum": {
"name": "StringIndexType",
"modelAsString": true,
"values": [
{
"value": "TextElements_v8",
"description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo."
},
{
"value": "UnicodeCodePoint",
"description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python."
},
{
"value": "Utf16CodeUnit",
"description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript."
}
]
}
}
},
"description": "Parameters object for an Extractive Summarization task."
}
]
}
},
"description": "An object representing the task definition for an Extractive Summarization task."
}
},
"customEntityRecognitionTasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"taskName": {
"type": "string"
},
"parameters": {
"allOf": [
{
"type": "object",
"properties": {
"loggingOptOut": {
"type": "boolean",
"default": false
}
},
"description": "Base parameters object for a text analysis task."
},
{
"required": [
"projectName",
"deploymentName"
],
"type": "object",
"properties": {
"projectName": {
"type": "string"
},
"deploymentName": {
"type": "string"
}
},
"description": "Parameters object for a text analysis task using custom models."
},
{
"type": "object",
"properties": {
"stringIndexType": {
"enum": [
"TextElements_v8",
"UnicodeCodePoint",
"Utf16CodeUnit"
],
"type": "string",
"description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.",
"default": "TextElements_v8",
"x-ms-enum": {
"name": "StringIndexType",
"modelAsString": true,
"values": [
{
"value": "TextElements_v8",
"description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo."
},
{
"value": "UnicodeCodePoint",
"description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python."
},
{
"value": "Utf16CodeUnit",
"description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript."
}
]
}
}
},
"description": "Parameters object for a Sentiment Analysis task."
}
]
}
},
"description": "Use custom models to ease the process of information extraction from unstructured documents like contracts or financial documents"
}
},
"customSingleClassificationTasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"taskName": {
"type": "string"
},
"parameters": {
"allOf": [
{
"type": "object",
"properties": {
"loggingOptOut": {
"type": "boolean",
"default": false
}
},
"description": "Base parameters object for a text analysis task."
},
{
"required": [
"projectName",
"deploymentName"
],
"type": "object",
"properties": {
"projectName": {
"type": "string"
},
"deploymentName": {
"type": "string"
}
},
"description": "Parameters object for a text analysis task using custom models."
}
]
}
},
"description": "Use custom models to classify text into single label taxonomy"
}
},
"customMultiClassificationTasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"taskName": {
"type": "string"
},
"parameters": {
"allOf": [
{
"type": "object",
"properties": {
"loggingOptOut": {
"type": "boolean",
"default": false
}
},
"description": "Base parameters object for a text analysis task."
},
{
"required": [
"projectName",
"deploymentName"
],
"type": "object",
"properties": {
"projectName": {
"type": "string"
},
"deploymentName": {
"type": "string"
}
},
"description": "Parameters object for a text analysis task using custom models."
}
]
}
},
"description": "Use custom models to classify text into multi label taxonomy"
}
}
},
"description": "The set of tasks to execute on the input documents."
}
}
}Response 202
A successful call results with an Operation-Location header used to check the status of the analysis job.
Response 400
Bad Request.
{
"error": {
"code": "InvalidRequest",
"message": "Invalid Request.",
"innererror": {
"code": "MissingInputRecords",
"message": "Missing input records."
}
}
}Response 500
Unexpected error
{
"error": {
"code": "InternalServerError",
"message": "Processing failed unexpectedly. Please try again later."
}
}Code samples
@ECHO OFF
curl -v -X POST "https://virginia.api.cognitive.microsoft.us/language/analyze-text/jobs?api-version=2021-11-01-preview"
-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://virginia.api.cognitive.microsoft.us/language/analyze-text/jobs?api-version=2021-11-01-preview&" + 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://virginia.api.cognitive.microsoft.us/language/analyze-text/jobs?api-version=2021-11-01-preview");
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://virginia.api.cognitive.microsoft.us/language/analyze-text/jobs?api-version=2021-11-01-preview&" + $.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://virginia.api.cognitive.microsoft.us/language/analyze-text/jobs?api-version=2021-11-01-preview";
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://virginia.api.cognitive.microsoft.us/language/analyze-text/jobs?api-version=2021-11-01-preview');
$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('virginia.api.cognitive.microsoft.us')
conn.request("POST", "/language/analyze-text/jobs?api-version=2021-11-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
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('virginia.api.cognitive.microsoft.us')
conn.request("POST", "/language/analyze-text/jobs?api-version=2021-11-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://virginia.api.cognitive.microsoft.us/language/analyze-text/jobs?api-version=2021-11-01-preview')
uri.query = URI.encode_www_form({
})
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