From a7c9768d74afc03e4c4e69867075ea475c59efaa Mon Sep 17 00:00:00 2001 From: Jose Arriaga Maldonado Date: Fri, 26 May 2023 15:34:54 -0700 Subject: [PATCH 1/3] Rename ExtractSummary to ExtractiveSummarize --- .../Azure.AI.TextAnalytics/README.md | 4 +- .../Azure.AI.TextAnalytics.netstandard2.0.cs | 112 +++++++-------- .../Azure.AI.TextAnalytics/samples/README.md | 2 +- .../samples/Sample11_ExtractSummary.md | 18 +-- .../src/AnalyzeActionsResult.cs | 10 +- ...Action.cs => ExtractiveSummarizeAction.cs} | 12 +- ....cs => ExtractiveSummarizeActionResult.cs} | 18 +-- ...ion.cs => ExtractiveSummarizeOperation.cs} | 54 +++---- ...tions.cs => ExtractiveSummarizeOptions.cs} | 6 +- ...Result.cs => ExtractiveSummarizeResult.cs} | 10 +- ...=> ExtractiveSummarizeResultCollection.cs} | 18 +-- .../ServiceClients/LanguageServiceClient.cs | 44 +++--- .../src/ServiceClients/LegacyServiceClient.cs | 4 +- .../src/ServiceClients/ServiceClient.cs | 18 +-- .../src/TextAnalyticsActions.cs | 4 +- .../src/TextAnalyticsClient.cs | 50 +++---- .../src/TextAnalyticsModelFactory.cs | 74 +++++----- .../Azure.AI.TextAnalytics/src/Transforms.cs | 34 ++--- .../tests/AnalyzeOperationTests.cs | 4 +- ...ryTests.cs => ExtractiveSummarizeTests.cs} | 136 +++++++++--------- .../AnalyzeOperationExtractiveSummarize.json} | 10 +- ...yzeOperationExtractiveSummarizeAsync.json} | 10 +- ...ummarizeWithAutoDetectedLanguageTest.json} | 16 +-- ...izeWithAutoDetectedLanguageTestAsync.json} | 16 +-- ...ractiveSummarizeBatchConvenienceTest.json} | 0 ...veSummarizeBatchConvenienceTestAsync.json} | 0 ...venienceWithAutoDetectedLanguageTest.json} | 0 ...nceWithAutoDetectedLanguageTestAsync.json} | 0 ...zeBatchConvenienceWithStatisticsTest.json} | 0 ...chConvenienceWithStatisticsTestAsync.json} | 0 .../ExtractiveSummarizeBatchTest.json} | 0 .../ExtractiveSummarizeBatchTestAsync.json} | 0 ...xtractiveSummarizeBatchWithErrorTest.json} | 0 ...tiveSummarizeBatchWithErrorTestAsync.json} | 0 ...ctiveSummarizeBatchWithRankOrderTest.json} | 0 ...SummarizeBatchWithRankOrderTestAsync.json} | 0 ...tiveSummarizeBatchWithStatisticsTest.json} | 0 ...ummarizeBatchWithStatisticsTestAsync.json} | 0 .../ExtractiveSummarizeWithAADTest.json} | 0 .../ExtractiveSummarizeWithAADTestAsync.json} | 0 .../tests/TextAnalyticsClientTests.cs | 10 +- .../tests/TextAnalyticsModelFactoryTests.cs | 10 +- ...ary.cs => Sample11_ExtractiveSummarize.cs} | 12 +- ...s => Sample11_ExtractiveSummarizeAsync.cs} | 12 +- ...ample11_ExtractiveSummarizeConvenience.cs} | 10 +- ...11_ExtractiveSummarizeConvenienceAsync.cs} | 16 +-- 46 files changed, 377 insertions(+), 377 deletions(-) rename sdk/textanalytics/Azure.AI.TextAnalytics/src/{ExtractSummaryAction.cs => ExtractiveSummarizeAction.cs} (90%) rename sdk/textanalytics/Azure.AI.TextAnalytics/src/{ExtractSummaryActionResult.cs => ExtractiveSummarizeActionResult.cs} (59%) rename sdk/textanalytics/Azure.AI.TextAnalytics/src/{ExtractSummaryOperation.cs => ExtractiveSummarizeOperation.cs} (79%) rename sdk/textanalytics/Azure.AI.TextAnalytics/src/{ExtractSummaryOptions.cs => ExtractiveSummarizeOptions.cs} (90%) rename sdk/textanalytics/Azure.AI.TextAnalytics/src/{ExtractSummaryResult.cs => ExtractiveSummarizeResult.cs} (85%) rename sdk/textanalytics/Azure.AI.TextAnalytics/src/{ExtractSummaryResultCollection.cs => ExtractiveSummarizeResultCollection.cs} (73%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/{ExtractSummaryTests.cs => ExtractiveSummarizeTests.cs} (78%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/AnalyzeOperationExtractSummary.json => ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarize.json} (98%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/AnalyzeOperationExtractSummaryAsync.json => ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarizeAsync.json} (98%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/AnalyzeOperationExtractSummaryWithAutoDetectedLanguageTest.json => ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarizeWithAutoDetectedLanguageTest.json} (97%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/AnalyzeOperationExtractSummaryWithAutoDetectedLanguageTestAsync.json => ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarizeWithAutoDetectedLanguageTestAsync.json} (97%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryBatchConvenienceTest.json => ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceTest.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryBatchConvenienceTestAsync.json => ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceTestAsync.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryBatchConvenienceWithAutoDetectedLanguageTest.json => ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceWithAutoDetectedLanguageTest.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryBatchConvenienceWithAutoDetectedLanguageTestAsync.json => ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceWithAutoDetectedLanguageTestAsync.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryBatchConvenienceWithStatisticsTest.json => ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceWithStatisticsTest.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryBatchConvenienceWithStatisticsTestAsync.json => ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceWithStatisticsTestAsync.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryBatchTest.json => ExtractiveSummarizeTests/ExtractiveSummarizeBatchTest.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryBatchTestAsync.json => ExtractiveSummarizeTests/ExtractiveSummarizeBatchTestAsync.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryBatchWithErrorTest.json => ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithErrorTest.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryBatchWithErrorTestAsync.json => ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithErrorTestAsync.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryBatchWithRankOrderTest.json => ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithRankOrderTest.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryBatchWithRankOrderTestAsync.json => ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithRankOrderTestAsync.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryBatchWithStatisticsTest.json => ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithStatisticsTest.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryBatchWithStatisticsTestAsync.json => ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithStatisticsTestAsync.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryWithAADTest.json => ExtractiveSummarizeTests/ExtractiveSummarizeWithAADTest.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{ExtractSummaryTests/ExtractSummaryWithAADTestAsync.json => ExtractiveSummarizeTests/ExtractiveSummarizeWithAADTestAsync.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/{Sample11_ExtractSummary.cs => Sample11_ExtractiveSummarize.cs} (93%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/{Sample11_ExtractSummaryAsync.cs => Sample11_ExtractiveSummarizeAsync.cs} (93%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/{Sample11_ExtractSummaryConvenience.cs => Sample11_ExtractiveSummarizeConvenience.cs} (93%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/{Sample11_ExtractSummaryConvenienceAsync.cs => Sample11_ExtractiveSummarizeConvenienceAsync.cs} (90%) diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/README.md b/sdk/textanalytics/Azure.AI.TextAnalytics/README.md index 1562c79f22bc..0fff560954a7 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/README.md +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/README.md @@ -756,7 +756,7 @@ Samples are provided for each main functional area, and for each area, samples a * [Custom Named Entities Recognition][recognize_custom_entities_sample] * [Custom Single Label Classification][single_category_classify_sample] * [Custom Multi Label Classification][multi_category_classify_sample] -* [Extractive Summarization][extract_summary_sample] +* [Extractive Summarization][extractive_summarize_sample] * [Abstractive Summarization][abstract_summary_sample] ### Advanced samples @@ -823,7 +823,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con [recognize_custom_entities_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample8_RecognizeCustomEntities.md [single_category_classify_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample9_SingleLabelClassify.md [multi_category_classify_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample10_MultiLabelClassify.md -[extract_summary_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractSummary.md +[extractive_summarize_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractiveSummarize.md [abstract_summary_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractSummary.md [azure_cli]: https://docs.microsoft.com/cli/azure diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/api/Azure.AI.TextAnalytics.netstandard2.0.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/api/Azure.AI.TextAnalytics.netstandard2.0.cs index 073297c271e8..c0f48e753bde 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/api/Azure.AI.TextAnalytics.netstandard2.0.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/api/Azure.AI.TextAnalytics.netstandard2.0.cs @@ -129,8 +129,8 @@ internal AnalyzeActionsResult() { } public System.Collections.Generic.IReadOnlyCollection AbstractSummaryResults { get { throw null; } } public System.Collections.Generic.IReadOnlyCollection AnalyzeHealthcareEntitiesResults { get { throw null; } } public System.Collections.Generic.IReadOnlyCollection AnalyzeSentimentResults { get { throw null; } } + public System.Collections.Generic.IReadOnlyCollection ExtractiveSummarizeResults { get { throw null; } } public System.Collections.Generic.IReadOnlyCollection ExtractKeyPhrasesResults { get { throw null; } } - public System.Collections.Generic.IReadOnlyCollection ExtractSummaryResults { get { throw null; } } public System.Collections.Generic.IReadOnlyCollection MultiLabelClassifyResults { get { throw null; } } public System.Collections.Generic.IReadOnlyCollection RecognizeCustomEntitiesResults { get { throw null; } } public System.Collections.Generic.IReadOnlyCollection RecognizeEntitiesResults { get { throw null; } } @@ -476,50 +476,25 @@ internal EntityDataSource() { } public string EntityId { get { throw null; } } public string Name { get { throw null; } } } - public partial class ExtractKeyPhrasesAction - { - public ExtractKeyPhrasesAction() { } - public ExtractKeyPhrasesAction(Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options) { } - public string ActionName { get { throw null; } set { } } - public bool? DisableServiceLogs { get { throw null; } set { } } - public string ModelVersion { get { throw null; } set { } } - } - public partial class ExtractKeyPhrasesActionResult : Azure.AI.TextAnalytics.TextAnalyticsActionResult - { - internal ExtractKeyPhrasesActionResult() { } - public Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection DocumentsResults { get { throw null; } } - } - public partial class ExtractKeyPhrasesResult : Azure.AI.TextAnalytics.TextAnalyticsResult - { - internal ExtractKeyPhrasesResult() { } - public Azure.AI.TextAnalytics.DetectedLanguage? DetectedLanguage { get { throw null; } } - public Azure.AI.TextAnalytics.KeyPhraseCollection KeyPhrases { get { throw null; } } - } - public partial class ExtractKeyPhrasesResultCollection : System.Collections.ObjectModel.ReadOnlyCollection - { - internal ExtractKeyPhrasesResultCollection() : base (default(System.Collections.Generic.IList)) { } - public string ModelVersion { get { throw null; } } - public Azure.AI.TextAnalytics.TextDocumentBatchStatistics Statistics { get { throw null; } } - } - public partial class ExtractSummaryAction + public partial class ExtractiveSummarizeAction { - public ExtractSummaryAction() { } - public ExtractSummaryAction(Azure.AI.TextAnalytics.ExtractSummaryOptions options) { } + public ExtractiveSummarizeAction() { } + public ExtractiveSummarizeAction(Azure.AI.TextAnalytics.ExtractiveSummarizeOptions options) { } public string ActionName { get { throw null; } set { } } public bool? DisableServiceLogs { get { throw null; } set { } } public int? MaxSentenceCount { get { throw null; } set { } } public string ModelVersion { get { throw null; } set { } } public Azure.AI.TextAnalytics.SummarySentencesOrder? OrderBy { get { throw null; } set { } } } - public partial class ExtractSummaryActionResult : Azure.AI.TextAnalytics.TextAnalyticsActionResult + public partial class ExtractiveSummarizeActionResult : Azure.AI.TextAnalytics.TextAnalyticsActionResult { - internal ExtractSummaryActionResult() { } - public Azure.AI.TextAnalytics.ExtractSummaryResultCollection DocumentsResults { get { throw null; } } + internal ExtractiveSummarizeActionResult() { } + public Azure.AI.TextAnalytics.ExtractiveSummarizeResultCollection DocumentsResults { get { throw null; } } } - public partial class ExtractSummaryOperation : Azure.PageableOperation + public partial class ExtractiveSummarizeOperation : Azure.PageableOperation { - protected ExtractSummaryOperation() { } - public ExtractSummaryOperation(string operationId, Azure.AI.TextAnalytics.TextAnalyticsClient client) { } + protected ExtractiveSummarizeOperation() { } + public ExtractiveSummarizeOperation(string operationId, Azure.AI.TextAnalytics.TextAnalyticsClient client) { } public virtual System.DateTimeOffset CreatedOn { get { throw null; } } public virtual string DisplayName { get { throw null; } } public virtual System.DateTimeOffset? ExpiresOn { get { throw null; } } @@ -531,30 +506,55 @@ public ExtractSummaryOperation(string operationId, Azure.AI.TextAnalytics.TextAn public virtual void Cancel(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { } public virtual System.Threading.Tasks.Task CancelAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public override Azure.Response GetRawResponse() { throw null; } - public override Azure.Pageable GetValues(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } - public override Azure.AsyncPageable GetValuesAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public override Azure.Pageable GetValues(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public override Azure.AsyncPageable GetValuesAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public override Azure.Response UpdateStatus(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public override System.Threading.Tasks.ValueTask UpdateStatusAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } - public override System.Threading.Tasks.ValueTask>> WaitForCompletionAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } - public override System.Threading.Tasks.ValueTask>> WaitForCompletionAsync(System.TimeSpan pollingInterval, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public override System.Threading.Tasks.ValueTask>> WaitForCompletionAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public override System.Threading.Tasks.ValueTask>> WaitForCompletionAsync(System.TimeSpan pollingInterval, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } } - public partial class ExtractSummaryOptions : Azure.AI.TextAnalytics.TextAnalyticsRequestOptions + public partial class ExtractiveSummarizeOptions : Azure.AI.TextAnalytics.TextAnalyticsRequestOptions { - public ExtractSummaryOptions() { } + public ExtractiveSummarizeOptions() { } public string DisplayName { get { throw null; } set { } } public int? MaxSentenceCount { get { throw null; } set { } } public Azure.AI.TextAnalytics.SummarySentencesOrder? OrderBy { get { throw null; } set { } } } - public partial class ExtractSummaryResult : Azure.AI.TextAnalytics.TextAnalyticsResult + public partial class ExtractiveSummarizeResult : Azure.AI.TextAnalytics.TextAnalyticsResult { - internal ExtractSummaryResult() { } + internal ExtractiveSummarizeResult() { } public Azure.AI.TextAnalytics.DetectedLanguage? DetectedLanguage { get { throw null; } } public System.Collections.Generic.IReadOnlyCollection Sentences { get { throw null; } } public System.Collections.Generic.IReadOnlyCollection Warnings { get { throw null; } } } - public partial class ExtractSummaryResultCollection : System.Collections.ObjectModel.ReadOnlyCollection + public partial class ExtractiveSummarizeResultCollection : System.Collections.ObjectModel.ReadOnlyCollection { - internal ExtractSummaryResultCollection() : base (default(System.Collections.Generic.IList)) { } + internal ExtractiveSummarizeResultCollection() : base (default(System.Collections.Generic.IList)) { } + public string ModelVersion { get { throw null; } } + public Azure.AI.TextAnalytics.TextDocumentBatchStatistics Statistics { get { throw null; } } + } + public partial class ExtractKeyPhrasesAction + { + public ExtractKeyPhrasesAction() { } + public ExtractKeyPhrasesAction(Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options) { } + public string ActionName { get { throw null; } set { } } + public bool? DisableServiceLogs { get { throw null; } set { } } + public string ModelVersion { get { throw null; } set { } } + } + public partial class ExtractKeyPhrasesActionResult : Azure.AI.TextAnalytics.TextAnalyticsActionResult + { + internal ExtractKeyPhrasesActionResult() { } + public Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection DocumentsResults { get { throw null; } } + } + public partial class ExtractKeyPhrasesResult : Azure.AI.TextAnalytics.TextAnalyticsResult + { + internal ExtractKeyPhrasesResult() { } + public Azure.AI.TextAnalytics.DetectedLanguage? DetectedLanguage { get { throw null; } } + public Azure.AI.TextAnalytics.KeyPhraseCollection KeyPhrases { get { throw null; } } + } + public partial class ExtractKeyPhrasesResultCollection : System.Collections.ObjectModel.ReadOnlyCollection + { + internal ExtractKeyPhrasesResultCollection() : base (default(System.Collections.Generic.IList)) { } public string ModelVersion { get { throw null; } } public Azure.AI.TextAnalytics.TextDocumentBatchStatistics Statistics { get { throw null; } } } @@ -1510,8 +1510,8 @@ public TextAnalyticsActions() { } public System.Collections.Generic.IReadOnlyCollection AnalyzeHealthcareEntitiesActions { get { throw null; } set { } } public System.Collections.Generic.IReadOnlyCollection AnalyzeSentimentActions { get { throw null; } set { } } public string DisplayName { get { throw null; } set { } } + public System.Collections.Generic.IReadOnlyCollection ExtractiveSummarizeActions { get { throw null; } set { } } public System.Collections.Generic.IReadOnlyCollection ExtractKeyPhrasesActions { get { throw null; } set { } } - public System.Collections.Generic.IReadOnlyCollection ExtractSummaryActions { get { throw null; } set { } } public System.Collections.Generic.IReadOnlyCollection MultiLabelClassifyActions { get { throw null; } set { } } public System.Collections.Generic.IReadOnlyCollection RecognizeCustomEntitiesActions { get { throw null; } set { } } public System.Collections.Generic.IReadOnlyCollection RecognizeEntitiesActions { get { throw null; } set { } } @@ -1609,10 +1609,10 @@ public TextAnalyticsClient(System.Uri endpoint, Azure.Core.TokenCredential crede public virtual Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation StartAnalyzeHealthcareEntities(System.Collections.Generic.IEnumerable documents, string language = null, Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public virtual System.Threading.Tasks.Task StartAnalyzeHealthcareEntitiesAsync(System.Collections.Generic.IEnumerable documents, Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public virtual System.Threading.Tasks.Task StartAnalyzeHealthcareEntitiesAsync(System.Collections.Generic.IEnumerable documents, string language = null, Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } - public virtual Azure.AI.TextAnalytics.ExtractSummaryOperation StartExtractSummary(System.Collections.Generic.IEnumerable documents, Azure.AI.TextAnalytics.ExtractSummaryOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } - public virtual Azure.AI.TextAnalytics.ExtractSummaryOperation StartExtractSummary(System.Collections.Generic.IEnumerable documents, string language = null, Azure.AI.TextAnalytics.ExtractSummaryOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } - public virtual System.Threading.Tasks.Task StartExtractSummaryAsync(System.Collections.Generic.IEnumerable documents, Azure.AI.TextAnalytics.ExtractSummaryOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } - public virtual System.Threading.Tasks.Task StartExtractSummaryAsync(System.Collections.Generic.IEnumerable documents, string language = null, Azure.AI.TextAnalytics.ExtractSummaryOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public virtual Azure.AI.TextAnalytics.ExtractiveSummarizeOperation StartExtractiveSummarize(System.Collections.Generic.IEnumerable documents, Azure.AI.TextAnalytics.ExtractiveSummarizeOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public virtual Azure.AI.TextAnalytics.ExtractiveSummarizeOperation StartExtractiveSummarize(System.Collections.Generic.IEnumerable documents, string language = null, Azure.AI.TextAnalytics.ExtractiveSummarizeOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public virtual System.Threading.Tasks.Task StartExtractiveSummarizeAsync(System.Collections.Generic.IEnumerable documents, Azure.AI.TextAnalytics.ExtractiveSummarizeOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public virtual System.Threading.Tasks.Task StartExtractiveSummarizeAsync(System.Collections.Generic.IEnumerable documents, string language = null, Azure.AI.TextAnalytics.ExtractiveSummarizeOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public virtual Azure.AI.TextAnalytics.ClassifyDocumentOperation StartMultiLabelClassify(System.Collections.Generic.IEnumerable documents, string projectName, string deploymentName, Azure.AI.TextAnalytics.MultiLabelClassifyOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public virtual Azure.AI.TextAnalytics.ClassifyDocumentOperation StartMultiLabelClassify(System.Collections.Generic.IEnumerable documents, string projectName, string deploymentName, string language = null, Azure.AI.TextAnalytics.MultiLabelClassifyOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public virtual System.Threading.Tasks.Task StartMultiLabelClassifyAsync(System.Collections.Generic.IEnumerable documents, string projectName, string deploymentName, Azure.AI.TextAnalytics.MultiLabelClassifyOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } @@ -1702,7 +1702,7 @@ public static partial class TextAnalyticsModelFactory public static Azure.AI.TextAnalytics.AnalyzeActionsResult AnalyzeActionsResult(System.Collections.Generic.IEnumerable extractKeyPhrasesActionResults, System.Collections.Generic.IEnumerable recognizeEntitiesActionResults, System.Collections.Generic.IEnumerable recognizePiiEntitiesActionResults, System.Collections.Generic.IEnumerable recognizeLinkedEntitiesActionResults, System.Collections.Generic.IEnumerable analyzeSentimentActionResults, System.Collections.Generic.IEnumerable recognizeCustomEntitiesActionResults, System.Collections.Generic.IEnumerable singleLabelClassifyActionResults, System.Collections.Generic.IEnumerable multiLabelClassifyActionResults) { throw null; } [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)] public static Azure.AI.TextAnalytics.AnalyzeActionsResult AnalyzeActionsResult(System.Collections.Generic.IEnumerable extractKeyPhrasesActionResults, System.Collections.Generic.IEnumerable recognizeEntitiesActionResults, System.Collections.Generic.IEnumerable recognizePiiEntitiesActionResults, System.Collections.Generic.IEnumerable recognizeLinkedEntitiesActionResults, System.Collections.Generic.IEnumerable analyzeSentimentActionResults, System.Collections.Generic.IEnumerable recognizeCustomEntitiesActionResults, System.Collections.Generic.IEnumerable singleLabelClassifyActionResults, System.Collections.Generic.IEnumerable multiLabelClassifyActionResults, System.Collections.Generic.IEnumerable analyzeHealthcareEntitiesActionResults) { throw null; } - public static Azure.AI.TextAnalytics.AnalyzeActionsResult AnalyzeActionsResult(System.Collections.Generic.IEnumerable extractKeyPhrasesActionResults, System.Collections.Generic.IEnumerable recognizeEntitiesActionResults, System.Collections.Generic.IEnumerable recognizePiiEntitiesActionResults, System.Collections.Generic.IEnumerable recognizeLinkedEntitiesActionResults, System.Collections.Generic.IEnumerable analyzeSentimentActionResults, System.Collections.Generic.IEnumerable recognizeCustomEntitiesActionResults, System.Collections.Generic.IEnumerable singleLabelClassifyActionResults, System.Collections.Generic.IEnumerable multiLabelClassifyActionResults, System.Collections.Generic.IEnumerable analyzeHealthcareEntitiesActionResults, System.Collections.Generic.IEnumerable extractSummaryActionResults, System.Collections.Generic.IEnumerable abstractSummaryActionResults) { throw null; } + public static Azure.AI.TextAnalytics.AnalyzeActionsResult AnalyzeActionsResult(System.Collections.Generic.IEnumerable extractKeyPhrasesActionResults, System.Collections.Generic.IEnumerable recognizeEntitiesActionResults, System.Collections.Generic.IEnumerable recognizePiiEntitiesActionResults, System.Collections.Generic.IEnumerable recognizeLinkedEntitiesActionResults, System.Collections.Generic.IEnumerable analyzeSentimentActionResults, System.Collections.Generic.IEnumerable recognizeCustomEntitiesActionResults, System.Collections.Generic.IEnumerable singleLabelClassifyActionResults, System.Collections.Generic.IEnumerable multiLabelClassifyActionResults, System.Collections.Generic.IEnumerable analyzeHealthcareEntitiesActionResults, System.Collections.Generic.IEnumerable extractiveSummarizeActionResults, System.Collections.Generic.IEnumerable abstractSummaryActionResults) { throw null; } public static Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesActionResult AnalyzeHealthcareEntitiesActionResult(Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesResultCollection result, string actionName, System.DateTimeOffset completedOn) { throw null; } public static Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesActionResult AnalyzeHealthcareEntitiesActionResult(string actionName, System.DateTimeOffset completedOn, string code, string message) { throw null; } public static Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesResult AnalyzeHealthcareEntitiesResult(string id, Azure.AI.TextAnalytics.TextDocumentStatistics statistics, System.Collections.Generic.IEnumerable healthcareEntities, System.Collections.Generic.IEnumerable entityRelations, System.BinaryData fhirBundle, string detectedLanguage, System.Collections.Generic.IEnumerable warnings) { throw null; } @@ -1746,6 +1746,11 @@ public static partial class TextAnalyticsModelFactory public static Azure.AI.TextAnalytics.DetectLanguageResultCollection DetectLanguageResultCollection(System.Collections.Generic.IEnumerable list, Azure.AI.TextAnalytics.TextDocumentBatchStatistics statistics, string modelVersion) { throw null; } public static Azure.AI.TextAnalytics.DocumentSentiment DocumentSentiment(Azure.AI.TextAnalytics.TextSentiment sentiment, double positiveScore, double neutralScore, double negativeScore, System.Collections.Generic.List sentenceSentiments, System.Collections.Generic.IList warnings = null) { throw null; } public static Azure.AI.TextAnalytics.EntityDataSource EntityDataSource(string name = null, string entityId = null) { throw null; } + public static Azure.AI.TextAnalytics.ExtractiveSummarizeActionResult ExtractiveSummarizeActionResult(Azure.AI.TextAnalytics.ExtractiveSummarizeResultCollection result, string actionName, System.DateTimeOffset completedOn) { throw null; } + public static Azure.AI.TextAnalytics.ExtractiveSummarizeActionResult ExtractiveSummarizeActionResult(string actionName, System.DateTimeOffset completedOn, string code, string message) { throw null; } + public static Azure.AI.TextAnalytics.ExtractiveSummarizeResult ExtractiveSummarizeResult(string id, Azure.AI.TextAnalytics.TextDocumentStatistics statistics, System.Collections.Generic.IEnumerable sentences, Azure.AI.TextAnalytics.DetectedLanguage? detectedLanguage = default(Azure.AI.TextAnalytics.DetectedLanguage?), System.Collections.Generic.IEnumerable warnings = null) { throw null; } + public static Azure.AI.TextAnalytics.ExtractiveSummarizeResult ExtractiveSummarizeResult(string id, string code, string message) { throw null; } + public static Azure.AI.TextAnalytics.ExtractiveSummarizeResultCollection ExtractiveSummarizeResultCollection(System.Collections.Generic.IEnumerable results, Azure.AI.TextAnalytics.TextDocumentBatchStatistics statistics, string modelVersion) { throw null; } [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)] public static Azure.AI.TextAnalytics.ExtractKeyPhrasesActionResult ExtractKeyPhrasesActionResult(Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection result, System.DateTimeOffset completedOn) { throw null; } public static Azure.AI.TextAnalytics.ExtractKeyPhrasesActionResult ExtractKeyPhrasesActionResult(Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection result, string actionName, System.DateTimeOffset completedOn) { throw null; } @@ -1757,11 +1762,6 @@ public static partial class TextAnalyticsModelFactory public static Azure.AI.TextAnalytics.ExtractKeyPhrasesResult ExtractKeyPhrasesResult(string id, Azure.AI.TextAnalytics.TextDocumentStatistics statistics, Azure.AI.TextAnalytics.KeyPhraseCollection keyPhrases) { throw null; } public static Azure.AI.TextAnalytics.ExtractKeyPhrasesResult ExtractKeyPhrasesResult(string id, Azure.AI.TextAnalytics.TextDocumentStatistics statistics, Azure.AI.TextAnalytics.KeyPhraseCollection keyPhrases, Azure.AI.TextAnalytics.DetectedLanguage? detectedLanguage = default(Azure.AI.TextAnalytics.DetectedLanguage?)) { throw null; } public static Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection ExtractKeyPhrasesResultCollection(System.Collections.Generic.IEnumerable list, Azure.AI.TextAnalytics.TextDocumentBatchStatistics statistics, string modelVersion) { throw null; } - public static Azure.AI.TextAnalytics.ExtractSummaryActionResult ExtractSummaryActionResult(Azure.AI.TextAnalytics.ExtractSummaryResultCollection result, string actionName, System.DateTimeOffset completedOn) { throw null; } - public static Azure.AI.TextAnalytics.ExtractSummaryActionResult ExtractSummaryActionResult(string actionName, System.DateTimeOffset completedOn, string code, string message) { throw null; } - public static Azure.AI.TextAnalytics.ExtractSummaryResult ExtractSummaryResult(string id, Azure.AI.TextAnalytics.TextDocumentStatistics statistics, System.Collections.Generic.IEnumerable sentences, Azure.AI.TextAnalytics.DetectedLanguage? detectedLanguage = default(Azure.AI.TextAnalytics.DetectedLanguage?), System.Collections.Generic.IEnumerable warnings = null) { throw null; } - public static Azure.AI.TextAnalytics.ExtractSummaryResult ExtractSummaryResult(string id, string code, string message) { throw null; } - public static Azure.AI.TextAnalytics.ExtractSummaryResultCollection ExtractSummaryResultCollection(System.Collections.Generic.IEnumerable results, Azure.AI.TextAnalytics.TextDocumentBatchStatistics statistics, string modelVersion) { throw null; } public static Azure.AI.TextAnalytics.HealthcareEntity HealthcareEntity(string text, string category, int offset, int length, double confidenceScore) { throw null; } public static Azure.AI.TextAnalytics.HealthcareEntityAssertion HealthcareEntityAssertion(Azure.AI.TextAnalytics.EntityConditionality? conditionality = default(Azure.AI.TextAnalytics.EntityConditionality?), Azure.AI.TextAnalytics.EntityCertainty? certainty = default(Azure.AI.TextAnalytics.EntityCertainty?), Azure.AI.TextAnalytics.EntityAssociation? association = default(Azure.AI.TextAnalytics.EntityAssociation?)) { throw null; } [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)] diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md b/sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md index f15c5a03b6ce..5a4bb9b16176 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md @@ -40,7 +40,7 @@ See the [README][README] of the Text Analytics client library for more informati * [Custom Named Entity Recognition](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample8_RecognizeCustomEntities.md) * [Custom Single Label Classification](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample9_SingleLabelClassify.md) * [Custom Multi Label Classification](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample10_MultiLabelClassify.md) -* [Extractive Summarization](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractSummary.md) +* [Extractive Summarization](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractiveSummarize.md) * [Abstractive Summarization](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractSummary.md) ## Advanced samples diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractSummary.md b/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractSummary.md index 2f454cc83ad2..a2cbe2b3d672 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractSummary.md +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractSummary.md @@ -16,9 +16,9 @@ The values of the `endpoint` and `apiKey` variables can be retrieved from enviro ## Summarize one or more documents -To summarize one or more text documents using extractive summarization, call `StartExtractSummary` on the `TextAnalyticsClient` by passing the documents as either an `IEnumerable` parameter or an `IEnumerable` parameter. This returns an `ExtractSummaryOperation`. +To summarize one or more text documents using extractive summarization, call `StartExtractiveSummarize` on the `TextAnalyticsClient` by passing the documents as either an `IEnumerable` parameter or an `IEnumerable` parameter. This returns an `ExtractiveSummarizeOperation`. -```C# Snippet:Sample11_ExtractSummaryConvenienceAsync +```C# Snippet:Sample11_ExtractiveSummarizeConvenienceAsync string document = "Windows 365 was in the works before COVID-19 sent companies around the world on a scramble to secure" + " solutions to support employees suddenly forced to work from home, but “what really put the" @@ -64,13 +64,13 @@ List batchedDocuments = new() }; // Perform the text analysis operation. -ExtractSummaryOperation operation = client.StartExtractSummary(batchedDocuments); +ExtractiveSummarizeOperation operation = client.StartExtractiveSummarize(batchedDocuments); await operation.WaitForCompletionAsync(); ``` -The `ExtractSummaryOperation` includes general information about the status of the long-running operation, and it can be queried at any time: +The `ExtractiveSummarizeOperation` includes general information about the status of the long-running operation, and it can be queried at any time: -```C# Snippet:Sample11_ExtractSummaryConvenienceAsync_ViewOperationStatus +```C# Snippet:Sample11_ExtractiveSummarizeConvenienceAsync_ViewOperationStatus // View the operation status. Console.WriteLine($"Created On : {operation.CreatedOn}"); Console.WriteLine($"Expires On : {operation.ExpiresOn}"); @@ -82,14 +82,14 @@ Console.WriteLine(); Once the long-running operation has completed, you can view the results of the extractive summarization, including any errors that might have occurred: -```C# Snippet:Sample11_ExtractSummaryConvenienceAsync_ViewResults +```C# Snippet:Sample11_ExtractiveSummarizeConvenienceAsync_ViewResults // View the operation results. -await foreach (ExtractSummaryResultCollection documentsInPage in operation.Value) +await foreach (ExtractiveSummarizeResultCollection documentsInPage in operation.Value) { - Console.WriteLine($"Extract Summary, version: \"{documentsInPage.ModelVersion}\""); + Console.WriteLine($"Extractive Summarize, version: \"{documentsInPage.ModelVersion}\""); Console.WriteLine(); - foreach (ExtractSummaryResult documentResult in documentsInPage) + foreach (ExtractiveSummarizeResult documentResult in documentsInPage) { if (documentResult.HasError) { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeActionsResult.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeActionsResult.cs index 3e2e92e9d9f0..f3aae4aca036 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeActionsResult.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeActionsResult.cs @@ -21,7 +21,7 @@ internal AnalyzeActionsResult( IReadOnlyCollection singleLabelClassifyActionResults, IReadOnlyCollection multiLabelClassifyActionResults, IReadOnlyCollection analyzeHealthcareEntitiesActionResults, - IReadOnlyCollection extractSummaryActionResults, + IReadOnlyCollection extractiveSummarizeActionResults, IReadOnlyCollection abstractSummaryActionResults ) { @@ -34,7 +34,7 @@ IReadOnlyCollection abstractSummaryActionResults SingleLabelClassifyResults = singleLabelClassifyActionResults; MultiLabelClassifyResults = multiLabelClassifyActionResults; AnalyzeHealthcareEntitiesResults = analyzeHealthcareEntitiesActionResults; - ExtractSummaryResults = extractSummaryActionResults; + ExtractiveSummarizeResults = extractiveSummarizeActionResults; AbstractSummaryResults = abstractSummaryActionResults; } @@ -55,7 +55,7 @@ IReadOnlyCollection analyzeSentimentActionResults MultiLabelClassifyResults = Array.Empty(); RecognizeCustomEntitiesResults = Array.Empty(); AnalyzeHealthcareEntitiesResults = Array.Empty(); - ExtractSummaryResults = Array.Empty(); + ExtractiveSummarizeResults = Array.Empty(); AbstractSummaryResults = Array.Empty(); } @@ -105,9 +105,9 @@ IReadOnlyCollection analyzeSentimentActionResults public IReadOnlyCollection AnalyzeHealthcareEntitiesResults { get; } /// - /// Determines the collection of . + /// Determines the collection of . /// - public IReadOnlyCollection ExtractSummaryResults { get; } + public IReadOnlyCollection ExtractiveSummarizeResults { get; } /// /// Determines the collection of . diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryAction.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeAction.cs similarity index 90% rename from sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryAction.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeAction.cs index 087cf5b6c577..34b38ca1bc4c 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryAction.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeAction.cs @@ -7,20 +7,20 @@ namespace Azure.AI.TextAnalytics /// A set of options used to configure extractive summarization, including the model version to use, the maximum /// number of sentences to extract, and more. /// - public class ExtractSummaryAction + public class ExtractiveSummarizeAction { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// - public ExtractSummaryAction() + public ExtractiveSummarizeAction() { } /// - /// Initializes a new instance of the class based on the given - /// . + /// Initializes a new instance of the class based on the given + /// . /// - public ExtractSummaryAction(ExtractSummaryOptions options) + public ExtractiveSummarizeAction(ExtractiveSummarizeOptions options) { ModelVersion = options.ModelVersion; DisableServiceLogs = options.DisableServiceLogs; diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryActionResult.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeActionResult.cs similarity index 59% rename from sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryActionResult.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeActionResult.cs index 57c2be7278f6..220ef83ef963 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryActionResult.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeActionResult.cs @@ -7,33 +7,33 @@ namespace Azure.AI.TextAnalytics { /// - /// A representation of the result of performing an on a given set of + /// A representation of the result of performing an on a given set of /// documents. /// - public class ExtractSummaryActionResult : TextAnalyticsActionResult + public class ExtractiveSummarizeActionResult : TextAnalyticsActionResult { - private readonly ExtractSummaryResultCollection _documentsResults; + private readonly ExtractiveSummarizeResultCollection _documentsResults; /// - /// Initializes a successful . + /// Initializes a successful . /// - internal ExtractSummaryActionResult( - ExtractSummaryResultCollection result, string actionName, DateTimeOffset completedOn) + internal ExtractiveSummarizeActionResult( + ExtractiveSummarizeResultCollection result, string actionName, DateTimeOffset completedOn) : base(actionName, completedOn) { _documentsResults = result; } /// - /// Initializes an with an error. + /// Initializes an with an error. /// - internal ExtractSummaryActionResult(string actionName, DateTimeOffset completedOn, Error error) + internal ExtractiveSummarizeActionResult(string actionName, DateTimeOffset completedOn, Error error) : base(actionName, completedOn, error) { } /// /// The collection of results corresponding to each input document. /// - public ExtractSummaryResultCollection DocumentsResults + public ExtractiveSummarizeResultCollection DocumentsResults { get { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryOperation.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeOperation.cs similarity index 79% rename from sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryOperation.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeOperation.cs index 165f99bece20..410aade83a29 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryOperation.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeOperation.cs @@ -17,8 +17,8 @@ namespace Azure.AI.TextAnalytics /// A representation of extractive summarization being performed on a given set of documents as a pageable, /// long-running operation. /// - public class ExtractSummaryOperation - : PageableOperation, IOperation> + public class ExtractiveSummarizeOperation + : PageableOperation, IOperation> { internal readonly IDictionary _idToIndexMap; @@ -26,14 +26,14 @@ public class ExtractSummaryOperation private readonly string _jobId; private readonly ServiceClient _serviceClient; private readonly ClientDiagnostics _diagnostics; - private readonly OperationInternal> _operationInternal; + private readonly OperationInternal> _operationInternal; private TextAnalyticsOperationStatus _status; private DateTimeOffset? _expiresOn; private DateTimeOffset _lastModified; private DateTimeOffset _createdOn; private string _displayName; - private Page _firstPage; + private Page _firstPage; /// /// The identifier of the long-running operation, which can be used to poll its current status. @@ -76,7 +76,7 @@ public class ExtractSummaryOperation public override bool HasValue => _operationInternal.HasValue; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// /// The identifier of the long-running operation. /// The client used to check for completion. @@ -87,7 +87,7 @@ public class ExtractSummaryOperation /// /// or is null. /// - public ExtractSummaryOperation(string operationId, TextAnalyticsClient client) + public ExtractiveSummarizeOperation(string operationId, TextAnalyticsClient client) { Argument.AssertNotNullOrEmpty(operationId, nameof(operationId)); Argument.AssertNotNull(client, nameof(client)); @@ -102,7 +102,7 @@ public ExtractSummaryOperation(string operationId, TextAnalyticsClient client) } catch (Exception e) { - throw new ArgumentException($"Invalid value. Please use the {nameof(ExtractSummaryOperation)}.{nameof(Id)} property value.", nameof(operationId), e); + throw new ArgumentException($"Invalid value. Please use the {nameof(ExtractiveSummarizeOperation)}.{nameof(Id)} property value.", nameof(operationId), e); } Id = operationId; @@ -112,9 +112,9 @@ public ExtractSummaryOperation(string operationId, TextAnalyticsClient client) } /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// - internal ExtractSummaryOperation( + internal ExtractiveSummarizeOperation( ServiceClient serviceClient, ClientDiagnostics diagnostics, string operationLocation, @@ -133,10 +133,10 @@ internal ExtractSummaryOperation( } /// - /// Initializes a new instance of the class. This constructor is only + /// Initializes a new instance of the class. This constructor is only /// intended for mocking. /// - protected ExtractSummaryOperation() + protected ExtractiveSummarizeOperation() { } @@ -144,7 +144,7 @@ protected ExtractSummaryOperation() /// Gets the last HTTP response received from the server associated with this long-running operation. /// /// - /// An instance of the class sends requests to the server via methods + /// An instance of the class sends requests to the server via methods /// such as , , etc. /// public override Response GetRawResponse() => _operationInternal.RawResponse; @@ -182,7 +182,7 @@ public override async ValueTask UpdateStatusAsync(CancellationToken ca /// /// The controlling the lifetime of the request. /// The HTTP response received from the server. - public override async ValueTask>> WaitForCompletionAsync(CancellationToken cancellationToken = default) => + public override async ValueTask>> WaitForCompletionAsync(CancellationToken cancellationToken = default) => await _operationInternal.WaitForCompletionAsync(cancellationToken).ConfigureAwait(false); /// @@ -197,7 +197,7 @@ public override async ValueTask /// The controlling the lifetime of the request. /// The HTTP response received from the server. - public override async ValueTask>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken cancellationToken = default) => + public override async ValueTask>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken cancellationToken = default) => await _operationInternal.WaitForCompletionAsync(pollingInterval, cancellationToken).ConfigureAwait(false); /// @@ -221,15 +221,15 @@ public virtual async Task CancelAsync(CancellationToken cancellationToken = defa /// The operation must have completed successfully (i.e., is true). /// /// The controlling the lifetime of the request. - public override Pageable GetValues(CancellationToken cancellationToken = default) + public override Pageable GetValues(CancellationToken cancellationToken = default) { // Validates that the operation has completed successfully. _ = _operationInternal.Value; - Page NextPageFunc(string nextLink, int? pageSizeHint) + Page NextPageFunc(string nextLink, int? pageSizeHint) { var response = _serviceClient.AnalyzeTextJobStatusNextPage(nextLink, pageSizeHint, _idToIndexMap, cancellationToken); - return Page.FromValues(new List() { Transforms.ConvertToExtractSummaryResultCollection(response.Value, _idToIndexMap) }, response.Value.NextLink, response.GetRawResponse()); + return Page.FromValues(new List() { Transforms.ConvertToExtractiveSummarizeResultCollection(response.Value, _idToIndexMap) }, response.Value.NextLink, response.GetRawResponse()); } return PageableHelpers.CreateEnumerable(_ => _firstPage, NextPageFunc); @@ -242,25 +242,25 @@ Page NextPageFunc(string nextLink, int? pageSize /// The operation must have completed successfully (i.e., is true). /// /// The controlling the lifetime of the request. - public override AsyncPageable GetValuesAsync(CancellationToken cancellationToken = default) + public override AsyncPageable GetValuesAsync(CancellationToken cancellationToken = default) { // Validates that the operation has completed successfully. _ = _operationInternal.Value; return CreateOperationValueAsync(cancellationToken); } - private AsyncPageable CreateOperationValueAsync(CancellationToken cancellationToken = default) + private AsyncPageable CreateOperationValueAsync(CancellationToken cancellationToken = default) { - async Task> NextPageFunc(string nextLink, int? pageSizeHint) + async Task> NextPageFunc(string nextLink, int? pageSizeHint) { var response = await _serviceClient.AnalyzeTextJobStatusNextPageAsync(nextLink, pageSizeHint, _idToIndexMap, cancellationToken).ConfigureAwait(false); - return Page.FromValues(new List() { Transforms.ConvertToExtractSummaryResultCollection(response.Value, _idToIndexMap) }, response.Value.NextLink, response.GetRawResponse()); + return Page.FromValues(new List() { Transforms.ConvertToExtractiveSummarizeResultCollection(response.Value, _idToIndexMap) }, response.Value.NextLink, response.GetRawResponse()); } return PageableHelpers.CreateAsyncEnumerable(_ => Task.FromResult(_firstPage), NextPageFunc); } - async ValueTask>> IOperation>.UpdateStateAsync(bool async, CancellationToken cancellationToken) + async ValueTask>> IOperation>.UpdateStateAsync(bool async, CancellationToken cancellationToken) { Response response = async ? await _serviceClient.AnalyzeTextJobStatusAsync(_jobId, _showStats, null, null, _idToIndexMap, cancellationToken).ConfigureAwait(false) @@ -277,22 +277,22 @@ async ValueTask>> I if (response.Value.Status == TextAnalyticsOperationStatus.Succeeded) { string nextLink = response.Value.NextLink; - _firstPage = Page.FromValues(new List() { Transforms.ConvertToExtractSummaryResultCollection(response.Value, _idToIndexMap) }, nextLink, rawResponse); + _firstPage = Page.FromValues(new List() { Transforms.ConvertToExtractiveSummarizeResultCollection(response.Value, _idToIndexMap) }, nextLink, rawResponse); - return OperationState>.Success(rawResponse, CreateOperationValueAsync(CancellationToken.None)); + return OperationState>.Success(rawResponse, CreateOperationValueAsync(CancellationToken.None)); } if (response.Value.Status == TextAnalyticsOperationStatus.Running || response.Value.Status == TextAnalyticsOperationStatus.NotStarted || response.Value.Status == TextAnalyticsOperationStatus.Cancelling) { - return OperationState>.Pending(rawResponse); + return OperationState>.Pending(rawResponse); } if (response.Value.Status == TextAnalyticsOperationStatus.Cancelled) { - return OperationState>.Failure(rawResponse, new RequestFailedException("The operation was canceled so no value is available.")); + return OperationState>.Failure(rawResponse, new RequestFailedException("The operation was canceled so no value is available.")); } - return OperationState>.Failure(rawResponse, new RequestFailedException(rawResponse)); + return OperationState>.Failure(rawResponse, new RequestFailedException(rawResponse)); } } } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryOptions.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeOptions.cs similarity index 90% rename from sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryOptions.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeOptions.cs index 5b14355c2df6..29fcc6370ad6 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryOptions.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeOptions.cs @@ -7,12 +7,12 @@ namespace Azure.AI.TextAnalytics /// A set of options used to configure extractive summarization, including the display name to use, the maximum /// number of sentences to extract, and more. /// - public class ExtractSummaryOptions : TextAnalyticsRequestOptions + public class ExtractiveSummarizeOptions : TextAnalyticsRequestOptions { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// - public ExtractSummaryOptions() + public ExtractiveSummarizeOptions() { } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryResult.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeResult.cs similarity index 85% rename from sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryResult.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeResult.cs index 6ae803dd0a36..df8400472e09 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryResult.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeResult.cs @@ -10,14 +10,14 @@ namespace Azure.AI.TextAnalytics /// /// A representation of the result of performing extractive summarization on a given document. /// - public partial class ExtractSummaryResult : TextAnalyticsResult + public partial class ExtractiveSummarizeResult : TextAnalyticsResult { private readonly IReadOnlyCollection _sentences; /// - /// Initializes a successful . + /// Initializes a successful . /// - internal ExtractSummaryResult( + internal ExtractiveSummarizeResult( string id, TextDocumentStatistics statistics, IList sentences, @@ -37,9 +37,9 @@ internal ExtractSummaryResult( } /// - /// Initializes an with an error. + /// Initializes an with an error. /// - internal ExtractSummaryResult(string id, TextAnalyticsError error) : base(id, error) { } + internal ExtractiveSummarizeResult(string id, TextAnalyticsError error) : base(id, error) { } /// /// The warnings that resulted from processing the document. diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryResultCollection.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeResultCollection.cs similarity index 73% rename from sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryResultCollection.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeResultCollection.cs index 73d518e0bf9d..321c3075379d 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractSummaryResultCollection.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ExtractiveSummarizeResultCollection.cs @@ -11,13 +11,13 @@ namespace Azure.AI.TextAnalytics /// /// A collection of the results of performing extractive summarization on a given set of documents. /// - [DebuggerTypeProxy(typeof(ExtractSummaryResultCollectionDebugView))] - public class ExtractSummaryResultCollection : ReadOnlyCollection + [DebuggerTypeProxy(typeof(ExtractiveSummarizeResultCollectionDebugView))] + public class ExtractiveSummarizeResultCollection : ReadOnlyCollection { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// - internal ExtractSummaryResultCollection(IList list, TextDocumentBatchStatistics statistics, string modelVersion) : base(list) + internal ExtractiveSummarizeResultCollection(IList list, TextDocumentBatchStatistics statistics, string modelVersion) : base(list) { Statistics = statistics; ModelVersion = modelVersion; @@ -39,19 +39,19 @@ internal ExtractSummaryResultCollection(IList list, TextDo public string ModelVersion { get; } /// - /// A debugger proxy for the class. + /// A debugger proxy for the class. /// - internal class ExtractSummaryResultCollectionDebugView + internal class ExtractiveSummarizeResultCollectionDebugView { - private ExtractSummaryResultCollection BaseCollection { get; } + private ExtractiveSummarizeResultCollection BaseCollection { get; } - public ExtractSummaryResultCollectionDebugView(ExtractSummaryResultCollection collection) + public ExtractiveSummarizeResultCollectionDebugView(ExtractiveSummarizeResultCollection collection) { BaseCollection = collection; } [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)] - public List Items + public List Items { get { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LanguageServiceClient.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LanguageServiceClient.cs index 00d49c341949..bc8c0a45ae5e 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LanguageServiceClient.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LanguageServiceClient.cs @@ -1849,9 +1849,9 @@ private IList CreateTasks(TextAnalyticsActions actions) { analyzeTasks.AddRange(Transforms.ConvertFromAnalyzeHealthcareEntitiesActionsToTasks(actions.AnalyzeHealthcareEntitiesActions)); } - if (actions.ExtractSummaryActions != null) + if (actions.ExtractiveSummarizeActions != null) { - analyzeTasks.AddRange(Transforms.ConvertFromExtractSummaryActionsToTasks(actions.ExtractSummaryActions)); + analyzeTasks.AddRange(Transforms.ConvertFromExtractiveSummarizeActionsToTasks(actions.ExtractiveSummarizeActions)); } if (actions.AbstractSummaryActions != null) { @@ -1859,9 +1859,9 @@ private IList CreateTasks(TextAnalyticsActions actions) } // Validate supported version. - if (actions.ExtractSummaryActions != null && actions.ExtractSummaryActions.Count > 0) + if (actions.ExtractiveSummarizeActions != null && actions.ExtractiveSummarizeActions.Count > 0) { - Validation.SupportsOperation(nameof(ExtractSummaryAction), TextAnalyticsClientOptions.ServiceVersion.V2022_10_01_Preview, ServiceVersion); + Validation.SupportsOperation(nameof(ExtractiveSummarizeAction), TextAnalyticsClientOptions.ServiceVersion.V2022_10_01_Preview, ServiceVersion); } return analyzeTasks; @@ -2079,41 +2079,41 @@ private async Task StartMultiLabelClassifyAsync(Multi #endregion - #region Extract Summary + #region Extractive Summarize - public override ExtractSummaryOperation StartExtractSummary(IEnumerable documents, string language = default, ExtractSummaryOptions options = default, CancellationToken cancellationToken = default) + public override ExtractiveSummarizeOperation StartExtractiveSummarize(IEnumerable documents, string language = default, ExtractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { Argument.AssertNotNullOrEmpty(documents, nameof(documents)); MultiLanguageAnalysisInput input = ConvertToMultiLanguageInputs(documents, language); - return StartExtractSummary(input, options, cancellationToken); + return StartExtractiveSummarize(input, options, cancellationToken); } - public override ExtractSummaryOperation StartExtractSummary(IEnumerable documents, ExtractSummaryOptions options = default, CancellationToken cancellationToken = default) + public override ExtractiveSummarizeOperation StartExtractiveSummarize(IEnumerable documents, ExtractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { Argument.AssertNotNullOrEmpty(documents, nameof(documents)); MultiLanguageAnalysisInput input = ConvertToMultiLanguageInputs(documents); - return StartExtractSummary(input, options, cancellationToken); + return StartExtractiveSummarize(input, options, cancellationToken); } - public override async Task StartExtractSummaryAsync(IEnumerable documents, string language = default, ExtractSummaryOptions options = default, CancellationToken cancellationToken = default) + public override async Task StartExtractiveSummarizeAsync(IEnumerable documents, string language = default, ExtractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { Argument.AssertNotNullOrEmpty(documents, nameof(documents)); MultiLanguageAnalysisInput input = ConvertToMultiLanguageInputs(documents, language); - return await StartExtractSummaryAsync(input, options, cancellationToken).ConfigureAwait(false); + return await StartExtractiveSummarizeAsync(input, options, cancellationToken).ConfigureAwait(false); } - public override async Task StartExtractSummaryAsync(IEnumerable documents, ExtractSummaryOptions options = default, CancellationToken cancellationToken = default) + public override async Task StartExtractiveSummarizeAsync(IEnumerable documents, ExtractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { Argument.AssertNotNullOrEmpty(documents, nameof(documents)); MultiLanguageAnalysisInput input = ConvertToMultiLanguageInputs(documents); - return await StartExtractSummaryAsync(input, options, cancellationToken).ConfigureAwait(false); + return await StartExtractiveSummarizeAsync(input, options, cancellationToken).ConfigureAwait(false); } - private static ExtractiveSummarizationLROTask CreateExtractiveSummarizationTask(ExtractSummaryOptions options) + private static ExtractiveSummarizationLROTask CreateExtractiveSummarizationTask(ExtractiveSummarizeOptions options) { return new ExtractiveSummarizationLROTask() { @@ -2128,11 +2128,11 @@ private static ExtractiveSummarizationLROTask CreateExtractiveSummarizationTask( }; } - private ExtractSummaryOperation StartExtractSummary(MultiLanguageAnalysisInput multiLanguageInput, ExtractSummaryOptions options, CancellationToken cancellationToken) + private ExtractiveSummarizeOperation StartExtractiveSummarize(MultiLanguageAnalysisInput multiLanguageInput, ExtractiveSummarizeOptions options, CancellationToken cancellationToken) { - options ??= new ExtractSummaryOptions(); + options ??= new ExtractiveSummarizeOptions(); - using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TextAnalyticsClient)}.{nameof(StartExtractSummary)}"); + using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TextAnalyticsClient)}.{nameof(StartExtractiveSummarize)}"); scope.Start(); try @@ -2146,7 +2146,7 @@ private ExtractSummaryOperation StartExtractSummary(MultiLanguageAnalysisInput m string location = response.Headers.OperationLocation; IDictionary idToIndexMap = CreateIdToIndexMap(multiLanguageInput.Documents); - return new ExtractSummaryOperation(this, _clientDiagnostics, location, idToIndexMap, options.IncludeStatistics); + return new ExtractiveSummarizeOperation(this, _clientDiagnostics, location, idToIndexMap, options.IncludeStatistics); } catch (Exception e) { @@ -2155,11 +2155,11 @@ private ExtractSummaryOperation StartExtractSummary(MultiLanguageAnalysisInput m } } - private async Task StartExtractSummaryAsync(MultiLanguageAnalysisInput multiLanguageInput, ExtractSummaryOptions options, CancellationToken cancellationToken) + private async Task StartExtractiveSummarizeAsync(MultiLanguageAnalysisInput multiLanguageInput, ExtractiveSummarizeOptions options, CancellationToken cancellationToken) { - options ??= new ExtractSummaryOptions(); + options ??= new ExtractiveSummarizeOptions(); - using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TextAnalyticsClient)}.{nameof(StartExtractSummary)}"); + using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TextAnalyticsClient)}.{nameof(StartExtractiveSummarize)}"); scope.Start(); try @@ -2173,7 +2173,7 @@ private async Task StartExtractSummaryAsync(MultiLangua string location = response.Headers.OperationLocation; IDictionary idToIndexMap = CreateIdToIndexMap(multiLanguageInput.Documents); - return new ExtractSummaryOperation(this, _clientDiagnostics, location, idToIndexMap, options.IncludeStatistics); + return new ExtractiveSummarizeOperation(this, _clientDiagnostics, location, idToIndexMap, options.IncludeStatistics); } catch (Exception e) { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LegacyServiceClient.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LegacyServiceClient.cs index 6efd08cbd1c3..b8a861638c2e 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LegacyServiceClient.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LegacyServiceClient.cs @@ -1543,9 +1543,9 @@ private Legacy.JobManifestTasks CreateTasks(TextAnalyticsActions actions) { throw Validation.NotSupported(nameof(SingleLabelClassifyAction), TextAnalyticsClientOptions.ServiceVersion.V2022_05_01, ServiceVersion); } - if (actions.ExtractSummaryActions != null && actions.ExtractSummaryActions.Count > 0) + if (actions.ExtractiveSummarizeActions != null && actions.ExtractiveSummarizeActions.Count > 0) { - throw Validation.NotSupported(nameof(ExtractSummaryAction), TextAnalyticsClientOptions.ServiceVersion.V2022_10_01_Preview, ServiceVersion); + throw Validation.NotSupported(nameof(ExtractiveSummarizeAction), TextAnalyticsClientOptions.ServiceVersion.V2022_10_01_Preview, ServiceVersion); } if (actions.AbstractSummaryActions != null && actions.AbstractSummaryActions.Count > 0) { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/ServiceClient.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/ServiceClient.cs index 4cd4da2be249..a7a8705950f6 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/ServiceClient.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/ServiceClient.cs @@ -153,19 +153,19 @@ public ServiceClient(TextAnalyticsClientOptions options) #endregion - #region Extract Summary + #region Extractive Summarize - public virtual ExtractSummaryOperation StartExtractSummary(IEnumerable documents, string language = default, ExtractSummaryOptions options = default, CancellationToken cancellationToken = default) => - throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartExtractSummary)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); + public virtual ExtractiveSummarizeOperation StartExtractiveSummarize(IEnumerable documents, string language = default, ExtractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) => + throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartExtractiveSummarize)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); - public virtual ExtractSummaryOperation StartExtractSummary(IEnumerable documents, ExtractSummaryOptions options = default, CancellationToken cancellationToken = default) => - throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartExtractSummary)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); + public virtual ExtractiveSummarizeOperation StartExtractiveSummarize(IEnumerable documents, ExtractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) => + throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartExtractiveSummarize)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); - public virtual Task StartExtractSummaryAsync(IEnumerable documents, string language = default, ExtractSummaryOptions options = default, CancellationToken cancellationToken = default) => - throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartExtractSummaryAsync)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); + public virtual Task StartExtractiveSummarizeAsync(IEnumerable documents, string language = default, ExtractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) => + throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartExtractiveSummarizeAsync)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); - public virtual Task StartExtractSummaryAsync(IEnumerable documents, ExtractSummaryOptions options = default, CancellationToken cancellationToken = default) => - throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartExtractSummaryAsync)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); + public virtual Task StartExtractiveSummarizeAsync(IEnumerable documents, ExtractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) => + throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartExtractiveSummarizeAsync)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); #endregion diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsActions.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsActions.cs index 270f1daba533..6d913158b301 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsActions.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsActions.cs @@ -86,12 +86,12 @@ public TextAnalyticsActions() public IReadOnlyCollection AnalyzeHealthcareEntitiesActions { get; set; } /// - /// The set of that will get executed on the input documents. + /// The set of that will get executed on the input documents. /// /// /// This property only applies for and newer. /// - public IReadOnlyCollection ExtractSummaryActions { get; set; } + public IReadOnlyCollection ExtractiveSummarizeActions { get; set; } /// /// The set of that will get executed on the input documents. diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsClient.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsClient.cs index a5f11c0c1e53..7b21bfc9b2ec 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsClient.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsClient.cs @@ -1716,7 +1716,7 @@ public virtual async Task StartAnalyzeHealth /// This method is only supported in service API version v3.1 and newer. The /// , , /// , and are only supported - /// in service API version 2022-05-01 and newer. The and + /// in service API version 2022-05-01 and newer. The and /// are only supported in service API version 2022-10-01-preview and newer. /// /// @@ -1762,7 +1762,7 @@ public virtual async Task StartAnalyzeActionsAsync( /// This method is only supported in service API version v3.1 and newer. The /// , , /// , and are only supported - /// in service API version 2022-05-01 and newer. The and + /// in service API version 2022-05-01 and newer. The and /// are only supported in service API version 2022-10-01-preview and newer. /// /// @@ -1807,7 +1807,7 @@ public virtual AnalyzeActionsOperation StartAnalyzeActions( /// This method is only supported in service API version v3.1 and newer. The /// , , /// , and are only supported - /// in service API version 2022-05-01 and newer. The and + /// in service API version 2022-05-01 and newer. The and /// are only supported in service API version 2022-10-01-preview and newer. /// /// @@ -1851,7 +1851,7 @@ public virtual AnalyzeActionsOperation StartAnalyzeActions( /// This method is only supported in service API version v3.1 and newer. The /// , , /// , and are only supported - /// in service API version 2022-05-01 and newer. The and + /// in service API version 2022-05-01 and newer. The and /// are only supported in service API version 2022-10-01-preview and newer. /// /// @@ -2196,7 +2196,7 @@ public virtual async Task StartMultiLabelClassifyAsyn #endregion - #region Extract Summary + #region Extractive Summarize /// /// Performs extractive summarization on the given documents, which consists of extracting sentences that @@ -2211,10 +2211,10 @@ public virtual async Task StartMultiLabelClassifyAsyn /// /// The documents to analyze. /// The language that the documents are written in. - /// The additional used to configure the operation. + /// The additional used to configure the operation. /// The controlling the lifetime of the request. /// - /// An that can be used to monitor the status of extractive + /// An that can be used to monitor the status of extractive /// summarization. Upon completion, the operation will contain the collections of extracted summary sentences /// for each document that was successfully analyzed. /// @@ -2222,14 +2222,14 @@ public virtual async Task StartMultiLabelClassifyAsyn /// The service returned a non-success status code. /// is an empty collection. /// is null. - public virtual ExtractSummaryOperation StartExtractSummary( + public virtual ExtractiveSummarizeOperation StartExtractiveSummarize( IEnumerable documents, string language = default, - ExtractSummaryOptions options = default, + ExtractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { options?.CheckSupported(ServiceVersion); - return _serviceClient.StartExtractSummary(documents, language, options, cancellationToken); + return _serviceClient.StartExtractiveSummarize(documents, language, options, cancellationToken); } /// @@ -2244,10 +2244,10 @@ public virtual ExtractSummaryOperation StartExtractSummary( /// This method is only available for , and newer. /// /// The documents to analyze. - /// The additional used to configure the operation. + /// The additional used to configure the operation. /// The controlling the lifetime of the request. /// - /// An that can be used to monitor the status of extractive + /// An that can be used to monitor the status of extractive /// summarization. Upon completion, the operation will contain the collections of extracted summary sentences /// for each document that was successfully analyzed. /// @@ -2255,13 +2255,13 @@ public virtual ExtractSummaryOperation StartExtractSummary( /// The service returned a non-success status code. /// is an empty collection. /// is null. - public virtual ExtractSummaryOperation StartExtractSummary( + public virtual ExtractiveSummarizeOperation StartExtractiveSummarize( IEnumerable documents, - ExtractSummaryOptions options = default, + ExtractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { options?.CheckSupported(ServiceVersion); - return _serviceClient.StartExtractSummary(documents, options, cancellationToken); + return _serviceClient.StartExtractiveSummarize(documents, options, cancellationToken); } /// @@ -2277,10 +2277,10 @@ public virtual ExtractSummaryOperation StartExtractSummary( /// /// The documents to analyze. /// The language that the documents are written in. - /// The additional used to configure the operation. + /// The additional used to configure the operation. /// The controlling the lifetime of the request. /// - /// A that can be used to monitor the status of the extractive + /// A that can be used to monitor the status of the extractive /// summarization. Upon completion, the operation will contain the collections of extracted summary sentences /// for each document that was successfully analyzed. /// @@ -2288,14 +2288,14 @@ public virtual ExtractSummaryOperation StartExtractSummary( /// The service returned a non-success status code. /// is an empty collection. /// is null. - public virtual async Task StartExtractSummaryAsync( + public virtual async Task StartExtractiveSummarizeAsync( IEnumerable documents, string language = default, - ExtractSummaryOptions options = default, + ExtractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { options?.CheckSupported(ServiceVersion); - return await _serviceClient.StartExtractSummaryAsync(documents, language, options, cancellationToken).ConfigureAwait(false); + return await _serviceClient.StartExtractiveSummarizeAsync(documents, language, options, cancellationToken).ConfigureAwait(false); } /// @@ -2310,10 +2310,10 @@ public virtual async Task StartExtractSummaryAsync( /// This method is only available for , and newer. /// /// The documents to analyze. - /// The additional used to configure the operation. + /// The additional used to configure the operation. /// The controlling the lifetime of the request. /// - /// A that can be used to monitor the status of the extractive + /// A that can be used to monitor the status of the extractive /// summarization. Upon completion, the operation will contain the collections of extracted summary sentences /// for each document that was successfully analyzed. /// @@ -2321,13 +2321,13 @@ public virtual async Task StartExtractSummaryAsync( /// The service returned a non-success status code. /// is an empty collection. /// is null. - public virtual async Task StartExtractSummaryAsync( + public virtual async Task StartExtractiveSummarizeAsync( IEnumerable documents, - ExtractSummaryOptions options = default, + ExtractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { options?.CheckSupported(ServiceVersion); - return await _serviceClient.StartExtractSummaryAsync(documents, options, cancellationToken).ConfigureAwait(false); + return await _serviceClient.StartExtractiveSummarizeAsync(documents, options, cancellationToken).ConfigureAwait(false); } #endregion diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsModelFactory.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsModelFactory.cs index dcc2593ff678..5cf038c26e6f 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsModelFactory.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsModelFactory.cs @@ -1019,7 +1019,7 @@ public static AnalyzeActionsResult AnalyzeActionsResult( new List(), new List(), new List(), - new List(), + new List(), new List() ); } @@ -1057,7 +1057,7 @@ public static AnalyzeActionsResult AnalyzeActionsResult( singleLabelClassifyActionResults.ToList(), multiLabelClassifyActionResults.ToList(), new List(), - new List(), + new List(), new List() ); } @@ -1097,7 +1097,7 @@ public static AnalyzeActionsResult AnalyzeActionsResult( singleLabelClassifyActionResults.ToList(), multiLabelClassifyActionResults.ToList(), analyzeHealthcareEntitiesActionResults.ToList(), - new List(), + new List(), new List() ); } @@ -1114,7 +1114,7 @@ public static AnalyzeActionsResult AnalyzeActionsResult( /// Sets the collection of . /// Sets the collection of . /// Sets the collection of . - /// Sets the collection of . + /// Sets the collection of . /// Sets the collection of . /// A new instance of for mocking purposes. public static AnalyzeActionsResult AnalyzeActionsResult( @@ -1127,7 +1127,7 @@ public static AnalyzeActionsResult AnalyzeActionsResult( IEnumerable singleLabelClassifyActionResults, IEnumerable multiLabelClassifyActionResults, IEnumerable analyzeHealthcareEntitiesActionResults, - IEnumerable extractSummaryActionResults, + IEnumerable extractiveSummarizeActionResults, IEnumerable abstractSummaryActionResults) { return new AnalyzeActionsResult( @@ -1140,7 +1140,7 @@ public static AnalyzeActionsResult AnalyzeActionsResult( singleLabelClassifyActionResults.ToList(), multiLabelClassifyActionResults.ToList(), analyzeHealthcareEntitiesActionResults.ToList(), - extractSummaryActionResults.ToList(), + extractiveSummarizeActionResults.ToList(), abstractSummaryActionResults.ToList() ); } @@ -1675,35 +1675,35 @@ public static AnalyzeHealthcareEntitiesActionResult AnalyzeHealthcareEntitiesAct } /// - /// Initializes a new instance of for mocking purposes. + /// Initializes a new instance of for mocking purposes. /// - /// Sets the property. + /// Sets the property. /// Sets the property. /// Sets the property. - /// A new instance of for mocking purposes. - public static ExtractSummaryActionResult ExtractSummaryActionResult( - ExtractSummaryResultCollection result, + /// A new instance of for mocking purposes. + public static ExtractiveSummarizeActionResult ExtractiveSummarizeActionResult( + ExtractiveSummarizeResultCollection result, string actionName, DateTimeOffset completedOn) { - return new ExtractSummaryActionResult(result, actionName, completedOn); + return new ExtractiveSummarizeActionResult(result, actionName, completedOn); } /// - /// Initializes a new instance of for mocking purposes. + /// Initializes a new instance of for mocking purposes. /// /// Sets the property. /// Sets the property. /// Sets the property. /// Sets the property. - /// A new instance of for mocking purposes. - public static ExtractSummaryActionResult ExtractSummaryActionResult( + /// A new instance of for mocking purposes. + public static ExtractiveSummarizeActionResult ExtractiveSummarizeActionResult( string actionName, DateTimeOffset completedOn, string code, string message) { - return new ExtractSummaryActionResult(actionName, completedOn, new Error(code, message)); + return new ExtractiveSummarizeActionResult(actionName, completedOn, new Error(code, message)); } /// @@ -1905,58 +1905,58 @@ public static EntityDataSource EntityDataSource(string name = null, string entit #endregion Healthcare - #region Extract Summary + #region Extractive Summarize /// - /// Initializes a new instance of for mocking purposes. + /// Initializes a new instance of for mocking purposes. /// /// Sets the property. /// Sets the property. - /// Sets the property. - /// Sets the property. - /// Sets the property. + /// Sets the property. + /// Sets the property. + /// Sets the property. /// - /// A new instance of for mocking purposes. + /// A new instance of for mocking purposes. /// - public static ExtractSummaryResult ExtractSummaryResult( + public static ExtractiveSummarizeResult ExtractiveSummarizeResult( string id, TextDocumentStatistics statistics, IEnumerable sentences, DetectedLanguage? detectedLanguage = default, IEnumerable warnings = default) { - return new ExtractSummaryResult(id, statistics, sentences.ToList(), detectedLanguage, warnings.ToList()); + return new ExtractiveSummarizeResult(id, statistics, sentences.ToList(), detectedLanguage, warnings.ToList()); } /// - /// Initializes a new instance of for mocking purposes. + /// Initializes a new instance of for mocking purposes. /// /// Sets the property. /// Sets the property. /// Sets the property. /// - /// A new instance of for mocking purposes. + /// A new instance of for mocking purposes. /// - public static ExtractSummaryResult ExtractSummaryResult(string id, string code, string message) + public static ExtractiveSummarizeResult ExtractiveSummarizeResult(string id, string code, string message) { - return new ExtractSummaryResult(id, new TextAnalyticsError(code, message)); + return new ExtractiveSummarizeResult(id, new TextAnalyticsError(code, message)); } /// - /// Initializes a new instance of for mocking purposes. + /// Initializes a new instance of for mocking purposes. /// - /// Sets the collection of . - /// Sets the property. - /// Sets the property. + /// Sets the collection of . + /// Sets the property. + /// Sets the property. /// - /// A new instance of for mocking purposes. + /// A new instance of for mocking purposes. /// - public static ExtractSummaryResultCollection ExtractSummaryResultCollection( - IEnumerable results, + public static ExtractiveSummarizeResultCollection ExtractiveSummarizeResultCollection( + IEnumerable results, TextDocumentBatchStatistics statistics, string modelVersion) { - return new ExtractSummaryResultCollection(results.ToList(), statistics, modelVersion); + return new ExtractiveSummarizeResultCollection(results.ToList(), statistics, modelVersion); } /// @@ -1984,7 +1984,7 @@ public static SummarySentence SummarySentence(string text, double rankScore, int /// Sets the property. /// Sets the property. /// Sets the property. - /// Sets the property. + /// Sets the property. /// Sets the property. /// /// A new instance of for mocking purposes. diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/Transforms.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/Transforms.cs index 8059dbb47527..34413bf2595d 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/Transforms.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/Transforms.cs @@ -497,28 +497,28 @@ internal static ClassifyDocumentResultCollection ConvertClassifyDocumentResultCo #endregion - #region Extract Summary + #region Extractive Summarize internal static List ConvertToSummarySentenceList(IEnumerable sentences) => sentences.Select((sentence) => new SummarySentence(sentence)).ToList(); - internal static ExtractSummaryResultCollection ConvertToExtractSummaryResultCollection( + internal static ExtractiveSummarizeResultCollection ConvertToExtractiveSummarizeResultCollection( ExtractiveSummarizationResult results, IDictionary idToIndexMap) { - List extractSummaryResults = new(results.Documents.Count); + List extractiveSummarizeResults = new(results.Documents.Count); // Read errors. foreach (InputError error in results.Errors) { - extractSummaryResults.Add(new ExtractSummaryResult(error.Id, ConvertToError(error.Error))); + extractiveSummarizeResults.Add(new ExtractiveSummarizeResult(error.Id, ConvertToError(error.Error))); } // Read results. foreach (ExtractedSummaryDocumentResultWithDetectedLanguage document in results.Documents) { - extractSummaryResults.Add( - new ExtractSummaryResult( + extractiveSummarizeResults.Add( + new ExtractiveSummarizeResult( document.Id, document.Statistics ?? default, ConvertToSummarySentenceList(document.Sentences), @@ -526,19 +526,19 @@ internal static ExtractSummaryResultCollection ConvertToExtractSummaryResultColl ConvertToWarnings(document.Warnings))); } - extractSummaryResults = SortHeterogeneousCollection(extractSummaryResults, idToIndexMap); + extractiveSummarizeResults = SortHeterogeneousCollection(extractiveSummarizeResults, idToIndexMap); - return new ExtractSummaryResultCollection(extractSummaryResults, results.Statistics, results.ModelVersion); + return new ExtractiveSummarizeResultCollection(extractiveSummarizeResults, results.Statistics, results.ModelVersion); } - internal static ExtractSummaryResultCollection ConvertToExtractSummaryResultCollection( + internal static ExtractiveSummarizeResultCollection ConvertToExtractiveSummarizeResultCollection( AnalyzeTextJobState jobState, IDictionary idToIndexMap) { AnalyzeTextLROResult task = jobState.Tasks.Items[0]; if (task.Kind == AnalyzeTextLROResultsKind.ExtractiveSummarizationLROResults) { - return ConvertToExtractSummaryResultCollection((task as ExtractiveSummarizationLROResult).Results, idToIndexMap); + return ConvertToExtractiveSummarizeResultCollection((task as ExtractiveSummarizationLROResult).Results, idToIndexMap); } throw new InvalidOperationException($"Invalid task executed. Expected a {nameof(AnalyzeTextLROResultsKind.ExtractiveSummarizationLROResults)} but instead got {task.Kind}."); } @@ -725,7 +725,7 @@ internal static CustomMultiLabelClassificationLROTask ConvertToCustomMultiClassi }; } - internal static ExtractiveSummarizationLROTask ConvertToExtractiveSummarizationTask(ExtractSummaryAction action) + internal static ExtractiveSummarizationLROTask ConvertToExtractiveSummarizationTask(ExtractiveSummarizeAction action) { return new ExtractiveSummarizationLROTask() { @@ -865,11 +865,11 @@ internal static IList ConvertFromRecognizeCustomEntitiesA return list; } - internal static IList ConvertFromExtractSummaryActionsToTasks(IReadOnlyCollection extractSummaryActions) + internal static IList ConvertFromExtractiveSummarizeActionsToTasks(IReadOnlyCollection extractiveSummarizeActions) { - List list = new(extractSummaryActions.Count); + List list = new(extractiveSummarizeActions.Count); - foreach (ExtractSummaryAction action in extractSummaryActions) + foreach (ExtractiveSummarizeAction action in extractiveSummarizeActions) { list.Add(ConvertToExtractiveSummarizationTask(action)); } @@ -900,7 +900,7 @@ internal static AnalyzeActionsResult ConvertToAnalyzeActionsResult(AnalyzeTextJo List singleLabelClassify = new(); List multiLabelClassify = new(); List analyzeHealthcareEntities = new(); - List extractSummary = new(); + List extractiveSummarize = new(); List abstractSummary = new(); foreach (AnalyzeTextLROResult task in jobState.Tasks.Items) @@ -943,7 +943,7 @@ internal static AnalyzeActionsResult ConvertToAnalyzeActionsResult(AnalyzeTextJo } else if (task.Kind == AnalyzeTextLROResultsKind.ExtractiveSummarizationLROResults) { - extractSummary.Add(new ExtractSummaryActionResult(ConvertToExtractSummaryResultCollection((task as ExtractiveSummarizationLROResult).Results, map), task.TaskName, task.LastUpdateDateTime)); + extractiveSummarize.Add(new ExtractiveSummarizeActionResult(ConvertToExtractiveSummarizeResultCollection((task as ExtractiveSummarizationLROResult).Results, map), task.TaskName, task.LastUpdateDateTime)); } else if (task.Kind == AnalyzeTextLROResultsKind.AbstractiveSummarizationLROResults) { @@ -961,7 +961,7 @@ internal static AnalyzeActionsResult ConvertToAnalyzeActionsResult(AnalyzeTextJo singleLabelClassify, multiLabelClassify, analyzeHealthcareEntities, - extractSummary, + extractiveSummarize, abstractSummary); } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/AnalyzeOperationTests.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/AnalyzeOperationTests.cs index 4fa8f4a2e624..4eff9018aff3 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/AnalyzeOperationTests.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/AnalyzeOperationTests.cs @@ -89,7 +89,7 @@ public async Task AnalyzeOperationTest() IReadOnlyCollection singleLabelClassifyResults = resultCollection.SingleLabelClassifyResults; IReadOnlyCollection multiLabelClassifyResults = resultCollection.MultiLabelClassifyResults; IReadOnlyCollection analyzeHealthcareEntitiesActionResults = resultCollection.AnalyzeHealthcareEntitiesResults; - IReadOnlyCollection extractSummaryActionResults = resultCollection.ExtractSummaryResults; + IReadOnlyCollection extractiveSummarizeActionResults = resultCollection.ExtractiveSummarizeResults; Assert.IsNotNull(keyPhrasesActionsResults); Assert.IsNotNull(entitiesActionsResults); @@ -100,7 +100,7 @@ public async Task AnalyzeOperationTest() Assert.IsNotNull(multiLabelClassifyResults); Assert.IsNotNull(recognizeCustomEntitiesActionResults); Assert.IsNotNull(analyzeHealthcareEntitiesActionResults); - Assert.IsNotNull(extractSummaryActionResults); + Assert.IsNotNull(extractiveSummarizeActionResults); var keyPhrasesListId1 = new List { "CEO", "SpaceX", "Elon Musk", "Tesla" }; var keyPhrasesListId2 = new List { "Tesla stock" }; diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/ExtractSummaryTests.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/ExtractiveSummarizeTests.cs similarity index 78% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/ExtractSummaryTests.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/ExtractiveSummarizeTests.cs index def2d7d05597..ee803a6ee5cd 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/ExtractSummaryTests.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/ExtractiveSummarizeTests.cs @@ -12,14 +12,14 @@ namespace Azure.AI.TextAnalytics.Tests { [ServiceVersion(Min = TextAnalyticsClientOptions.ServiceVersion.V2022_10_01_Preview)] - public class ExtractSummaryTests : TextAnalyticsClientLiveTestBase + public class ExtractiveSummarizeTests : TextAnalyticsClientLiveTestBase { - public ExtractSummaryTests(bool isAsync, TextAnalyticsClientOptions.ServiceVersion serviceVersion) + public ExtractiveSummarizeTests(bool isAsync, TextAnalyticsClientOptions.ServiceVersion serviceVersion) : base(isAsync, serviceVersion) { } - private const string ExtractSummaryDocument1 = + private const string ExtractiveSummarizeDocument1 = "No roads or rails connect the 39,000 people dispersed across Nunavut, a territory in northeastern Canada that spans three time zones and features fjord-cut isles that stretch into the Arctic Circle off the west coast of Greenland. About 80% of the population is of Inuit descent with cultural ties to the land that date back more than 4,000 years." + " Today, low-bandwidth satellite internet service links the people of Nunavut to each other and with the rest of the world." + " The Government of Nunavut relies on this internet link to provide healthcare, education, housing and family, and financial and other services to 25 communities. The smallest, Grise Fiord, has a population of 130; the largest, the capital, Iqaluit, has 8,500 people. About 3,100 people work full-time for the government, which has an office in each community. Another 3,000 people work for the government as relief workers, casual, term or contractors." @@ -44,7 +44,7 @@ public ExtractSummaryTests(bool isAsync, TextAnalyticsClientOptions.ServiceVersi + " As the team used the service and encountered bugs in the system, they worked through and solved them on their way to creating a unique category of virtualization, the Cloud PC." + " “We’re giving you Windows from the cloud,” Manchester said."; - private const string ExtractSummaryDocument2 = + private const string ExtractiveSummarizeDocument2 = "Windows 365 was in the works before COVID-19 sent companies around the world on a scramble to secure solutions to support employees suddenly forced to work from home, but “what really put the firecracker behind it was the pandemic, it accelerated everything,” McKelvey said. She explained that customers were asking, “’How do we create an experience for people that makes them still feel connected to the company without the physical presence of being there?”" + " In this new world of Windows 365, remote workers flip the lid on their laptop, bootup the family workstation or clip a keyboard onto a tablet, launch a native app or modern web browser and login to their Windows 365 account. From there, their Cloud PC appears with their background, apps, settings and content just as they left it when they last were last there – in the office, at home or a coffee shop." + " “And then, when you’re done, you’re done. You won’t have any issues around security because you’re not saving anything on your device,” McKelvey said, noting that all the data is stored in the cloud." @@ -58,17 +58,17 @@ public ExtractSummaryTests(bool isAsync, TextAnalyticsClientOptions.ServiceVersi private static readonly List s_batchConvenienceDocuments = new() { - ExtractSummaryDocument1, - ExtractSummaryDocument2 + ExtractiveSummarizeDocument1, + ExtractiveSummarizeDocument2 }; private static List s_batchDocuments = new() { - new TextDocumentInput("1", ExtractSummaryDocument1) + new TextDocumentInput("1", ExtractiveSummarizeDocument1) { Language = "en", }, - new TextDocumentInput("2", ExtractSummaryDocument2) + new TextDocumentInput("2", ExtractiveSummarizeDocument2) { Language = "en", } @@ -76,53 +76,53 @@ public ExtractSummaryTests(bool isAsync, TextAnalyticsClientOptions.ServiceVersi private const int DefaultSummaryMaxSentenceCount = 3; - private const int ExtractSummaryMaxSentenceCount = 5; + private const int ExtractiveSummarizeMaxSentenceCount = 5; [RecordedTest] [RetryOnInternalServerError] - public async Task ExtractSummaryWithAADTest() + public async Task ExtractiveSummarizeWithAADTest() { TextAnalyticsClient client = GetClient(useTokenCredential: true); - ExtractSummaryOperation operation = await client.StartExtractSummaryAsync(s_batchDocuments); + ExtractiveSummarizeOperation operation = await client.StartExtractiveSummarizeAsync(s_batchDocuments); await operation.WaitForCompletionAsync(); ValidateOperationProperties(operation); - List resultInPages = operation.Value.ToEnumerableAsync().Result; + List resultInPages = operation.Value.ToEnumerableAsync().Result; Assert.AreEqual(1, resultInPages.Count); // Take the first page. - ExtractSummaryResultCollection resultCollection = resultInPages.FirstOrDefault(); + ExtractiveSummarizeResultCollection resultCollection = resultInPages.FirstOrDefault(); ValidateSummaryBatchResult(resultCollection, SummarySentencesOrder.Offset); } [RecordedTest] [RetryOnInternalServerError] - public async Task ExtractSummaryBatchWithRankOrderTest() + public async Task ExtractiveSummarizeBatchWithRankOrderTest() { TextAnalyticsClient client = GetClient(); - ExtractSummaryOptions options = new ExtractSummaryOptions() + ExtractiveSummarizeOptions options = new ExtractiveSummarizeOptions() { - MaxSentenceCount = ExtractSummaryMaxSentenceCount, + MaxSentenceCount = ExtractiveSummarizeMaxSentenceCount, OrderBy = SummarySentencesOrder.Rank }; - ExtractSummaryOperation operation = await client.StartExtractSummaryAsync(s_batchDocuments, options); + ExtractiveSummarizeOperation operation = await client.StartExtractiveSummarizeAsync(s_batchDocuments, options); await operation.WaitForCompletionAsync(); ValidateOperationProperties(operation); - List resultInPages = operation.Value.ToEnumerableAsync().Result; + List resultInPages = operation.Value.ToEnumerableAsync().Result; Assert.AreEqual(1, resultInPages.Count); // Take the first page. - ExtractSummaryResultCollection resultCollection = resultInPages.FirstOrDefault(); - ValidateSummaryBatchResult(resultCollection, SummarySentencesOrder.Rank, ExtractSummaryMaxSentenceCount); + ExtractiveSummarizeResultCollection resultCollection = resultInPages.FirstOrDefault(); + ValidateSummaryBatchResult(resultCollection, SummarySentencesOrder.Rank, ExtractiveSummarizeMaxSentenceCount); } [RecordedTest] [RetryOnInternalServerError] - public async Task ExtractSummaryBatchWithErrorTest() + public async Task ExtractiveSummarizeBatchWithErrorTest() { TextAnalyticsClient client = GetClient(); @@ -132,15 +132,15 @@ public async Task ExtractSummaryBatchWithErrorTest() "", }; - ExtractSummaryOperation operation = await client.StartExtractSummaryAsync(documents, "en"); + ExtractiveSummarizeOperation operation = await client.StartExtractiveSummarizeAsync(documents, "en"); await operation.WaitForCompletionAsync(); ValidateOperationProperties(operation); - List resultInPages = operation.Value.ToEnumerableAsync().Result; + List resultInPages = operation.Value.ToEnumerableAsync().Result; Assert.AreEqual(1, resultInPages.Count); // Take the first page. - ExtractSummaryResultCollection resultCollection = resultInPages.FirstOrDefault(); + ExtractiveSummarizeResultCollection resultCollection = resultInPages.FirstOrDefault(); Assert.IsFalse(resultCollection[0].HasError); Assert.IsTrue(resultCollection[1].HasError); Assert.AreEqual(TextAnalyticsErrorCode.InvalidDocument, resultCollection[1].Error.ErrorCode.ToString()); @@ -148,141 +148,141 @@ public async Task ExtractSummaryBatchWithErrorTest() [RecordedTest] [RetryOnInternalServerError] - public async Task ExtractSummaryBatchConvenienceTest() + public async Task ExtractiveSummarizeBatchConvenienceTest() { TextAnalyticsClient client = GetClient(); - ExtractSummaryOperation operation = await client.StartExtractSummaryAsync(s_batchConvenienceDocuments); + ExtractiveSummarizeOperation operation = await client.StartExtractiveSummarizeAsync(s_batchConvenienceDocuments); await operation.WaitForCompletionAsync(); ValidateOperationProperties(operation); - List resultInPages = operation.Value.ToEnumerableAsync().Result; + List resultInPages = operation.Value.ToEnumerableAsync().Result; Assert.AreEqual(1, resultInPages.Count); // Take the first page. - ExtractSummaryResultCollection resultCollection = resultInPages.FirstOrDefault(); + ExtractiveSummarizeResultCollection resultCollection = resultInPages.FirstOrDefault(); ValidateSummaryBatchResult(resultCollection, SummarySentencesOrder.Offset); } [RecordedTest] [RetryOnInternalServerError] - public async Task ExtractSummaryBatchConvenienceWithStatisticsTest() + public async Task ExtractiveSummarizeBatchConvenienceWithStatisticsTest() { TextAnalyticsClient client = GetClient(); - ExtractSummaryOptions options = new ExtractSummaryOptions() + ExtractiveSummarizeOptions options = new ExtractiveSummarizeOptions() { - MaxSentenceCount = ExtractSummaryMaxSentenceCount, + MaxSentenceCount = ExtractiveSummarizeMaxSentenceCount, IncludeStatistics = true, }; - ExtractSummaryOperation operation = await client.StartExtractSummaryAsync(s_batchConvenienceDocuments, "en", options); + ExtractiveSummarizeOperation operation = await client.StartExtractiveSummarizeAsync(s_batchConvenienceDocuments, "en", options); await operation.WaitForCompletionAsync(); ValidateOperationProperties(operation); - List resultInPages = operation.Value.ToEnumerableAsync().Result; + List resultInPages = operation.Value.ToEnumerableAsync().Result; Assert.AreEqual(1, resultInPages.Count); // Take the first page. - ExtractSummaryResultCollection resultCollection = resultInPages.FirstOrDefault(); - ValidateSummaryBatchResult(resultCollection, SummarySentencesOrder.Offset, ExtractSummaryMaxSentenceCount, true); + ExtractiveSummarizeResultCollection resultCollection = resultInPages.FirstOrDefault(); + ValidateSummaryBatchResult(resultCollection, SummarySentencesOrder.Offset, ExtractiveSummarizeMaxSentenceCount, true); } [RecordedTest] [RetryOnInternalServerError] - public async Task ExtractSummaryBatchTest() + public async Task ExtractiveSummarizeBatchTest() { TextAnalyticsClient client = GetClient(); - ExtractSummaryOperation operation = await client.StartExtractSummaryAsync(s_batchDocuments); + ExtractiveSummarizeOperation operation = await client.StartExtractiveSummarizeAsync(s_batchDocuments); await operation.WaitForCompletionAsync(); ValidateOperationProperties(operation); - List resultInPages = operation.Value.ToEnumerableAsync().Result; + List resultInPages = operation.Value.ToEnumerableAsync().Result; Assert.AreEqual(1, resultInPages.Count); // Take the first page. - ExtractSummaryResultCollection resultCollection = resultInPages.FirstOrDefault(); + ExtractiveSummarizeResultCollection resultCollection = resultInPages.FirstOrDefault(); ValidateSummaryBatchResult(resultCollection, SummarySentencesOrder.Offset); } [RecordedTest] [RetryOnInternalServerError] - public async Task ExtractSummaryBatchWithStatisticsTest() + public async Task ExtractiveSummarizeBatchWithStatisticsTest() { TextAnalyticsClient client = GetClient(); - ExtractSummaryOptions options = new ExtractSummaryOptions() + ExtractiveSummarizeOptions options = new ExtractiveSummarizeOptions() { - MaxSentenceCount = ExtractSummaryMaxSentenceCount, + MaxSentenceCount = ExtractiveSummarizeMaxSentenceCount, IncludeStatistics = true, }; - ExtractSummaryOperation operation = await client.StartExtractSummaryAsync(s_batchDocuments, options); + ExtractiveSummarizeOperation operation = await client.StartExtractiveSummarizeAsync(s_batchDocuments, options); await operation.WaitForCompletionAsync(); ValidateOperationProperties(operation); - List resultInPages = operation.Value.ToEnumerableAsync().Result; + List resultInPages = operation.Value.ToEnumerableAsync().Result; Assert.AreEqual(1, resultInPages.Count); // Take the first page. - ExtractSummaryResultCollection resultCollection = resultInPages.FirstOrDefault(); - ValidateSummaryBatchResult(resultCollection, SummarySentencesOrder.Offset, ExtractSummaryMaxSentenceCount, true); + ExtractiveSummarizeResultCollection resultCollection = resultInPages.FirstOrDefault(); + ValidateSummaryBatchResult(resultCollection, SummarySentencesOrder.Offset, ExtractiveSummarizeMaxSentenceCount, true); } [RecordedTest] [RetryOnInternalServerError] - public async Task ExtractSummaryBatchConvenienceWithAutoDetectedLanguageTest() + public async Task ExtractiveSummarizeBatchConvenienceWithAutoDetectedLanguageTest() { TextAnalyticsClient client = GetClient(); - ExtractSummaryOperation operation = await client.StartExtractSummaryAsync(s_batchConvenienceDocuments, "auto"); + ExtractiveSummarizeOperation operation = await client.StartExtractiveSummarizeAsync(s_batchConvenienceDocuments, "auto"); await operation.WaitForCompletionAsync(); ValidateOperationProperties(operation); - List resultInPages = operation.Value.ToEnumerableAsync().Result; + List resultInPages = operation.Value.ToEnumerableAsync().Result; Assert.AreEqual(1, resultInPages.Count); // Take the first page. - ExtractSummaryResultCollection resultCollection = resultInPages.FirstOrDefault(); + ExtractiveSummarizeResultCollection resultCollection = resultInPages.FirstOrDefault(); ValidateSummaryBatchResult(resultCollection, SummarySentencesOrder.Offset, isLanguageAutoDetected: true); } [RecordedTest] [RetryOnInternalServerError] [ServiceVersion(Min = TextAnalyticsClientOptions.ServiceVersion.V2022_10_01_Preview)] - public async Task AnalyzeOperationExtractSummary() + public async Task AnalyzeOperationExtractiveSummarize() { TextAnalyticsClient client = GetClient(); TextAnalyticsActions batchActions = new TextAnalyticsActions() { - ExtractSummaryActions = new List() { new ExtractSummaryAction() { MaxSentenceCount = 2 } }, - DisplayName = "AnalyzeOperationExtractSummary", + ExtractiveSummarizeActions = new List() { new ExtractiveSummarizeAction() { MaxSentenceCount = 2 } }, + DisplayName = "AnalyzeOperationExtractiveSummarize", }; AnalyzeActionsOperation operation = await client.StartAnalyzeActionsAsync(s_batchConvenienceDocuments, batchActions); await operation.WaitForCompletionAsync(); AnalyzeActionsResult resultCollection = operation.Value.ToEnumerableAsync().Result.FirstOrDefault(); - IReadOnlyCollection extractSummaryActionsResults = resultCollection.ExtractSummaryResults; - Assert.IsNotNull(extractSummaryActionsResults); + IReadOnlyCollection extractiveSummarizeActionsResults = resultCollection.ExtractiveSummarizeResults; + Assert.IsNotNull(extractiveSummarizeActionsResults); - ExtractSummaryResultCollection extractSummaryDocumentsResults = extractSummaryActionsResults.FirstOrDefault().DocumentsResults; - ValidateSummaryBatchResult(extractSummaryDocumentsResults, SummarySentencesOrder.Offset); + ExtractiveSummarizeResultCollection extractiveSummarizeDocumentsResults = extractiveSummarizeActionsResults.FirstOrDefault().DocumentsResults; + ValidateSummaryBatchResult(extractiveSummarizeDocumentsResults, SummarySentencesOrder.Offset); } [RecordedTest] [RetryOnInternalServerError] [ServiceVersion(Max = TextAnalyticsClientOptions.ServiceVersion.V2022_05_01)] - public void AnalyzeOperationExtractSummaryActionNotSupported() + public void AnalyzeOperationExtractiveSummarizeActionNotSupported() { TestDiagnostics = false; TextAnalyticsClient client = GetClient(); TextAnalyticsActions batchActions = new() { - ExtractSummaryActions = new[] + ExtractiveSummarizeActions = new[] { - new ExtractSummaryAction(), + new ExtractiveSummarizeAction(), }, }; @@ -292,14 +292,14 @@ public void AnalyzeOperationExtractSummaryActionNotSupported() [RecordedTest] [RetryOnInternalServerError] - public async Task AnalyzeOperationExtractSummaryWithAutoDetectedLanguageTest() + public async Task AnalyzeOperationExtractiveSummarizeWithAutoDetectedLanguageTest() { TextAnalyticsClient client = GetClient(); List documents = s_batchConvenienceDocuments; TextAnalyticsActions actions = new() { - ExtractSummaryActions = new List() { new ExtractSummaryAction() }, - DisplayName = "ExtractSummaryWithAutoDetectedLanguage", + ExtractiveSummarizeActions = new List() { new ExtractiveSummarizeAction() }, + DisplayName = "ExtractiveSummarizeWithAutoDetectedLanguage", }; AnalyzeActionsOperation operation = await client.StartAnalyzeActionsAsync(documents, actions, "auto"); @@ -307,14 +307,14 @@ public async Task AnalyzeOperationExtractSummaryWithAutoDetectedLanguageTest() // Take the first page. AnalyzeActionsResult resultCollection = operation.Value.ToEnumerableAsync().Result.FirstOrDefault(); - IReadOnlyCollection actionResults = resultCollection.ExtractSummaryResults; + IReadOnlyCollection actionResults = resultCollection.ExtractiveSummarizeResults; Assert.IsNotNull(actionResults); - ExtractSummaryResultCollection results = actionResults.FirstOrDefault().DocumentsResults; + ExtractiveSummarizeResultCollection results = actionResults.FirstOrDefault().DocumentsResults; ValidateSummaryBatchResult(results, SummarySentencesOrder.Offset, isLanguageAutoDetected: true); } - private void ValidateOperationProperties(ExtractSummaryOperation operation) + private void ValidateOperationProperties(ExtractiveSummarizeOperation operation) { Assert.AreNotEqual(new DateTimeOffset(), operation.CreatedOn); // TODO: Re-enable this check (https://github.com/Azure/azure-sdk-for-net/issues/31855). @@ -362,7 +362,7 @@ private void ValidateSummaryDocumentResult( } private void ValidateSummaryBatchResult( - ExtractSummaryResultCollection results, + ExtractiveSummarizeResultCollection results, SummarySentencesOrder expectedOrder, int maxSentenceCount = DefaultSummaryMaxSentenceCount, bool includeStatistics = default, @@ -383,7 +383,7 @@ private void ValidateSummaryBatchResult( Assert.IsNull(results.Statistics); } - foreach (ExtractSummaryResult result in results) + foreach (ExtractiveSummarizeResult result in results) { Assert.That(result.Id, Is.Not.Null.And.Not.Empty); Assert.False(result.HasError); diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/AnalyzeOperationExtractSummary.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarize.json similarity index 98% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/AnalyzeOperationExtractSummary.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarize.json index f824b8b02899..7c2b1ac893c5 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/AnalyzeOperationExtractSummary.json +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarize.json @@ -14,7 +14,7 @@ "x-ms-return-client-request-id": "true" }, "RequestBody": { - "displayName": "AnalyzeOperationExtractSummary", + "displayName": "AnalyzeOperationExtractiveSummarize", "analysisInput": { "documents": [ { @@ -81,7 +81,7 @@ "expirationDateTime": "2023-04-15T20:08:20Z", "status": "running", "errors": [], - "displayName": "AnalyzeOperationExtractSummary", + "displayName": "AnalyzeOperationExtractiveSummarize", "tasks": { "completed": 0, "failed": 0, @@ -120,7 +120,7 @@ "expirationDateTime": "2023-04-15T20:08:20Z", "status": "running", "errors": [], - "displayName": "AnalyzeOperationExtractSummary", + "displayName": "AnalyzeOperationExtractiveSummarize", "tasks": { "completed": 0, "failed": 0, @@ -159,7 +159,7 @@ "expirationDateTime": "2023-04-15T20:08:20Z", "status": "running", "errors": [], - "displayName": "AnalyzeOperationExtractSummary", + "displayName": "AnalyzeOperationExtractiveSummarize", "tasks": { "completed": 0, "failed": 0, @@ -198,7 +198,7 @@ "expirationDateTime": "2023-04-15T20:08:20Z", "status": "succeeded", "errors": [], - "displayName": "AnalyzeOperationExtractSummary", + "displayName": "AnalyzeOperationExtractiveSummarize", "tasks": { "completed": 1, "failed": 0, diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/AnalyzeOperationExtractSummaryAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarizeAsync.json similarity index 98% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/AnalyzeOperationExtractSummaryAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarizeAsync.json index f438909dfbc1..91ca4567d33a 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/AnalyzeOperationExtractSummaryAsync.json +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarizeAsync.json @@ -14,7 +14,7 @@ "x-ms-return-client-request-id": "true" }, "RequestBody": { - "displayName": "AnalyzeOperationExtractSummary", + "displayName": "AnalyzeOperationExtractiveSummarize", "analysisInput": { "documents": [ { @@ -81,7 +81,7 @@ "expirationDateTime": "2023-04-15T20:08:33Z", "status": "running", "errors": [], - "displayName": "AnalyzeOperationExtractSummary", + "displayName": "AnalyzeOperationExtractiveSummarize", "tasks": { "completed": 0, "failed": 0, @@ -120,7 +120,7 @@ "expirationDateTime": "2023-04-15T20:08:33Z", "status": "running", "errors": [], - "displayName": "AnalyzeOperationExtractSummary", + "displayName": "AnalyzeOperationExtractiveSummarize", "tasks": { "completed": 0, "failed": 0, @@ -159,7 +159,7 @@ "expirationDateTime": "2023-04-15T20:08:33Z", "status": "running", "errors": [], - "displayName": "AnalyzeOperationExtractSummary", + "displayName": "AnalyzeOperationExtractiveSummarize", "tasks": { "completed": 0, "failed": 0, @@ -198,7 +198,7 @@ "expirationDateTime": "2023-04-15T20:08:33Z", "status": "succeeded", "errors": [], - "displayName": "AnalyzeOperationExtractSummary", + "displayName": "AnalyzeOperationExtractiveSummarize", "tasks": { "completed": 1, "failed": 0, diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/AnalyzeOperationExtractSummaryWithAutoDetectedLanguageTest.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarizeWithAutoDetectedLanguageTest.json similarity index 97% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/AnalyzeOperationExtractSummaryWithAutoDetectedLanguageTest.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarizeWithAutoDetectedLanguageTest.json index 79e68c1fdf96..b0ad2517c73a 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/AnalyzeOperationExtractSummaryWithAutoDetectedLanguageTest.json +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarizeWithAutoDetectedLanguageTest.json @@ -14,7 +14,7 @@ "x-ms-return-client-request-id": "true" }, "RequestBody": { - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "analysisInput": { "documents": [ { @@ -80,7 +80,7 @@ "expirationDateTime": "2022-11-23T08:07:28Z", "status": "notStarted", "errors": [], - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "tasks": { "completed": 0, "failed": 0, @@ -119,7 +119,7 @@ "expirationDateTime": "2022-11-23T08:07:28Z", "status": "running", "errors": [], - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "tasks": { "completed": 0, "failed": 0, @@ -158,7 +158,7 @@ "expirationDateTime": "2022-11-23T08:07:28Z", "status": "running", "errors": [], - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "tasks": { "completed": 0, "failed": 0, @@ -197,7 +197,7 @@ "expirationDateTime": "2022-11-23T08:07:28Z", "status": "running", "errors": [], - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "tasks": { "completed": 0, "failed": 0, @@ -236,7 +236,7 @@ "expirationDateTime": "2022-11-23T08:07:28Z", "status": "running", "errors": [], - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "tasks": { "completed": 0, "failed": 0, @@ -275,7 +275,7 @@ "expirationDateTime": "2022-11-23T08:07:28Z", "status": "running", "errors": [], - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "tasks": { "completed": 0, "failed": 0, @@ -314,7 +314,7 @@ "expirationDateTime": "2022-11-23T08:07:28Z", "status": "succeeded", "errors": [], - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "tasks": { "completed": 1, "failed": 0, diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/AnalyzeOperationExtractSummaryWithAutoDetectedLanguageTestAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarizeWithAutoDetectedLanguageTestAsync.json similarity index 97% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/AnalyzeOperationExtractSummaryWithAutoDetectedLanguageTestAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarizeWithAutoDetectedLanguageTestAsync.json index f71095104c8e..568d908d3eb2 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/AnalyzeOperationExtractSummaryWithAutoDetectedLanguageTestAsync.json +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/AnalyzeOperationExtractiveSummarizeWithAutoDetectedLanguageTestAsync.json @@ -14,7 +14,7 @@ "x-ms-return-client-request-id": "true" }, "RequestBody": { - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "analysisInput": { "documents": [ { @@ -80,7 +80,7 @@ "expirationDateTime": "2022-11-23T08:08:10Z", "status": "notStarted", "errors": [], - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "tasks": { "completed": 0, "failed": 0, @@ -119,7 +119,7 @@ "expirationDateTime": "2022-11-23T08:08:10Z", "status": "running", "errors": [], - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "tasks": { "completed": 0, "failed": 0, @@ -158,7 +158,7 @@ "expirationDateTime": "2022-11-23T08:08:10Z", "status": "running", "errors": [], - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "tasks": { "completed": 0, "failed": 0, @@ -197,7 +197,7 @@ "expirationDateTime": "2022-11-23T08:08:10Z", "status": "running", "errors": [], - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "tasks": { "completed": 0, "failed": 0, @@ -236,7 +236,7 @@ "expirationDateTime": "2022-11-23T08:08:10Z", "status": "running", "errors": [], - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "tasks": { "completed": 0, "failed": 0, @@ -275,7 +275,7 @@ "expirationDateTime": "2022-11-23T08:08:10Z", "status": "running", "errors": [], - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "tasks": { "completed": 0, "failed": 0, @@ -314,7 +314,7 @@ "expirationDateTime": "2022-11-23T08:08:10Z", "status": "succeeded", "errors": [], - "displayName": "ExtractSummaryWithAutoDetectedLanguage", + "displayName": "ExtractiveSummarizeWithAutoDetectedLanguage", "tasks": { "completed": 1, "failed": 0, diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchConvenienceTest.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceTest.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchConvenienceTest.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceTest.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchConvenienceTestAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceTestAsync.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchConvenienceTestAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceTestAsync.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchConvenienceWithAutoDetectedLanguageTest.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceWithAutoDetectedLanguageTest.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchConvenienceWithAutoDetectedLanguageTest.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceWithAutoDetectedLanguageTest.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchConvenienceWithAutoDetectedLanguageTestAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceWithAutoDetectedLanguageTestAsync.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchConvenienceWithAutoDetectedLanguageTestAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceWithAutoDetectedLanguageTestAsync.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchConvenienceWithStatisticsTest.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceWithStatisticsTest.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchConvenienceWithStatisticsTest.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceWithStatisticsTest.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchConvenienceWithStatisticsTestAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceWithStatisticsTestAsync.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchConvenienceWithStatisticsTestAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchConvenienceWithStatisticsTestAsync.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchTest.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchTest.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchTest.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchTest.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchTestAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchTestAsync.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchTestAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchTestAsync.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchWithErrorTest.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithErrorTest.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchWithErrorTest.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithErrorTest.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchWithErrorTestAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithErrorTestAsync.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchWithErrorTestAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithErrorTestAsync.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchWithRankOrderTest.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithRankOrderTest.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchWithRankOrderTest.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithRankOrderTest.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchWithRankOrderTestAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithRankOrderTestAsync.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchWithRankOrderTestAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithRankOrderTestAsync.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchWithStatisticsTest.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithStatisticsTest.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchWithStatisticsTest.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithStatisticsTest.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchWithStatisticsTestAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithStatisticsTestAsync.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryBatchWithStatisticsTestAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeBatchWithStatisticsTestAsync.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryWithAADTest.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeWithAADTest.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryWithAADTest.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeWithAADTest.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryWithAADTestAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeWithAADTestAsync.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractSummaryTests/ExtractSummaryWithAADTestAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/ExtractiveSummarizeTests/ExtractiveSummarizeWithAADTestAsync.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsClientTests.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsClientTests.cs index 6ac613186843..846a584b34d4 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsClientTests.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsClientTests.cs @@ -148,13 +148,13 @@ public void RecognizeLinkedEntitiesArgumentValidation() } [Test] - public void ExtractSummaryArgumentValidation() + public void ExtractiveSummarizeArgumentValidation() { - Assert.ThrowsAsync(() => Client.StartExtractSummaryAsync((string[])null)); - Assert.ThrowsAsync(() => Client.StartExtractSummaryAsync(Array.Empty())); + Assert.ThrowsAsync(() => Client.StartExtractiveSummarizeAsync((string[])null)); + Assert.ThrowsAsync(() => Client.StartExtractiveSummarizeAsync(Array.Empty())); - Assert.ThrowsAsync(() => Client.StartExtractSummaryAsync((TextDocumentInput[])null)); - Assert.ThrowsAsync(() => Client.StartExtractSummaryAsync(Array.Empty())); + Assert.ThrowsAsync(() => Client.StartExtractiveSummarizeAsync((TextDocumentInput[])null)); + Assert.ThrowsAsync(() => Client.StartExtractiveSummarizeAsync(Array.Empty())); } [Test] diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsModelFactoryTests.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsModelFactoryTests.cs index c774c90ad317..c766215794e1 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsModelFactoryTests.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsModelFactoryTests.cs @@ -70,10 +70,10 @@ public void AnalyzeActionsResult() TextAnalyticsModelFactory.AnalyzeHealthcareEntitiesActionResult(default, default, default), }; - var extractSummaryActionResults = new List() + var extractiveSummarizeActionResults = new List() { - TextAnalyticsModelFactory.ExtractSummaryActionResult(default, default, default), - TextAnalyticsModelFactory.ExtractSummaryActionResult(default, default, default), + TextAnalyticsModelFactory.ExtractiveSummarizeActionResult(default, default, default), + TextAnalyticsModelFactory.ExtractiveSummarizeActionResult(default, default, default), }; var abstractSummaryActionResults = new List() @@ -105,7 +105,7 @@ public void AnalyzeActionsResult() singleLabelClassifyActionResults, multiLabelClassifyActionResults, analyzeHealthcareEntitiesActionResults, - extractSummaryActionResults, + extractiveSummarizeActionResults, abstractSummaryActionResults); CollectionAssert.AreEquivalent(extractKeyPhrasesActionResults, actionsResult.ExtractKeyPhrasesResults); @@ -117,7 +117,7 @@ public void AnalyzeActionsResult() CollectionAssert.AreEquivalent(singleLabelClassifyActionResults, actionsResult.SingleLabelClassifyResults); CollectionAssert.AreEquivalent(multiLabelClassifyActionResults, actionsResult.MultiLabelClassifyResults); CollectionAssert.AreEquivalent(analyzeHealthcareEntitiesActionResults, actionsResult.AnalyzeHealthcareEntitiesResults); - CollectionAssert.AreEquivalent(extractSummaryActionResults, actionsResult.ExtractSummaryResults); + CollectionAssert.AreEquivalent(extractiveSummarizeActionResults, actionsResult.ExtractiveSummarizeResults); CollectionAssert.AreEquivalent(abstractSummaryActionResults, actionsResult.AbstractSummaryResults); } #endregion Action Result Models diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractSummary.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractiveSummarize.cs similarity index 93% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractSummary.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractiveSummarize.cs index 60c99fedca08..1196df8a6d4e 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractSummary.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractiveSummarize.cs @@ -10,7 +10,7 @@ namespace Azure.AI.TextAnalytics.Samples public partial class TextAnalyticsSamples : TextAnalyticsSampleBase { [Test] - public void ExtractSummary() + public void ExtractiveSummarize() { Uri endpoint = new(TestEnvironment.Endpoint); AzureKeyCredential credential = new(TestEnvironment.ApiKey); @@ -63,14 +63,14 @@ public void ExtractSummary() } }; - ExtractSummaryOptions options = new() + ExtractiveSummarizeOptions options = new() { MaxSentenceCount = 5, OrderBy = SummarySentencesOrder.Rank }; // Perform the text analysis operation. - ExtractSummaryOperation operation = client.StartExtractSummary(batchedDocuments, options); + ExtractiveSummarizeOperation operation = client.StartExtractiveSummarize(batchedDocuments, options); operation.WaitForCompletion(); Console.WriteLine($"The operation has completed."); @@ -85,12 +85,12 @@ public void ExtractSummary() Console.WriteLine(); // View the operation results. - foreach (ExtractSummaryResultCollection documentsInPage in operation.GetValues()) + foreach (ExtractiveSummarizeResultCollection documentsInPage in operation.GetValues()) { - Console.WriteLine($"Extract Summary, model version: \"{documentsInPage.ModelVersion}\""); + Console.WriteLine($"Extractive Summarize, model version: \"{documentsInPage.ModelVersion}\""); Console.WriteLine(); - foreach (ExtractSummaryResult documentResult in documentsInPage) + foreach (ExtractiveSummarizeResult documentResult in documentsInPage) { if (documentResult.HasError) { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractSummaryAsync.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractiveSummarizeAsync.cs similarity index 93% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractSummaryAsync.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractiveSummarizeAsync.cs index 0c4f80724d17..33ada25c3496 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractSummaryAsync.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractiveSummarizeAsync.cs @@ -11,7 +11,7 @@ namespace Azure.AI.TextAnalytics.Samples public partial class TextAnalyticsSamples : TextAnalyticsSampleBase { [Test] - public async Task ExtractSummaryAsync() + public async Task ExtractiveSummarizeAsync() { Uri endpoint = new(TestEnvironment.Endpoint); AzureKeyCredential credential = new(TestEnvironment.ApiKey); @@ -64,14 +64,14 @@ public async Task ExtractSummaryAsync() } }; - ExtractSummaryOptions options = new() + ExtractiveSummarizeOptions options = new() { MaxSentenceCount = 5, OrderBy = SummarySentencesOrder.Rank }; // Perform the text analysis operation. - ExtractSummaryOperation operation = client.StartExtractSummary(batchedDocuments, options); + ExtractiveSummarizeOperation operation = client.StartExtractiveSummarize(batchedDocuments, options); await operation.WaitForCompletionAsync(); Console.WriteLine($"The operation has completed."); @@ -86,12 +86,12 @@ public async Task ExtractSummaryAsync() Console.WriteLine(); // View the operation results. - await foreach (ExtractSummaryResultCollection documentsInPage in operation.Value) + await foreach (ExtractiveSummarizeResultCollection documentsInPage in operation.Value) { - Console.WriteLine($"Extract Summary, model version: \"{documentsInPage.ModelVersion}\""); + Console.WriteLine($"Extractive Summarize, model version: \"{documentsInPage.ModelVersion}\""); Console.WriteLine(); - foreach (ExtractSummaryResult documentResult in documentsInPage) + foreach (ExtractiveSummarizeResult documentResult in documentsInPage) { if (documentResult.HasError) { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractSummaryConvenience.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractiveSummarizeConvenience.cs similarity index 93% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractSummaryConvenience.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractiveSummarizeConvenience.cs index 6b5471186c33..5ecc3cbb5671 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractSummaryConvenience.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractiveSummarizeConvenience.cs @@ -10,7 +10,7 @@ namespace Azure.AI.TextAnalytics.Samples public partial class TextAnalyticsSamples : TextAnalyticsSampleBase { [Test] - public void ExtractSummaryConvenience() + public void ExtractiveSummarizeConvenience() { Uri endpoint = new(TestEnvironment.Endpoint); AzureKeyCredential credential = new(TestEnvironment.ApiKey); @@ -61,7 +61,7 @@ public void ExtractSummaryConvenience() }; // Perform the text analysis operation. - ExtractSummaryOperation operation = client.StartExtractSummary(batchedDocuments); + ExtractiveSummarizeOperation operation = client.StartExtractiveSummarize(batchedDocuments); operation.WaitForCompletion(); Console.WriteLine($"The operation has completed."); @@ -76,12 +76,12 @@ public void ExtractSummaryConvenience() Console.WriteLine(); // View the operation results. - foreach (ExtractSummaryResultCollection documentsInPage in operation.GetValues()) + foreach (ExtractiveSummarizeResultCollection documentsInPage in operation.GetValues()) { - Console.WriteLine($"Extract Summary, model version: \"{documentsInPage.ModelVersion}\""); + Console.WriteLine($"Extractive Summarize, model version: \"{documentsInPage.ModelVersion}\""); Console.WriteLine(); - foreach (ExtractSummaryResult documentResult in documentsInPage) + foreach (ExtractiveSummarizeResult documentResult in documentsInPage) { if (documentResult.HasError) { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractSummaryConvenienceAsync.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractiveSummarizeConvenienceAsync.cs similarity index 90% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractSummaryConvenienceAsync.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractiveSummarizeConvenienceAsync.cs index e1f1a7a586b5..561ef90c7f96 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractSummaryConvenienceAsync.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample11_ExtractiveSummarizeConvenienceAsync.cs @@ -11,13 +11,13 @@ namespace Azure.AI.TextAnalytics.Samples public partial class TextAnalyticsSamples : TextAnalyticsSampleBase { [Test] - public async Task ExtractSummaryConvenienceAsync() + public async Task ExtractiveSummarizeConvenienceAsync() { Uri endpoint = new(TestEnvironment.Endpoint); AzureKeyCredential credential = new(TestEnvironment.ApiKey); TextAnalyticsClient client = new(endpoint, credential, CreateSampleOptions()); - #region Snippet:Sample11_ExtractSummaryConvenienceAsync + #region Snippet:Sample11_ExtractiveSummarizeConvenienceAsync string document = "Windows 365 was in the works before COVID-19 sent companies around the world on a scramble to secure" + " solutions to support employees suddenly forced to work from home, but “what really put the" @@ -63,14 +63,14 @@ public async Task ExtractSummaryConvenienceAsync() }; // Perform the text analysis operation. - ExtractSummaryOperation operation = client.StartExtractSummary(batchedDocuments); + ExtractiveSummarizeOperation operation = client.StartExtractiveSummarize(batchedDocuments); await operation.WaitForCompletionAsync(); #endregion Console.WriteLine($"The operation has completed."); Console.WriteLine(); - #region Snippet:Sample11_ExtractSummaryConvenienceAsync_ViewOperationStatus + #region Snippet:Sample11_ExtractiveSummarizeConvenienceAsync_ViewOperationStatus // View the operation status. Console.WriteLine($"Created On : {operation.CreatedOn}"); Console.WriteLine($"Expires On : {operation.ExpiresOn}"); @@ -80,14 +80,14 @@ public async Task ExtractSummaryConvenienceAsync() Console.WriteLine(); #endregion - #region Snippet:Sample11_ExtractSummaryConvenienceAsync_ViewResults + #region Snippet:Sample11_ExtractiveSummarizeConvenienceAsync_ViewResults // View the operation results. - await foreach (ExtractSummaryResultCollection documentsInPage in operation.Value) + await foreach (ExtractiveSummarizeResultCollection documentsInPage in operation.Value) { - Console.WriteLine($"Extract Summary, version: \"{documentsInPage.ModelVersion}\""); + Console.WriteLine($"Extractive Summarize, version: \"{documentsInPage.ModelVersion}\""); Console.WriteLine(); - foreach (ExtractSummaryResult documentResult in documentsInPage) + foreach (ExtractiveSummarizeResult documentResult in documentsInPage) { if (documentResult.HasError) { From 4b7e5cd634e2c94310a1e28654b021b437b1323d Mon Sep 17 00:00:00 2001 From: Jose Arriaga Maldonado Date: Fri, 26 May 2023 16:13:55 -0700 Subject: [PATCH 2/3] Rename AbstractSummary to AbstractiveSummarize --- .../Azure.AI.TextAnalytics/README.md | 4 +- .../Azure.AI.TextAnalytics.netstandard2.0.cs | 78 +++++++------- .../Azure.AI.TextAnalytics/samples/README.md | 2 +- .../samples/Sample12_AbstractSummary.md | 18 ++-- ...ction.cs => AbstractiveSummarizeAction.cs} | 12 +-- ...cs => AbstractiveSummarizeActionResult.cs} | 18 ++-- ...on.cs => AbstractiveSummarizeOperation.cs} | 54 +++++----- ...ions.cs => AbstractiveSummarizeOptions.cs} | 6 +- ...esult.cs => AbstractiveSummarizeResult.cs} | 10 +- ...> AbstractiveSummarizeResultCollection.cs} | 20 ++-- .../src/AnalyzeActionsResult.cs | 10 +- .../ServiceClients/LanguageServiceClient.cs | 40 +++---- .../src/ServiceClients/LegacyServiceClient.cs | 4 +- .../src/ServiceClients/ServiceClient.cs | 18 ++-- .../src/TextAnalyticsActions.cs | 4 +- .../src/TextAnalyticsClient.cs | 50 ++++----- .../src/TextAnalyticsModelFactory.cs | 70 ++++++------ .../Azure.AI.TextAnalytics/src/Transforms.cs | 34 +++--- ...yTests.cs => AbstractiveSummarizeTests.cs} | 100 +++++++++--------- ...ractiveSummarizeBatchConvenienceTest.json} | 0 ...veSummarizeBatchConvenienceTestAsync.json} | 0 ...zeBatchConvenienceWithStatisticsTest.json} | 0 ...chConvenienceWithStatisticsTestAsync.json} | 0 .../AbstractiveSummarizeBatchTest.json} | 0 .../AbstractiveSummarizeBatchTestAsync.json} | 0 ...stractiveSummarizeBatchWithErrorTest.json} | 0 ...tiveSummarizeBatchWithErrorTestAsync.json} | 0 ...tiveSummarizeBatchWithStatisticsTest.json} | 0 ...ummarizeBatchWithStatisticsTestAsync.json} | 0 .../AbstractiveSummarizeWithAADTest.json} | 0 ...AbstractiveSummarizeWithAADTestAsync.json} | 0 ...AnalyzeOperationAbstractiveSummarize.json} | 8 +- ...zeOperationAbstractiveSummarizeAsync.json} | 8 +- .../tests/TextAnalyticsClientTests.cs | 10 +- .../tests/TextAnalyticsModelFactoryTests.cs | 10 +- ...ry.cs => Sample12_AbstractiveSummarize.cs} | 12 +-- ... => Sample12_AbstractiveSummarizeAsync.cs} | 12 +-- ...mple12_AbstractiveSummarizeConvenience.cs} | 10 +- ...2_AbstractiveSummarizeConvenienceAsync.cs} | 16 +-- 39 files changed, 319 insertions(+), 319 deletions(-) rename sdk/textanalytics/Azure.AI.TextAnalytics/src/{AbstractSummaryAction.cs => AbstractiveSummarizeAction.cs} (88%) rename sdk/textanalytics/Azure.AI.TextAnalytics/src/{AbstractSummaryActionResult.cs => AbstractiveSummarizeActionResult.cs} (59%) rename sdk/textanalytics/Azure.AI.TextAnalytics/src/{AbstractSummaryOperation.cs => AbstractiveSummarizeOperation.cs} (79%) rename sdk/textanalytics/Azure.AI.TextAnalytics/src/{AbstractSummaryOptions.cs => AbstractiveSummarizeOptions.cs} (85%) rename sdk/textanalytics/Azure.AI.TextAnalytics/src/{AbstractSummaryResult.cs => AbstractiveSummarizeResult.cs} (85%) rename sdk/textanalytics/Azure.AI.TextAnalytics/src/{AbstractSummaryResultCollection.cs => AbstractiveSummarizeResultCollection.cs} (73%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/{AbstractSummaryTests.cs => AbstractiveSummarizeTests.cs} (81%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{AbstractSummaryTests/AbstractSummaryBatchConvenienceTest.json => AbstractiveSummarizeTests/AbstractiveSummarizeBatchConvenienceTest.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{AbstractSummaryTests/AbstractSummaryBatchConvenienceTestAsync.json => AbstractiveSummarizeTests/AbstractiveSummarizeBatchConvenienceTestAsync.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{AbstractSummaryTests/AbstractSummaryBatchConvenienceWithStatisticsTest.json => AbstractiveSummarizeTests/AbstractiveSummarizeBatchConvenienceWithStatisticsTest.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{AbstractSummaryTests/AbstractSummaryBatchConvenienceWithStatisticsTestAsync.json => AbstractiveSummarizeTests/AbstractiveSummarizeBatchConvenienceWithStatisticsTestAsync.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{AbstractSummaryTests/AbstractSummaryBatchTest.json => AbstractiveSummarizeTests/AbstractiveSummarizeBatchTest.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{AbstractSummaryTests/AbstractSummaryBatchTestAsync.json => AbstractiveSummarizeTests/AbstractiveSummarizeBatchTestAsync.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{AbstractSummaryTests/AbstractSummaryBatchWithErrorTest.json => AbstractiveSummarizeTests/AbstractiveSummarizeBatchWithErrorTest.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{AbstractSummaryTests/AbstractSummaryBatchWithErrorTestAsync.json => AbstractiveSummarizeTests/AbstractiveSummarizeBatchWithErrorTestAsync.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{AbstractSummaryTests/AbstractSummaryBatchWithStatisticsTest.json => AbstractiveSummarizeTests/AbstractiveSummarizeBatchWithStatisticsTest.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{AbstractSummaryTests/AbstractSummaryBatchWithStatisticsTestAsync.json => AbstractiveSummarizeTests/AbstractiveSummarizeBatchWithStatisticsTestAsync.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{AbstractSummaryTests/AbstractSummaryWithAADTest.json => AbstractiveSummarizeTests/AbstractiveSummarizeWithAADTest.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{AbstractSummaryTests/AbstractSummaryWithAADTestAsync.json => AbstractiveSummarizeTests/AbstractiveSummarizeWithAADTestAsync.json} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{AbstractSummaryTests/AnalyzeOperationAbstractSummary.json => AbstractiveSummarizeTests/AnalyzeOperationAbstractiveSummarize.json} (98%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/{AbstractSummaryTests/AnalyzeOperationAbstractSummaryAsync.json => AbstractiveSummarizeTests/AnalyzeOperationAbstractiveSummarizeAsync.json} (98%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/{Sample12_AbstractSummary.cs => Sample12_AbstractiveSummarize.cs} (93%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/{Sample12_AbstractSummaryAsync.cs => Sample12_AbstractiveSummarizeAsync.cs} (93%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/{Sample12_AbstractSummaryConvenience.cs => Sample12_AbstractiveSummarizeConvenience.cs} (93%) rename sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/{Sample12_AbstractSummaryConvenienceAsync.cs => Sample12_AbstractiveSummarizeConvenienceAsync.cs} (90%) diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/README.md b/sdk/textanalytics/Azure.AI.TextAnalytics/README.md index 0fff560954a7..16594cd9ae32 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/README.md +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/README.md @@ -757,7 +757,7 @@ Samples are provided for each main functional area, and for each area, samples a * [Custom Single Label Classification][single_category_classify_sample] * [Custom Multi Label Classification][multi_category_classify_sample] * [Extractive Summarization][extractive_summarize_sample] -* [Abstractive Summarization][abstract_summary_sample] +* [Abstractive Summarization][abstractive_summarize_sample] ### Advanced samples @@ -824,7 +824,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con [single_category_classify_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample9_SingleLabelClassify.md [multi_category_classify_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample10_MultiLabelClassify.md [extractive_summarize_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractiveSummarize.md -[abstract_summary_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractSummary.md +[abstractive_summarize_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractiveSummarize.md [azure_cli]: https://docs.microsoft.com/cli/azure [azure_sub]: https://azure.microsoft.com/free/dotnet/ diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/api/Azure.AI.TextAnalytics.netstandard2.0.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/api/Azure.AI.TextAnalytics.netstandard2.0.cs index c0f48e753bde..027b1024688f 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/api/Azure.AI.TextAnalytics.netstandard2.0.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/api/Azure.AI.TextAnalytics.netstandard2.0.cs @@ -1,31 +1,23 @@ namespace Azure.AI.TextAnalytics { - [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)] - public readonly partial struct AbstractiveSummary - { - private readonly object _dummy; - private readonly int _dummyPrimitive; - public System.Collections.Generic.IReadOnlyCollection Contexts { get { throw null; } } - public string Text { get { throw null; } } - } - public partial class AbstractSummaryAction + public partial class AbstractiveSummarizeAction { - public AbstractSummaryAction() { } - public AbstractSummaryAction(Azure.AI.TextAnalytics.AbstractSummaryOptions options) { } + public AbstractiveSummarizeAction() { } + public AbstractiveSummarizeAction(Azure.AI.TextAnalytics.AbstractiveSummarizeOptions options) { } public string ActionName { get { throw null; } set { } } public bool? DisableServiceLogs { get { throw null; } set { } } public string ModelVersion { get { throw null; } set { } } public int? SentenceCount { get { throw null; } set { } } } - public partial class AbstractSummaryActionResult : Azure.AI.TextAnalytics.TextAnalyticsActionResult + public partial class AbstractiveSummarizeActionResult : Azure.AI.TextAnalytics.TextAnalyticsActionResult { - internal AbstractSummaryActionResult() { } - public Azure.AI.TextAnalytics.AbstractSummaryResultCollection DocumentsResults { get { throw null; } } + internal AbstractiveSummarizeActionResult() { } + public Azure.AI.TextAnalytics.AbstractiveSummarizeResultCollection DocumentsResults { get { throw null; } } } - public partial class AbstractSummaryOperation : Azure.PageableOperation + public partial class AbstractiveSummarizeOperation : Azure.PageableOperation { - protected AbstractSummaryOperation() { } - public AbstractSummaryOperation(string operationId, Azure.AI.TextAnalytics.TextAnalyticsClient client) { } + protected AbstractiveSummarizeOperation() { } + public AbstractiveSummarizeOperation(string operationId, Azure.AI.TextAnalytics.TextAnalyticsClient client) { } public virtual System.DateTimeOffset CreatedOn { get { throw null; } } public virtual string DisplayName { get { throw null; } } public virtual System.DateTimeOffset? ExpiresOn { get { throw null; } } @@ -37,32 +29,40 @@ public AbstractSummaryOperation(string operationId, Azure.AI.TextAnalytics.TextA public virtual void Cancel(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { } public virtual System.Threading.Tasks.Task CancelAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public override Azure.Response GetRawResponse() { throw null; } - public override Azure.Pageable GetValues(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } - public override Azure.AsyncPageable GetValuesAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public override Azure.Pageable GetValues(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public override Azure.AsyncPageable GetValuesAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public override Azure.Response UpdateStatus(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public override System.Threading.Tasks.ValueTask UpdateStatusAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } - public override System.Threading.Tasks.ValueTask>> WaitForCompletionAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } - public override System.Threading.Tasks.ValueTask>> WaitForCompletionAsync(System.TimeSpan pollingInterval, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public override System.Threading.Tasks.ValueTask>> WaitForCompletionAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public override System.Threading.Tasks.ValueTask>> WaitForCompletionAsync(System.TimeSpan pollingInterval, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } } - public partial class AbstractSummaryOptions : Azure.AI.TextAnalytics.TextAnalyticsRequestOptions + public partial class AbstractiveSummarizeOptions : Azure.AI.TextAnalytics.TextAnalyticsRequestOptions { - public AbstractSummaryOptions() { } + public AbstractiveSummarizeOptions() { } public string DisplayName { get { throw null; } set { } } public int? SentenceCount { get { throw null; } set { } } } - public partial class AbstractSummaryResult : Azure.AI.TextAnalytics.TextAnalyticsResult + public partial class AbstractiveSummarizeResult : Azure.AI.TextAnalytics.TextAnalyticsResult { - internal AbstractSummaryResult() { } + internal AbstractiveSummarizeResult() { } public Azure.AI.TextAnalytics.DetectedLanguage? DetectedLanguage { get { throw null; } } public System.Collections.Generic.IReadOnlyCollection Summaries { get { throw null; } } public System.Collections.Generic.IReadOnlyCollection Warnings { get { throw null; } } } - public partial class AbstractSummaryResultCollection : System.Collections.ObjectModel.ReadOnlyCollection + public partial class AbstractiveSummarizeResultCollection : System.Collections.ObjectModel.ReadOnlyCollection { - internal AbstractSummaryResultCollection() : base (default(System.Collections.Generic.IList)) { } + internal AbstractiveSummarizeResultCollection() : base (default(System.Collections.Generic.IList)) { } public string ModelVersion { get { throw null; } } public Azure.AI.TextAnalytics.TextDocumentBatchStatistics Statistics { get { throw null; } } } + [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)] + public readonly partial struct AbstractiveSummary + { + private readonly object _dummy; + private readonly int _dummyPrimitive; + public System.Collections.Generic.IReadOnlyCollection Contexts { get { throw null; } } + public string Text { get { throw null; } } + } public partial class AgeResolution : Azure.AI.TextAnalytics.BaseResolution { internal AgeResolution() { } @@ -126,7 +126,7 @@ public AnalyzeActionsOptions() { } public partial class AnalyzeActionsResult { internal AnalyzeActionsResult() { } - public System.Collections.Generic.IReadOnlyCollection AbstractSummaryResults { get { throw null; } } + public System.Collections.Generic.IReadOnlyCollection AbstractiveSummarizeResults { get { throw null; } } public System.Collections.Generic.IReadOnlyCollection AnalyzeHealthcareEntitiesResults { get { throw null; } } public System.Collections.Generic.IReadOnlyCollection AnalyzeSentimentResults { get { throw null; } } public System.Collections.Generic.IReadOnlyCollection ExtractiveSummarizeResults { get { throw null; } } @@ -1506,7 +1506,7 @@ internal TextAnalyticsActionResult() { } public partial class TextAnalyticsActions { public TextAnalyticsActions() { } - public System.Collections.Generic.IReadOnlyCollection AbstractSummaryActions { get { throw null; } set { } } + public System.Collections.Generic.IReadOnlyCollection AbstractiveSummarizeActions { get { throw null; } set { } } public System.Collections.Generic.IReadOnlyCollection AnalyzeHealthcareEntitiesActions { get { throw null; } set { } } public System.Collections.Generic.IReadOnlyCollection AnalyzeSentimentActions { get { throw null; } set { } } public string DisplayName { get { throw null; } set { } } @@ -1597,10 +1597,10 @@ public TextAnalyticsClient(System.Uri endpoint, Azure.Core.TokenCredential crede public virtual Azure.Response RecognizePiiEntitiesBatch(System.Collections.Generic.IEnumerable documents, string language = null, Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public virtual System.Threading.Tasks.Task> RecognizePiiEntitiesBatchAsync(System.Collections.Generic.IEnumerable documents, Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public virtual System.Threading.Tasks.Task> RecognizePiiEntitiesBatchAsync(System.Collections.Generic.IEnumerable documents, string language = null, Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } - public virtual Azure.AI.TextAnalytics.AbstractSummaryOperation StartAbstractSummary(System.Collections.Generic.IEnumerable documents, Azure.AI.TextAnalytics.AbstractSummaryOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } - public virtual Azure.AI.TextAnalytics.AbstractSummaryOperation StartAbstractSummary(System.Collections.Generic.IEnumerable documents, string language = null, Azure.AI.TextAnalytics.AbstractSummaryOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } - public virtual System.Threading.Tasks.Task StartAbstractSummaryAsync(System.Collections.Generic.IEnumerable documents, Azure.AI.TextAnalytics.AbstractSummaryOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } - public virtual System.Threading.Tasks.Task StartAbstractSummaryAsync(System.Collections.Generic.IEnumerable documents, string language = null, Azure.AI.TextAnalytics.AbstractSummaryOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public virtual Azure.AI.TextAnalytics.AbstractiveSummarizeOperation StartAbstractiveSummarize(System.Collections.Generic.IEnumerable documents, Azure.AI.TextAnalytics.AbstractiveSummarizeOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public virtual Azure.AI.TextAnalytics.AbstractiveSummarizeOperation StartAbstractiveSummarize(System.Collections.Generic.IEnumerable documents, string language = null, Azure.AI.TextAnalytics.AbstractiveSummarizeOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public virtual System.Threading.Tasks.Task StartAbstractiveSummarizeAsync(System.Collections.Generic.IEnumerable documents, Azure.AI.TextAnalytics.AbstractiveSummarizeOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } + public virtual System.Threading.Tasks.Task StartAbstractiveSummarizeAsync(System.Collections.Generic.IEnumerable documents, string language = null, Azure.AI.TextAnalytics.AbstractiveSummarizeOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public virtual Azure.AI.TextAnalytics.AnalyzeActionsOperation StartAnalyzeActions(System.Collections.Generic.IEnumerable documents, Azure.AI.TextAnalytics.TextAnalyticsActions actions, Azure.AI.TextAnalytics.AnalyzeActionsOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public virtual Azure.AI.TextAnalytics.AnalyzeActionsOperation StartAnalyzeActions(System.Collections.Generic.IEnumerable documents, Azure.AI.TextAnalytics.TextAnalyticsActions actions, string language = null, Azure.AI.TextAnalytics.AnalyzeActionsOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } public virtual System.Threading.Tasks.Task StartAnalyzeActionsAsync(System.Collections.Generic.IEnumerable documents, Azure.AI.TextAnalytics.TextAnalyticsActions actions, Azure.AI.TextAnalytics.AnalyzeActionsOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; } @@ -1689,12 +1689,12 @@ internal TextAnalyticsInput() { } } public static partial class TextAnalyticsModelFactory { + public static Azure.AI.TextAnalytics.AbstractiveSummarizeActionResult AbstractiveSummarizeActionResult(Azure.AI.TextAnalytics.AbstractiveSummarizeResultCollection result, string actionName, System.DateTimeOffset completedOn) { throw null; } + public static Azure.AI.TextAnalytics.AbstractiveSummarizeActionResult AbstractiveSummarizeActionResult(string actionName, System.DateTimeOffset completedOn, string code, string message) { throw null; } + public static Azure.AI.TextAnalytics.AbstractiveSummarizeResult AbstractiveSummarizeResult(string id, Azure.AI.TextAnalytics.TextDocumentStatistics statistics, System.Collections.Generic.IEnumerable summaries, Azure.AI.TextAnalytics.DetectedLanguage? detectedLanguage = default(Azure.AI.TextAnalytics.DetectedLanguage?), System.Collections.Generic.IEnumerable warnings = null) { throw null; } + public static Azure.AI.TextAnalytics.AbstractiveSummarizeResult AbstractiveSummarizeResult(string id, string code, string message) { throw null; } + public static Azure.AI.TextAnalytics.AbstractiveSummarizeResultCollection AbstractiveSummarizeResultCollection(System.Collections.Generic.IEnumerable results, Azure.AI.TextAnalytics.TextDocumentBatchStatistics statistics, string modelVersion) { throw null; } public static Azure.AI.TextAnalytics.AbstractiveSummary AbstractiveSummary(string text, System.Collections.Generic.IEnumerable contexts) { throw null; } - public static Azure.AI.TextAnalytics.AbstractSummaryActionResult AbstractSummaryActionResult(Azure.AI.TextAnalytics.AbstractSummaryResultCollection result, string actionName, System.DateTimeOffset completedOn) { throw null; } - public static Azure.AI.TextAnalytics.AbstractSummaryActionResult AbstractSummaryActionResult(string actionName, System.DateTimeOffset completedOn, string code, string message) { throw null; } - public static Azure.AI.TextAnalytics.AbstractSummaryResult AbstractSummaryResult(string id, Azure.AI.TextAnalytics.TextDocumentStatistics statistics, System.Collections.Generic.IEnumerable summaries, Azure.AI.TextAnalytics.DetectedLanguage? detectedLanguage = default(Azure.AI.TextAnalytics.DetectedLanguage?), System.Collections.Generic.IEnumerable warnings = null) { throw null; } - public static Azure.AI.TextAnalytics.AbstractSummaryResult AbstractSummaryResult(string id, string code, string message) { throw null; } - public static Azure.AI.TextAnalytics.AbstractSummaryResultCollection AbstractSummaryResultCollection(System.Collections.Generic.IEnumerable results, Azure.AI.TextAnalytics.TextDocumentBatchStatistics statistics, string modelVersion) { throw null; } public static Azure.AI.TextAnalytics.AgeResolution AgeResolution(Azure.AI.TextAnalytics.AgeUnit unit, double value) { throw null; } [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)] public static Azure.AI.TextAnalytics.AnalyzeActionsResult AnalyzeActionsResult(System.Collections.Generic.IEnumerable extractKeyPhrasesActionResult, System.Collections.Generic.IEnumerable recognizeEntitiesActionResults, System.Collections.Generic.IEnumerable recognizePiiEntitiesActionResults, System.Collections.Generic.IEnumerable recognizeLinkedEntitiesActionsResults, System.Collections.Generic.IEnumerable analyzeSentimentActionsResults) { throw null; } @@ -1702,7 +1702,7 @@ public static partial class TextAnalyticsModelFactory public static Azure.AI.TextAnalytics.AnalyzeActionsResult AnalyzeActionsResult(System.Collections.Generic.IEnumerable extractKeyPhrasesActionResults, System.Collections.Generic.IEnumerable recognizeEntitiesActionResults, System.Collections.Generic.IEnumerable recognizePiiEntitiesActionResults, System.Collections.Generic.IEnumerable recognizeLinkedEntitiesActionResults, System.Collections.Generic.IEnumerable analyzeSentimentActionResults, System.Collections.Generic.IEnumerable recognizeCustomEntitiesActionResults, System.Collections.Generic.IEnumerable singleLabelClassifyActionResults, System.Collections.Generic.IEnumerable multiLabelClassifyActionResults) { throw null; } [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)] public static Azure.AI.TextAnalytics.AnalyzeActionsResult AnalyzeActionsResult(System.Collections.Generic.IEnumerable extractKeyPhrasesActionResults, System.Collections.Generic.IEnumerable recognizeEntitiesActionResults, System.Collections.Generic.IEnumerable recognizePiiEntitiesActionResults, System.Collections.Generic.IEnumerable recognizeLinkedEntitiesActionResults, System.Collections.Generic.IEnumerable analyzeSentimentActionResults, System.Collections.Generic.IEnumerable recognizeCustomEntitiesActionResults, System.Collections.Generic.IEnumerable singleLabelClassifyActionResults, System.Collections.Generic.IEnumerable multiLabelClassifyActionResults, System.Collections.Generic.IEnumerable analyzeHealthcareEntitiesActionResults) { throw null; } - public static Azure.AI.TextAnalytics.AnalyzeActionsResult AnalyzeActionsResult(System.Collections.Generic.IEnumerable extractKeyPhrasesActionResults, System.Collections.Generic.IEnumerable recognizeEntitiesActionResults, System.Collections.Generic.IEnumerable recognizePiiEntitiesActionResults, System.Collections.Generic.IEnumerable recognizeLinkedEntitiesActionResults, System.Collections.Generic.IEnumerable analyzeSentimentActionResults, System.Collections.Generic.IEnumerable recognizeCustomEntitiesActionResults, System.Collections.Generic.IEnumerable singleLabelClassifyActionResults, System.Collections.Generic.IEnumerable multiLabelClassifyActionResults, System.Collections.Generic.IEnumerable analyzeHealthcareEntitiesActionResults, System.Collections.Generic.IEnumerable extractiveSummarizeActionResults, System.Collections.Generic.IEnumerable abstractSummaryActionResults) { throw null; } + public static Azure.AI.TextAnalytics.AnalyzeActionsResult AnalyzeActionsResult(System.Collections.Generic.IEnumerable extractKeyPhrasesActionResults, System.Collections.Generic.IEnumerable recognizeEntitiesActionResults, System.Collections.Generic.IEnumerable recognizePiiEntitiesActionResults, System.Collections.Generic.IEnumerable recognizeLinkedEntitiesActionResults, System.Collections.Generic.IEnumerable analyzeSentimentActionResults, System.Collections.Generic.IEnumerable recognizeCustomEntitiesActionResults, System.Collections.Generic.IEnumerable singleLabelClassifyActionResults, System.Collections.Generic.IEnumerable multiLabelClassifyActionResults, System.Collections.Generic.IEnumerable analyzeHealthcareEntitiesActionResults, System.Collections.Generic.IEnumerable extractiveSummarizeActionResults, System.Collections.Generic.IEnumerable abstractiveSummarizeActionResults) { throw null; } public static Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesActionResult AnalyzeHealthcareEntitiesActionResult(Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesResultCollection result, string actionName, System.DateTimeOffset completedOn) { throw null; } public static Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesActionResult AnalyzeHealthcareEntitiesActionResult(string actionName, System.DateTimeOffset completedOn, string code, string message) { throw null; } public static Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesResult AnalyzeHealthcareEntitiesResult(string id, Azure.AI.TextAnalytics.TextDocumentStatistics statistics, System.Collections.Generic.IEnumerable healthcareEntities, System.Collections.Generic.IEnumerable entityRelations, System.BinaryData fhirBundle, string detectedLanguage, System.Collections.Generic.IEnumerable warnings) { throw null; } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md b/sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md index 5a4bb9b16176..5104789eb48c 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md @@ -41,7 +41,7 @@ See the [README][README] of the Text Analytics client library for more informati * [Custom Single Label Classification](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample9_SingleLabelClassify.md) * [Custom Multi Label Classification](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample10_MultiLabelClassify.md) * [Extractive Summarization](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractiveSummarize.md) -* [Abstractive Summarization](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractSummary.md) +* [Abstractive Summarization](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractiveSummarize.md) ## Advanced samples diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractSummary.md b/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractSummary.md index 0b542c79945b..66f28740f747 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractSummary.md +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractSummary.md @@ -16,9 +16,9 @@ The values of the `endpoint` and `apiKey` variables can be retrieved from enviro ## Summarize one or more documents -To summarize one or more text documents using abstractive summarization, call `StartAbstractSummary` on the `TextAnalyticsClient` by passing the documents as either an `IEnumerable` parameter or an `IEnumerable` parameter. This returns an `AbstractSummaryOperation`. +To summarize one or more text documents using abstractive summarization, call `StartAbstractiveSummarize` on the `TextAnalyticsClient` by passing the documents as either an `IEnumerable` parameter or an `IEnumerable` parameter. This returns an `AbstractiveSummarizeOperation`. -```C# Snippet:Sample12_AbstractSummaryConvenienceAsync +```C# Snippet:Sample12_AbstractiveSummarizeConvenienceAsync string document = "Windows 365 was in the works before COVID-19 sent companies around the world on a scramble to secure" + " solutions to support employees suddenly forced to work from home, but “what really put the" @@ -64,13 +64,13 @@ List batchedDocuments = new() }; // Perform the text analysis operation. -AbstractSummaryOperation operation = client.StartAbstractSummary(batchedDocuments); +AbstractiveSummarizeOperation operation = client.StartAbstractiveSummarize(batchedDocuments); await operation.WaitForCompletionAsync(); ``` -The `AbstractSummaryOperation` includes general information about the status of the long-running operation, and it can be queried at any time: +The `AbstractiveSummarizeOperation` includes general information about the status of the long-running operation, and it can be queried at any time: -```C# Snippet:Sample12_AbstractSummaryConvenienceAsync_ViewOperationStatus +```C# Snippet:Sample12_AbstractiveSummarizeConvenienceAsync_ViewOperationStatus // View the operation status. Console.WriteLine($"Created On : {operation.CreatedOn}"); Console.WriteLine($"Expires On : {operation.ExpiresOn}"); @@ -82,14 +82,14 @@ Console.WriteLine(); Once the long-running operation has completed, you can view the results of the abstractive summarization, including any errors that might have occurred: -```C# Snippet:Sample12_AbstractSummaryConvenienceAsync_ViewResults +```C# Snippet:Sample12_AbstractiveSummarizeConvenienceAsync_ViewResults // View the operation results. -await foreach (AbstractSummaryResultCollection documentsInPage in operation.Value) +await foreach (AbstractiveSummarizeResultCollection documentsInPage in operation.Value) { - Console.WriteLine($"Abstract Summary, model version: \"{documentsInPage.ModelVersion}\""); + Console.WriteLine($"Abstractive Summarize, model version: \"{documentsInPage.ModelVersion}\""); Console.WriteLine(); - foreach (AbstractSummaryResult documentResult in documentsInPage) + foreach (AbstractiveSummarizeResult documentResult in documentsInPage) { if (documentResult.HasError) { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryAction.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeAction.cs similarity index 88% rename from sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryAction.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeAction.cs index 64e94cf2e2ca..34d9f600d77c 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryAction.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeAction.cs @@ -7,20 +7,20 @@ namespace Azure.AI.TextAnalytics /// A set of options used to configure abstractive summarization, including the model version to use, the maximum /// number of sentences that the resulting summary can have, and more. /// - public class AbstractSummaryAction + public class AbstractiveSummarizeAction { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// - public AbstractSummaryAction() + public AbstractiveSummarizeAction() { } /// - /// Initializes a new instance of the class based on the given - /// . + /// Initializes a new instance of the class based on the given + /// . /// - public AbstractSummaryAction(AbstractSummaryOptions options) + public AbstractiveSummarizeAction(AbstractiveSummarizeOptions options) { ModelVersion = options.ModelVersion; DisableServiceLogs = options.DisableServiceLogs; diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryActionResult.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeActionResult.cs similarity index 59% rename from sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryActionResult.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeActionResult.cs index 9e671f9b3fd0..4af5530c639c 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryActionResult.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeActionResult.cs @@ -7,33 +7,33 @@ namespace Azure.AI.TextAnalytics { /// - /// A representation of the result of performing an on a given set of + /// A representation of the result of performing an on a given set of /// documents. /// - public class AbstractSummaryActionResult : TextAnalyticsActionResult + public class AbstractiveSummarizeActionResult : TextAnalyticsActionResult { - private readonly AbstractSummaryResultCollection _documentsResults; + private readonly AbstractiveSummarizeResultCollection _documentsResults; /// - /// Initializes a successful . + /// Initializes a successful . /// - internal AbstractSummaryActionResult( - AbstractSummaryResultCollection result, string actionName, DateTimeOffset completedOn) + internal AbstractiveSummarizeActionResult( + AbstractiveSummarizeResultCollection result, string actionName, DateTimeOffset completedOn) : base(actionName, completedOn) { _documentsResults = result; } /// - /// Initializes an with an error. + /// Initializes an with an error. /// - internal AbstractSummaryActionResult(string actionName, DateTimeOffset completedOn, Error error) + internal AbstractiveSummarizeActionResult(string actionName, DateTimeOffset completedOn, Error error) : base(actionName, completedOn, error) { } /// /// The collection of results corresponding to each input document. /// - public AbstractSummaryResultCollection DocumentsResults + public AbstractiveSummarizeResultCollection DocumentsResults { get { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryOperation.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeOperation.cs similarity index 79% rename from sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryOperation.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeOperation.cs index 8bc150e87a76..de2efbae1e60 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryOperation.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeOperation.cs @@ -17,8 +17,8 @@ namespace Azure.AI.TextAnalytics /// A representation of abstractive summarization being performed on a given set of documents as a pageable, /// long-running operation. /// - public class AbstractSummaryOperation - : PageableOperation, IOperation> + public class AbstractiveSummarizeOperation + : PageableOperation, IOperation> { internal readonly IDictionary _idToIndexMap; @@ -26,14 +26,14 @@ public class AbstractSummaryOperation private readonly string _jobId; private readonly ServiceClient _serviceClient; private readonly ClientDiagnostics _diagnostics; - private readonly OperationInternal> _operationInternal; + private readonly OperationInternal> _operationInternal; private TextAnalyticsOperationStatus _status; private DateTimeOffset? _expiresOn; private DateTimeOffset _lastModified; private DateTimeOffset _createdOn; private string _displayName; - private Page _firstPage; + private Page _firstPage; /// /// The identifier of the long-running operation, which can be used to poll its current status. @@ -76,7 +76,7 @@ public class AbstractSummaryOperation public override bool HasValue => _operationInternal.HasValue; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// /// The identifier of the long-running operation. /// The client used to check for completion. @@ -87,7 +87,7 @@ public class AbstractSummaryOperation /// /// or is null. /// - public AbstractSummaryOperation(string operationId, TextAnalyticsClient client) + public AbstractiveSummarizeOperation(string operationId, TextAnalyticsClient client) { Argument.AssertNotNullOrEmpty(operationId, nameof(operationId)); Argument.AssertNotNull(client, nameof(client)); @@ -102,7 +102,7 @@ public AbstractSummaryOperation(string operationId, TextAnalyticsClient client) } catch (Exception e) { - throw new ArgumentException($"Invalid value. Please use the {nameof(AbstractSummaryOperation)}.{nameof(Id)} property value.", nameof(operationId), e); + throw new ArgumentException($"Invalid value. Please use the {nameof(AbstractiveSummarizeOperation)}.{nameof(Id)} property value.", nameof(operationId), e); } Id = operationId; @@ -112,9 +112,9 @@ public AbstractSummaryOperation(string operationId, TextAnalyticsClient client) } /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// - internal AbstractSummaryOperation( + internal AbstractiveSummarizeOperation( ServiceClient serviceClient, ClientDiagnostics diagnostics, string operationLocation, @@ -133,10 +133,10 @@ internal AbstractSummaryOperation( } /// - /// Initializes a new instance of the class. This constructor is only + /// Initializes a new instance of the class. This constructor is only /// intended for mocking. /// - protected AbstractSummaryOperation() + protected AbstractiveSummarizeOperation() { } @@ -144,7 +144,7 @@ protected AbstractSummaryOperation() /// Gets the last HTTP response received from the server associated with this long-running operation. /// /// - /// An instance of the class sends requests to the server via methods + /// An instance of the class sends requests to the server via methods /// such as , , etc. /// public override Response GetRawResponse() => _operationInternal.RawResponse; @@ -182,7 +182,7 @@ public override async ValueTask UpdateStatusAsync(CancellationToken ca /// /// The controlling the lifetime of the request. /// The HTTP response received from the server. - public override async ValueTask>> WaitForCompletionAsync(CancellationToken cancellationToken = default) => + public override async ValueTask>> WaitForCompletionAsync(CancellationToken cancellationToken = default) => await _operationInternal.WaitForCompletionAsync(cancellationToken).ConfigureAwait(false); /// @@ -197,7 +197,7 @@ public override async ValueTask /// The controlling the lifetime of the request. /// The HTTP response received from the server. - public override async ValueTask>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken cancellationToken = default) => + public override async ValueTask>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken cancellationToken = default) => await _operationInternal.WaitForCompletionAsync(pollingInterval, cancellationToken).ConfigureAwait(false); /// @@ -221,15 +221,15 @@ public virtual async Task CancelAsync(CancellationToken cancellationToken = defa /// The operation must have completed successfully (i.e., is true). /// /// The controlling the lifetime of the request. - public override Pageable GetValues(CancellationToken cancellationToken = default) + public override Pageable GetValues(CancellationToken cancellationToken = default) { // Validates that the operation has completed successfully. _ = _operationInternal.Value; - Page NextPageFunc(string nextLink, int? pageSizeHint) + Page NextPageFunc(string nextLink, int? pageSizeHint) { var response = _serviceClient.AnalyzeTextJobStatusNextPage(nextLink, pageSizeHint, _idToIndexMap, cancellationToken); - return Page.FromValues(new List() { Transforms.ConvertToAbstractSummaryResultCollection(response.Value, _idToIndexMap) }, response.Value.NextLink, response.GetRawResponse()); + return Page.FromValues(new List() { Transforms.ConvertToAbstractiveSummarizeResultCollection(response.Value, _idToIndexMap) }, response.Value.NextLink, response.GetRawResponse()); } return PageableHelpers.CreateEnumerable(_ => _firstPage, NextPageFunc); @@ -242,25 +242,25 @@ Page NextPageFunc(string nextLink, int? pageSiz /// The operation must have completed successfully (i.e., is true). /// /// The controlling the lifetime of the request. - public override AsyncPageable GetValuesAsync(CancellationToken cancellationToken = default) + public override AsyncPageable GetValuesAsync(CancellationToken cancellationToken = default) { // Validates that the operation has completed successfully. _ = _operationInternal.Value; return CreateOperationValueAsync(cancellationToken); } - private AsyncPageable CreateOperationValueAsync(CancellationToken cancellationToken = default) + private AsyncPageable CreateOperationValueAsync(CancellationToken cancellationToken = default) { - async Task> NextPageFunc(string nextLink, int? pageSizeHint) + async Task> NextPageFunc(string nextLink, int? pageSizeHint) { var response = await _serviceClient.AnalyzeTextJobStatusNextPageAsync(nextLink, pageSizeHint, _idToIndexMap, cancellationToken).ConfigureAwait(false); - return Page.FromValues(new List() { Transforms.ConvertToAbstractSummaryResultCollection(response.Value, _idToIndexMap) }, response.Value.NextLink, response.GetRawResponse()); + return Page.FromValues(new List() { Transforms.ConvertToAbstractiveSummarizeResultCollection(response.Value, _idToIndexMap) }, response.Value.NextLink, response.GetRawResponse()); } return PageableHelpers.CreateAsyncEnumerable(_ => Task.FromResult(_firstPage), NextPageFunc); } - async ValueTask>> IOperation>.UpdateStateAsync(bool async, CancellationToken cancellationToken) + async ValueTask>> IOperation>.UpdateStateAsync(bool async, CancellationToken cancellationToken) { Response response = async ? await _serviceClient.AnalyzeTextJobStatusAsync(_jobId, _showStats, null, null, _idToIndexMap, cancellationToken).ConfigureAwait(false) @@ -277,22 +277,22 @@ async ValueTask>> if (response.Value.Status == TextAnalyticsOperationStatus.Succeeded) { string nextLink = response.Value.NextLink; - _firstPage = Page.FromValues(new List() { Transforms.ConvertToAbstractSummaryResultCollection(response.Value, _idToIndexMap) }, nextLink, rawResponse); + _firstPage = Page.FromValues(new List() { Transforms.ConvertToAbstractiveSummarizeResultCollection(response.Value, _idToIndexMap) }, nextLink, rawResponse); - return OperationState>.Success(rawResponse, CreateOperationValueAsync(CancellationToken.None)); + return OperationState>.Success(rawResponse, CreateOperationValueAsync(CancellationToken.None)); } if (response.Value.Status == TextAnalyticsOperationStatus.Running || response.Value.Status == TextAnalyticsOperationStatus.NotStarted || response.Value.Status == TextAnalyticsOperationStatus.Cancelling) { - return OperationState>.Pending(rawResponse); + return OperationState>.Pending(rawResponse); } if (response.Value.Status == TextAnalyticsOperationStatus.Cancelled) { - return OperationState>.Failure(rawResponse, new RequestFailedException("The operation was canceled so no value is available.")); + return OperationState>.Failure(rawResponse, new RequestFailedException("The operation was canceled so no value is available.")); } - return OperationState>.Failure(rawResponse, new RequestFailedException(rawResponse)); + return OperationState>.Failure(rawResponse, new RequestFailedException(rawResponse)); } } } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryOptions.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeOptions.cs similarity index 85% rename from sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryOptions.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeOptions.cs index dd0c43ac786b..73b5a13110cb 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryOptions.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeOptions.cs @@ -7,12 +7,12 @@ namespace Azure.AI.TextAnalytics /// A set of options used to configure abstractive summarization, including the display name to use, the maximum /// number of sentences that the resulting summary can have, and more. /// - public class AbstractSummaryOptions : TextAnalyticsRequestOptions + public class AbstractiveSummarizeOptions : TextAnalyticsRequestOptions { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// - public AbstractSummaryOptions() + public AbstractiveSummarizeOptions() { } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryResult.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeResult.cs similarity index 85% rename from sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryResult.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeResult.cs index 68543d2637f2..725219febcc7 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryResult.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeResult.cs @@ -10,14 +10,14 @@ namespace Azure.AI.TextAnalytics /// /// A representation of the result of performing abstractive summarization on a given document. /// - public partial class AbstractSummaryResult : TextAnalyticsResult + public partial class AbstractiveSummarizeResult : TextAnalyticsResult { private readonly IReadOnlyCollection _summaries; /// - /// Initializes a successful . + /// Initializes a successful . /// - internal AbstractSummaryResult( + internal AbstractiveSummarizeResult( string id, TextDocumentStatistics statistics, IList summaries, @@ -37,9 +37,9 @@ internal AbstractSummaryResult( } /// - /// Initializes an with an error. + /// Initializes an with an error. /// - internal AbstractSummaryResult(string id, TextAnalyticsError error) : base(id, error) { } + internal AbstractiveSummarizeResult(string id, TextAnalyticsError error) : base(id, error) { } /// /// The warnings that resulted from processing the document. diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryResultCollection.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeResultCollection.cs similarity index 73% rename from sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryResultCollection.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeResultCollection.cs index 51f3f88610f0..5dbb8c75f9b7 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryResultCollection.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeResultCollection.cs @@ -11,14 +11,14 @@ namespace Azure.AI.TextAnalytics /// /// A collection of the results of performing abstractive summarization on a given set of documents. /// - [DebuggerTypeProxy(typeof(AbstractSummaryResultCollectionDebugView))] - public class AbstractSummaryResultCollection : ReadOnlyCollection + [DebuggerTypeProxy(typeof(AbstractiveSummarizeResultCollectionDebugView))] + public class AbstractiveSummarizeResultCollection : ReadOnlyCollection { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// - internal AbstractSummaryResultCollection( - IList list, TextDocumentBatchStatistics statistics, string modelVersion) + internal AbstractiveSummarizeResultCollection( + IList list, TextDocumentBatchStatistics statistics, string modelVersion) : base(list) { Statistics = statistics; @@ -41,19 +41,19 @@ internal AbstractSummaryResultCollection( public string ModelVersion { get; } /// - /// A debugger proxy for the class. + /// A debugger proxy for the class. /// - internal class AbstractSummaryResultCollectionDebugView + internal class AbstractiveSummarizeResultCollectionDebugView { - private AbstractSummaryResultCollection BaseCollection { get; } + private AbstractiveSummarizeResultCollection BaseCollection { get; } - public AbstractSummaryResultCollectionDebugView(AbstractSummaryResultCollection collection) + public AbstractiveSummarizeResultCollectionDebugView(AbstractiveSummarizeResultCollection collection) { BaseCollection = collection; } [DebuggerBrowsable(DebuggerBrowsableState.RootHidden)] - public List Items + public List Items { get { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeActionsResult.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeActionsResult.cs index f3aae4aca036..8b1428a57828 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeActionsResult.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/AnalyzeActionsResult.cs @@ -22,7 +22,7 @@ internal AnalyzeActionsResult( IReadOnlyCollection multiLabelClassifyActionResults, IReadOnlyCollection analyzeHealthcareEntitiesActionResults, IReadOnlyCollection extractiveSummarizeActionResults, - IReadOnlyCollection abstractSummaryActionResults + IReadOnlyCollection abstractiveSummarizeActionResults ) { ExtractKeyPhrasesResults = extractKeyPhrasesActionResults; @@ -35,7 +35,7 @@ IReadOnlyCollection abstractSummaryActionResults MultiLabelClassifyResults = multiLabelClassifyActionResults; AnalyzeHealthcareEntitiesResults = analyzeHealthcareEntitiesActionResults; ExtractiveSummarizeResults = extractiveSummarizeActionResults; - AbstractSummaryResults = abstractSummaryActionResults; + AbstractiveSummarizeResults = abstractiveSummarizeActionResults; } internal AnalyzeActionsResult( @@ -56,7 +56,7 @@ IReadOnlyCollection analyzeSentimentActionResults RecognizeCustomEntitiesResults = Array.Empty(); AnalyzeHealthcareEntitiesResults = Array.Empty(); ExtractiveSummarizeResults = Array.Empty(); - AbstractSummaryResults = Array.Empty(); + AbstractiveSummarizeResults = Array.Empty(); } /// @@ -110,8 +110,8 @@ IReadOnlyCollection analyzeSentimentActionResults public IReadOnlyCollection ExtractiveSummarizeResults { get; } /// - /// Determines the collection of . + /// Determines the collection of . /// - public IReadOnlyCollection AbstractSummaryResults { get; } + public IReadOnlyCollection AbstractiveSummarizeResults { get; } } } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LanguageServiceClient.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LanguageServiceClient.cs index bc8c0a45ae5e..e5c4be4c5d35 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LanguageServiceClient.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LanguageServiceClient.cs @@ -1853,9 +1853,9 @@ private IList CreateTasks(TextAnalyticsActions actions) { analyzeTasks.AddRange(Transforms.ConvertFromExtractiveSummarizeActionsToTasks(actions.ExtractiveSummarizeActions)); } - if (actions.AbstractSummaryActions != null) + if (actions.AbstractiveSummarizeActions != null) { - analyzeTasks.AddRange(Transforms.ConvertFromAbstractSummaryActionsToTasks(actions.AbstractSummaryActions)); + analyzeTasks.AddRange(Transforms.ConvertFromAbstractiveSummarizeActionsToTasks(actions.AbstractiveSummarizeActions)); } // Validate supported version. @@ -2184,41 +2184,41 @@ private async Task StartExtractiveSummarizeAsync(M #endregion - #region Abstract Summary + #region Abstractive Summarize - public override AbstractSummaryOperation StartAbstractSummary(IEnumerable documents, string language = default, AbstractSummaryOptions options = default, CancellationToken cancellationToken = default) + public override AbstractiveSummarizeOperation StartAbstractiveSummarize(IEnumerable documents, string language = default, AbstractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { Argument.AssertNotNullOrEmpty(documents, nameof(documents)); MultiLanguageAnalysisInput input = ConvertToMultiLanguageInputs(documents, language); - return StartAbstractSummary(input, options, cancellationToken); + return StartAbstractiveSummarize(input, options, cancellationToken); } - public override AbstractSummaryOperation StartAbstractSummary(IEnumerable documents, AbstractSummaryOptions options = default, CancellationToken cancellationToken = default) + public override AbstractiveSummarizeOperation StartAbstractiveSummarize(IEnumerable documents, AbstractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { Argument.AssertNotNullOrEmpty(documents, nameof(documents)); MultiLanguageAnalysisInput input = ConvertToMultiLanguageInputs(documents); - return StartAbstractSummary(input, options, cancellationToken); + return StartAbstractiveSummarize(input, options, cancellationToken); } - public override async Task StartAbstractSummaryAsync(IEnumerable documents, string language = default, AbstractSummaryOptions options = default, CancellationToken cancellationToken = default) + public override async Task StartAbstractiveSummarizeAsync(IEnumerable documents, string language = default, AbstractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { Argument.AssertNotNullOrEmpty(documents, nameof(documents)); MultiLanguageAnalysisInput input = ConvertToMultiLanguageInputs(documents, language); - return await StartAbstractSummaryAsync(input, options, cancellationToken).ConfigureAwait(false); + return await StartAbstractiveSummarizeAsync(input, options, cancellationToken).ConfigureAwait(false); } - public override async Task StartAbstractSummaryAsync(IEnumerable documents, AbstractSummaryOptions options = default, CancellationToken cancellationToken = default) + public override async Task StartAbstractiveSummarizeAsync(IEnumerable documents, AbstractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { Argument.AssertNotNullOrEmpty(documents, nameof(documents)); MultiLanguageAnalysisInput input = ConvertToMultiLanguageInputs(documents); - return await StartAbstractSummaryAsync(input, options, cancellationToken).ConfigureAwait(false); + return await StartAbstractiveSummarizeAsync(input, options, cancellationToken).ConfigureAwait(false); } - private static AbstractiveSummarizationLROTask CreateAbstractiveSummarizationTask(AbstractSummaryOptions options) + private static AbstractiveSummarizationLROTask CreateAbstractiveSummarizationTask(AbstractiveSummarizeOptions options) { AbstractiveSummarizationTaskParameters parameters = new() { @@ -2231,11 +2231,11 @@ private static AbstractiveSummarizationLROTask CreateAbstractiveSummarizationTas return new AbstractiveSummarizationLROTask(parameters); } - private AbstractSummaryOperation StartAbstractSummary(MultiLanguageAnalysisInput multiLanguageInput, AbstractSummaryOptions options, CancellationToken cancellationToken) + private AbstractiveSummarizeOperation StartAbstractiveSummarize(MultiLanguageAnalysisInput multiLanguageInput, AbstractiveSummarizeOptions options, CancellationToken cancellationToken) { - options ??= new AbstractSummaryOptions(); + options ??= new AbstractiveSummarizeOptions(); - using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TextAnalyticsClient)}.{nameof(StartAbstractSummary)}"); + using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TextAnalyticsClient)}.{nameof(StartAbstractiveSummarize)}"); scope.Start(); try @@ -2249,7 +2249,7 @@ private AbstractSummaryOperation StartAbstractSummary(MultiLanguageAnalysisInput string location = response.Headers.OperationLocation; IDictionary idToIndexMap = CreateIdToIndexMap(multiLanguageInput.Documents); - return new AbstractSummaryOperation(this, _clientDiagnostics, location, idToIndexMap, options.IncludeStatistics); + return new AbstractiveSummarizeOperation(this, _clientDiagnostics, location, idToIndexMap, options.IncludeStatistics); } catch (Exception e) { @@ -2258,11 +2258,11 @@ private AbstractSummaryOperation StartAbstractSummary(MultiLanguageAnalysisInput } } - private async Task StartAbstractSummaryAsync(MultiLanguageAnalysisInput multiLanguageInput, AbstractSummaryOptions options, CancellationToken cancellationToken) + private async Task StartAbstractiveSummarizeAsync(MultiLanguageAnalysisInput multiLanguageInput, AbstractiveSummarizeOptions options, CancellationToken cancellationToken) { - options ??= new AbstractSummaryOptions(); + options ??= new AbstractiveSummarizeOptions(); - using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TextAnalyticsClient)}.{nameof(StartAbstractSummary)}"); + using DiagnosticScope scope = _clientDiagnostics.CreateScope($"{nameof(TextAnalyticsClient)}.{nameof(StartAbstractiveSummarize)}"); scope.Start(); try @@ -2276,7 +2276,7 @@ private async Task StartAbstractSummaryAsync(MultiLang string location = response.Headers.OperationLocation; IDictionary idToIndexMap = CreateIdToIndexMap(multiLanguageInput.Documents); - return new AbstractSummaryOperation(this, _clientDiagnostics, location, idToIndexMap, options.IncludeStatistics); + return new AbstractiveSummarizeOperation(this, _clientDiagnostics, location, idToIndexMap, options.IncludeStatistics); } catch (Exception e) { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LegacyServiceClient.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LegacyServiceClient.cs index b8a861638c2e..48709f37e9c6 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LegacyServiceClient.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/LegacyServiceClient.cs @@ -1547,9 +1547,9 @@ private Legacy.JobManifestTasks CreateTasks(TextAnalyticsActions actions) { throw Validation.NotSupported(nameof(ExtractiveSummarizeAction), TextAnalyticsClientOptions.ServiceVersion.V2022_10_01_Preview, ServiceVersion); } - if (actions.AbstractSummaryActions != null && actions.AbstractSummaryActions.Count > 0) + if (actions.AbstractiveSummarizeActions != null && actions.AbstractiveSummarizeActions.Count > 0) { - throw Validation.NotSupported(nameof(AbstractSummaryAction), TextAnalyticsClientOptions.ServiceVersion.V2022_10_01_Preview, ServiceVersion); + throw Validation.NotSupported(nameof(AbstractiveSummarizeAction), TextAnalyticsClientOptions.ServiceVersion.V2022_10_01_Preview, ServiceVersion); } return tasks; } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/ServiceClient.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/ServiceClient.cs index a7a8705950f6..5874dcfac966 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/ServiceClient.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/ServiceClients/ServiceClient.cs @@ -169,19 +169,19 @@ public virtual Task StartExtractiveSummarizeAsync( #endregion - #region Abstract Summary + #region Abstractive Summarize - public virtual AbstractSummaryOperation StartAbstractSummary(IEnumerable documents, string language = default, AbstractSummaryOptions options = default, CancellationToken cancellationToken = default) => - throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartAbstractSummary)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); + public virtual AbstractiveSummarizeOperation StartAbstractiveSummarize(IEnumerable documents, string language = default, AbstractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) => + throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartAbstractiveSummarize)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); - public virtual AbstractSummaryOperation StartAbstractSummary(IEnumerable documents, AbstractSummaryOptions options = default, CancellationToken cancellationToken = default) => - throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartAbstractSummary)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); + public virtual AbstractiveSummarizeOperation StartAbstractiveSummarize(IEnumerable documents, AbstractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) => + throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartAbstractiveSummarize)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); - public virtual Task StartAbstractSummaryAsync(IEnumerable documents, string language = default, AbstractSummaryOptions options = default, CancellationToken cancellationToken = default) => - throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartAbstractSummaryAsync)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); + public virtual Task StartAbstractiveSummarizeAsync(IEnumerable documents, string language = default, AbstractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) => + throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartAbstractiveSummarizeAsync)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); - public virtual Task StartAbstractSummaryAsync(IEnumerable documents, AbstractSummaryOptions options = default, CancellationToken cancellationToken = default) => - throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartAbstractSummaryAsync)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); + public virtual Task StartAbstractiveSummarizeAsync(IEnumerable documents, AbstractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) => + throw Validation.NotSupported($"{nameof(TextAnalyticsClient)}.{nameof(TextAnalyticsClient.StartAbstractiveSummarizeAsync)}", ServiceVersion.V2022_10_01_Preview, ServiceVersion); #endregion diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsActions.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsActions.cs index 6d913158b301..176a17cb0edb 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsActions.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsActions.cs @@ -94,11 +94,11 @@ public TextAnalyticsActions() public IReadOnlyCollection ExtractiveSummarizeActions { get; set; } /// - /// The set of that will get executed on the input documents. + /// The set of that will get executed on the input documents. /// /// /// This property only applies for and newer. /// - public IReadOnlyCollection AbstractSummaryActions { get; set; } + public IReadOnlyCollection AbstractiveSummarizeActions { get; set; } } } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsClient.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsClient.cs index 7b21bfc9b2ec..627fc664be6c 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsClient.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsClient.cs @@ -1717,7 +1717,7 @@ public virtual async Task StartAnalyzeHealth /// , , /// , and are only supported /// in service API version 2022-05-01 and newer. The and - /// are only supported in service API version 2022-10-01-preview and newer. + /// are only supported in service API version 2022-10-01-preview and newer. /// /// /// Service returned a non-success status code. @@ -1763,7 +1763,7 @@ public virtual async Task StartAnalyzeActionsAsync( /// , , /// , and are only supported /// in service API version 2022-05-01 and newer. The and - /// are only supported in service API version 2022-10-01-preview and newer. + /// are only supported in service API version 2022-10-01-preview and newer. /// /// /// Service returned a non-success status code. @@ -1808,7 +1808,7 @@ public virtual AnalyzeActionsOperation StartAnalyzeActions( /// , , /// , and are only supported /// in service API version 2022-05-01 and newer. The and - /// are only supported in service API version 2022-10-01-preview and newer. + /// are only supported in service API version 2022-10-01-preview and newer. /// /// /// Service returned a non-success status code. @@ -1852,7 +1852,7 @@ public virtual AnalyzeActionsOperation StartAnalyzeActions( /// , , /// , and are only supported /// in service API version 2022-05-01 and newer. The and - /// are only supported in service API version 2022-10-01-preview and newer. + /// are only supported in service API version 2022-10-01-preview and newer. /// /// /// Service returned a non-success status code. @@ -2332,7 +2332,7 @@ public virtual async Task StartExtractiveSummarize #endregion - #region Abstract Summary + #region Abstractive Summarize /// /// Performs abstractive summarization on a given set of documents, which consists of generating a summary with @@ -2347,10 +2347,10 @@ public virtual async Task StartExtractiveSummarize /// /// The documents to analyze. /// The language that the documents are written in. - /// The additional used to configure the operation. + /// The additional used to configure the operation. /// The controlling the lifetime of the request. /// - /// An that can be used to monitor the status of the abstractive + /// An that can be used to monitor the status of the abstractive /// summarization. Upon completion, the operation will contain the collections of summaries that were generated /// for each document that was successfully analyzed. /// @@ -2358,14 +2358,14 @@ public virtual async Task StartExtractiveSummarize /// The service returned a non-success status code. /// is an empty collection. /// is null. - public virtual AbstractSummaryOperation StartAbstractSummary( + public virtual AbstractiveSummarizeOperation StartAbstractiveSummarize( IEnumerable documents, string language = default, - AbstractSummaryOptions options = default, + AbstractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { options?.CheckSupported(ServiceVersion); - return _serviceClient.StartAbstractSummary(documents, language, options, cancellationToken); + return _serviceClient.StartAbstractiveSummarize(documents, language, options, cancellationToken); } /// @@ -2380,10 +2380,10 @@ public virtual AbstractSummaryOperation StartAbstractSummary( /// This method is only available for , and newer. /// /// The documents to analyze. - /// The additional used to configure the operation. + /// The additional used to configure the operation. /// The controlling the lifetime of the request. /// - /// An that can be used to monitor the status of the abstractive + /// An that can be used to monitor the status of the abstractive /// summarization. Upon completion, the operation will contain the collections of summaries that were generated /// for each document that was successfully analyzed. /// @@ -2391,13 +2391,13 @@ public virtual AbstractSummaryOperation StartAbstractSummary( /// The service returned a non-success status code. /// is an empty collection. /// is null. - public virtual AbstractSummaryOperation StartAbstractSummary( + public virtual AbstractiveSummarizeOperation StartAbstractiveSummarize( IEnumerable documents, - AbstractSummaryOptions options = default, + AbstractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { options?.CheckSupported(ServiceVersion); - return _serviceClient.StartAbstractSummary(documents, options, cancellationToken); + return _serviceClient.StartAbstractiveSummarize(documents, options, cancellationToken); } /// @@ -2413,10 +2413,10 @@ public virtual AbstractSummaryOperation StartAbstractSummary( /// /// The documents to analyze. /// The language that the documents are written in. - /// The additional used to configure the operation. + /// The additional used to configure the operation. /// The controlling the lifetime of the request. /// - /// A that can be used to monitor the status of the abstractive + /// A that can be used to monitor the status of the abstractive /// summarization. Upon completion, the operation will contain the collections of summaries that were generated /// for each document that was successfully analyzed. /// @@ -2424,14 +2424,14 @@ public virtual AbstractSummaryOperation StartAbstractSummary( /// The service returned a non-success status code. /// is an empty collection. /// is null. - public virtual async Task StartAbstractSummaryAsync( + public virtual async Task StartAbstractiveSummarizeAsync( IEnumerable documents, string language = default, - AbstractSummaryOptions options = default, + AbstractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { options?.CheckSupported(ServiceVersion); - return await _serviceClient.StartAbstractSummaryAsync(documents, language, options, cancellationToken).ConfigureAwait(false); + return await _serviceClient.StartAbstractiveSummarizeAsync(documents, language, options, cancellationToken).ConfigureAwait(false); } /// @@ -2446,10 +2446,10 @@ public virtual async Task StartAbstractSummaryAsync( /// This method is only available for , and newer. /// /// The documents to analyze. - /// The additional used to configure the operation. + /// The additional used to configure the operation. /// The controlling the lifetime of the request. /// - /// A that can be used to monitor the status of the abstractive + /// A that can be used to monitor the status of the abstractive /// summarization. Upon completion, the operation will contain the collections of summaries that were generated /// for each document that was successfully analyzed. /// @@ -2457,13 +2457,13 @@ public virtual async Task StartAbstractSummaryAsync( /// The service returned a non-success status code. /// is an empty collection. /// is null. - public virtual async Task StartAbstractSummaryAsync( + public virtual async Task StartAbstractiveSummarizeAsync( IEnumerable documents, - AbstractSummaryOptions options = default, + AbstractiveSummarizeOptions options = default, CancellationToken cancellationToken = default) { options?.CheckSupported(ServiceVersion); - return await _serviceClient.StartAbstractSummaryAsync(documents, options, cancellationToken).ConfigureAwait(false); + return await _serviceClient.StartAbstractiveSummarizeAsync(documents, options, cancellationToken).ConfigureAwait(false); } #endregion diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsModelFactory.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsModelFactory.cs index 5cf038c26e6f..bb603f8808da 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsModelFactory.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/TextAnalyticsModelFactory.cs @@ -1020,7 +1020,7 @@ public static AnalyzeActionsResult AnalyzeActionsResult( new List(), new List(), new List(), - new List() + new List() ); } @@ -1058,7 +1058,7 @@ public static AnalyzeActionsResult AnalyzeActionsResult( multiLabelClassifyActionResults.ToList(), new List(), new List(), - new List() + new List() ); } @@ -1098,7 +1098,7 @@ public static AnalyzeActionsResult AnalyzeActionsResult( multiLabelClassifyActionResults.ToList(), analyzeHealthcareEntitiesActionResults.ToList(), new List(), - new List() + new List() ); } @@ -1115,7 +1115,7 @@ public static AnalyzeActionsResult AnalyzeActionsResult( /// Sets the collection of . /// Sets the collection of . /// Sets the collection of . - /// Sets the collection of . + /// Sets the collection of . /// A new instance of for mocking purposes. public static AnalyzeActionsResult AnalyzeActionsResult( IEnumerable extractKeyPhrasesActionResults, @@ -1128,7 +1128,7 @@ public static AnalyzeActionsResult AnalyzeActionsResult( IEnumerable multiLabelClassifyActionResults, IEnumerable analyzeHealthcareEntitiesActionResults, IEnumerable extractiveSummarizeActionResults, - IEnumerable abstractSummaryActionResults) + IEnumerable abstractiveSummarizeActionResults) { return new AnalyzeActionsResult( extractKeyPhrasesActionResults.ToList(), @@ -1141,7 +1141,7 @@ public static AnalyzeActionsResult AnalyzeActionsResult( multiLabelClassifyActionResults.ToList(), analyzeHealthcareEntitiesActionResults.ToList(), extractiveSummarizeActionResults.ToList(), - abstractSummaryActionResults.ToList() + abstractiveSummarizeActionResults.ToList() ); } @@ -1707,35 +1707,35 @@ public static ExtractiveSummarizeActionResult ExtractiveSummarizeActionResult( } /// - /// Initializes a new instance of for mocking purposes. + /// Initializes a new instance of for mocking purposes. /// - /// Sets the property. + /// Sets the property. /// Sets the property. /// Sets the property. - /// A new instance of for mocking purposes. - public static AbstractSummaryActionResult AbstractSummaryActionResult( - AbstractSummaryResultCollection result, + /// A new instance of for mocking purposes. + public static AbstractiveSummarizeActionResult AbstractiveSummarizeActionResult( + AbstractiveSummarizeResultCollection result, string actionName, DateTimeOffset completedOn) { - return new AbstractSummaryActionResult(result, actionName, completedOn); + return new AbstractiveSummarizeActionResult(result, actionName, completedOn); } /// - /// Initializes a new instance of for mocking purposes. + /// Initializes a new instance of for mocking purposes. /// /// Sets the property. /// Sets the property. /// Sets the property. /// Sets the property. - /// A new instance of for mocking purposes. - public static AbstractSummaryActionResult AbstractSummaryActionResult( + /// A new instance of for mocking purposes. + public static AbstractiveSummarizeActionResult AbstractiveSummarizeActionResult( string actionName, DateTimeOffset completedOn, string code, string message) { - return new AbstractSummaryActionResult(actionName, completedOn, new Error(code, message)); + return new AbstractiveSummarizeActionResult(actionName, completedOn, new Error(code, message)); } #endregion Action Result Models @@ -1976,58 +1976,58 @@ public static SummarySentence SummarySentence(string text, double rankScore, int #endregion - #region Abstract Summary + #region Abstractive Summarize /// - /// Initializes a new instance of for mocking purposes. + /// Initializes a new instance of for mocking purposes. /// /// Sets the property. /// Sets the property. - /// Sets the property. + /// Sets the property. /// Sets the property. - /// Sets the property. + /// Sets the property. /// - /// A new instance of for mocking purposes. + /// A new instance of for mocking purposes. /// - public static AbstractSummaryResult AbstractSummaryResult( + public static AbstractiveSummarizeResult AbstractiveSummarizeResult( string id, TextDocumentStatistics statistics, IEnumerable summaries, DetectedLanguage? detectedLanguage = default, IEnumerable warnings = default) { - return new AbstractSummaryResult(id, statistics, summaries.ToList(), detectedLanguage, warnings.ToList()); + return new AbstractiveSummarizeResult(id, statistics, summaries.ToList(), detectedLanguage, warnings.ToList()); } /// - /// Initializes a new instance of for mocking purposes. + /// Initializes a new instance of for mocking purposes. /// /// Sets the property. /// Sets the property. /// Sets the property. /// - /// A new instance of for mocking purposes. + /// A new instance of for mocking purposes. /// - public static AbstractSummaryResult AbstractSummaryResult(string id, string code, string message) + public static AbstractiveSummarizeResult AbstractiveSummarizeResult(string id, string code, string message) { - return new AbstractSummaryResult(id, new TextAnalyticsError(code, message)); + return new AbstractiveSummarizeResult(id, new TextAnalyticsError(code, message)); } /// - /// Initializes a new instance of for mocking purposes. + /// Initializes a new instance of for mocking purposes. /// - /// Sets the collection of . - /// Sets the property. - /// Sets the property. + /// Sets the collection of . + /// Sets the property. + /// Sets the property. /// - /// A new instance of for mocking purposes. + /// A new instance of for mocking purposes. /// - public static AbstractSummaryResultCollection AbstractSummaryResultCollection( - IEnumerable results, + public static AbstractiveSummarizeResultCollection AbstractiveSummarizeResultCollection( + IEnumerable results, TextDocumentBatchStatistics statistics, string modelVersion) { - return new AbstractSummaryResultCollection(results.ToList(), statistics, modelVersion); + return new AbstractiveSummarizeResultCollection(results.ToList(), statistics, modelVersion); } /// diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/src/Transforms.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/src/Transforms.cs index 34413bf2595d..bdcbcc9b7a19 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/src/Transforms.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/src/Transforms.cs @@ -545,28 +545,28 @@ internal static ExtractiveSummarizeResultCollection ConvertToExtractiveSummarize #endregion - #region Abstract Summary + #region Abstractive Summarize internal static List ConvertToSummaryList(IEnumerable summaries) => summaries.Select((summary) => new AbstractiveSummary(summary)).ToList(); - internal static AbstractSummaryResultCollection ConvertToAbstractSummaryResultCollection( + internal static AbstractiveSummarizeResultCollection ConvertToAbstractiveSummarizeResultCollection( AbstractiveSummarizationResult results, IDictionary idToIndexMap) { - List abstractSummaryResults = new(results.Documents.Count); + List abstractiveSummarizeResults = new(results.Documents.Count); // Read errors. foreach (InputError error in results.Errors) { - abstractSummaryResults.Add(new AbstractSummaryResult(error.Id, ConvertToError(error.Error))); + abstractiveSummarizeResults.Add(new AbstractiveSummarizeResult(error.Id, ConvertToError(error.Error))); } // Read results. foreach (AbstractiveSummaryDocumentResultWithDetectedLanguage document in results.Documents) { - abstractSummaryResults.Add( - new AbstractSummaryResult( + abstractiveSummarizeResults.Add( + new AbstractiveSummarizeResult( document.Id, document.Statistics ?? default, ConvertToSummaryList(document.Summaries), @@ -574,19 +574,19 @@ internal static AbstractSummaryResultCollection ConvertToAbstractSummaryResultCo ConvertToWarnings(document.Warnings))); } - abstractSummaryResults = SortHeterogeneousCollection(abstractSummaryResults, idToIndexMap); + abstractiveSummarizeResults = SortHeterogeneousCollection(abstractiveSummarizeResults, idToIndexMap); - return new AbstractSummaryResultCollection(abstractSummaryResults, results.Statistics, results.ModelVersion); + return new AbstractiveSummarizeResultCollection(abstractiveSummarizeResults, results.Statistics, results.ModelVersion); } - internal static AbstractSummaryResultCollection ConvertToAbstractSummaryResultCollection( + internal static AbstractiveSummarizeResultCollection ConvertToAbstractiveSummarizeResultCollection( AnalyzeTextJobState jobState, IDictionary idToIndexMap) { AnalyzeTextLROResult task = jobState.Tasks.Items[0]; if (task.Kind == AnalyzeTextLROResultsKind.AbstractiveSummarizationLROResults) { - return ConvertToAbstractSummaryResultCollection((task as AbstractiveSummarizationLROResult).Results, idToIndexMap); + return ConvertToAbstractiveSummarizeResultCollection((task as AbstractiveSummarizationLROResult).Results, idToIndexMap); } throw new InvalidOperationException($"Invalid task executed. Expected a {nameof(AnalyzeTextLROResultsKind.AbstractiveSummarizationLROResults)} but instead got {task.Kind}."); } @@ -741,7 +741,7 @@ internal static ExtractiveSummarizationLROTask ConvertToExtractiveSummarizationT }; } - internal static AbstractiveSummarizationLROTask ConvertToAbstractiveSummarizationTask(AbstractSummaryAction action) + internal static AbstractiveSummarizationLROTask ConvertToAbstractiveSummarizationTask(AbstractiveSummarizeAction action) { AbstractiveSummarizationTaskParameters parameters = new() { @@ -877,11 +877,11 @@ internal static IList ConvertFromExtractiveSumma return list; } - internal static IList ConvertFromAbstractSummaryActionsToTasks(IReadOnlyCollection abstractSummaryActions) + internal static IList ConvertFromAbstractiveSummarizeActionsToTasks(IReadOnlyCollection abstractiveSummarizeActions) { - List list = new(abstractSummaryActions.Count); + List list = new(abstractiveSummarizeActions.Count); - foreach (AbstractSummaryAction action in abstractSummaryActions) + foreach (AbstractiveSummarizeAction action in abstractiveSummarizeActions) { list.Add(ConvertToAbstractiveSummarizationTask(action)); } @@ -901,7 +901,7 @@ internal static AnalyzeActionsResult ConvertToAnalyzeActionsResult(AnalyzeTextJo List multiLabelClassify = new(); List analyzeHealthcareEntities = new(); List extractiveSummarize = new(); - List abstractSummary = new(); + List abstractiveSummarize = new(); foreach (AnalyzeTextLROResult task in jobState.Tasks.Items) { @@ -947,7 +947,7 @@ internal static AnalyzeActionsResult ConvertToAnalyzeActionsResult(AnalyzeTextJo } else if (task.Kind == AnalyzeTextLROResultsKind.AbstractiveSummarizationLROResults) { - abstractSummary.Add(new AbstractSummaryActionResult(ConvertToAbstractSummaryResultCollection((task as AbstractiveSummarizationLROResult).Results, map), task.TaskName, task.LastUpdateDateTime)); + abstractiveSummarize.Add(new AbstractiveSummarizeActionResult(ConvertToAbstractiveSummarizeResultCollection((task as AbstractiveSummarizationLROResult).Results, map), task.TaskName, task.LastUpdateDateTime)); } } @@ -962,7 +962,7 @@ internal static AnalyzeActionsResult ConvertToAnalyzeActionsResult(AnalyzeTextJo multiLabelClassify, analyzeHealthcareEntities, extractiveSummarize, - abstractSummary); + abstractiveSummarize); } #endregion diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/AbstractSummaryTests.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/AbstractiveSummarizeTests.cs similarity index 81% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/AbstractSummaryTests.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/AbstractiveSummarizeTests.cs index 2c393b2a0c43..e1c76f9561e6 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/AbstractSummaryTests.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/AbstractiveSummarizeTests.cs @@ -12,9 +12,9 @@ namespace Azure.AI.TextAnalytics.Tests { [ServiceVersion(Min = TextAnalyticsClientOptions.ServiceVersion.V2022_10_01_Preview)] - public class AbstractSummaryTests : TextAnalyticsClientLiveTestBase + public class AbstractiveSummarizeTests : TextAnalyticsClientLiveTestBase { - public AbstractSummaryTests(bool isAsync, TextAnalyticsClientOptions.ServiceVersion serviceVersion) + public AbstractiveSummarizeTests(bool isAsync, TextAnalyticsClientOptions.ServiceVersion serviceVersion) : base(isAsync, serviceVersion) { } @@ -85,25 +85,25 @@ public void TestSetup() [RecordedTest] [RetryOnInternalServerError] - public async Task AbstractSummaryWithAADTest() + public async Task AbstractiveSummarizeWithAADTest() { TextAnalyticsClient client = GetClient(useTokenCredential: true); - AbstractSummaryOperation operation = await client.StartAbstractSummaryAsync(s_batchDocuments); + AbstractiveSummarizeOperation operation = await client.StartAbstractiveSummarizeAsync(s_batchDocuments); await operation.WaitForCompletionAsync(); ValidateOperationProperties(operation); - List resultInPages = operation.Value.ToEnumerableAsync().Result; + List resultInPages = operation.Value.ToEnumerableAsync().Result; Assert.AreEqual(1, resultInPages.Count); // Take the first page. - AbstractSummaryResultCollection resultCollection = resultInPages.FirstOrDefault(); + AbstractiveSummarizeResultCollection resultCollection = resultInPages.FirstOrDefault(); ValidateSummaryBatchResult(resultCollection); } [RecordedTest] [RetryOnInternalServerError] - public async Task AbstractSummaryBatchWithErrorTest() + public async Task AbstractiveSummarizeBatchWithErrorTest() { TextAnalyticsClient client = GetClient(); @@ -113,15 +113,15 @@ public async Task AbstractSummaryBatchWithErrorTest() "", }; - AbstractSummaryOperation operation = await client.StartAbstractSummaryAsync(documents, "en"); + AbstractiveSummarizeOperation operation = await client.StartAbstractiveSummarizeAsync(documents, "en"); await operation.WaitForCompletionAsync(); ValidateOperationProperties(operation); - List resultInPages = operation.Value.ToEnumerableAsync().Result; + List resultInPages = operation.Value.ToEnumerableAsync().Result; Assert.AreEqual(1, resultInPages.Count); // Take the first page. - AbstractSummaryResultCollection resultCollection = resultInPages.FirstOrDefault(); + AbstractiveSummarizeResultCollection resultCollection = resultInPages.FirstOrDefault(); Assert.IsFalse(resultCollection[0].HasError); Assert.IsTrue(resultCollection[1].HasError); Assert.AreEqual(TextAnalyticsErrorCode.InvalidDocument, resultCollection[1].Error.ErrorCode.ToString()); @@ -129,142 +129,142 @@ public async Task AbstractSummaryBatchWithErrorTest() [RecordedTest] [RetryOnInternalServerError] - public async Task AbstractSummaryBatchConvenienceTest() + public async Task AbstractiveSummarizeBatchConvenienceTest() { TextAnalyticsClient client = GetClient(); - AbstractSummaryOperation operation = await client.StartAbstractSummaryAsync(s_batchConvenienceDocuments); + AbstractiveSummarizeOperation operation = await client.StartAbstractiveSummarizeAsync(s_batchConvenienceDocuments); await operation.WaitForCompletionAsync(); ValidateOperationProperties(operation); - List resultInPages = operation.Value.ToEnumerableAsync().Result; + List resultInPages = operation.Value.ToEnumerableAsync().Result; Assert.AreEqual(1, resultInPages.Count); // Take the first page. - AbstractSummaryResultCollection resultCollection = resultInPages.FirstOrDefault(); + AbstractiveSummarizeResultCollection resultCollection = resultInPages.FirstOrDefault(); ValidateSummaryBatchResult(resultCollection); } [RecordedTest] [RetryOnInternalServerError] - public async Task AbstractSummaryBatchConvenienceWithStatisticsTest() + public async Task AbstractiveSummarizeBatchConvenienceWithStatisticsTest() { TextAnalyticsClient client = GetClient(); - AbstractSummaryOptions options = new AbstractSummaryOptions() + AbstractiveSummarizeOptions options = new AbstractiveSummarizeOptions() { SentenceCount = AbstractiveSummarizationSentenceCount, IncludeStatistics = true, }; - AbstractSummaryOperation operation = await client.StartAbstractSummaryAsync(s_batchConvenienceDocuments, "en", options); + AbstractiveSummarizeOperation operation = await client.StartAbstractiveSummarizeAsync(s_batchConvenienceDocuments, "en", options); await operation.WaitForCompletionAsync(); ValidateOperationProperties(operation); - List resultInPages = operation.Value.ToEnumerableAsync().Result; + List resultInPages = operation.Value.ToEnumerableAsync().Result; Assert.AreEqual(1, resultInPages.Count); // Take the first page. - AbstractSummaryResultCollection resultCollection = resultInPages.FirstOrDefault(); + AbstractiveSummarizeResultCollection resultCollection = resultInPages.FirstOrDefault(); ValidateSummaryBatchResult(resultCollection, true); } [RecordedTest] [RetryOnInternalServerError] - public async Task AbstractSummaryBatchTest() + public async Task AbstractiveSummarizeBatchTest() { TextAnalyticsClient client = GetClient(); - AbstractSummaryOperation operation = await client.StartAbstractSummaryAsync(s_batchDocuments); + AbstractiveSummarizeOperation operation = await client.StartAbstractiveSummarizeAsync(s_batchDocuments); await operation.WaitForCompletionAsync(); ValidateOperationProperties(operation); - List resultInPages = operation.Value.ToEnumerableAsync().Result; + List resultInPages = operation.Value.ToEnumerableAsync().Result; Assert.AreEqual(1, resultInPages.Count); // Take the first page. - AbstractSummaryResultCollection resultCollection = resultInPages.FirstOrDefault(); + AbstractiveSummarizeResultCollection resultCollection = resultInPages.FirstOrDefault(); ValidateSummaryBatchResult(resultCollection); } [RecordedTest] [RetryOnInternalServerError] - public async Task AbstractSummaryBatchWithStatisticsTest() + public async Task AbstractiveSummarizeBatchWithStatisticsTest() { TextAnalyticsClient client = GetClient(); - AbstractSummaryOptions options = new AbstractSummaryOptions() + AbstractiveSummarizeOptions options = new AbstractiveSummarizeOptions() { SentenceCount = AbstractiveSummarizationSentenceCount, IncludeStatistics = true, }; - AbstractSummaryOperation operation = await client.StartAbstractSummaryAsync(s_batchDocuments, options); + AbstractiveSummarizeOperation operation = await client.StartAbstractiveSummarizeAsync(s_batchDocuments, options); await operation.WaitForCompletionAsync(); ValidateOperationProperties(operation); - List resultInPages = operation.Value.ToEnumerableAsync().Result; + List resultInPages = operation.Value.ToEnumerableAsync().Result; Assert.AreEqual(1, resultInPages.Count); // Take the first page. - AbstractSummaryResultCollection resultCollection = resultInPages.FirstOrDefault(); + AbstractiveSummarizeResultCollection resultCollection = resultInPages.FirstOrDefault(); ValidateSummaryBatchResult(resultCollection, true); } [RecordedTest] [RetryOnInternalServerError] [Ignore("https://github.com/Azure/azure-sdk-for-net/issues/32614")] - public async Task AbstractSummaryBatchConvenienceWithAutoDetectedLanguageTest() + public async Task AbstractiveSummarizeBatchConvenienceWithAutoDetectedLanguageTest() { TextAnalyticsClient client = GetClient(); - AbstractSummaryOperation operation = await client.StartAbstractSummaryAsync(s_batchConvenienceDocuments, "en"); + AbstractiveSummarizeOperation operation = await client.StartAbstractiveSummarizeAsync(s_batchConvenienceDocuments, "en"); await operation.WaitForCompletionAsync(); ValidateOperationProperties(operation); - List resultInPages = operation.Value.ToEnumerableAsync().Result; + List resultInPages = operation.Value.ToEnumerableAsync().Result; Assert.AreEqual(1, resultInPages.Count); // Take the first page. - AbstractSummaryResultCollection resultCollection = resultInPages.FirstOrDefault(); + AbstractiveSummarizeResultCollection resultCollection = resultInPages.FirstOrDefault(); ValidateSummaryBatchResult(resultCollection, isLanguageAutoDetected: true); } [RecordedTest] [RetryOnInternalServerError] [ServiceVersion(Min = TextAnalyticsClientOptions.ServiceVersion.V2022_10_01_Preview)] - public async Task AnalyzeOperationAbstractSummary() + public async Task AnalyzeOperationAbstractiveSummarize() { TextAnalyticsClient client = GetClient(); TextAnalyticsActions batchActions = new TextAnalyticsActions() { - AbstractSummaryActions = new List() { new AbstractSummaryAction() { SentenceCount = 2 } }, - DisplayName = "AnalyzeOperationAbstractSummary", + AbstractiveSummarizeActions = new List() { new AbstractiveSummarizeAction() { SentenceCount = 2 } }, + DisplayName = "AnalyzeOperationAbstractiveSummarize", }; AnalyzeActionsOperation operation = await client.StartAnalyzeActionsAsync(s_batchConvenienceDocuments, batchActions); await operation.WaitForCompletionAsync(); AnalyzeActionsResult resultCollection = operation.Value.ToEnumerableAsync().Result.FirstOrDefault(); - IReadOnlyCollection abstractSummaryActionsResults = resultCollection.AbstractSummaryResults; - Assert.IsNotNull(abstractSummaryActionsResults); + IReadOnlyCollection abstractiveSummarizeActionsResults = resultCollection.AbstractiveSummarizeResults; + Assert.IsNotNull(abstractiveSummarizeActionsResults); - AbstractSummaryResultCollection abstractSummaryDocumentsResults = abstractSummaryActionsResults.FirstOrDefault().DocumentsResults; - ValidateSummaryBatchResult(abstractSummaryDocumentsResults); + AbstractiveSummarizeResultCollection abstractiveSummarizeDocumentsResults = abstractiveSummarizeActionsResults.FirstOrDefault().DocumentsResults; + ValidateSummaryBatchResult(abstractiveSummarizeDocumentsResults); } [RecordedTest] [RetryOnInternalServerError] [ServiceVersion(Max = TextAnalyticsClientOptions.ServiceVersion.V2022_05_01)] - public void AnalyzeOperationAbstractSummaryActionNotSupported() + public void AnalyzeOperationAbstractiveSummarizeActionNotSupported() { TestDiagnostics = false; TextAnalyticsClient client = GetClient(); TextAnalyticsActions batchActions = new() { - AbstractSummaryActions = new[] + AbstractiveSummarizeActions = new[] { - new AbstractSummaryAction(), + new AbstractiveSummarizeAction(), }, }; @@ -275,14 +275,14 @@ public void AnalyzeOperationAbstractSummaryActionNotSupported() [RecordedTest] [RetryOnInternalServerError] [Ignore("https://github.com/Azure/azure-sdk-for-net/issues/32614")] - public async Task AnalyzeOperationAbstractSummaryWithAutoDetectedLanguageTest() + public async Task AnalyzeOperationAbstractiveSummarizeWithAutoDetectedLanguageTest() { TextAnalyticsClient client = GetClient(); List documents = s_batchConvenienceDocuments; TextAnalyticsActions actions = new() { - AbstractSummaryActions = new List() { new AbstractSummaryAction() }, - DisplayName = "AbstractSummaryWithAutoDetectedLanguage", + AbstractiveSummarizeActions = new List() { new AbstractiveSummarizeAction() }, + DisplayName = "AbstractiveSummarizeWithAutoDetectedLanguage", }; AnalyzeActionsOperation operation = await client.StartAnalyzeActionsAsync(documents, actions, "auto"); @@ -290,14 +290,14 @@ public async Task AnalyzeOperationAbstractSummaryWithAutoDetectedLanguageTest() // Take the first page. AnalyzeActionsResult resultCollection = operation.Value.ToEnumerableAsync().Result.FirstOrDefault(); - IReadOnlyCollection actionResults = resultCollection.AbstractSummaryResults; + IReadOnlyCollection actionResults = resultCollection.AbstractiveSummarizeResults; Assert.IsNotNull(actionResults); - AbstractSummaryResultCollection results = actionResults.FirstOrDefault().DocumentsResults; + AbstractiveSummarizeResultCollection results = actionResults.FirstOrDefault().DocumentsResults; ValidateSummaryBatchResult(results, isLanguageAutoDetected: true); } - private void ValidateOperationProperties(AbstractSummaryOperation operation) + private void ValidateOperationProperties(AbstractiveSummarizeOperation operation) { Assert.AreNotEqual(new DateTimeOffset(), operation.CreatedOn); // TODO: Re-enable this check (https://github.com/Azure/azure-sdk-for-net/issues/31855). @@ -310,7 +310,7 @@ private void ValidateOperationProperties(AbstractSummaryOperation operation) } private void ValidateSummaryBatchResult( - AbstractSummaryResultCollection results, + AbstractiveSummarizeResultCollection results, bool includeStatistics = default, bool isLanguageAutoDetected = default) { @@ -329,7 +329,7 @@ private void ValidateSummaryBatchResult( Assert.IsNull(results.Statistics); } - foreach (AbstractSummaryResult result in results) + foreach (AbstractiveSummarizeResult result in results) { Assert.That(result.Id, Is.Not.Null.And.Not.Empty); Assert.False(result.HasError); diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchConvenienceTest.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchConvenienceTest.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchConvenienceTest.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchConvenienceTest.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchConvenienceTestAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchConvenienceTestAsync.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchConvenienceTestAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchConvenienceTestAsync.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchConvenienceWithStatisticsTest.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchConvenienceWithStatisticsTest.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchConvenienceWithStatisticsTest.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchConvenienceWithStatisticsTest.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchConvenienceWithStatisticsTestAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchConvenienceWithStatisticsTestAsync.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchConvenienceWithStatisticsTestAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchConvenienceWithStatisticsTestAsync.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchTest.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchTest.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchTest.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchTest.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchTestAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchTestAsync.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchTestAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchTestAsync.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchWithErrorTest.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchWithErrorTest.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchWithErrorTest.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchWithErrorTest.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchWithErrorTestAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchWithErrorTestAsync.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchWithErrorTestAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchWithErrorTestAsync.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchWithStatisticsTest.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchWithStatisticsTest.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchWithStatisticsTest.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchWithStatisticsTest.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchWithStatisticsTestAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchWithStatisticsTestAsync.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryBatchWithStatisticsTestAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeBatchWithStatisticsTestAsync.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryWithAADTest.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeWithAADTest.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryWithAADTest.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeWithAADTest.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryWithAADTestAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeWithAADTestAsync.json similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AbstractSummaryWithAADTestAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AbstractiveSummarizeWithAADTestAsync.json diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AnalyzeOperationAbstractSummary.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AnalyzeOperationAbstractiveSummarize.json similarity index 98% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AnalyzeOperationAbstractSummary.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AnalyzeOperationAbstractiveSummarize.json index 05b0612f9880..814269a029c5 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AnalyzeOperationAbstractSummary.json +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AnalyzeOperationAbstractiveSummarize.json @@ -14,7 +14,7 @@ "x-ms-return-client-request-id": "true" }, "RequestBody": { - "displayName": "AnalyzeOperationAbstractSummary", + "displayName": "AnalyzeOperationAbstractiveSummarize", "analysisInput": { "documents": [ { @@ -81,7 +81,7 @@ "expirationDateTime": "2023-04-15T20:13:00Z", "status": "running", "errors": [], - "displayName": "AnalyzeOperationAbstractSummary", + "displayName": "AnalyzeOperationAbstractiveSummarize", "tasks": { "completed": 0, "failed": 0, @@ -120,7 +120,7 @@ "expirationDateTime": "2023-04-15T20:13:00Z", "status": "running", "errors": [], - "displayName": "AnalyzeOperationAbstractSummary", + "displayName": "AnalyzeOperationAbstractiveSummarize", "tasks": { "completed": 0, "failed": 0, @@ -159,7 +159,7 @@ "expirationDateTime": "2023-04-15T20:13:00Z", "status": "succeeded", "errors": [], - "displayName": "AnalyzeOperationAbstractSummary", + "displayName": "AnalyzeOperationAbstractiveSummarize", "tasks": { "completed": 1, "failed": 0, diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AnalyzeOperationAbstractSummaryAsync.json b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AnalyzeOperationAbstractiveSummarizeAsync.json similarity index 98% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AnalyzeOperationAbstractSummaryAsync.json rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AnalyzeOperationAbstractiveSummarizeAsync.json index 6a02cebc0113..7f1d0e237e6e 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractSummaryTests/AnalyzeOperationAbstractSummaryAsync.json +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/SessionRecords/AbstractiveSummarizeTests/AnalyzeOperationAbstractiveSummarizeAsync.json @@ -14,7 +14,7 @@ "x-ms-return-client-request-id": "true" }, "RequestBody": { - "displayName": "AnalyzeOperationAbstractSummary", + "displayName": "AnalyzeOperationAbstractiveSummarize", "analysisInput": { "documents": [ { @@ -81,7 +81,7 @@ "expirationDateTime": "2023-04-15T20:13:11Z", "status": "notStarted", "errors": [], - "displayName": "AnalyzeOperationAbstractSummary", + "displayName": "AnalyzeOperationAbstractiveSummarize", "tasks": { "completed": 0, "failed": 0, @@ -120,7 +120,7 @@ "expirationDateTime": "2023-04-15T20:13:11Z", "status": "running", "errors": [], - "displayName": "AnalyzeOperationAbstractSummary", + "displayName": "AnalyzeOperationAbstractiveSummarize", "tasks": { "completed": 0, "failed": 0, @@ -159,7 +159,7 @@ "expirationDateTime": "2023-04-15T20:13:11Z", "status": "succeeded", "errors": [], - "displayName": "AnalyzeOperationAbstractSummary", + "displayName": "AnalyzeOperationAbstractiveSummarize", "tasks": { "completed": 1, "failed": 0, diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsClientTests.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsClientTests.cs index 846a584b34d4..be1e707b7797 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsClientTests.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsClientTests.cs @@ -158,13 +158,13 @@ public void ExtractiveSummarizeArgumentValidation() } [Test] - public void AbstractSummaryArgumentValidation() + public void AbstractiveSummarizeArgumentValidation() { - Assert.ThrowsAsync(() => Client.StartAbstractSummaryAsync((string[])null)); - Assert.ThrowsAsync(() => Client.StartAbstractSummaryAsync(Array.Empty())); + Assert.ThrowsAsync(() => Client.StartAbstractiveSummarizeAsync((string[])null)); + Assert.ThrowsAsync(() => Client.StartAbstractiveSummarizeAsync(Array.Empty())); - Assert.ThrowsAsync(() => Client.StartAbstractSummaryAsync((TextDocumentInput[])null)); - Assert.ThrowsAsync(() => Client.StartAbstractSummaryAsync(Array.Empty())); + Assert.ThrowsAsync(() => Client.StartAbstractiveSummarizeAsync((TextDocumentInput[])null)); + Assert.ThrowsAsync(() => Client.StartAbstractiveSummarizeAsync(Array.Empty())); } } } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsModelFactoryTests.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsModelFactoryTests.cs index c766215794e1..518de2b104cb 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsModelFactoryTests.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/TextAnalyticsModelFactoryTests.cs @@ -76,10 +76,10 @@ public void AnalyzeActionsResult() TextAnalyticsModelFactory.ExtractiveSummarizeActionResult(default, default, default), }; - var abstractSummaryActionResults = new List() + var abstractiveSummarizeActionResults = new List() { - TextAnalyticsModelFactory.AbstractSummaryActionResult(default, default, default), - TextAnalyticsModelFactory.AbstractSummaryActionResult(default, default, default), + TextAnalyticsModelFactory.AbstractiveSummarizeActionResult(default, default, default), + TextAnalyticsModelFactory.AbstractiveSummarizeActionResult(default, default, default), }; var actionsResult = TextAnalyticsModelFactory.AnalyzeActionsResult( @@ -106,7 +106,7 @@ public void AnalyzeActionsResult() multiLabelClassifyActionResults, analyzeHealthcareEntitiesActionResults, extractiveSummarizeActionResults, - abstractSummaryActionResults); + abstractiveSummarizeActionResults); CollectionAssert.AreEquivalent(extractKeyPhrasesActionResults, actionsResult.ExtractKeyPhrasesResults); CollectionAssert.AreEquivalent(recognizeEntitiesActionResults, actionsResult.RecognizeEntitiesResults); @@ -118,7 +118,7 @@ public void AnalyzeActionsResult() CollectionAssert.AreEquivalent(multiLabelClassifyActionResults, actionsResult.MultiLabelClassifyResults); CollectionAssert.AreEquivalent(analyzeHealthcareEntitiesActionResults, actionsResult.AnalyzeHealthcareEntitiesResults); CollectionAssert.AreEquivalent(extractiveSummarizeActionResults, actionsResult.ExtractiveSummarizeResults); - CollectionAssert.AreEquivalent(abstractSummaryActionResults, actionsResult.AbstractSummaryResults); + CollectionAssert.AreEquivalent(abstractiveSummarizeActionResults, actionsResult.AbstractiveSummarizeResults); } #endregion Action Result Models } diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractSummary.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractiveSummarize.cs similarity index 93% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractSummary.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractiveSummarize.cs index 08fc28eb36ff..75f10f132617 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractSummary.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractiveSummarize.cs @@ -10,7 +10,7 @@ namespace Azure.AI.TextAnalytics.Samples public partial class TextAnalyticsSamples : TextAnalyticsSampleBase { [Test] - public void AbstractSummary() + public void AbstractiveSummarize() { TestEnvironment.IgnoreIfNotPublicCloud(); @@ -65,13 +65,13 @@ public void AbstractSummary() } }; - AbstractSummaryOptions options = new() + AbstractiveSummarizeOptions options = new() { SentenceCount = 2 }; // Perform the text analysis operation. - AbstractSummaryOperation operation = client.StartAbstractSummary(batchedDocuments, options); + AbstractiveSummarizeOperation operation = client.StartAbstractiveSummarize(batchedDocuments, options); operation.WaitForCompletion(); Console.WriteLine($"The operation has completed."); @@ -86,12 +86,12 @@ public void AbstractSummary() Console.WriteLine(); // View the operation results. - foreach (AbstractSummaryResultCollection documentsInPage in operation.GetValues()) + foreach (AbstractiveSummarizeResultCollection documentsInPage in operation.GetValues()) { - Console.WriteLine($"Abstract Summary, version: \"{documentsInPage.ModelVersion}\""); + Console.WriteLine($"Abstractive Summarize, version: \"{documentsInPage.ModelVersion}\""); Console.WriteLine(); - foreach (AbstractSummaryResult documentResult in documentsInPage) + foreach (AbstractiveSummarizeResult documentResult in documentsInPage) { if (documentResult.HasError) { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractSummaryAsync.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractiveSummarizeAsync.cs similarity index 93% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractSummaryAsync.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractiveSummarizeAsync.cs index c87b3330d1d5..b8b4745e30dd 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractSummaryAsync.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractiveSummarizeAsync.cs @@ -11,7 +11,7 @@ namespace Azure.AI.TextAnalytics.Samples public partial class TextAnalyticsSamples : TextAnalyticsSampleBase { [Test] - public async Task AbstractSummaryAsync() + public async Task AbstractiveSummarizeAsync() { TestEnvironment.IgnoreIfNotPublicCloud(); @@ -66,13 +66,13 @@ public async Task AbstractSummaryAsync() } }; - AbstractSummaryOptions options = new() + AbstractiveSummarizeOptions options = new() { SentenceCount = 2 }; // Perform the text analysis operation. - AbstractSummaryOperation operation = client.StartAbstractSummary(batchedDocuments, options); + AbstractiveSummarizeOperation operation = client.StartAbstractiveSummarize(batchedDocuments, options); await operation.WaitForCompletionAsync(); Console.WriteLine($"The operation has completed."); @@ -87,12 +87,12 @@ public async Task AbstractSummaryAsync() Console.WriteLine(); // View the operation results. - await foreach (AbstractSummaryResultCollection documentsInPage in operation.Value) + await foreach (AbstractiveSummarizeResultCollection documentsInPage in operation.Value) { - Console.WriteLine($"Abstract Summary, model version: \"{documentsInPage.ModelVersion}\""); + Console.WriteLine($"Abstractive Summarize, model version: \"{documentsInPage.ModelVersion}\""); Console.WriteLine(); - foreach (AbstractSummaryResult documentResult in documentsInPage) + foreach (AbstractiveSummarizeResult documentResult in documentsInPage) { if (documentResult.HasError) { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractSummaryConvenience.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractiveSummarizeConvenience.cs similarity index 93% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractSummaryConvenience.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractiveSummarizeConvenience.cs index e62146083603..ad8069513ebb 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractSummaryConvenience.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractiveSummarizeConvenience.cs @@ -10,7 +10,7 @@ namespace Azure.AI.TextAnalytics.Samples public partial class TextAnalyticsSamples : TextAnalyticsSampleBase { [Test] - public void AbstractSummaryConvenience() + public void AbstractiveSummarizeConvenience() { TestEnvironment.IgnoreIfNotPublicCloud(); @@ -63,7 +63,7 @@ public void AbstractSummaryConvenience() }; // Perform the text analysis operation. - AbstractSummaryOperation operation = client.StartAbstractSummary(batchedDocuments); + AbstractiveSummarizeOperation operation = client.StartAbstractiveSummarize(batchedDocuments); operation.WaitForCompletion(); Console.WriteLine($"The operation has completed."); @@ -78,12 +78,12 @@ public void AbstractSummaryConvenience() Console.WriteLine(); // View the operation results. - foreach (AbstractSummaryResultCollection documentsInPage in operation.GetValues()) + foreach (AbstractiveSummarizeResultCollection documentsInPage in operation.GetValues()) { - Console.WriteLine($"Abstract Summary, model version: \"{documentsInPage.ModelVersion}\""); + Console.WriteLine($"Abstractive Summarize, model version: \"{documentsInPage.ModelVersion}\""); Console.WriteLine(); - foreach (AbstractSummaryResult documentResult in documentsInPage) + foreach (AbstractiveSummarizeResult documentResult in documentsInPage) { if (documentResult.HasError) { diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractSummaryConvenienceAsync.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractiveSummarizeConvenienceAsync.cs similarity index 90% rename from sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractSummaryConvenienceAsync.cs rename to sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractiveSummarizeConvenienceAsync.cs index 93956c7af7ff..fb89d54d57cb 100644 --- a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractSummaryConvenienceAsync.cs +++ b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/Sample12_AbstractiveSummarizeConvenienceAsync.cs @@ -11,7 +11,7 @@ namespace Azure.AI.TextAnalytics.Samples public partial class TextAnalyticsSamples : TextAnalyticsSampleBase { [Test] - public async Task AbstractSummaryConvenienceAsync() + public async Task AbstractiveSummarizeConvenienceAsync() { TestEnvironment.IgnoreIfNotPublicCloud(); @@ -19,7 +19,7 @@ public async Task AbstractSummaryConvenienceAsync() AzureKeyCredential credential = new(TestEnvironment.ApiKey); TextAnalyticsClient client = new(endpoint, credential, CreateSampleOptions()); - #region Snippet:Sample12_AbstractSummaryConvenienceAsync + #region Snippet:Sample12_AbstractiveSummarizeConvenienceAsync string document = "Windows 365 was in the works before COVID-19 sent companies around the world on a scramble to secure" + " solutions to support employees suddenly forced to work from home, but “what really put the" @@ -65,14 +65,14 @@ public async Task AbstractSummaryConvenienceAsync() }; // Perform the text analysis operation. - AbstractSummaryOperation operation = client.StartAbstractSummary(batchedDocuments); + AbstractiveSummarizeOperation operation = client.StartAbstractiveSummarize(batchedDocuments); await operation.WaitForCompletionAsync(); #endregion Console.WriteLine($"The operation has completed."); Console.WriteLine(); - #region Snippet:Sample12_AbstractSummaryConvenienceAsync_ViewOperationStatus + #region Snippet:Sample12_AbstractiveSummarizeConvenienceAsync_ViewOperationStatus // View the operation status. Console.WriteLine($"Created On : {operation.CreatedOn}"); Console.WriteLine($"Expires On : {operation.ExpiresOn}"); @@ -82,14 +82,14 @@ public async Task AbstractSummaryConvenienceAsync() Console.WriteLine(); #endregion - #region Snippet:Sample12_AbstractSummaryConvenienceAsync_ViewResults + #region Snippet:Sample12_AbstractiveSummarizeConvenienceAsync_ViewResults // View the operation results. - await foreach (AbstractSummaryResultCollection documentsInPage in operation.Value) + await foreach (AbstractiveSummarizeResultCollection documentsInPage in operation.Value) { - Console.WriteLine($"Abstract Summary, model version: \"{documentsInPage.ModelVersion}\""); + Console.WriteLine($"Abstractive Summarize, model version: \"{documentsInPage.ModelVersion}\""); Console.WriteLine(); - foreach (AbstractSummaryResult documentResult in documentsInPage) + foreach (AbstractiveSummarizeResult documentResult in documentsInPage) { if (documentResult.HasError) { From 6d9900a2d6b0f02e6b0483403bc54ad788221951 Mon Sep 17 00:00:00 2001 From: Jose Arriaga Maldonado Date: Fri, 26 May 2023 16:23:06 -0700 Subject: [PATCH 3/3] Add missing file renames --- ...Sample11_ExtractSummary.md => Sample11_ExtractiveSummarize.md} | 0 ...mple12_AbstractSummary.md => Sample12_AbstractiveSummarize.md} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename sdk/textanalytics/Azure.AI.TextAnalytics/samples/{Sample11_ExtractSummary.md => Sample11_ExtractiveSummarize.md} (100%) rename sdk/textanalytics/Azure.AI.TextAnalytics/samples/{Sample12_AbstractSummary.md => Sample12_AbstractiveSummarize.md} (100%) diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractSummary.md b/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractiveSummarize.md similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractSummary.md rename to sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractiveSummarize.md diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractSummary.md b/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractiveSummarize.md similarity index 100% rename from sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractSummary.md rename to sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractiveSummarize.md