Skip to content

Commit d279d0c

Browse files
authored
Merge pull request #49652 from v-jaswel/patch-15
Update overview.md
2 parents 860aae5 + ba6cebf commit d279d0c

File tree

1 file changed

+34
-29
lines changed

1 file changed

+34
-29
lines changed

articles/cognitive-services/text-analytics/overview.md

Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Text Analytics API overview - Azure Cognitive Services | Microsoft Docs
3-
description: Text Analytics API in Azure Cognitive Services for sentiment analysis, key phrase extraction, and language detection.
2+
title: Text Analytics overview - Azure Cognitive Services | Microsoft Docs
3+
description: Text Analytics in Azure Cognitive Services for sentiment analysis, key phrase extraction, language detection, and entity linking.
44
services: cognitive-services
55
author: ashmaka
66
manager: cgronlun
@@ -10,74 +10,79 @@ ms.topic: article
1010
ms.date: 5/02/2018
1111
ms.author: ashmaka
1212
---
13-
# What is Text Analytics API Version 2.0?
1413

15-
The Text Analytics API is a cloud-based service that provides advanced natural language processing over raw text, and includes four main functions: sentiment analysis, key phrase extraction, language detection, and entity linking.
14+
# What is Text Analytics?
1615

17-
The API is backed by resources in [Microsoft Cognitive Services](https://docs.microsoft.com/azure/cognitive-services/), a collection of machine learning and AI algorithms in the cloud, readily consumable in your development projects.
16+
The Text Analytics service provides advanced natural language processing for raw unstructured text. It includes four main functions: sentiment analysis, key phrase extraction, language detection, and entity linking.
1817

19-
## Capabilities in Text Analytics
18+
## Analyze sentiment
2019

21-
Text analysis can mean different things, but in Cognitive Services, the Text Analytics API provides four types of analysis as described in the following table.
20+
[Find out](how-tos/text-analytics-how-to-sentiment-analysis.md) what customers think of your brand or topic by analyzing raw text for clues about positive or negative sentiment. This API returns a sentiment score between 0 and 1 for each document, where 1 is the most positive.<br />
21+
The analysis models are pretrained using an extensive body of text and natural language technologies from Microsoft. For [selected languages](text-analytics-supported-languages.md), the API can analyze and score any raw text that you provide.
2222

23-
| Operations| Description | APIs |
24-
|-----------|-------------|------|
25-
|[**Sentiment Analysis**](how-tos/text-analytics-how-to-sentiment-analysis.md) | Find out what customers think of your brand or topic by analyzing raw text for clues about positive or negative sentiment. This API returns a sentiment score between 0 and 1 for each document, where 1 is the most positive.<br /> The analysis models are pretrained using an extensive body of text and natural language technologies from Microsoft. For [selected languages](text-analytics-supported-languages.md), the API can analyze and score any raw text that you provide, directly returning results to the calling application. | [REST](https://westus.dev.cognitive.microsoft.com/docs/services/TextAnalytics.V2.0/operations/56f30ceeeda5650db055a3c9) <br /> [.NET](https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/quickstarts/csharp#install-the-nuget-sdk-package) |
26-
|[**Key Phrase Extraction**](how-tos/text-analytics-how-to-keyword-extraction.md) | Automatically extract key phrases to quickly identify the main points. For example, for the input text "The food was delicious and there were wonderful staff", the API returns the main talking points: "food" and "wonderful staff". | [REST](https://westus.dev.cognitive.microsoft.com/docs/services/TextAnalytics.V2.0/operations/56f30ceeeda5650db055a3c6) <br /> [.NET](https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/quickstarts/csharp#install-the-nuget-sdk-package) |
27-
|[**Language Detection**](how-tos/text-analytics-how-to-language-detection.md) | For up to 120 languages, detect which language the input text is written in and report a single language code for every document submitted on the request. The language code is paired with a score indicating the strength of the score. | [REST](https://westus.dev.cognitive.microsoft.com/docs/services/TextAnalytics.V2.0/operations/56f30ceeeda5650db055a3c7) <br /> [.NET](https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/quickstarts/csharp#install-the-nuget-sdk-package) |
28-
|[**Entity Linking (Preview)**](how-tos/text-analytics-how-to-entity-linking.md) | Identify well-known entities in your text and link to more information on the web. Entity linking recognizes and disambiguates when a term is used as one of separately distinguishable entities, verbs, and other word forms. | [REST](https://westus.dev.cognitive.microsoft.com/docs/services/TextAnalytics.V2.0/operations/5ac4251d5b4ccd1554da7634) |
23+
## Extract key phrases
24+
25+
Automatically [extract key phrases](how-tos/text-analytics-how-to-keyword-extraction.md) to quickly identify the main points. For example, given the input text "The food was delicious and there were wonderful staff", the Text Analytics service returns the main talking points: "food" and "wonderful staff".
26+
27+
## Detect language
28+
29+
For up to 120 languages, [detect](how-tos/text-analytics-how-to-language-detection.md) which language the input text is written in and report a single language code for every document submitted on the request. The language code is paired with a score indicating the strength of the score.
30+
31+
## Identify linked entities (Preview)
32+
33+
[Identify](how-tos/text-analytics-how-to-entity-linking.md) well-known entities in your text and link to more information on the web. Entity linking recognizes and disambiguates when a term is used as one of separately distinguishable entities, verbs, and other word forms.
2934

3035
## Typical workflow
3136

3237
The workflow is simple: you submit data for analysis and handle outputs in your code. Analyzers are consumed as-is, with no additional configuration or customization.
3338

3439
1. [Sign up](https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account) for an [access key](how-tos/text-analytics-how-to-access-key.md). The key must be passed on each request.
3540

36-
2. [Formulate a request](how-tos/text-analytics-how-to-call-api.md#json-schema) containing your data as raw unstructured text, in JSON.
41+
2. [Create a request](how-tos/text-analytics-how-to-call-api.md#json-schema) in JSON that contains your data as raw unstructured text.
3742

38-
3. Post the request to the endpoint established during sign-up, appending the desired resource: sentiment analysis, key phrase extraction, language detection, or entity identification.
43+
3. Post the request to the endpoint established during sign-up, appending the API you want to call: sentiment analysis, key phrase extraction, language detection, or entity identification.
3944

4045
4. Stream or store the response locally. Depending on the request, results are either a sentiment score, a collection of extracted key phrases, or a language code.
4146

42-
Output is returned as a single JSON document, with results for each text document you posted, based on ID. You can subsequently analyze, visualize, or categorize the results into actionable insights.
47+
Output is returned as a single JSON document, with results for each text document you posted, based on ID. You can then analyze, visualize, or categorize the results into actionable insights.
4348

44-
Data is not stored in your account. Operations performed by the Text Analytics API are stateless, which means the text you provide is processed and results are returned immediately.
49+
Operations done by the Text Analytics service are stateless. Data is not stored in your account.
4550

46-
<a name="supported-languages"></a>
51+
<a name="data-limits"></a>
4752

48-
## Supported languages
53+
## Specifications
4954

50-
This section has been moved to a separate article for better discoverability. Refer to [Supported languages in Text Analytics API](text-analytics-supported-languages.md) for this content.
55+
### Supported languages
5156

52-
<a name="data-limits"></a>
57+
See [Supported languages in Text Analytics](text-analytics-supported-languages.md).
5358

54-
## Data limits
59+
### Data limits
5560

56-
All of the Text Analytics API endpoints accept raw text data. The current limit is 5,000 characters for each document; if you need to analyze larger documents, you can break them up into smaller chunks. If you still require a higher limit, [contact us](https://azure.microsoft.com/overview/sales-number/) so that we can discuss your requirements.
61+
All of the Text Analytics service endpoints accept raw text data. The current limit is 5,000 characters for each document; if you need to analyze larger documents, you can break them up into smaller chunks. If you still require a higher limit, [contact us](https://azure.microsoft.com/overview/sales-number/) so that we can discuss your requirements.
5762

5863
| Limit | Value |
5964
|------------------------|---------------|
6065
| Maximum size of a single document | 5,000 characters as measured by `String.Length`. |
6166
| Maximum size of entire request | 1 MB |
6267
| Maximum number of documents in a request | 1,000 documents |
6368

64-
The rate limit is 100 calls per minute. Note that you can submit a large quantity of documents in a single call (up to 1000 documents).
69+
The rate limit is 100 calls per minute. Note you can submit a large quantity of documents in a single call (up to 1000 documents).
6570

66-
## Unicode encoding
71+
### Unicode encoding
6772

68-
The Text Analytics API uses Unicode encoding for text representation and character count calculations. Requests can be submitted in both UTF-8 and UTF-16 with no measurable differences in the character count. Unicode codepoints are used as the heuristic for character length and are considered equivalent for the purposes of text analytics data limits. If you use `String.Length` to get the character count, you are using the same method we use to measure data size.
73+
The Text Analytics service uses Unicode encoding for text representation and character count calculations. You can submit requests in either UTF-8 or UTF-16, with no measurable differences in the character count. If you use `String.Length` to get the character count, you're using the same method we use to measure data size.
6974

7075
## Next steps
7176

72-
First, try the [interactive demo](https://azure.microsoft.com/services/cognitive-services/text-analytics/). You can paste a text input (5,000 character maximum) to detect the language (up to 120), calculate a sentiment score, or extract key phrases. No sign-up necessary.
77+
First, try the [interactive demo](https://azure.microsoft.com/services/cognitive-services/text-analytics/). You can paste a text input (5,000 character maximum) to detect the language (up to 120), calculate a sentiment score, extract key phrases, or identify linked entities. No sign-up is necessary.
7378

74-
When you are ready to call the API directly:
79+
When you're ready to call the Text Analytics service directly:
7580

7681
+ [Sign up](how-tos/text-analytics-how-to-signup.md) for an access key and review the steps for [calling the API](how-tos/text-analytics-how-to-call-api.md).
7782

7883
+ [Quickstart](quickstarts/csharp.md) is a walkthrough of the REST API calls written in C#. Learn how to submit text, choose an analysis, and view results with minimal code.
7984

80-
+ [API reference documentation](//go.microsoft.com/fwlink/?LinkID=759346) provides the technical documentation for the APIs. The documentation supports embedded calls so that you can call the API from each documentation page.
85+
+ [API reference documentation](//go.microsoft.com/fwlink/?LinkID=759346) provides the technical documentation for the REST APIs. The documentation supports embedded calls, so you can call the API from each documentation page.
8186

8287
+ [External & Community Content](text-analytics-resource-external-community.md) provides a list of blog posts and videos demonstrating how to use Text Analytics with other tools and technologies.
8388

0 commit comments

Comments
 (0)