fixed mentions to v3.1-preview.1 in code and docstrings

Azure · Jul 29, 2020 · f85ae53 · f85ae53
1 parent e5451ea
commit f85ae53
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 7 deletions.
diff --git a/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md b/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md
@@ -5,7 +5,7 @@
 **New features**
 - We are now targeting the service's v3.1-preview.1 API as the default. If you would like to still use version v3.0 of the service,
 pass in `v3.0` to the kwarg `api_version` when creating your TextAnalyticsClient
-- We have added an API `recognize_pii_entities` which returns entities containing personal information for a batch of documents. Only available for version v3.1-preview.1 and up.
+- We have added an API `recognize_pii_entities` which returns entities containing personal information for a batch of documents. Only available for API version v3.1-preview.1 and up.
 
 ## 5.0.0 (2020-07-27)
 

diff --git a/sdk/textanalytics/azure-ai-textanalytics/README.md b/sdk/textanalytics/azure-ai-textanalytics/README.md
@@ -294,7 +294,7 @@ and [supported types][linked_entities_categories].
 
 ### Recognize PII entities
 [recognize_pii_entities][recognize_pii_entities] recognizes and categorizes Personally Identifiable Information (PII) entities in its input text, such as
-Social Security Numbers, bank account information, credit card numbers, and more.
+Social Security Numbers, bank account information, credit card numbers, and more. This endpoint is only available for v3.1-preview.1 and up.
 
 ```python
 from azure.core.credentials import AzureKeyCredential
@@ -303,7 +303,7 @@ from azure.ai.textanalytics import TextAnalyticsClient, ApiVersion
 credential = AzureKeyCredential("<api_key>")
 endpoint="https://<region>.api.cognitive.microsoft.com/"
 
-text_analytics_client = TextAnalyticsClient(endpoint, credential, api_version=ApiVersion.V3_1_preview_1)
+text_analytics_client = TextAnalyticsClient(endpoint, credential)
 
 documents = [
     "The employee's SSN is 859-98-0987.",

diff --git a/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_text_analytics_client.py b/sdk/textanalytics/azure-ai-textanalytics/azure/ai/textanalytics/_text_analytics_client.py
@@ -289,7 +289,7 @@ def recognize_pii_entities(  # type: ignore
         except AttributeError as error:
             if "'TextAnalyticsClient' object has no attribute 'entities_recognition_pii'" in str(error):
                 raise NotImplementedError(
-                    "'recognize_pii_entities' endpoint is only available for API version v3.1-preview.1"
+                    "'recognize_pii_entities' endpoint is only available for API version v3.1-preview.1 and up"
                 )
             raise error
         except HttpResponseError as error:

diff --git a/...alytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_text_analytics_client_async.py b/...alytics/azure-ai-textanalytics/azure/ai/textanalytics/aio/_text_analytics_client_async.py
@@ -291,7 +291,7 @@ async def recognize_pii_entities(  # type: ignore
         except AttributeError as error:
             if "'TextAnalyticsClient' object has no attribute 'entities_recognition_pii'" in str(error):
                 raise NotImplementedError(
-                    "'recognize_pii_entities' endpoint is only available for API version v3.1-preview.1"
+                    "'recognize_pii_entities' endpoint is only available for API version v3.1-preview.1 and up"
                 )
             raise error
         except HttpResponseError as error:

diff --git a/...ytics/azure-ai-textanalytics/samples/async_samples/sample_recognize_pii_entities_async.py b/...ytics/azure-ai-textanalytics/samples/async_samples/sample_recognize_pii_entities_async.py
@@ -11,6 +11,7 @@
 
 DESCRIPTION:
     This sample demonstrates how to recognize personally identifiable information in a batch of documents.
+    The endpoint recognize_pii_entities is only available for API version v3.1-preview.1 and up.
 
 USAGE:
     python sample_recognize_pii_entities_async.py
@@ -36,7 +37,7 @@ async def recognize_pii_entities_async(self):
         key = os.environ["AZURE_TEXT_ANALYTICS_KEY"]
 
         text_analytics_client = TextAnalyticsClient(
-            endpoint=endpoint, credential=AzureKeyCredential(key), api_version=ApiVersion.V3_1_preview_1
+            endpoint=endpoint, credential=AzureKeyCredential(key)
         )
         documents = [
             "The employee's SSN is 859-98-0987.",

diff --git a/sdk/textanalytics/azure-ai-textanalytics/samples/sample_recognize_pii_entities.py b/sdk/textanalytics/azure-ai-textanalytics/samples/sample_recognize_pii_entities.py
@@ -11,6 +11,7 @@
 
 DESCRIPTION:
     This sample demonstrates how to recognize personally identifiable information in a batch of documents.
+    The endpoint recognize_pii_entities is only available for API version v3.1-preview.1 and up.
 
 USAGE:
     python sample_recognize_pii_entities.py
@@ -34,7 +35,7 @@ def recognize_pii_entities(self):
         key = os.environ["AZURE_TEXT_ANALYTICS_KEY"]
 
         text_analytics_client = TextAnalyticsClient(
-            endpoint=endpoint, credential=AzureKeyCredential(key), api_version=ApiVersion.V3_1_preview_1
+            endpoint=endpoint, credential=AzureKeyCredential(key)
         )
         documents = [
             "The employee's SSN is 859-98-0987.",