Text Analytics API (v3.0-Preview)

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:

  • Canada Central - canadacentral.api.cognitive.microsoft.com
  • Central US - centralus.api.cognitive.microsoft.com
  • East Asia - eastasia.api.cognitive.microsoft.com

Sentiment

The API returns a document sentiment prediction, as well as sentiment scores for each sentiment class (Positive, Negative, and Neutral).In addition, sentence level sentiment predictions are returned. 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:

East Asia Canada Central Central US

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": "en",
      "id": "2",
      "text": "It's incredibly sunny outside! I'm so happy."
    },
    {
      "language": "en",
      "id": "3",
      "text": "Pike place market is my favorite Seattle attraction."
    }
  ]
}
{
  "description": "Contains a set of input documents to be analyzed by the service.",
  "type": "object",
  "properties": {
    "documents": {
      "description": "The set of documents to process as part of this batch.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "description": "Contains an input document to be analyzed by the service.",
        "type": "object",
        "properties": {
          "language": {
            "description": "This is the 2 letter ISO 639-1 representation of a language.\r\nFor example, use \"en\" for English; \"es\" for Spanish etc.,.",
            "type": "string"
          },
          "id": {
            "description": "A unique, non-empty document identifier.",
            "type": "string"
          },
          "text": {
            "description": "The input text to process.",
            "type": "string"
          }
        }
      },
      "readOnly": true
    }
  },
  "example": {
    "documents": [
      {
        "language": "en",
        "id": "1",
        "text": "Hello world. This is some input text that I love."
      },
      {
        "language": "en",
        "id": "2",
        "text": "It's incredibly sunny outside! I'm so happy."
      },
      {
        "language": "en",
        "id": "3",
        "text": "Pike place market is my favorite Seattle attraction."
      }
    ]
  }
}
{
  "documents": [
    {
      "language": "en",
      "id": "1",
      "text": "Hello world. This is some input text that I love."
    },
    {
      "language": "en",
      "id": "2",
      "text": "It's incredibly sunny outside! I'm so happy."
    },
    {
      "language": "en",
      "id": "3",
      "text": "Pike place market is my favorite Seattle attraction."
    }
  ]
}
{
  "description": "Contains a set of input documents to be analyzed by the service.",
  "type": "object",
  "properties": {
    "documents": {
      "description": "The set of documents to process as part of this batch.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "description": "Contains an input document to be analyzed by the service.",
        "type": "object",
        "properties": {
          "language": {
            "description": "This is the 2 letter ISO 639-1 representation of a language.\r\nFor example, use \"en\" for English; \"es\" for Spanish etc.,.",
            "type": "string"
          },
          "id": {
            "description": "A unique, non-empty document identifier.",
            "type": "string"
          },
          "text": {
            "description": "The input text to process.",
            "type": "string"
          }
        }
      },
      "readOnly": true
    }
  },
  "example": {
    "documents": [
      {
        "language": "en",
        "id": "1",
        "text": "Hello world. This is some input text that I love."
      },
      {
        "language": "en",
        "id": "2",
        "text": "It's incredibly sunny outside! I'm so happy."
      },
      {
        "language": "en",
        "id": "3",
        "text": "Pike place market is my favorite Seattle attraction."
      }
    ]
  }
}

Response 200

A successful call results in a document sentiment prediction, as well as sentiment scores for each sentiment class (Positive, Negative, and Neutral)

