From 1fe64d750604158fdae79edbd50089285d900429 Mon Sep 17 00:00:00 2001 From: iscai-msft Date: Wed, 2 Sep 2020 15:21:06 -0400 Subject: [PATCH 1/3] add pre suffix to pip install --- sdk/textanalytics/azure-ai-textanalytics/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/textanalytics/azure-ai-textanalytics/README.md b/sdk/textanalytics/azure-ai-textanalytics/README.md index 71a75b8c3a8a..4e30c7d9902a 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/README.md +++ b/sdk/textanalytics/azure-ai-textanalytics/README.md @@ -65,7 +65,7 @@ For example, `https://.cognitiveservices.azure.com/`. Install the Azure Text Analytics client library for Python with [pip][pip]: ```bash -pip install azure-ai-textanalytics +pip install azure-ai-textanalytics --pre ``` > Note: This version of the client library supports the v3.0 version of the Text Analytics service From 2ac1e2f107d3d834899a7634068c046e6c3f6672 Mon Sep 17 00:00:00 2001 From: iscai-msft Date: Wed, 2 Sep 2020 16:00:01 -0400 Subject: [PATCH 2/3] add note about api versions --- sdk/textanalytics/azure-ai-textanalytics/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/sdk/textanalytics/azure-ai-textanalytics/README.md b/sdk/textanalytics/azure-ai-textanalytics/README.md index 4e30c7d9902a..5a8e2c309fc1 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/README.md +++ b/sdk/textanalytics/azure-ai-textanalytics/README.md @@ -68,7 +68,9 @@ 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 +> Note: This version of the client library supports both the v3.0 version, and the preview versions of the v3.1 version of the Text Analytics service. If you do not specify the `--pre` flag when installing the package, you will download version 5.0.0 of the library, which will only +include support of the services v3.0 version. Specifying the `--pre` flag will give you the latest beta release of this library, which includes +support of all preview versions of v3.1, and also continuing support of the service's v3.0 version. ### Authenticate the client #### Get the endpoint From e80bc268b40cd13752006eff2ef77387751aa77b Mon Sep 17 00:00:00 2001 From: iscai-msft Date: Thu, 3 Sep 2020 11:06:49 -0400 Subject: [PATCH 3/3] create table showing SDK -> API version --- sdk/textanalytics/azure-ai-textanalytics/README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/sdk/textanalytics/azure-ai-textanalytics/README.md b/sdk/textanalytics/azure-ai-textanalytics/README.md index 5a8e2c309fc1..b0288ee39f00 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/README.md +++ b/sdk/textanalytics/azure-ai-textanalytics/README.md @@ -67,10 +67,13 @@ Install the Azure Text Analytics client library for Python with [pip][pip]: ```bash pip install azure-ai-textanalytics --pre ``` +> This table shows the relationship between SDK versions and supported API versions of the service +>| SDK version | Supported API version of service | +>| ----------- | ----------- | +>| Latest GA release (can be installed by removing the `--pre` flag) | 3.0 | +>| Latest release (beta) | 3.0, 3.1-preview | + -> Note: This version of the client library supports both the v3.0 version, and the preview versions of the v3.1 version of the Text Analytics service. If you do not specify the `--pre` flag when installing the package, you will download version 5.0.0 of the library, which will only -include support of the services v3.0 version. Specifying the `--pre` flag will give you the latest beta release of this library, which includes -support of all preview versions of v3.1, and also continuing support of the service's v3.0 version. ### Authenticate the client #### Get the endpoint