Text Analytics API (v2.1)

The Text Analytics API is a suite of text analytics web services 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 and entity extraction as well as language detection. No training data is needed to use this API; just bring your text data. This API uses advanced natural language processing techniques to deliver best in class predictions.

Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview

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
  • Japan East - japaneast.api.cognitive.microsoft.com
  • Japan West - japanwest.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
  • South Africa North - southafricanorth.api.cognitive.microsoft.com
  • South Central US - southcentralus.api.cognitive.microsoft.com
  • Southeast Asia - southeastasia.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

Entities

The API returns a list of known entities and general named entities ("Person", "Location", "Organization" etc) in a given document. Known entities are returned with Wikipedia Id and Wikipedia link, and also Bing Id which can be used in Bing Entity Search API. General named entities are returned with entity types. If a general named entity is also a known entity, then all information regarding it (Wikipedia Id, Bing Id, entity type etc) will be returned. See the Supported Entity Types in Text Analytics API for the list of supported Entity Types. See the Supported languages in Text Analytics API for the list of enabled languages.

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

Open API testing console

Request URL

Request parameters

(optional)
boolean

(optional) if set to true, response will contain input and document level statistics.

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.

{
  "documents": [
    {
      "language": "en",
      "id": "1",
      "text": "Hello world. This is some input text that I love."
    },
    {
      "language": "fr",
      "id": "2",
      "text": "Bonjour tout le monde"
    },
    {
      "language": "es",
      "id": "3",
      "text": "La carretera estaba atascada. Había mucho tráfico el día de ayer."
    }
  ]
}
{
  "type": "object",
  "properties": {
    "documents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "language": {
            "description": "This is the 2 letter ISO 639-1 representation of a language.\r\n            For example, use \"en\" for English; \"es\" for Spanish etc.,",
            "type": "string"
          },
          "id": {
            "description": "Unique, non-empty document identifier.",
            "type": "string"
          },
          "text": {
            "type": "string"
          }
        }
      }
    }
  },
  "example": {
    "documents": [
      {
        "language": "en",
        "id": "1",
        "text": "Hello world. This is some input text that I love."
      },
      {
        "language": "fr",
        "id": "2",
        "text": "Bonjour tout le monde"
      },
      {
        "language": "es",
        "id": "3",
        "text": "La carretera estaba atascada. Había mucho tráfico el día de ayer."
      }
    ]
  }
}
{
  "documents": [
    {
      "language": "en",
      "id": "1",
      "text": "Hello world. This is some input text that I love."
    },
    {
      "language": "fr",
      "id": "2",
      "text": "Bonjour tout le monde"
    },
    {
      "language": "es",
      "id": "3",
      "text": "La carretera estaba atascada. Había mucho tráfico el día de ayer."
    }
  ]
}
{
  "type": "object",
  "properties": {
    "documents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "language": {
            "description": "This is the 2 letter ISO 639-1 representation of a language.\r\n            For example, use \"en\" for English; \"es\" for Spanish etc.,",
            "type": "string"
          },
          "id": {
            "description": "Unique, non-empty document identifier.",
            "type": "string"
          },
          "text": {
            "type": "string"
          }
        }
      }
    }
  },
  "example": {
    "documents": [
      {
        "language": "en",
        "id": "1",
        "text": "Hello world. This is some input text that I love."
      },
      {
        "language": "fr",
        "id": "2",
        "text": "Bonjour tout le monde"
      },
      {
        "language": "es",
        "id": "3",
        "text": "La carretera estaba atascada. Había mucho tráfico el día de ayer."
      }
    ]
  }
}

Response 200

A successful call results in a list of recognized entities returned for each valid document

