Skip to content

Commit 0dc71f4

Browse files
committed
Merge branch 'may-ta-v3' of https://github.com/aahill/azure-docs-pr into may-ta-v3
2 parents 1d71f08 + 54a865e commit 0dc71f4

File tree

7 files changed

+32
-26
lines changed

7 files changed

+32
-26
lines changed

articles/cognitive-services/text-analytics/how-tos/text-analytics-how-to-keyword-extraction.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.author: aahi
1414

1515
# Example: How to extract key phrases using Text Analytics
1616

17-
The [Key Phrase Extraction API](https://westcentralus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v2-1/operations/56f30ceeeda5650db055a3c6) evaluates unstructured text, and for each JSON document, returns a list of key phrases.
17+
The [Key Phrase Extraction API](https://westus2.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-0/operations/KeyPhrases) evaluates unstructured text, and for each JSON document, returns a list of key phrases.
1818

1919
This capability is useful if you need to quickly identify the main points in a collection of documents. For example, given input text "The food was delicious and there were wonderful staff", the service returns the main talking points: "food" and "wonderful staff".
2020

@@ -67,7 +67,7 @@ Document size must be 5,120 or fewer characters per document, and you can have u
6767

6868
For information about request definition, see [How to call the Text Analytics API](text-analytics-how-to-call-api.md). The following points are restated for convenience:
6969

70-
+ Create a **POST** request. Review the API documentation for this request: [Key Phrases API](https://westcentralus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v2-1/operations/56f30ceeeda5650db055a3c6).
70+
+ Create a **POST** request. Review the API documentation for this request: [Key Phrases API](https://westus2.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-0/operations/KeyPhrases).
7171

7272
+ Set the HTTP endpoint for key phrase extraction by using either a Text Analytics resource on Azure or an instantiated [Text Analytics container](text-analytics-how-to-install-containers.md). You must include `/text/analytics/v3.0/keyPhrases` in the URL. For example: `https://<your-custom-subdomain>.api.cognitiveservices.azure.com/text/analytics/v3.0/keyPhrases`.
7373

@@ -76,7 +76,7 @@ For information about request definition, see [How to call the Text Analytics AP
7676
+ In the request body, provide the JSON documents collection you prepared for this analysis.
7777

7878
> [!Tip]
79-
> Use [Postman](text-analytics-how-to-call-api.md) or open the **API testing console** in the [documentation](https://westcentralus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v2-1/operations/56f30ceeeda5650db055a3c6) to structure a request and POST it to the service.
79+
> Use [Postman](text-analytics-how-to-call-api.md) or open the **API testing console** in the [documentation](https://westus2.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-0/operations/KeyPhrases) to structure a request and POST it to the service.
8080
8181
## Step 2: Post the request
8282

@@ -147,7 +147,7 @@ As noted, the analyzer finds and discards non-essential words, and it keeps sing
147147

148148
In this article, you learned concepts and workflow for key phrase extraction by using Text Analytics in Cognitive Services. In summary:
149149

150-
+ [Key phrase extraction API](https://westcentralus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v2-1/operations/56f30ceeeda5650db055a3c6) is available for selected languages.
150+
+ [Key phrase extraction API](https://westus2.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-0/operations/KeyPhrases) is available for selected languages.
151151
+ JSON documents in the request body include an ID, text, and language code.
152152
+ POST request is to a `/keyphrases` endpoint, using a personalized [access key and an endpoint](../../cognitive-services-apis-create-account.md#get-the-keys-for-your-resource) that is valid for your subscription.
153153
+ Response output, which consists of key words and phrases for each document ID, can be streamed to any app that accepts JSON, including Microsoft Office Excel and Power BI, to name a few.
@@ -161,4 +161,4 @@ In this article, you learned concepts and workflow for key phrase extraction by
161161
## Next steps
162162

163163
> [!div class="nextstepaction"]
164-
> [Text Analytics API](https://westus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-V2-1/operations/56f30ceeeda5650db055a3c6)
164+
> [Text Analytics API](https://westus2.dev.cognitive.microsoft.com/docs/services/TextAnalytics-V3-0/)

articles/cognitive-services/text-analytics/how-tos/text-analytics-how-to-language-detection.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.author: aahi
1414

1515
# Example: Detect language with Text Analytics
1616

17-
The [Language Detection](https://westcentralus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v2-1/operations/56f30ceeeda5650db055a3c7) feature of the Azure Text Analytics REST API evaluates text input for each document and returns language identifiers with a score that indicates the strength of the analysis.
17+
The [Language Detection](https://westus2.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-0/operations/Languages) feature of the Azure Text Analytics REST API evaluates text input for each document and returns language identifiers with a score that indicates the strength of the analysis.
1818

1919
This capability is useful for content stores that collect arbitrary text, where language is unknown. You can parse the results of this analysis to determine which language is used in the input document. The response also returns a score that reflects the confidence of the model. The score value is between 0 and 1.
2020

@@ -62,7 +62,7 @@ The document size must be under 5,120 characters per document. You can have up t
6262

6363
For more information on request definition, see [Call the Text Analytics API](text-analytics-how-to-call-api.md). The following points are restated for convenience:
6464

65-
+ Create a POST request. To review the API documentation for this request, see the [Language Detection API](https://westcentralus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v2-1/operations/56f30ceeeda5650db055a3c7).
65+
+ Create a POST request. To review the API documentation for this request, see the [Language Detection API](https://westus2.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-0/operations/Languages).
6666

6767
+ Set the HTTP endpoint for language detection. Use either a Text Analytics resource on Azure or an instantiated [Text Analytics container](text-analytics-how-to-install-containers.md). You must include `/text/analytics/v3.0/languages` in the URL. For example: `https://<your-custom-subdomain>.cognitiveservices.azure.com/text/analytics/v3.0/languages`.
6868

@@ -71,7 +71,7 @@ For more information on request definition, see [Call the Text Analytics API](te
7171
+ In the request body, provide the JSON documents collection you prepared for this analysis.
7272

7373
> [!Tip]
74-
> Use [Postman](text-analytics-how-to-call-api.md) or open the **API testing console** in the [documentation](https://westcentralus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v2-1/operations/56f30ceeeda5650db055a3c7) to structure a request and POST it to the service.
74+
> Use [Postman](text-analytics-how-to-call-api.md) or open the **API testing console** in the [documentation](https://westus2.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-0/operations/Languages) to structure a request and POST it to the service.
7575
7676
## Step 2: POST the request
7777

@@ -181,7 +181,7 @@ The service now has additional context to make a better judgment:
181181
{
182182
"name": "English",
183183
"iso6391Name": "en",
184-
"ConfidenceScore": 1
184+
"confidenceScore": 1
185185
}
186186
]
187187
},
@@ -191,7 +191,7 @@ The service now has additional context to make a better judgment:
191191
{
192192
"name": "French",
193193
"iso6391Name": "fr",
194-
"ConfidenceScore": 1
194+
"confidenceScore": 1
195195
}
196196
]
197197
}
@@ -209,7 +209,7 @@ If the analyzer can't parse the input, it returns `(Unknown)`. An example is if
209209
{
210210
"name": "(Unknown)",
211211
"iso6391Name": "(Unknown)",
212-
"ConfidenceScore": "NaN"
212+
"confidenceScore": "NaN"
213213
}
214214
]
215215
}
@@ -245,7 +245,7 @@ The resulting output consists of the predominant language, with a score of less
245245
{
246246
"name": "Spanish",
247247
"iso6391Name": "es",
248-
"Confidencescore": 0.9375
248+
"confidencescore": 0.94
249249
}
250250
]
251251
}
@@ -258,7 +258,7 @@ The resulting output consists of the predominant language, with a score of less
258258

259259
In this article, you learned concepts and workflow for language detection by using Text Analytics in Azure Cognitive Services. The following points were explained and demonstrated:
260260

261-
+ [Language detection](https://westcentralus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v2-1/operations/56f30ceeeda5650db055a3c7) is available for a wide range of languages, variants, dialects, and some regional or cultural languages.
261+
+ [Language detection](https://westus2.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-0/operations/Languages) is available for a wide range of languages, variants, dialects, and some regional or cultural languages.
262262
+ JSON documents in the request body include an ID and text.
263263
+ The POST request is to a `/languages` endpoint by using a personalized [access key and an endpoint](../../cognitive-services-apis-create-account.md#get-the-keys-for-your-resource) that's valid for your subscription.
264264
+ Response output consists of language identifiers for each document ID. The output can be streamed to any app that accepts JSON. Example apps include Excel and Power BI, to name a few.

articles/cognitive-services/text-analytics/includes/text-analytics-api-references.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ ms.author: assafi
1313

1414
> [!Tip]
1515
> For detailed API technical documentation and to see it in action, use the following links. You can also send POST requests from the built-in API test console. No setup is required, simply paste your resource key and JSON documents into the request:
16-
> - Latest stable API - [v2.1](https://westcentralus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v2-1)
17-
> - Latest preview API - [v3.0-Preview.1](https://westus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-0-Preview-1)
16+
> - Latest stable API - [v3.0](https://westcentralus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-0)
17+
> - Latest preview API - [v3.1-Preview.1](https://westcentralus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-1-Preview-1)

articles/cognitive-services/text-analytics/includes/v3-region-availability.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ ms.author: aahi
1212
---
1313

1414
> [!IMPORTANT]
15-
> Text Analytics API v3 is not available in the following regions: Central India, UAE North, South Africa North, China North 2, China East 2.
15+
> Text Analytics API v3 is not available in the following regions: Central India, UAE North, South Africa North, China North 2, China East.
1616
1717

articles/cognitive-services/text-analytics/language-support.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.author: aahi
1414
# Text Analytics API v3 language support
1515

1616
> [!IMPORTANT]
17-
> Version 3.x of the Text Analytics API is currently unavailable in the following regions: Central India, UAE North, South Africa North, China North 2, China East 2.
17+
> Version 3.x of the Text Analytics API is currently unavailable in the following regions: Central India, UAE North, South Africa North, China North 2, China East.
1818
1919

2020
#### [Sentiment Analysis](#tab/sentiment-analysis)
@@ -51,8 +51,8 @@ ms.author: aahi
5151
#### [Named Entity Recognition (NER)](#tab/named-entity-recognition)
5252

5353
> [!NOTE]
54-
> * NER v3 currently only supports the English language. If you call NER v3 with a different language, The API will return v2.1 results, provided the language is supported in version 2.1.
55-
> * v2.1 only returns the full set of available entities for the English, Chinese-Simplified, French, German, and Spanish languages. the "Person", "Location" and "Organization" entities are returned for other languages.
54+
> * NER v3 currently only supports the English language. If you call NER v3 with a different language, the API will return v2.1 results, provided the language is supported in version 2.1.
55+
> * v2.1 only returns the full set of available entities for the English, Chinese-Simplified, French, German, and Spanish languages. The "Person", "Location" and "Organization" entities are returned for the other supported languages.
5656
5757
| Language | Language code | v2.1 support | v3 support | Starting with v3 model version: | Notes |
5858
|:-----------------------|:-------------:|:----------:|:----------:|:-------------------------------:|:------------------:|

articles/cognitive-services/text-analytics/quickstarts/text-analytics-sdk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Use the Text Analytics client library to perform:
2727
::: zone pivot="programming-language-csharp"
2828

2929
> [!IMPORTANT]
30-
> * The latest preview version of the Text Analytics API is `3.0-preview`, which includes a public preview for improved [Sentiment Analysis](../how-tos/text-analytics-how-to-sentiment-analysis.md#sentiment-analysis-versions-and-features) and [Named Entity Recognition (NER)](../how-tos/text-analytics-how-to-entity-linking.md#named-entity-recognition-versions-and-features). The latest stable version is `2.1`.
30+
> * The latest preview version of the Text Analytics API is `3.1-preview`, which includes a public preview for Opinion Mining [Sentiment Analysis](../how-tos/text-analytics-how-to-sentiment-analysis.md#opinion-mining) and new [Personal (`PII`) domain filter](how-tos/text-analytics-how-to-entity-linking.md#named-entity-recognition-versions-and-features) for protected health information (`PHI`). The latest stable version is `3.0`.
3131
> * Be sure to only follow the instructions for the version you are using.
3232
> * The code in this article uses synchronous methods and un-secured credentials storage for simplicity reasons. For production scenarios, we recommend using the batched asynchronous methods for performance and scalability. See the reference documentation below.
3333

articles/cognitive-services/text-analytics/whats-new.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ The Text Analytics API is updated on an ongoing basis. To stay up-to-date with r
2323
Text Analysis API v3 is now generally available with the following updates:
2424

2525
* Model version `2020-04-01`
26-
* Updated [language support](language-support.md) for [sentiment analysis v3](how-tos/text-analytics-how-to-sentiment-analysis.md)
27-
* Separate endpoint for entity linking
26+
* Updated [language support](language-support.md) for [Sentiment Analysis (SA) v3](how-tos/text-analytics-how-to-sentiment-analysis.md)
27+
* Separate endpoint for Entity Linking
2828
* New "Address" entity category in [Named Entity Recognition (NER) v3](how-tos/text-analytics-how-to-entity-linking.md).
2929
* New subcategories in NER v3:
3030
* Location - Geographical
@@ -38,7 +38,7 @@ Text Analysis API v3 is now generally available with the following updates:
3838

3939
The following properties in the JSON response have been added:
4040
* `SentenceText` in Sentiment Analysis
41-
* Warnings for each document
41+
* `Warnings` for each document
4242

4343
The names of the following properties in the JSON response have been changed, where applicable:
4444

@@ -50,11 +50,17 @@ The names of the following properties in the JSON response have been changed, wh
5050
[!INCLUDE [v3 region availability](includes/v3-region-availability.md)]
5151

5252
> [!div class="nextstepaction"]
53-
> [Learn more about Text Analytics API v3](https://westus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-0/operations/Languages)
53+
> [Learn more about Text Analytics API v3](https://westus2.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-0/operations/Languages)
5454
5555
### Text Analytics API v3.1 Public Preview
56-
* New sentiment analysis feature - [Opinion Mining](how-tos/text-analytics-how-to-sentiment-analysis.md#opinion-mining)
57-
* New [NER domain filter](how-tos/text-analytics-how-to-entity-linking.md#named-entity-recognition-versions-and-features) for personal (`PII`) and protected health (`PHI`) information.
56+
* New Sentiment Analysis feature - [Opinion Mining](how-tos/text-analytics-how-to-sentiment-analysis.md#opinion-mining)
57+
* New [Personal (`PII`) domain filter](how-tos/text-analytics-how-to-entity-linking.md#named-entity-recognition-versions-and-features) for protected health information (`PHI`).
58+
* New Personal (`PII`) categories:
59+
* International Classification of Diseases (ICD-9-CM)
60+
* International Classification of Diseases (ICD-10-CM)
61+
62+
> [!div class="nextstepaction"]
63+
> [Learn more about Text Analytics API v3.1 Preview](https://westcentralus.dev.cognitive.microsoft.com/docs/services/TextAnalytics-v3-1-preview-1/operations/Languages)
5864
5965
## February 2020
6066

0 commit comments

Comments
 (0)