Text Analytics API (v3.1-preview.2)

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 extraction and 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

Entities containing personal information

The API returns a list of entities with personal information ("SSN", "Bank Account" etc) in the document. For the list of supported entity types, check Supported Entity Types in Text Analytics API. 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:

West US West US 2 East US East US 2 West Central US South Central US West Europe North Europe Southeast Asia East Asia Australia East Brazil South Canada Central UK South Japan East Central US France Central Korea Central Japan West North Central US South Africa North UAE North Switzerland North Switzerland West Central India West US 3 Norway East Jio India West

Request URL

Request parameters

(optional)
string

(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.

(optional)
boolean

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

(optional)
string

(Optional) if set to 'PHI', response will contain only PHI entities.

(optional)
string

(Optional) 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.

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": "0",
			"text": "Microsoft employee with ssn 859-98-0987 is using our awesome API's."
		},
		{
			"language": "en",
			"id": "1",
			"text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check."
		},
		{
			"language": "en",
			"id": "2",
			"text": "Is 998.214.865-68 your Brazilian CPF number?"
		}
	]
}
{
  "type": "object",
  "required": [
    "documents"
  ],
  "properties": {
    "documents": {
      "type": "array",
      "description": "The set of documents to process as part of this batch.",
      "items": {
        "type": "object",
        "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."
          }
        },
        "description": "Contains an input document to be analyzed by the service."
      }
    }
  },
  "description": "Contains a set of input documents to be analyzed by the service."
}
{
    "documents": [
        {
            "redactedText": "********* employee with ssn *********** is using our awesome API's.",
            "id": "0",
            "entities": [
                {
                    "text": "Microsoft",
                    "category": "Organization",
                    "offset": 0,
                    "length": 9,
                    "confidenceScore": 0.38
                },
                {
                    "text": "859-98-0987",
                    "category": "U.S. Social Security Number (SSN)",
                    "offset": 28,
                    "length": 11,
                    "confidenceScore": 0.65
                }
            ],
            "warnings": []
        },
        {
            "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.",
            "id": "1",
            "entities": [
                {
                    "text": "111000025",
                    "category": "Phone Number",
                    "offset": 18,
                    "length": 9,
                    "confidenceScore": 0.8
                },
                {
                    "text": "111000025",
                    "category": "ABA Routing Number",
                    "offset": 18,
                    "length": 9,
                    "confidenceScore": 0.75
                },
                {
                    "text": "111000025",
                    "category": "New Zealand Social Welfare Number",
                    "offset": 18,
                    "length": 9,
                    "confidenceScore": 0.65
                },
                {
                    "text": "111000025",
                    "category": "Portugal Tax Identification Number",
                    "offset": 18,
                    "length": 9,
                    "confidenceScore": 0.65
                }
            ],
            "warnings": []
        },
        {
            "redactedText": "Is ************** your Brazilian CPF number?",
            "id": "2",
            "entities": [
                {
                    "text": "998.214.865-68",
                    "category": "Brazil CPF Number",
                    "offset": 3,
                    "length": 14,
                    "confidenceScore": 0.85
                }
            ],
            "warnings": []
        }
    ],
    "errors": [],
    "modelVersion": "2020-07-01"
}
{
  "type": "object",
  "required": [
    "documents"
  ],
  "properties": {
    "documents": {
      "type": "array",
      "description": "The set of documents to process as part of this batch.",
      "items": {
        "type": "object",
        "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."
          }
        },
        "description": "Contains an input document to be analyzed by the service."
      }
    }
  },
  "description": "Contains a set of input documents to be analyzed by the service."
}

Response 200

A successful call results in a list of entities containing personal information returned for each valid document

