Skip to content

Commit 2466897

Browse files
authored
[Text Analytics] Improve README.md (#14663)
1 parent d31aa59 commit 2466897

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

sdk/textanalytics/ai-text-analytics/README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[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:
44

5-
**Note:** This SDK targets Azure Text Analytics service API version 3.1.0-preview.3.
5+
**Note:** This SDK targets Azure Text Analytics service API version 3.1.0-preview.4.
66

77
- Language Detection
88
- Sentiment Analysis
@@ -74,7 +74,7 @@ az cognitiveservices account keys list --resource-group <your-resource-group-nam
7474

7575
Once you have an API key and endpoint, you can use the `AzureKeyCredential` class to authenticate the client as follows:
7676

77-
```js
77+
```javascript
7878
const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");
7979

8080
const client = new TextAnalyticsClient("<endpoint>", new AzureKeyCredential("<API key>"));
@@ -93,7 +93,7 @@ You will also need to [register a new AAD application][register_aad_app] and gra
9393

9494
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`.
9595

96-
```js
96+
```javascript
9797
const { TextAnalyticsClient } = require("@azure/ai-text-analytics");
9898
const { DefaultAzureCredential } = require("@azure/identity");
9999

@@ -104,7 +104,7 @@ const client = new TextAnalyticsClient("<endpoint>", new DefaultAzureCredential(
104104

105105
### TextAnalyticsClient
106106

107-
`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.
107+
`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.
108108

109109
### Input
110110

@@ -130,7 +130,7 @@ const textDocumentInputs = [
130130
];
131131
```
132132

133-
See [service limiations][data_limits] for the input, including document length limits, maximum batch size, and supported text encodings.
133+
See [service limitations][data_limits] for the input, including document length limits, maximum batch size, and supported text encodings.
134134

135135
### Return Value
136136

@@ -500,7 +500,7 @@ main();
500500

501501
## Known Issues
502502

503-
- `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].
503+
- `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).
504504
- 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.
505505

506506
## Troubleshooting
@@ -519,17 +519,15 @@ For more detailed instructions on how to enable logs, you can look at the [@azur
519519

520520
## Next steps
521521

522-
Please take a look at the
523-
[samples](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/textanalytics/ai-text-analytics/samples)
524-
directory for detailed examples on how to use this library.
522+
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.
525523

526524
## Contributing
527525

528526
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
529527

530528
## Related projects
531529

532-
- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
530+
- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
533531

534532
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Ftextanalytics%2Fai-text-analytics%2FREADME.png)
535533

0 commit comments

Comments
 (0)