{
  "documents": [
    {
      "id": "1",
      "entities": [
        {
          "name": "Microsoft",
          "matches": [
            {
              "wikipediaScore": null,
              "entityTypeScore": 0.9,
              "text": "MSFT",
              "offset": 0,
              "length": 4
            },
            {
              "wikipediaScore": 0.8,
              "entityTypeScore": 0.9,
              "text": "Microsoft",
              "offset": 25,
              "length": 9
            }
          ],
          "wikipediaLanguage": "en",
          "wikipediaId": "Microsoft",
          "wikipediaUrl": "https://en.wikipedia.org/wiki/Microsoft",
          "bingId": "a093e9b9-90f5-a3d5-c4b8-5855e1b01f85",
          "type": "Organization",
          "subType": null
        },
        {
          "name": "Windows 10",
          "matches": [
            {
              "wikipediaScore": 0.8,
              "entityTypeScore": null,
              "text": "Windows 10",
              "offset": 44,
              "length": 10
            }
          ],
          "wikipediaLanguage": "en",
          "wikipediaId": "Windows 10",
          "wikipediaUrl": "https://en.wikipedia.org/wiki/Windows_10",
          "bingId": "5f9fbd03-49c4-39ef-cc95-de83ab897b94",
          "type": null,
          "subType": null
        }
      ]
    },
    {
      "id": "2",
      "entities": [
        {
          "name": "John",
          "matches": [
            {
              "wikipediaScore": null,
              "entityTypeScore": 0.9,
              "text": "John",
              "offset": 0,
              "length": 4
            }
          ],
          "wikipediaLanguage": null,
          "wikipediaId": null,
          "wikipediaUrl": null,
          "bingId": null,
          "type": "Person",
          "subType": null
        },
        {
          "name": "Application programming interface",
          "matches": [
            {
              "wikipediaScore": 0.8,
              "entityTypeScore": null,
              "text": "API",
              "offset": 31,
              "length": 3
            }
          ],
          "wikipediaLanguage": "en",
          "wikipediaId": "Application programming interface",
          "wikipediaUrl": "https://en.wikipedia.org/wiki/Application_programming_interface",
          "bingId": "e8c1a257-7315-a482-c81d-202a0260e4ed",
          "type": null,
          "subType": null
        },
        {
          "name": "Microsoft",
          "matches": [
            {
              "wikipediaScore": 0.8,
              "entityTypeScore": 0.9,
              "text": "Microsoft",
              "offset": 40,
              "length": 9
            }
          ],
          "wikipediaLanguage": "en",
          "wikipediaId": "Microsoft",
          "wikipediaUrl": "https://en.wikipedia.org/wiki/Microsoft",
          "bingId": "a093e9b9-90f5-a3d5-c4b8-5855e1b01f85",
          "type": "Organization",
          "subType": null
        }
      ]
    }
  ],
  "errors": []
}
{
  "type": "object",
  "properties": {
    "documents": {
      "description": "Response by document",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Unique, non-empty document identifier.",
            "type": "string"
          },
          "entities": {
            "description": "Recognized entities in the document.",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "description": "Entity formal name.",
                  "type": "string"
                },
                "matches": {
                  "description": "List of instances this entity appears in the text.",
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "wikipediaScore": {
                        "format": "double",
                        "description": "(optional) If a well-known item with Wikipedia link is recognized,\r\n            a decimal number denoting the confidence level of the Wikipedia info will be returned.",
                        "type": "number"
                      },
                      "entityTypeScore": {
                        "format": "double",
                        "description": "(optional) If an entity type is recognized,\r\n            a decimal number denoting the confidence level of the entity type will be returned.",
                        "type": "number"
                      },
                      "text": {
                        "description": "Entity text as appears in the request.",
                        "type": "string"
                      },
                      "offset": {
                        "format": "int32",
                        "description": "Start position (in Unicode characters) for the entity match text.",
                        "type": "integer"
                      },
                      "length": {
                        "format": "int32",
                        "description": "Length (in Unicode characters) for the entity match text.",
                        "type": "integer"
                      }
                    }
                  }
                },
                "wikipediaLanguage": {
                  "description": "Wikipedia language for which the WikipediaId and WikipediaUrl refers to.",
                  "type": "string"
                },
                "wikipediaId": {
                  "description": "Wikipedia unique identifier of the recognized entity.",
                  "type": "string"
                },
                "wikipediaUrl": {
                  "description": "URL for the entity's Wikipedia page.",
                  "type": "string",
                  "readOnly": true
                },
                "bingId": {
                  "description": "Bing unique identifier of the recognized entity.",
                  "type": "string"
                },
                "type": {
                  "description": "Entity type from Named Entity Recognition model",
                  "type": "string"
                },
                "subType": {
                  "description": "Entity sub type from Named Entity Recognition model",
                  "type": "string"
                }
              }
            },
            "readOnly": true
          },
          "statistics": {
            "type": "object",
            "properties": {
              "charactersCount": {
                "format": "int32",
                "description": "Number of text elements recognized in the document.",
                "type": "integer"
              },
              "transactionsCount": {
                "format": "int32",
                "description": "Number of transactions for the document.",
                "type": "integer"
              }
            },
            "description": "(Optional) if showStats=true was specified in the request this field will contain information about the \r\n            document payload."
          }
        }
      },
      "readOnly": true
    },
    "errors": {
      "description": "Errors and Warnings by document",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Input document unique identifier the error refers to.",
            "type": "string"
          },
          "message": {
            "description": "Error message.",
            "type": "string"
          }
        }
      },
      "readOnly": true
    },
    "statistics": {
      "type": "object",
      "properties": {
        "documentsCount": {
          "format": "int32",
          "description": "Number of documents submitted in the request.",
          "type": "integer"
        },
        "validDocumentsCount": {
          "format": "int32",
          "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents.",
          "type": "integer"
        },
        "erroneousDocumentsCount": {
          "format": "int32",
          "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents.",
          "type": "integer"
        },
        "transactionsCount": {
          "format": "int64",
          "description": "Number of transactions for the request.",
          "type": "integer"
        }
      },
      "description": "/// <summary>\r\n            (Optional) if showStats=true was specified in the request this field will contain information about the \r\n            request payload.\r\n            </summary>",
      "readOnly": true
    }
  }
}
{
  "documents": [
    {
      "id": "string",
      "entities": [
        {
          "name": "string",
          "matches": [
            {
              "wikipediaScore": 0.0,
              "entityTypeScore": 0.0,
              "text": "string",
              "offset": 0,
              "length": 0
            }
          ],
          "wikipediaLanguage": "string",
          "wikipediaId": "string",
          "wikipediaUrl": "string",
          "bingId": "string",
          "type": "string",
          "subType": "string"
        }
      ],
      "statistics": {
        "charactersCount": 0,
        "transactionsCount": 0
      }
    }
  ],
  "errors": [
    {
      "id": "string",
      "message": "string"
    }
  ],
  "statistics": {
    "documentsCount": 0,
    "validDocumentsCount": 0,
    "erroneousDocumentsCount": 0,
    "transactionsCount": 0
  }
}
{
  "type": "object",
  "properties": {
    "documents": {
      "description": "Response by document",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Unique, non-empty document identifier.",
            "type": "string"
          },
          "entities": {
            "description": "Recognized entities in the document.",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "description": "Entity formal name.",
                  "type": "string"
                },
                "matches": {
                  "description": "List of instances this entity appears in the text.",
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "wikipediaScore": {
                        "format": "double",
                        "description": "(optional) If a well-known item with Wikipedia link is recognized,\r\n            a decimal number denoting the confidence level of the Wikipedia info will be returned.",
                        "type": "number"
                      },
                      "entityTypeScore": {
                        "format": "double",
                        "description": "(optional) If an entity type is recognized,\r\n            a decimal number denoting the confidence level of the entity type will be returned.",
                        "type": "number"
                      },
                      "text": {
                        "description": "Entity text as appears in the request.",
                        "type": "string"
                      },
                      "offset": {
                        "format": "int32",
                        "description": "Start position (in Unicode characters) for the entity match text.",
                        "type": "integer"
                      },
                      "length": {
                        "format": "int32",
                        "description": "Length (in Unicode characters) for the entity match text.",
                        "type": "integer"
                      }
                    }
                  }
                },
                "wikipediaLanguage": {
                  "description": "Wikipedia language for which the WikipediaId and WikipediaUrl refers to.",
                  "type": "string"
                },
                "wikipediaId": {
                  "description": "Wikipedia unique identifier of the recognized entity.",
                  "type": "string"
                },
                "wikipediaUrl": {
                  "description": "URL for the entity's Wikipedia page.",
                  "type": "string",
                  "readOnly": true
                },
                "bingId": {
                  "description": "Bing unique identifier of the recognized entity.",
                  "type": "string"
                },
                "type": {
                  "description": "Entity type from Named Entity Recognition model",
                  "type": "string"
                },
                "subType": {
                  "description": "Entity sub type from Named Entity Recognition model",
                  "type": "string"
                }
              }
            },
            "readOnly": true
          },
          "statistics": {
            "type": "object",
            "properties": {
              "charactersCount": {
                "format": "int32",
                "description": "Number of text elements recognized in the document.",
                "type": "integer"
              },
              "transactionsCount": {
                "format": "int32",
                "description": "Number of transactions for the document.",
                "type": "integer"
              }
            },
            "description": "(Optional) if showStats=true was specified in the request this field will contain information about the \r\n            document payload."
          }
        }
      },
      "readOnly": true
    },
    "errors": {
      "description": "Errors and Warnings by document",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Input document unique identifier the error refers to.",
            "type": "string"
          },
          "message": {
            "description": "Error message.",
            "type": "string"
          }
        }
      },
      "readOnly": true
    },
    "statistics": {
      "type": "object",
      "properties": {
        "documentsCount": {
          "format": "int32",
          "description": "Number of documents submitted in the request.",
          "type": "integer"
        },
        "validDocumentsCount": {
          "format": "int32",
          "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents.",
          "type": "integer"
        },
        "erroneousDocumentsCount": {
          "format": "int32",
          "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents.",
          "type": "integer"
        },
        "transactionsCount": {
          "format": "int64",
          "description": "Number of transactions for the request.",
          "type": "integer"
        }
      },
      "description": "/// <summary>\r\n            (Optional) if showStats=true was specified in the request this field will contain information about the \r\n            request payload.\r\n            </summary>",
      "readOnly": true
    }
  }
}

