[text analytics] merging feature branch into master (#11632)

Author: iscai-msft

sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md

@@ -1,7 +1,20 @@
 # Change Log azure-ai-textanalytics
 
-## 1.0.0b5 (Unreleased)
+## 1.0.0b6 (2020-05-27)
 
+**New features**
+- We now have a `warnings` property on each document-level response object returned from the endpoints. It is a list of `TextAnalyticsWarning`s.
+- Added `text` property to `SentenceSentiment`
+
+**Breaking changes**
+- Now targets only the service's v3.0 API, instead of the v3.0-preview.1 API
+- `score` attribute of `DetectedLanguage` has been renamed to `confidence_score`
+- Removed `grapheme_offset` and `grapheme_length` from `CategorizedEntity`, `SentenceSentiment`, and `LinkedEntityMatch`
+- `TextDocumentStatistics` attribute `grapheme_count` has been renamed to `character_count`
+
+## 1.0.0b5
+
+- This was a broken release
 
 ## 1.0.0b4 (2020-04-07)
 

sdk/textanalytics/azure-ai-textanalytics/README.md

@@ -23,6 +23,8 @@ Install the Azure Text Analytics client library for Python with [pip][pip]:
 pip install azure-ai-textanalytics --pre
 ```
 
+> Note: This version of the client library supports the v3.0 version of the Text Analytics service
+
 ### Authenticate the client
 #### Create a Cognitive Services or Text Analytics resource
 Text Analytics supports both [multi-service and single-service access][multi_and_single_service].
@@ -343,7 +345,7 @@ result = [doc for doc in response if not doc.is_error]
 for doc in result:
     print("Language detected: {}".format(doc.primary_language.name))
     print("ISO6391 name: {}".format(doc.primary_language.iso6391_name))
-    print("Confidence score: {}\n".format(doc.primary_language.score))
+    print("Confidence score: {}\n".format(doc.primary_language.confidence_score))
 ```
 
 The returned response is a heterogeneous list of result and error objects: list[[DetectLanguageResult][detect_language_result], [DocumentError][document_error]]

sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/__init__.py

@@ -17,6 +17,7 @@
     RecognizeEntitiesResult,
     DetectLanguageResult,
     TextAnalyticsError,
+    TextAnalyticsWarning,
     ExtractKeyPhrasesResult,
     RecognizeLinkedEntitiesResult,
     TextDocumentStatistics,
@@ -35,6 +36,7 @@
     'DetectLanguageResult',
     'CategorizedEntity',
     'TextAnalyticsError',
+    'TextAnalyticsWarning',
     'ExtractKeyPhrasesResult',
     'RecognizeLinkedEntitiesResult',
     'AnalyzeSentimentResult',

sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/__init__.py

@@ -8,3 +8,9 @@
 
 from ._text_analytics_client import TextAnalyticsClient
 __all__ = ['TextAnalyticsClient']
+
+try:
+    from ._patch import patch_sdk
+    patch_sdk()
+except ImportError:
+    pass

sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/_configuration.py

@@ -6,11 +6,17 @@
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 
-from typing import Any
+from typing import TYPE_CHECKING
 
 from azure.core.configuration import Configuration
 from azure.core.pipeline import policies
 
+if TYPE_CHECKING:
+    # pylint: disable=unused-import,ungrouped-imports
+    from typing import Any
+
+    from azure.core.credentials import TokenCredential
+
 VERSION = "unknown"
 
 class TextAnalyticsClientConfiguration(Configuration):
@@ -20,7 +26,7 @@ class TextAnalyticsClientConfiguration(Configuration):
     attributes.
 
     :param credential: Credential needed for the client to connect to Azure.
-    :type credential: azure.core.credentials.TokenCredential
+    :type credential: ~azure.core.credentials.TokenCredential
     :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
     :type endpoint: str
     """
@@ -41,6 +47,7 @@ def __init__(
         self.credential = credential
         self.endpoint = endpoint
         self.credential_scopes = ['https://cognitiveservices.azure.com/.default']
+        self.credential_scopes.extend(kwargs.pop('credential_scopes', []))
         kwargs.setdefault('sdk_moniker', 'ai-textanalytics/{}'.format(VERSION))
         self._configure(**kwargs)
 

sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/_text_analytics_client.py

@@ -6,11 +6,15 @@
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 
-from typing import Any
+from typing import TYPE_CHECKING
 
 from azure.core import PipelineClient
 from msrest import Deserializer, Serializer
 
+if TYPE_CHECKING:
+    # pylint: disable=unused-import,ungrouped-imports
+    from typing import Any
+
 from ._configuration import TextAnalyticsClientConfiguration
 from .operations import TextAnalyticsClientOperationsMixin
 from . import models
@@ -20,9 +24,10 @@ class TextAnalyticsClient(TextAnalyticsClientOperationsMixin):
     """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 extraction and 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.
 
     :param credential: Credential needed for the client to connect to Azure.
-    :type credential: azure.core.credentials.TokenCredential
+    :type credential: ~azure.core.credentials.TokenCredential
     :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
     :type endpoint: str
+    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(
@@ -32,7 +37,7 @@ def __init__(
         **kwargs  # type: Any
     ):
         # type: (...) -> None
-        base_url = '{Endpoint}/text/analytics/v3.0-preview.1'
+        base_url = '{Endpoint}/text/analytics/v3.0'
         self._config = TextAnalyticsClientConfiguration(credential, endpoint, **kwargs)
         self._client = PipelineClient(base_url=base_url, config=self._config, **kwargs)
 

sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/aio/_configuration_async.py

@@ -6,11 +6,15 @@
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 
-from typing import Any
+from typing import Any, TYPE_CHECKING
 
 from azure.core.configuration import Configuration
 from azure.core.pipeline import policies
 
+if TYPE_CHECKING:
+    # pylint: disable=unused-import,ungrouped-imports
+    from azure.core.credentials import TokenCredential
+
 VERSION = "unknown"
 
 class TextAnalyticsClientConfiguration(Configuration):
@@ -20,7 +24,7 @@ class TextAnalyticsClientConfiguration(Configuration):
     attributes.
 
     :param credential: Credential needed for the client to connect to Azure.
-    :type credential: azure.core.credentials.AsyncTokenCredential
+    :type credential: ~azure.core.credentials_async.AsyncTokenCredential
     :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
     :type endpoint: str
     """
@@ -40,6 +44,7 @@ def __init__(
         self.credential = credential
         self.endpoint = endpoint
         self.credential_scopes = ['https://cognitiveservices.azure.com/.default']
+        self.credential_scopes.extend(kwargs.pop('credential_scopes', []))
         kwargs.setdefault('sdk_moniker', 'ai-textanalytics/{}'.format(VERSION))
         self._configure(**kwargs)
 

sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_generated/aio/_text_analytics_client_async.py

@@ -20,9 +20,10 @@ class TextAnalyticsClient(TextAnalyticsClientOperationsMixin):
     """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 extraction and 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.
 
     :param credential: Credential needed for the client to connect to Azure.
-    :type credential: azure.core.credentials.AsyncTokenCredential
+    :type credential: ~azure.core.credentials_async.AsyncTokenCredential
     :param endpoint: Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
     :type endpoint: str
+    :keyword int polling_interval: Default waiting time between two polls for LRO operations if no Retry-After header is present.
     """
 
     def __init__(
@@ -31,7 +32,7 @@ def __init__(
         endpoint: str,
         **kwargs: Any
     ) -> None:
-        base_url = '{Endpoint}/text/analytics/v3.0-preview.1'
+        base_url = '{Endpoint}/text/analytics/v3.0'
         self._config = TextAnalyticsClientConfiguration(credential, endpoint, **kwargs)
         self._client = AsyncPipelineClient(base_url=base_url, config=self._config, **kwargs)