Skip to content

Commit 056e856

Browse files
authored
[Text Analytics] Edit README section about Azure CLI (Azure#33465)
1 parent a1617ba commit 056e856

File tree

1 file changed

+21
-43
lines changed
  • sdk/textanalytics/Azure.AI.TextAnalytics

1 file changed

+21
-43
lines changed

sdk/textanalytics/Azure.AI.TextAnalytics/README.md

Lines changed: 21 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# Azure Cognitive Services Text Analytics client library for .NET
2+
23
Text Analytics is part of the Azure Cognitive Service for Language, a cloud-based service that provides Natural Language Processing (NLP) features for understanding and analyzing text. This client library offers the following features:
34

4-
* Language detection
5-
* Sentiment analysis
6-
* Key phrase extraction
7-
* Named entity recognition (NER)
8-
* Personally identifiable information (PII) entity recognition
9-
* Entity linking
10-
* Text analytics for health
11-
* Custom named entity recognition (Custom NER)
12-
* Custom text classification
13-
* Dynamic text classification
14-
* Extractive text summarization
15-
* Abstractive text summarization
5+
* Language detection
6+
* Sentiment analysis
7+
* Key phrase extraction
8+
* Named entity recognition (NER)
9+
* Personally identifiable information (PII) entity recognition
10+
* Entity linking
11+
* Text analytics for health
12+
* Custom named entity recognition (Custom NER)
13+
* Custom text classification
14+
* Dynamic text classification
15+
* Extractive text summarization
16+
* Abstractive text summarization
1617

1718
[Source code][textanalytics_client_src] | [Package (NuGet)][textanalytics_nuget_package] | [API reference documentation][textanalytics_refdocs] | [Product documentation][language_service_docs] | [Samples][textanalytics_samples]
1819

@@ -43,36 +44,11 @@ This table shows the relationship between SDK versions and supported API version
4344
* An [Azure subscription][azure_sub].
4445
* An existing Cognitive Services or Language service resource.
4546

46-
#### Create a Cognitive Services or Language service resource
47-
48-
The Language service supports both [multi-service and single-service access][cognitive_resource_portal]. Create a Cognitive Services resource if you plan to access multiple cognitive services under a single endpoint/key. For Language service access only, create a Language service resource.
49-
50-
You can create either resource using:
51-
52-
**Option 1:** [Azure Portal][cognitive_resource_portal].
53-
54-
**Option 2:** [Azure CLI][cognitive_resource_cli].
55-
56-
Below is an example of how you can create a Language service resource using the CLI:
47+
#### Create a Cognitive Services resource or a Language service resource
5748

58-
```PowerShell
59-
# Create a new resource group to hold the Language service resource -
60-
# if using an existing resource group, skip this step
61-
az group create --name <your-resource-name> --location <location>
62-
```
63-
64-
```PowerShell
65-
# Create Text Analytics
66-
az cognitiveservices account create \
67-
--name <your-resource-name> \
68-
--resource-group <your-resource-group-name> \
69-
--kind TextAnalytics \
70-
--sku <sku> \
71-
--location <location> \
72-
--yes
73-
```
49+
Azure Cognitive Service for Language supports both [multi-service and single-service access][service_access]. Create a Cognitive Services resource if you plan to access multiple cognitive services under a single endpoint and API key. To access the features of the Language service only, create a Language service resource instead.
7450

75-
For more information about creating the resource or how to get the location and sku information see [here][cognitive_resource_cli].
51+
You can create either resource via the [Azure portal][create_ta_resource_azure_portal] or, alternatively, you can follow the steps in [this document][create_ta_resource_azure_cli] to create it using the [Azure CLI][azure_cli].
7652

7753
### Authenticate the client
7854

@@ -157,6 +133,7 @@ For long running operations in the Azure SDK, the client exposes a `Start<operat
157133
We guarantee that all client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that the recommendation of reusing client instances is always safe, even across threads.
158134

159135
### Additional concepts
136+
160137
<!-- CLIENT COMMON BAR -->
161138
[Client options](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) |
162139
[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) |
@@ -168,7 +145,7 @@ We guarantee that all client instance methods are thread-safe and independent of
168145

169146
## Examples
170147

171-
The following section provides several code snippets using the `client` [created above](#create-textanalyticsclient-with-azure-active-directory-credential), and covers the main features present in this client library. Although most of the snippets below make use of synchronous service calls, keep in mind that the `Azure.AI.TextAnalytics` package supports both synchronous and asynchronous APIs.
148+
The following section provides several code snippets using the `client` [created above](#create-a-textanalyticsclient-using-an-api-key-credential), and covers the main features present in this client library. Although most of the snippets below make use of synchronous service calls, keep in mind that the `Azure.AI.TextAnalytics` package supports both synchronous and asynchronous APIs.
172149

173150
### Sync examples
174151

@@ -802,8 +779,6 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
802779
[textanalytics_refdocs]: https://aka.ms/azsdk-net-textanalytics-ref-docs
803780
[textanalytics_nuget_package]: https://www.nuget.org/packages/Azure.AI.TextAnalytics
804781
[textanalytics_samples]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md
805-
[cognitive_resource_portal]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account
806-
[cognitive_resource_cli]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli
807782
[dotnet_lro]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt
808783
[mock_client_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample_MockClient.md
809784

@@ -845,6 +820,9 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
845820

846821
[azure_cli]: https://docs.microsoft.com/cli/azure
847822
[azure_sub]: https://azure.microsoft.com/free/dotnet/
823+
[service_access]: https://learn.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account
824+
[create_ta_resource_azure_portal]: https://learn.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account
825+
[create_ta_resource_azure_cli]: https://learn.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli
848826
[nuget]: https://www.nuget.org/
849827
[azure_portal]: https://portal.azure.com
850828
[moq]: https://github.com/Moq/moq4/

0 commit comments

Comments
 (0)