{
  "documents": [
    {
      "id": "1",
      "sentiment": "positive",
      "documentScores": 
        {
          "positive": 0.998519241809845,
          "neutral": 0.0009635657188483,
          "negative": 0.000517153472174
        },
      "sentences": [
        {
          "sentiment": "neutral",
          "sentenceScores": 
            {
              "positive": 0.070910170674324,
              "neutral": 0.91240334510803223,
              "negative": 0.0166865326464176
            },
          "offset": 0,
          "length": 12
        }, 
        {
          "sentiment": "positive",
          "sentenceScores": 
            {
              "positive": 0.998519241809845,
              "neutral": 0.0009635657188483,
              "negative": 0.000517153472174
            },
          "offset": 13,
          "length": 36
        }
      ]
    }, 
    {
      "id": "2",
      "sentiment": "positive",
      "documentScores": 
        {
          "positive": 0.99545717239379883,
          "neutral": 0.0034653299953789,
          "negative": 0.0010774657130241
        },
      "sentences": [
        {
          "sentiment": "neutral",
          "sentenceScores": 
            {
              "positive": 0.0499138832092285,
              "neutral": 0.93870127201080322,
              "negative": 0.0113849258050323
            },
          "offset": 0,
          "length": 30
        }, 
        {
          "sentiment": "positive",
          "sentenceScores": 
            {
              "positive": 0.99545717239379883,
              "neutral": 0.0034653299953789,
              "negative": 0.0010774657130241
            },
          "offset": 31,
          "length": 13
        }
      ]
    }, 
    {
      "id": "3",
      "sentiment": "positive",
      "documentScores": 
        {
          "positive": 0.99651283025741577,
          "neutral": 0.0018965365597978,
          "negative": 0.0015906029148027
        },
      "sentences": [
        {
          "sentiment": "positive",
          "sentenceScores": 
            {
              "positive": 0.99651283025741577,
              "neutral": 0.0018965365597978,
              "negative": 0.0015906029148027
            },
          "offset": 0,
          "length": 52
        }
      ]
    }
  ],
  "errors": []
}
{
  "description": "A wrapper class around a collection of results and errors.",
  "type": "object",
  "properties": {
    "documents": {
      "description": "The set of successful results.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Unique, non-empty document identifier.",
            "type": "string"
          },
          "sentiment": {
            "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).",
            "enum": [
              "positive",
              "neutral",
              "negative",
              "mixed"
            ],
            "type": "string"
          },
          "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\ndocument payload."
          },
          "documentScores": {
            "description": "Document level sentiment confidence scores for each sentiment class.",
            "type": "object",
            "properties": {
              "positive": {
                "format": "double",
                "type": "number"
              },
              "neutral": {
                "format": "double",
                "type": "number"
              },
              "negative": {
                "format": "double",
                "type": "number"
              }
            }
          },
          "sentences": {
            "description": "Sentence level sentiment analysis.",
            "uniqueItems": false,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "sentiment": {
                  "description": "The predicted Sentiment for the sentence.",
                  "enum": [
                    "positive",
                    "neutral",
                    "negative"
                  ],
                  "type": "string"
                },
                "sentenceScores": {
                  "description": "The sentiment confidence score for the sentence for all classes.",
                  "type": "object",
                  "properties": {
                    "positive": {
                      "format": "double",
                      "type": "number"
                    },
                    "neutral": {
                      "format": "double",
                      "type": "number"
                    },
                    "negative": {
                      "format": "double",
                      "type": "number"
                    }
                  }
                },
                "offset": {
                  "format": "int32",
                  "description": "The sentence offset from the start of the document.",
                  "type": "integer"
                },
                "length": {
                  "format": "int32",
                  "description": "The sentence length as given by StringInfo's LengthInTextElements property.",
                  "type": "integer"
                },
                "warnings": {
                  "description": "The warnings generated for the sentence.",
                  "uniqueItems": false,
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      },
      "readOnly": true
    },
    "errors": {
      "description": "The set of error results.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "description": "Contains error information about a particular document.",
        "type": "object",
        "properties": {
          "id": {
            "description": "The input document unique identifier that this error refers to.",
            "type": "string"
          },
          "message": {
            "description": "The actual 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": "(Optional) if showStats=true was specified in the request this field will contain information about the\r\nrequest payload.",
      "readOnly": true
    }
  }
}
{
  "documents": [
    {
      "id": "string",
      "sentiment": "positive",
      "statistics": {
        "charactersCount": 0,
        "transactionsCount": 0
      },
      "documentScores": {
        "positive": 0.0,
        "neutral": 0.0,
        "negative": 0.0
      },
      "sentences": [
        {
          "sentiment": "positive",
          "sentenceScores": {
            "positive": 0.0,
            "neutral": 0.0,
            "negative": 0.0
          },
          "offset": 0,
          "length": 0,
          "warnings": [
            "string"
          ]
        }
      ]
    }
  ],
  "errors": [
    {
      "id": "string",
      "message": "string"
    }
  ],
  "statistics": {
    "documentsCount": 0,
    "validDocumentsCount": 0,
    "erroneousDocumentsCount": 0,
    "transactionsCount": 0
  }
}
{
  "description": "A wrapper class around a collection of results and errors.",
  "type": "object",
  "properties": {
    "documents": {
      "description": "The set of successful results.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Unique, non-empty document identifier.",
            "type": "string"
          },
          "sentiment": {
            "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).",
            "enum": [
              "positive",
              "neutral",
              "negative",
              "mixed"
            ],
            "type": "string"
          },
          "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\ndocument payload."
          },
          "documentScores": {
            "description": "Document level sentiment confidence scores for each sentiment class.",
            "type": "object",
            "properties": {
              "positive": {
                "format": "double",
                "type": "number"
              },
              "neutral": {
                "format": "double",
                "type": "number"
              },
              "negative": {
                "format": "double",
                "type": "number"
              }
            }
          },
          "sentences": {
            "description": "Sentence level sentiment analysis.",
            "uniqueItems": false,
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "sentiment": {
                  "description": "The predicted Sentiment for the sentence.",
                  "enum": [
                    "positive",
                    "neutral",
                    "negative"
                  ],
                  "type": "string"
                },
                "sentenceScores": {
                  "description": "The sentiment confidence score for the sentence for all classes.",
                  "type": "object",
                  "properties": {
                    "positive": {
                      "format": "double",
                      "type": "number"
                    },
                    "neutral": {
                      "format": "double",
                      "type": "number"
                    },
                    "negative": {
                      "format": "double",
                      "type": "number"
                    }
                  }
                },
                "offset": {
                  "format": "int32",
                  "description": "The sentence offset from the start of the document.",
                  "type": "integer"
                },
                "length": {
                  "format": "int32",
                  "description": "The sentence length as given by StringInfo's LengthInTextElements property.",
                  "type": "integer"
                },
                "warnings": {
                  "description": "The warnings generated for the sentence.",
                  "uniqueItems": false,
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      },
      "readOnly": true
    },
    "errors": {
      "description": "The set of error results.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "description": "Contains error information about a particular document.",
        "type": "object",
        "properties": {
          "id": {
            "description": "The input document unique identifier that this error refers to.",
            "type": "string"
          },
          "message": {
            "description": "The actual 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": "(Optional) if showStats=true was specified in the request this field will contain information about the\r\nrequest payload.",
      "readOnly": true
    }
  }
}

Response 500

Error Response

{
  "error": {
    "code": "string",
    "innerError": {
      "requestId": "string"
    },
    "message": "string"
  }
}
{
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "innerError": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            }
          }
        },
        "message": {
          "type": "string"
        }
      }
    }
  }
}
{
  "error": {
    "code": "string",
    "innerError": {
      "requestId": "string"
    },
    "message": "string"
  }
}
{
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "innerError": {
          "type": "object",
          "properties": {
            "requestId": {
              "type": "string"
            }
          }
        },
        "message": {
          "type": "string"
        }
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://westcentralus.api.cognitive.microsoft.com/text/analytics/v3.0-preview/sentiment?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://westcentralus.api.cognitive.microsoft.com/text/analytics/v3.0-preview/sentiment?" + 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://westcentralus.api.cognitive.microsoft.com/text/analytics/v3.0-preview/sentiment");

            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://westcentralus.api.cognitive.microsoft.com/text/analytics/v3.0-preview/sentiment?" + $.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://westcentralus.api.cognitive.microsoft.com/text/analytics/v3.0-preview/sentiment";
    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://westcentralus.api.cognitive.microsoft.com/text/analytics/v3.0-preview/sentiment');
$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('westcentralus.api.cognitive.microsoft.com')
    conn.request("POST", "/text/analytics/v3.0-preview/sentiment?%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('westcentralus.api.cognitive.microsoft.com')
    conn.request("POST", "/text/analytics/v3.0-preview/sentiment?%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://westcentralus.api.cognitive.microsoft.com/text/analytics/v3.0-preview/sentiment')
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