{
	"documents": [
		{
			"id": "0",
			"entities": [
				{
					"text": "859-98-0987",
					"category": "U.S. Social Security Number (SSN)",
					"subcategory": "",
					"offset": 28,
					"length": 11,
					"confidenceScore": 0.65
				}
			],
			"redactedText": "My SSN is ***********",
			"warnings": []
		},
		{
			"id": "1",
			"entities": [
				{
					"text": "111000025",
					"category": "ABA Routing Number",
					"subcategory": "",
					"offset": 18,
					"length": 9,
					"confidenceScore": 0.75
				}
			],
			"redactedText": "My ABA Routing Number is *********",
			"warnings": []
		},
		{
			"id": "2",
			"entities": [
				{
					"text": "998.214.865-68",
					"category": "Brazil CPF Number",
					"subcategory": "",
					"offset": 3,
					"length": 14,
					"confidenceScore": 0.85
				}
			],
			"redactedText": "My Brazil CPF Number is **************",
			"warnings": []
		}
	],
	"errors": [],
	"modelVersion": "2019-10-01"
}
{
	"documents": [
		{
			"id": "0",
			"entities": [
				{
					"text": "859-98-0987",
					"category": "U.S. Social Security Number (SSN)",
					"subcategory": "",
					"offset": 28,
					"length": 11,
					"confidenceScore": 0.65
				}
			],
			"redactedText": "My SSN is ***********",
			"warnings": []
		},
		{
			"id": "1",
			"entities": [
				{
					"text": "111000025",
					"category": "ABA Routing Number",
					"subcategory": "",
					"offset": 18,
					"length": 9,
					"confidenceScore": 0.75
				}
			],
			"redactedText": "My ABA Routing Number is *********",
			"warnings": []
		},
		{
			"id": "2",
			"entities": [
				{
					"text": "998.214.865-68",
					"category": "Brazil CPF Number",
					"subcategory": "",
					"offset": 3,
					"length": 14,
					"confidenceScore": 0.85
				}
			],
			"redactedText": "My Brazil CPF Number is **************",
			"warnings": []
		}
	],
	"errors": [],
	"modelVersion": "2019-10-01"
}

Response 500

Error Response

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

Code samples

@ECHO OFF

curl -v -X POST "https://norwayeast.api.cognitive.microsoft.com/text/analytics/v3.1-preview.2/entities/recognition/pii?model-version={string}&showStats={boolean}&domain={string}&stringIndexType={string}"
-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["model-version"] = "{string}";
            queryString["showStats"] = "{boolean}";
            queryString["domain"] = "{string}";
            queryString["stringIndexType"] = "{string}";
            var uri = "https://norwayeast.api.cognitive.microsoft.com/text/analytics/v3.1-preview.2/entities/recognition/pii?" + 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://norwayeast.api.cognitive.microsoft.com/text/analytics/v3.1-preview.2/entities/recognition/pii");

            builder.setParameter("model-version", "{string}");
            builder.setParameter("showStats", "{boolean}");
            builder.setParameter("domain", "{string}");
            builder.setParameter("stringIndexType", "{string}");

            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
            "model-version": "{string}",
            "showStats": "{boolean}",
            "domain": "{string}",
            "stringIndexType": "{string}",
        };
      
        $.ajax({
            url: "https://norwayeast.api.cognitive.microsoft.com/text/analytics/v3.1-preview.2/entities/recognition/pii?" + $.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://norwayeast.api.cognitive.microsoft.com/text/analytics/v3.1-preview.2/entities/recognition/pii";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"model-version={string}",
                         @"showStats={boolean}",
                         @"domain={string}",
                         @"stringIndexType={string}",
                      ];
    
    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://norwayeast.api.cognitive.microsoft.com/text/analytics/v3.1-preview.2/entities/recognition/pii');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'model-version' => '{string}',
    'showStats' => '{boolean}',
    'domain' => '{string}',
    'stringIndexType' => '{string}',
);

$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
    'model-version': '{string}',
    'showStats': '{boolean}',
    'domain': '{string}',
    'stringIndexType': '{string}',
})

try:
    conn = httplib.HTTPSConnection('norwayeast.api.cognitive.microsoft.com')
    conn.request("POST", "/text/analytics/v3.1-preview.2/entities/recognition/pii?%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
    'model-version': '{string}',
    'showStats': '{boolean}',
    'domain': '{string}',
    'stringIndexType': '{string}',
})

try:
    conn = http.client.HTTPSConnection('norwayeast.api.cognitive.microsoft.com')
    conn.request("POST", "/text/analytics/v3.1-preview.2/entities/recognition/pii?%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://norwayeast.api.cognitive.microsoft.com/text/analytics/v3.1-preview.2/entities/recognition/pii')

query = URI.encode_www_form({
    # Request parameters
    'model-version' => '{string}',
    'showStats' => '{boolean}',
    'domain' => '{string}',
    'stringIndexType' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

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