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

The Text Analytics API is a suite of natural language processing (NLP) services built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text using NLP tasks such as sentiment analysis, named entity recognition (NER) of general and personally identifiable information domains, key phrase extraction (KPE) and language detection. It can also be used to batch NER and KPE operations asynchronously to process documents with a single request. Furthermore, this API provides an asynchronous operation for analyzing unstructured clinical and biomedical text using NER, entity linking, relation extraction and entity negation tasks. More documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview

Get healthcare analysis job status and results

Get details of the healthcare prediction job specified by the jobId.

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

East US 2 Central US North Europe West Europe West US 2

Request URL

Request parameters

string

Format - uuid. Job ID

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

(optional)
boolean

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

Request headers

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

Request body

Response 200

OK

{
	"createdDateTime": "2020-10-01T15:01:03Z",
	"expirationDateTime": "2020-10-03T15:01:03Z",
	"jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18",
	"lastUpdateDateTime": "2020-10-01T15:01:03Z",
	"status": "succeeded",
	"results": {
		"documents": [
			{
				"id": "1",
				"entities": [
					{
						"offset": 18,
						"length": 5,
						"text": "100mg",
						"category": "Dosage",
						"confidenceScore": 0.99,
						"isNegated": false
					},
					{
						"offset": 27,
						"length": 9,
						"text": "ibuprofen",
						"category": "MedicationName",
						"confidenceScore": 1.0,
						"isNegated": false,
						"links": [
							{
								"id": "C0020740",
								"dataSource": "UMLS"
							},
							{
								"id": "0000019879",
								"dataSource": "AOD"
							},
							{
								"id": "M01AE01",
								"dataSource": "ATC"
							},
							{
								"id": "0046165",
								"dataSource": "CCPSS"
							},
							{
								"id": "0000006519",
								"dataSource": "CHV"
							},
							{
								"id": "2270-2077",
								"dataSource": "CSP"
							},
							{
								"id": "DB01050",
								"dataSource": "DRUGBANK"
							},
							{
								"id": "1611",
								"dataSource": "GS"
							},
							{
								"id": "sh97005926",
								"dataSource": "LCH_NW"
							},
							{
								"id": "LP16165-0",
								"dataSource": "LNC"
							},
							{
								"id": "40458",
								"dataSource": "MEDCIN"
							},
							{
								"id": "d00015",
								"dataSource": "MMSL"
							},
							{
								"id": "D007052",
								"dataSource": "MSH"
							},
							{
								"id": "WK2XYI10QM",
								"dataSource": "MTHSPL"
							},
							{
								"id": "C561",
								"dataSource": "NCI"
							},
							{
								"id": "C561",
								"dataSource": "NCI_CTRP"
							},
							{
								"id": "00803",
								"dataSource": "NCI_DCP"
							},
							{
								"id": "NSC0256857",
								"dataSource": "NCI_DTP"
							},
							{
								"id": "WK2XYI10QM",
								"dataSource": "NCI_FDA"
							},
							{
								"id": "CDR0000613511",
								"dataSource": "NCI_NCI-GLOSS"
							},
							{
								"id": "002377",
								"dataSource": "NDDF"
							},
							{
								"id": "CDR0000040475",
								"dataSource": "PDQ"
							},
							{
								"id": "x02MO",
								"dataSource": "RCD"
							},
							{
								"id": "5640",
								"dataSource": "RXNORM"
							},
							{
								"id": "E-7772",
								"dataSource": "SNM"
							},
							{
								"id": "C-603C0",
								"dataSource": "SNMI"
							},
							{
								"id": "387207008",
								"dataSource": "SNOMEDCT_US"
							},
							{
								"id": "m39860",
								"dataSource": "USP"
							},
							{
								"id": "MTHU000060",
								"dataSource": "USPMG"
							},
							{
								"id": "4017840",
								"dataSource": "VANDF"
							}
						]
					},
					{
						"offset": 37,
						"length": 11,
						"text": "twice daily",
						"category": "Frequency",
						"confidenceScore": 1,
						"isNegated": false
					}
				],
				"relations": [
					{
						"relationType": "DosageOfMedication",
						"bidirectional": false,
						"source": "#/documents/0/entities/0",
						"target": "#/documents/0/entities/1"
					},
					{
						"relationType": "FrequencyOfMedication",
						"bidirectional": false,
						"source": "#/documents/0/entities/2",
						"target": "#/documents/0/entities/1"
					}
				],
				"warnings": []
			}
		],
		"errors": [],
		"modelVersion": "2020-05-08"
	}
}
{
	"createdDateTime": "2020-10-01T15:01:03Z",
	"expirationDateTime": "2020-10-03T15:01:03Z",
	"jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18",
	"lastUpdateDateTime": "2020-10-01T15:01:03Z",
	"status": "succeeded",
	"results": {
		"documents": [
			{
				"id": "1",
				"entities": [
					{
						"offset": 18,
						"length": 5,
						"text": "100mg",
						"category": "Dosage",
						"confidenceScore": 0.99,
						"isNegated": false
					},
					{
						"offset": 27,
						"length": 9,
						"text": "ibuprofen",
						"category": "MedicationName",
						"confidenceScore": 1.0,
						"isNegated": false,
						"links": [
							{
								"id": "C0020740",
								"dataSource": "UMLS"
							},
							{
								"id": "0000019879",
								"dataSource": "AOD"
							},
							{
								"id": "M01AE01",
								"dataSource": "ATC"
							},
							{
								"id": "0046165",
								"dataSource": "CCPSS"
							},
							{
								"id": "0000006519",
								"dataSource": "CHV"
							},
							{
								"id": "2270-2077",
								"dataSource": "CSP"
							},
							{
								"id": "DB01050",
								"dataSource": "DRUGBANK"
							},
							{
								"id": "1611",
								"dataSource": "GS"
							},
							{
								"id": "sh97005926",
								"dataSource": "LCH_NW"
							},
							{
								"id": "LP16165-0",
								"dataSource": "LNC"
							},
							{
								"id": "40458",
								"dataSource": "MEDCIN"
							},
							{
								"id": "d00015",
								"dataSource": "MMSL"
							},
							{
								"id": "D007052",
								"dataSource": "MSH"
							},
							{
								"id": "WK2XYI10QM",
								"dataSource": "MTHSPL"
							},
							{
								"id": "C561",
								"dataSource": "NCI"
							},
							{
								"id": "C561",
								"dataSource": "NCI_CTRP"
							},
							{
								"id": "00803",
								"dataSource": "NCI_DCP"
							},
							{
								"id": "NSC0256857",
								"dataSource": "NCI_DTP"
							},
							{
								"id": "WK2XYI10QM",
								"dataSource": "NCI_FDA"
							},
							{
								"id": "CDR0000613511",
								"dataSource": "NCI_NCI-GLOSS"
							},
							{
								"id": "002377",
								"dataSource": "NDDF"
							},
							{
								"id": "CDR0000040475",
								"dataSource": "PDQ"
							},
							{
								"id": "x02MO",
								"dataSource": "RCD"
							},
							{
								"id": "5640",
								"dataSource": "RXNORM"
							},
							{
								"id": "E-7772",
								"dataSource": "SNM"
							},
							{
								"id": "C-603C0",
								"dataSource": "SNMI"
							},
							{
								"id": "387207008",
								"dataSource": "SNOMEDCT_US"
							},
							{
								"id": "m39860",
								"dataSource": "USP"
							},
							{
								"id": "MTHU000060",
								"dataSource": "USPMG"
							},
							{
								"id": "4017840",
								"dataSource": "VANDF"
							}
						]
					},
					{
						"offset": 37,
						"length": 11,
						"text": "twice daily",
						"category": "Frequency",
						"confidenceScore": 1,
						"isNegated": false
					}
				],
				"relations": [
					{
						"relationType": "DosageOfMedication",
						"bidirectional": false,
						"source": "#/documents/0/entities/0",
						"target": "#/documents/0/entities/1"
					},
					{
						"relationType": "FrequencyOfMedication",
						"bidirectional": false,
						"source": "#/documents/0/entities/2",
						"target": "#/documents/0/entities/1"
					}
				],
				"warnings": []
			}
		],
		"errors": [],
		"modelVersion": "2020-05-08"
	}
}

