Skip to content

Commit 07d41c4

Browse files
updating readmes for ta to include ext summarization (Azure#20094)
1 parent 39d64d0 commit 07d41c4

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

sdk/textanalytics/azure-ai-textanalytics/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Text Analytics is a cloud-based service that provides advanced natural language
1010
- Key Phrase Extraction
1111
- Multiple Analysis
1212
- Healthcare Entities Analysis
13+
- Extractive Text Summarization
1314

1415
[Source code][source_code] | [Package (PyPI)][ta_pypi] | [API reference documentation][ta_ref_docs] | [Product documentation][ta_product_documentation] | [Samples][ta_samples]
1516

@@ -504,7 +505,7 @@ Note: The Healthcare Entities Analysis service is available in API version v3.1
504505
- Linked Entity Recognition
505506
- Key Phrase Extraction
506507
- Sentiment Analysis
507-
- Extractive Summarization
508+
- Extractive Summarization (see sample [here][extract_summary_sample])
508509

509510
```python
510511
from azure.core.credentials import AzureKeyCredential
@@ -639,6 +640,7 @@ Common scenarios
639640
- Detect language: [sample_detect_language.py][detect_language_sample] ([async version][detect_language_sample_async])
640641
- Healthcare Entities Analysis: [sample_analyze_healthcare_entities.py][analyze_healthcare_entities_sample] ([async version][analyze_healthcare_entities_sample_async])
641642
- Multiple Analysis: [sample_analyze_actions.py][analyze_sample] ([async version][analyze_sample_async])
643+
- Extractive text summarization: [sample_extract_summary.py][extract_summary_sample] ([async version][extract_summary_sample_async])
642644

643645
Advanced scenarios
644646

@@ -734,6 +736,8 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
734736
[analyze_sample_async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_analyze_actions_async.py
735737
[opinion_mining_sample]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/textanalytics/azure-ai-textanalytics/samples/sample_analyze_sentiment_with_opinion_mining.py
736738
[opinion_mining_sample_async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_analyze_sentiment_with_opinion_mining_async.py
739+
[extract_summary_sample]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/textanalytics/azure-ai-textanalytics/samples/sample_extract_summary.py
740+
[extract_summary_sample_async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_extract_summary_async.py
737741
[cla]: https://cla.microsoft.com
738742
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
739743
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/

sdk/textanalytics/azure-ai-textanalytics/samples/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ These sample programs show common scenarios for the Text Analytics client's offe
3030
|[sample_alternative_document_input.py][sample_alternative_document_input] and [sample_alternative_document_input_async.py][sample_alternative_document_input_async]|Pass documents to an endpoint using dicts|
3131
|[sample_analyze_healthcare_entities.py][analyze_healthcare_entities_sample] and [sample_analyze_healthcare_entities_async.py][analyze_healthcare_entities_sample_async]|Analyze healthcare entities|
3232
|[sample_analyze_actions.py][analyze_sample] and [sample_analyze_actions_async.py][analyze_sample_async]|Run multiple analyses together in a single request|
33+
|[sample_extract_summary.py][extract_summary_sample] and [sample_extract_summary_async.py][extract_summary_sample_async]|As part of the analyze API, run extractive text summarization on documents|
3334

3435
## Prerequisites
3536
* Python 2.7, or 3.6 or later is required to use this package (3.6 or later if using asyncio)
@@ -98,6 +99,8 @@ what you can do with the Azure Text Analytics client library.
9899
[analyze_sample_async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_analyze_actions_async.py
99100
[sample_analyze_healthcare_entities_with_cancellation]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/textanalytics/azure-ai-textanalytics/samples/sample_analyze_healthcare_entities_with_cancellation.py
100101
[sample_analyze_healthcare_entities_with_cancellation_async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_analyze_healthcare_entities_with_cancellation_async.py
102+
[extract_summary_sample]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/textanalytics/azure-ai-textanalytics/samples/sample_extract_summary.py
103+
[extract_summary_sample_async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/textanalytics/azure-ai-textanalytics/samples/async_samples/sample_extract_summary_async.py
101104
[pip]: https://pypi.org/project/pip/
102105
[azure_subscription]: https://azure.microsoft.com/free/
103106
[azure_text_analytics_account]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=singleservice%2Cwindows

0 commit comments

Comments
 (0)