You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sdk/textanalytics/ai-text-analytics/README.md
+8-10Lines changed: 8 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
[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:
4
4
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.
6
6
7
7
- Language Detection
8
8
- Sentiment Analysis
@@ -74,7 +74,7 @@ az cognitiveservices account keys list --resource-group <your-resource-group-nam
74
74
75
75
Once you have an API key and endpoint, you can use the `AzureKeyCredential` class to authenticate the client as follows:
@@ -93,7 +93,7 @@ You will also need to [register a new AAD application][register_aad_app] and gra
93
93
94
94
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`.
@@ -104,7 +104,7 @@ const client = new TextAnalyticsClient("<endpoint>", new DefaultAzureCredential(
104
104
105
105
### TextAnalyticsClient
106
106
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.
108
108
109
109
### Input
110
110
@@ -130,7 +130,7 @@ const textDocumentInputs = [
130
130
];
131
131
```
132
132
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.
134
134
135
135
### Return Value
136
136
@@ -500,7 +500,7 @@ main();
500
500
501
501
## Known Issues
502
502
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).
504
504
- 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.
505
505
506
506
## Troubleshooting
@@ -519,17 +519,15 @@ For more detailed instructions on how to enable logs, you can look at the [@azur
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.
525
523
526
524
## Contributing
527
525
528
526
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.
529
527
530
528
## Related projects
531
529
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)
0 commit comments