From 2466897251c4f4e3638636c41d0d4ee702b84245 Mon Sep 17 00:00:00 2001 From: Deyaaeldeen Almahallawi Date: Tue, 6 Apr 2021 13:26:40 -0400 Subject: [PATCH] [Text Analytics] Improve README.md (#14663) --- sdk/textanalytics/ai-text-analytics/README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/sdk/textanalytics/ai-text-analytics/README.md b/sdk/textanalytics/ai-text-analytics/README.md index 59e0f6ebd97c..0fedc7b7c231 100644 --- a/sdk/textanalytics/ai-text-analytics/README.md +++ b/sdk/textanalytics/ai-text-analytics/README.md @@ -2,7 +2,7 @@ [Azure TextAnalytics](https://azure.microsoft.com/services/cognitive-services/text-analytics/) is a cloud-based service that provides advanced natural language processing over raw text, and includes six main functions: -**Note:** This SDK targets Azure Text Analytics service API version 3.1.0-preview.3. +**Note:** This SDK targets Azure Text Analytics service API version 3.1.0-preview.4. - Language Detection - Sentiment Analysis @@ -74,7 +74,7 @@ az cognitiveservices account keys list --resource-group ", new AzureKeyCredential("")); @@ -93,7 +93,7 @@ You will also need to [register a new AAD application][register_aad_app] and gra Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`. -```js +```javascript const { TextAnalyticsClient } = require("@azure/ai-text-analytics"); const { DefaultAzureCredential } = require("@azure/identity"); @@ -104,7 +104,7 @@ const client = new TextAnalyticsClient("", new DefaultAzureCredential( ### TextAnalyticsClient -`TextAnalyticsClient` is the primary interface for developers using the Text Analytics client library. It provides asynchronous methods to access a specific use of Text Analytics, such as language detection or key phrase extraction. +`TextAnalyticsClient` is the primary interface for developers using the Text Analytics client library. Explore the methods on this client object to understand the different features of the Text Analytics service that you can access. ### Input @@ -130,7 +130,7 @@ const textDocumentInputs = [ ]; ``` -See [service limiations][data_limits] for the input, including document length limits, maximum batch size, and supported text encodings. +See [service limitations][data_limits] for the input, including document length limits, maximum batch size, and supported text encodings. ### Return Value @@ -500,7 +500,7 @@ main(); ## Known Issues -- `beginAnalyzeHealthcare` is still in gated preview and can not be used with AAD credentials. For more information, see (the Text Analytics for Health documentation)[https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/how-tos/text-analytics-for-health?tabs=ner#request-access-to-the-public-preview]. +- `beginAnalyzeHealthcare` is still in gated preview and can not be used with AAD credentials. For more information, see [the Text Analytics for Health documentation](https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-for-health?tabs=ner#request-access-to-the-public-preview). - At time of this SDK release, the `modelVersion` option to `beginAnalyzeHealthcareEntities` is ignored by the service. The service always processes the operation using the "latest" model. ## Troubleshooting @@ -519,9 +519,7 @@ For more detailed instructions on how to enable logs, you can look at the [@azur ## Next steps -Please take a look at the -[samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/textanalytics/ai-text-analytics/samples) -directory for detailed examples on how to use this library. +Please take a look at the [samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/textanalytics/ai-text-analytics/samples) directory for detailed examples on how to use this library. ## Contributing @@ -529,7 +527,7 @@ If you'd like to contribute to this library, please read the [contributing guide ## Related projects -- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js) +- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js) ![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Ftextanalytics%2Fai-text-analytics%2FREADME.png)