From 1ad43789043579bc0701eb66dbea3f2225c0276f Mon Sep 17 00:00:00 2001 From: Krista Pratico Date: Wed, 8 Jan 2020 09:20:46 -0800 Subject: [PATCH 1/3] update history for TA preview release --- sdk/textanalytics/azure-ai-textanalytics/HISTORY.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/sdk/textanalytics/azure-ai-textanalytics/HISTORY.md b/sdk/textanalytics/azure-ai-textanalytics/HISTORY.md index f0b15378a5a4..66ee0f4e50f5 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/HISTORY.md +++ b/sdk/textanalytics/azure-ai-textanalytics/HISTORY.md @@ -1,14 +1,14 @@ # Change Log azure-ai-textanalytics -## 1.0.0b1 (2020-01-06) +## 1.0.0b1 (2020-01-09) Version (1.0.0b1) is the first preview of our efforts to create a user-friendly and Pythonic client library for Azure Text Analytics. For more information about this, and preview releases of other Azure SDK libraries, please visit https://azure.github.io/azure-sdk/releases/latest/python.html. **Breaking changes: New API design** -- New namespace: - - The namespace for Azure Text Analytics client library has changed from `azure.cognitiveservices.language.textanalytics` to `azure.ai.textanalytics` +- New namespace/package name: + - The namespace/package name for Azure Text Analytics client library has changed from `azure.cognitiveservices.language.textanalytics` to `azure.ai.textanalytics` - New operations and naming: - `detect_language` is renamed to `detect_languages` @@ -43,12 +43,13 @@ https://azure.github.io/azure-sdk/releases/latest/python.html. - `detect_languages` now takes a parameter `country_hint` which allows you to specify the country hint for the entire batch. Any per-item country hints will take precedence over a whole batch hint. - `recognize_entities`, `recognize_pii_entities`, `recognize_linked_entities`, `extract_key_phrases`, `analyze_sentiment` now take a parameter `language` which allows you to specify the language for the entire batch. Any per-item specified language will take precedence over a whole batch hint. + - A `default_country_hint` or `default_language` keyword argument can be passed at client instantiation to set the default values for all operations. - A `response_hook` keyword argument can be passed with a callback to use the raw response from the service. Additionally, values returned for `TextDocumentBatchStatistics` and `model_version` used must be retrieved using a response hook. - `show_stats` and `model_version` parameters move to keyword only arguments. - New return types - The return types for the batching methods (`detect_languages`, `recognize_entities`, `recognize_pii_entities`, `recognize_linked_entities`, `extract_key_phrases`, `analyze_sentiment`) now return a heterogeneous list of - result objects and document errors in the order passed in with the request. To iterate over the list and filter for result or error, a boolean on each object called `is_error` can be used to determine whether the returned response object at + result objects and document errors in the order passed in with the request. To iterate over the list and filter for result or error, a boolean property on each object called `is_error` can be used to determine whether the returned response object at that index is a result or an error: - `detect_languages` now returns a List[Union[`DetectLanguageResult`, `DocumentError`]] - `recognize_entities` now returns a List[Union[`RecognizeEntitiesResult`, `DocumentError`]] @@ -65,7 +66,7 @@ https://azure.github.io/azure-sdk/releases/latest/python.html. - `single_analyze_sentiment` returns a `AnalyzeSentimentResult` - New underlying REST pipeline implementation, based on the new `azure-core` library. -- Client and pipeline configuration is now available via keyword arguments at both the client level, and per-operation. See reference documentation for a full list of optional configuration arguments. +- Client and pipeline configuration is now available via keyword arguments at both the client level, and per-operation. See README for a full list of optional configuration arguments. - Authentication using `azure-identity` credentials - see the [Azure Identity documentation](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/identity/azure-identity/README.md) From f51b192ea9da52511fa184160dda8b386b9f6106 Mon Sep 17 00:00:00 2001 From: Krista Pratico Date: Wed, 8 Jan 2020 10:20:52 -0800 Subject: [PATCH 2/3] add note to track1 --- .../azure-cognitiveservices-language-textanalytics/README.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/sdk/cognitiveservices/azure-cognitiveservices-language-textanalytics/README.rst b/sdk/cognitiveservices/azure-cognitiveservices-language-textanalytics/README.rst index fc583774b7d0..8b472fe96865 100644 --- a/sdk/cognitiveservices/azure-cognitiveservices-language-textanalytics/README.rst +++ b/sdk/cognitiveservices/azure-cognitiveservices-language-textanalytics/README.rst @@ -1,6 +1,8 @@ Microsoft Azure SDK for Python ============================== +.. note:: If you are looking for the new, preview version of Azure Text Analytics, please see `azure-ai-textanalytics `_. + This is the Microsoft Azure Cognitive Services Text Analytics Client Library. This package has been tested with Python 2.7, 3.5, 3.6 and 3.7. From b5c9dde5cea6cb375f95583120248f09d6c4cd4c Mon Sep 17 00:00:00 2001 From: Krista Pratico Date: Wed, 8 Jan 2020 10:22:41 -0800 Subject: [PATCH 3/3] formatting --- .../azure-cognitiveservices-language-textanalytics/README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/cognitiveservices/azure-cognitiveservices-language-textanalytics/README.rst b/sdk/cognitiveservices/azure-cognitiveservices-language-textanalytics/README.rst index 8b472fe96865..d9d6332752bf 100644 --- a/sdk/cognitiveservices/azure-cognitiveservices-language-textanalytics/README.rst +++ b/sdk/cognitiveservices/azure-cognitiveservices-language-textanalytics/README.rst @@ -1,7 +1,7 @@ Microsoft Azure SDK for Python ============================== -.. note:: If you are looking for the new, preview version of Azure Text Analytics, please see `azure-ai-textanalytics `_. +**NOTE:** If you are looking for the new, preview version of Azure Text Analytics, please see `azure-ai-textanalytics `_. This is the Microsoft Azure Cognitive Services Text Analytics Client Library.