Response 500

Error Response

Code samples

@ECHO OFF

curl -v -X POST "https://*.cognitiveservices.azure.com/text/analytics/v2.1/entities?showStats={boolean}"
-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}");

            // Request parameters
            queryString["showStats"] = "{boolean}";
            var uri = "https://*.cognitiveservices.azure.com/text/analytics/v2.1/entities?" + 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://*.cognitiveservices.azure.com/text/analytics/v2.1/entities");

            builder.setParameter("showStats", "{boolean}");

            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
            "showStats": "{boolean}",
        };
      
        $.ajax({
            url: "https://*.cognitiveservices.azure.com/text/analytics/v2.1/entities?" + $.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://*.cognitiveservices.azure.com/text/analytics/v2.1/entities";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"showStats={boolean}",
                      ];
    
    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://*.cognitiveservices.azure.com/text/analytics/v2.1/entities');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'showStats' => '{boolean}',
);

$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({
    # Request parameters
    'showStats': '{boolean}',
})

try:
    conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("POST", "/text/analytics/v2.1/entities?%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({
    # Request parameters
    'showStats': '{boolean}',
})

try:
    conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("POST", "/text/analytics/v2.1/entities?%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/text/analytics/v2.1/entities')
uri.query = URI.encode_www_form({
    # Request parameters
    'showStats' => '{boolean}'
})

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