[Text Analytics] Rename summarization (Azure#34042)

ExtractSummary- ➡️ ExtractiveSummarize-
AbstractSummary- ➡️ AbstractiveSummarize-
SummarySentence ➡️ ExtractiveSummarySentece
SummarySentencesOrder ➡️ ExtractiveSummarySentencesOrder
SummaryContext ➡️ AbstractiveSummaryContext

Author: joseharriaga

sdk/textanalytics/Azure.AI.TextAnalytics/README.md

@@ -752,8 +752,8 @@ 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]
 * [Dynamic Classification][dynamic_classify_sample]
-* [Extractive Summarization][extract_summary_sample]
-* [Abstractive Summarization][abstract_summary_sample]
+* [Extractive Summarization][extractive_summarize_sample]
+* [Abstractive Summarization][abstractive_summarize_sample]
 
 ### Advanced samples
 
@@ -815,8 +815,8 @@ 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
 [dynamic_classify_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_DynamicClassify.md
-[extract_summary_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_ExtractSummary.md
-[abstract_summary_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample13_AbstractSummary.md
+[extractive_summarize_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_ExtractiveSummarize.md
+[abstractive_summarize_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample13_AbstractiveSummarize.md
 
 [azure_cli]: https://docs.microsoft.com/cli/azure
 [azure_sub]: https://azure.microsoft.com/free/dotnet/

sdk/textanalytics/Azure.AI.TextAnalytics/api/Azure.AI.TextAnalytics.netstandard2.0.cs

@@ -38,8 +38,8 @@ Text Analytics is part of the Azure Cognitive Service for Language, a cloud-base
 - [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)
 - [Dynamic Classification](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_DynamicClassify.md)
-- [Extractive Summarization](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_ExtractSummary.md)
-- [Abstractive Summarization](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample13_AbstractSummary.md)
+- [Extractive Summarization](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_ExtractiveSummarize.md)
+- [Abstractive Summarization](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample13_AbstractiveSummarize.md)
 
 ## Advanced samples
 - [Analyze Sentiment with Opinion Mining](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample2.1_AnalyzeSentimentWithOpinionMining.md)

sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md

@@ -13,9 +13,9 @@ TextAnalyticsClient client = new(new Uri(endpoint), new AzureKeyCredential(apiKe
 The values of the `endpoint` and `apiKey` variables can be retrieved from environment variables, configuration settings, or any other secure approach that works for your application.
 
 ## Perform extractive summarization on one or more documents
-To perform extractive text summarization on one or more documents, call `StartExtractSummary` on the `TextAnalyticsClient` by passing the documents as an `IEnumerable<string>` parameter. This returns an `ExtractSummaryOperation`, which is a long-running operation that can be used to poll the service until the operation has completed and the results of the extractive summarization are available.
+To perform extractive text summarization on one or more documents, call `StartExtractiveSummarize` on the `TextAnalyticsClient` by passing the documents as an `IEnumerable<string>` parameter. This returns an `ExtractiveSummarizeOperation`, which is a long-running operation that can be used to poll the service until the operation has completed and the results of the extractive summarization are available.
 
-```C# Snippet:TextAnalyticsExtractSummaryAsync
+```C# Snippet:TextAnalyticsExtractiveSummarizeAsync
 // Get the document.
 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"
@@ -49,17 +49,17 @@ List<string> documentBatch = new()
 };
 
 // Start the text analysis operation.
-ExtractSummaryOperation operation = client.StartExtractSummary(documentBatch);
+ExtractiveSummarizeOperation operation = client.StartExtractiveSummarize(documentBatch);
 
 await operation.WaitForCompletionAsync();
 
 Console.WriteLine($"The operation has completed.");
 Console.WriteLine();
 ```
 
-The `ExtractSummaryOperation` includes general information about the status of the operation, and it can be queried at any time:
+The `ExtractiveSummarizeOperation` includes general information about the status of the operation, and it can be queried at any time:
 
-```C# Snippet:TextAnalyticsExtractSummaryOperationStatus
+```C# Snippet:TextAnalyticsExtractiveSummarizeOperationStatus
 // View the operation status.
 Console.WriteLine($"Created On   : {operation.CreatedOn}");
 Console.WriteLine($"Expires On   : {operation.ExpiresOn}");
@@ -71,14 +71,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:TextAnalyticsExtractSummaryAsyncViewResults
+```C# Snippet:TextAnalyticsExtractiveSummarizeAsyncViewResults
 // View the operation results.
-await foreach (ExtractSummaryResultCollection documentsInPage in operation.Value)
+await foreach (ExtractiveSummarizeResultCollection documentsInPage in operation.Value)
 {
     Console.WriteLine($"Results of \"Extractive Summarization\" Model, version: \"{documentsInPage.ModelVersion}\"");
     Console.WriteLine();
 
-    foreach (ExtractSummaryResult documentResult in documentsInPage)
+    foreach (ExtractiveSummarizeResult documentResult in documentsInPage)
     {
         if (documentResult.HasError)
         {
@@ -91,7 +91,7 @@ await foreach (ExtractSummaryResultCollection documentsInPage in operation.Value
         Console.WriteLine($"  Extracted the following {documentResult.Sentences.Count} sentence(s):");
         Console.WriteLine();
 
-        foreach (SummarySentence sentence in documentResult.Sentences)
+        foreach (ExtractiveSummarySentence sentence in documentResult.Sentences)
         {
             Console.WriteLine($"  Sentence: {sentence.Text}");
             Console.WriteLine($"  Rank Score: {sentence.RankScore}");

…ytics/samples/Sample12_ExtractSummary.md …/samples/Sample12_ExtractiveSummarize.mdsdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_ExtractSummary.md renamed to sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_ExtractiveSummarize.md sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_ExtractSummary.md renamed to sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_ExtractiveSummarize.md

@@ -13,9 +13,9 @@ TextAnalyticsClient client = new(new Uri(endpoint), new AzureKeyCredential(apiKe
 The values of the `endpoint` and `apiKey` variables can be retrieved from environment variables, configuration settings, or any other secure approach that works for your application.
 
 ## Perform abstractive summarization on one or more documents
-To perform abstractive text summarization on one or more documents, call `StartAbstractSummary` on the `TextAnalyticsClient` by passing the documents as an `IEnumerable<string>` parameter. This returns an `AbstractSummaryOperation`, which is a long-running operation that can be used to poll the service until the operation has completed and the results of the abstractive summarization are available.
+To perform abstractive text summarization on one or more documents, call `StartAbstractiveSummarize` on the `TextAnalyticsClient` by passing the documents as an `IEnumerable<string>` parameter. This returns an `AbstractiveSummarizeOperation`, which is a long-running operation that can be used to poll the service until the operation has completed and the results of the abstractive summarization are available.
 
-```C# Snippet:TextAnalyticsAbstractSummaryAsync
+```C# Snippet:TextAnalyticsAbstractiveSummarizeAsync
 // Get the document.
 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"
@@ -49,17 +49,17 @@ List<string> documentBatch = new()
 };
 
 // Start the text analysis operation.
-AbstractSummaryOperation operation = client.StartAbstractSummary(documentBatch);
+AbstractiveSummarizeOperation operation = client.StartAbstractiveSummarize(documentBatch);
 
 await operation.WaitForCompletionAsync();
 
 Console.WriteLine($"The operation has completed.");
 Console.WriteLine();
 ```
 
-The `AbstractSummaryOperation` includes general information about the status of the operation, and it can be queried at any time:
+The `AbstractiveSummarizeOperation` includes general information about the status of the operation, and it can be queried at any time:
 
-```C# Snippet:TextAnalyticsAbstractSummaryOperationStatus
+```C# Snippet:TextAnalyticsAbstractiveSummarizeOperationStatus
 // View the operation status.
 Console.WriteLine($"Created On   : {operation.CreatedOn}");
 Console.WriteLine($"Expires On   : {operation.ExpiresOn}");
@@ -71,14 +71,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:TextAnalyticsAbstractSummaryAsyncViewResults
+```C# Snippet:TextAnalyticsAbstractiveSummarizeAsyncViewResults
 // View the operation results.
-await foreach (AbstractSummaryResultCollection documentsInPage in operation.Value)
+await foreach (AbstractiveSummarizeResultCollection documentsInPage in operation.Value)
 {
     Console.WriteLine($"Results of \"Abstractive Summarization\" Model, version: \"{documentsInPage.ModelVersion}\"");
     Console.WriteLine();
 
-    foreach (AbstractSummaryResult documentResult in documentsInPage)
+    foreach (AbstractiveSummarizeResult documentResult in documentsInPage)
     {
         if (documentResult.HasError)
         {
@@ -96,7 +96,7 @@ await foreach (AbstractSummaryResultCollection documentsInPage in operation.Valu
             Console.WriteLine($"  Text: {summary.Text.Replace("\n", " ")}");
             Console.WriteLine($"  Contexts:");
 
-            foreach (SummaryContext context in summary.Contexts)
+            foreach (AbstractiveSummaryContext context in summary.Contexts)
             {
                 Console.WriteLine($"    Offset: {context.Offset}");
                 Console.WriteLine($"    Length: {context.Length}");

…tics/samples/Sample13_AbstractSummary.md …samples/Sample13_AbstractiveSummarize.mdsdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample13_AbstractSummary.md renamed to sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample13_AbstractiveSummarize.md sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample13_AbstractSummary.md renamed to sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample13_AbstractiveSummarize.md

@@ -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.
     /// </summary>
-    public class AbstractSummaryAction
+    public class AbstractiveSummarizeAction
     {
         /// <summary>
-        /// Initializes a new instance of the <see cref="AbstractSummaryAction"/> class.
+        /// Initializes a new instance of the <see cref="AbstractiveSummarizeAction"/> class.
         /// </summary>
-        public AbstractSummaryAction()
+        public AbstractiveSummarizeAction()
         {
         }
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="AbstractSummaryAction"/> class based on the given
-        /// <see cref="AbstractSummaryOptions"/>.
+        /// Initializes a new instance of the <see cref="AbstractiveSummarizeAction"/> class based on the given
+        /// <see cref="AbstractiveSummarizeOptions"/>.
         /// </summary>
-        public AbstractSummaryAction(AbstractSummaryOptions options)
+        public AbstractiveSummarizeAction(AbstractiveSummarizeOptions options)
         {
             ModelVersion = options.ModelVersion;
             DisableServiceLogs = options.DisableServiceLogs;

…xtAnalytics/src/AbstractSummaryAction.cs …lytics/src/AbstractiveSummarizeAction.cssdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryAction.cs renamed to sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeAction.cs sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryAction.cs renamed to sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeAction.cs

@@ -7,33 +7,33 @@
 namespace Azure.AI.TextAnalytics
 {
     /// <summary>
-    /// A representation of the result of performing an <see cref="AbstractSummaryAction"/> on a given set of
+    /// A representation of the result of performing an <see cref="AbstractiveSummarizeAction"/> on a given set of
     /// documents.
     /// </summary>
-    public class AbstractSummaryActionResult : TextAnalyticsActionResult
+    public class AbstractiveSummarizeActionResult : TextAnalyticsActionResult
     {
-        private readonly AbstractSummaryResultCollection _documentsResults;
+        private readonly AbstractiveSummarizeResultCollection _documentsResults;
 
         /// <summary>
-        /// Initializes a successful <see cref="AbstractSummaryActionResult"/>.
+        /// Initializes a successful <see cref="AbstractiveSummarizeActionResult"/>.
         /// </summary>
-        internal AbstractSummaryActionResult(
-            AbstractSummaryResultCollection result, string actionName, DateTimeOffset completedOn)
+        internal AbstractiveSummarizeActionResult(
+            AbstractiveSummarizeResultCollection result, string actionName, DateTimeOffset completedOn)
             : base(actionName, completedOn)
         {
             _documentsResults = result;
         }
 
         /// <summary>
-        /// Initializes an <see cref="AbstractSummaryActionResult"/> with an error.
+        /// Initializes an <see cref="AbstractiveSummarizeActionResult"/> with an error.
         /// </summary>
-        internal AbstractSummaryActionResult(string actionName, DateTimeOffset completedOn, Error error)
+        internal AbstractiveSummarizeActionResult(string actionName, DateTimeOffset completedOn, Error error)
             : base(actionName, completedOn, error) { }
 
         /// <summary>
         /// The collection of results corresponding to each input document.
         /// </summary>
-        public AbstractSummaryResultCollection DocumentsResults
+        public AbstractiveSummarizeResultCollection DocumentsResults
         {
             get
             {