Response 404

Job ID not found.

{
	"error": {
		"code": "InvalidRequest",
		"message": "Invalid Request.",
		"innererror": {
			"code": "MissingInputRecords",
			"message": "Missing input records."
		}
	}
}
{
	"error": {
		"code": "InvalidRequest",
		"message": "Invalid Request.",
		"innererror": {
			"code": "MissingInputRecords",
			"message": "Missing input records."
		}
	}
}

Response 500

Internal 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 GET "https://uksouth.api.cognitive.microsoft.com/text/analytics/v3.1-preview.3/entities/health/jobs/{jobId}?$top=20&$skip=0&showStats={boolean}"
-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["$top"] = "20";
            queryString["$skip"] = "0";
            queryString["showStats"] = "{boolean}";
            var uri = "https://uksouth.api.cognitive.microsoft.com/text/analytics/v3.1-preview.3/entities/health/jobs/{jobId}?" + 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://uksouth.api.cognitive.microsoft.com/text/analytics/v3.1-preview.3/entities/health/jobs/{jobId}");

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

            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
            "$top": "20",
            "$skip": "0",
            "showStats": "{boolean}",
        };
      
        $.ajax({
            url: "https://uksouth.api.cognitive.microsoft.com/text/analytics/v3.1-preview.3/entities/health/jobs/{jobId}?" + $.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://uksouth.api.cognitive.microsoft.com/text/analytics/v3.1-preview.3/entities/health/jobs/{jobId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"$top=20",
                         @"$skip=0",
                         @"showStats={boolean}",
                      ];
    
    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://uksouth.api.cognitive.microsoft.com/text/analytics/v3.1-preview.3/entities/health/jobs/{jobId}');
$url = $request->getUrl();

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

$request->setHeader($headers);

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

$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
    '$top': '20',
    '$skip': '0',
    'showStats': '{boolean}',
})

try:
    conn = httplib.HTTPSConnection('uksouth.api.cognitive.microsoft.com')
    conn.request("GET", "/text/analytics/v3.1-preview.3/entities/health/jobs/{jobId}?%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
    '$top': '20',
    '$skip': '0',
    'showStats': '{boolean}',
})

try:
    conn = http.client.HTTPSConnection('uksouth.api.cognitive.microsoft.com')
    conn.request("GET", "/text/analytics/v3.1-preview.3/entities/health/jobs/{jobId}?%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://uksouth.api.cognitive.microsoft.com/text/analytics/v3.1-preview.3/entities/health/jobs/{jobId}')
uri.query = URI.encode_www_form({
    # Request parameters
    '$top' => '20',
    '$skip' => '0',
    'showStats' => '{boolean}'
})

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