Skip to content

Commit 9ef69d4

Browse files
authored
[Text Analytics] Rename ExtractSummary and AbstractSummary (#36555)
1 parent 3987fa3 commit 9ef69d4

File tree

72 files changed

+695
-695
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+695
-695
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -756,8 +756,8 @@ Samples are provided for each main functional area, and for each area, samples a
756756
* [Custom Named Entities Recognition][recognize_custom_entities_sample]
757757
* [Custom Single Label Classification][single_category_classify_sample]
758758
* [Custom Multi Label Classification][multi_category_classify_sample]
759-
* [Extractive Summarization][extract_summary_sample]
760-
* [Abstractive Summarization][abstract_summary_sample]
759+
* [Extractive Summarization][extractive_summarize_sample]
760+
* [Abstractive Summarization][abstractive_summarize_sample]
761761

762762
### Advanced samples
763763

@@ -823,8 +823,8 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
823823
[recognize_custom_entities_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample8_RecognizeCustomEntities.md
824824
[single_category_classify_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample9_SingleLabelClassify.md
825825
[multi_category_classify_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample10_MultiLabelClassify.md
826-
[extract_summary_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractSummary.md
827-
[abstract_summary_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractSummary.md
826+
[extractive_summarize_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractiveSummarize.md
827+
[abstractive_summarize_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractiveSummarize.md
828828

829829
[azure_cli]: https://docs.microsoft.com/cli/azure
830830
[azure_sub]: https://azure.microsoft.com/free/dotnet/

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

Lines changed: 94 additions & 94 deletions
Large diffs are not rendered by default.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ See the [README][README] of the Text Analytics client library for more informati
4040
* [Custom Named Entity Recognition](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample8_RecognizeCustomEntities.md)
4141
* [Custom Single Label Classification](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample9_SingleLabelClassify.md)
4242
* [Custom Multi Label Classification](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample10_MultiLabelClassify.md)
43-
* [Extractive Summarization](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractSummary.md)
44-
* [Abstractive Summarization](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractSummary.md)
43+
* [Extractive Summarization](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractiveSummarize.md)
44+
* [Abstractive Summarization](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractiveSummarize.md)
4545

4646
## Advanced samples
4747

sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractSummary.md renamed to sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractiveSummarize.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ The values of the `endpoint` and `apiKey` variables can be retrieved from enviro
1616

1717
## Summarize one or more documents
1818

19-
To summarize one or more text documents using extractive summarization, call `StartExtractSummary` on the `TextAnalyticsClient` by passing the documents as either an `IEnumerable<string>` parameter or an `IEnumerable<TextDocumentInput>` parameter. This returns an `ExtractSummaryOperation`.
19+
To summarize one or more text documents using extractive summarization, call `StartExtractiveSummarize` on the `TextAnalyticsClient` by passing the documents as either an `IEnumerable<string>` parameter or an `IEnumerable<TextDocumentInput>` parameter. This returns an `ExtractiveSummarizeOperation`.
2020

21-
```C# Snippet:Sample11_ExtractSummaryConvenienceAsync
21+
```C# Snippet:Sample11_ExtractiveSummarizeConvenienceAsync
2222
string document =
2323
"Windows 365 was in the works before COVID-19 sent companies around the world on a scramble to secure"
2424
+ " solutions to support employees suddenly forced to work from home, but “what really put the"
@@ -64,13 +64,13 @@ List<string> batchedDocuments = new()
6464
};
6565

6666
// Perform the text analysis operation.
67-
ExtractSummaryOperation operation = client.StartExtractSummary(batchedDocuments);
67+
ExtractiveSummarizeOperation operation = client.StartExtractiveSummarize(batchedDocuments);
6868
await operation.WaitForCompletionAsync();
6969
```
7070

71-
The `ExtractSummaryOperation` includes general information about the status of the long-running operation, and it can be queried at any time:
71+
The `ExtractiveSummarizeOperation` includes general information about the status of the long-running operation, and it can be queried at any time:
7272

73-
```C# Snippet:Sample11_ExtractSummaryConvenienceAsync_ViewOperationStatus
73+
```C# Snippet:Sample11_ExtractiveSummarizeConvenienceAsync_ViewOperationStatus
7474
// View the operation status.
7575
Console.WriteLine($"Created On : {operation.CreatedOn}");
7676
Console.WriteLine($"Expires On : {operation.ExpiresOn}");
@@ -82,14 +82,14 @@ Console.WriteLine();
8282

8383
Once the long-running operation has completed, you can view the results of the extractive summarization, including any errors that might have occurred:
8484

85-
```C# Snippet:Sample11_ExtractSummaryConvenienceAsync_ViewResults
85+
```C# Snippet:Sample11_ExtractiveSummarizeConvenienceAsync_ViewResults
8686
// View the operation results.
87-
await foreach (ExtractSummaryResultCollection documentsInPage in operation.Value)
87+
await foreach (ExtractiveSummarizeResultCollection documentsInPage in operation.Value)
8888
{
89-
Console.WriteLine($"Extract Summary, version: \"{documentsInPage.ModelVersion}\"");
89+
Console.WriteLine($"Extractive Summarize, version: \"{documentsInPage.ModelVersion}\"");
9090
Console.WriteLine();
9191

92-
foreach (ExtractSummaryResult documentResult in documentsInPage)
92+
foreach (ExtractiveSummarizeResult documentResult in documentsInPage)
9393
{
9494
if (documentResult.HasError)
9595
{

sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractSummary.md renamed to sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractiveSummarize.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ The values of the `endpoint` and `apiKey` variables can be retrieved from enviro
1616

1717
## Summarize one or more documents
1818

19-
To summarize one or more text documents using abstractive summarization, call `StartAbstractSummary` on the `TextAnalyticsClient` by passing the documents as either an `IEnumerable<string>` parameter or an `IEnumerable<TextDocumentInput>` parameter. This returns an `AbstractSummaryOperation`.
19+
To summarize one or more text documents using abstractive summarization, call `StartAbstractiveSummarize` on the `TextAnalyticsClient` by passing the documents as either an `IEnumerable<string>` parameter or an `IEnumerable<TextDocumentInput>` parameter. This returns an `AbstractiveSummarizeOperation`.
2020

21-
```C# Snippet:Sample12_AbstractSummaryConvenienceAsync
21+
```C# Snippet:Sample12_AbstractiveSummarizeConvenienceAsync
2222
string document =
2323
"Windows 365 was in the works before COVID-19 sent companies around the world on a scramble to secure"
2424
+ " solutions to support employees suddenly forced to work from home, but “what really put the"
@@ -64,13 +64,13 @@ List<string> batchedDocuments = new()
6464
};
6565

6666
// Perform the text analysis operation.
67-
AbstractSummaryOperation operation = client.StartAbstractSummary(batchedDocuments);
67+
AbstractiveSummarizeOperation operation = client.StartAbstractiveSummarize(batchedDocuments);
6868
await operation.WaitForCompletionAsync();
6969
```
7070

71-
The `AbstractSummaryOperation` includes general information about the status of the long-running operation, and it can be queried at any time:
71+
The `AbstractiveSummarizeOperation` includes general information about the status of the long-running operation, and it can be queried at any time:
7272

73-
```C# Snippet:Sample12_AbstractSummaryConvenienceAsync_ViewOperationStatus
73+
```C# Snippet:Sample12_AbstractiveSummarizeConvenienceAsync_ViewOperationStatus
7474
// View the operation status.
7575
Console.WriteLine($"Created On : {operation.CreatedOn}");
7676
Console.WriteLine($"Expires On : {operation.ExpiresOn}");
@@ -82,14 +82,14 @@ Console.WriteLine();
8282

8383
Once the long-running operation has completed, you can view the results of the abstractive summarization, including any errors that might have occurred:
8484

85-
```C# Snippet:Sample12_AbstractSummaryConvenienceAsync_ViewResults
85+
```C# Snippet:Sample12_AbstractiveSummarizeConvenienceAsync_ViewResults
8686
// View the operation results.
87-
await foreach (AbstractSummaryResultCollection documentsInPage in operation.Value)
87+
await foreach (AbstractiveSummarizeResultCollection documentsInPage in operation.Value)
8888
{
89-
Console.WriteLine($"Abstract Summary, model version: \"{documentsInPage.ModelVersion}\"");
89+
Console.WriteLine($"Abstractive Summarize, model version: \"{documentsInPage.ModelVersion}\"");
9090
Console.WriteLine();
9191

92-
foreach (AbstractSummaryResult documentResult in documentsInPage)
92+
foreach (AbstractiveSummarizeResult documentResult in documentsInPage)
9393
{
9494
if (documentResult.HasError)
9595
{

sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryAction.cs renamed to sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeAction.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,20 @@ namespace Azure.AI.TextAnalytics
77
/// A set of options used to configure abstractive summarization, including the model version to use, the maximum
88
/// number of sentences that the resulting summary can have, and more.
99
/// </summary>
10-
public class AbstractSummaryAction
10+
public class AbstractiveSummarizeAction
1111
{
1212
/// <summary>
13-
/// Initializes a new instance of the <see cref="AbstractSummaryAction"/> class.
13+
/// Initializes a new instance of the <see cref="AbstractiveSummarizeAction"/> class.
1414
/// </summary>
15-
public AbstractSummaryAction()
15+
public AbstractiveSummarizeAction()
1616
{
1717
}
1818

1919
/// <summary>
20-
/// Initializes a new instance of the <see cref="AbstractSummaryAction"/> class based on the given
21-
/// <see cref="AbstractSummaryOptions"/>.
20+
/// Initializes a new instance of the <see cref="AbstractiveSummarizeAction"/> class based on the given
21+
/// <see cref="AbstractiveSummarizeOptions"/>.
2222
/// </summary>
23-
public AbstractSummaryAction(AbstractSummaryOptions options)
23+
public AbstractiveSummarizeAction(AbstractiveSummarizeOptions options)
2424
{
2525
ModelVersion = options.ModelVersion;
2626
DisableServiceLogs = options.DisableServiceLogs;

sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractSummaryActionResult.cs renamed to sdk/textanalytics/Azure.AI.TextAnalytics/src/AbstractiveSummarizeActionResult.cs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,33 @@
77
namespace Azure.AI.TextAnalytics
88
{
99
/// <summary>
10-
/// A representation of the result of performing an <see cref="AbstractSummaryAction"/> on a given set of
10+
/// A representation of the result of performing an <see cref="AbstractiveSummarizeAction"/> on a given set of
1111
/// documents.
1212
/// </summary>
13-
public class AbstractSummaryActionResult : TextAnalyticsActionResult
13+
public class AbstractiveSummarizeActionResult : TextAnalyticsActionResult
1414
{
15-
private readonly AbstractSummaryResultCollection _documentsResults;
15+
private readonly AbstractiveSummarizeResultCollection _documentsResults;
1616

1717
/// <summary>
18-
/// Initializes a successful <see cref="AbstractSummaryActionResult"/>.
18+
/// Initializes a successful <see cref="AbstractiveSummarizeActionResult"/>.
1919
/// </summary>
20-
internal AbstractSummaryActionResult(
21-
AbstractSummaryResultCollection result, string actionName, DateTimeOffset completedOn)
20+
internal AbstractiveSummarizeActionResult(
21+
AbstractiveSummarizeResultCollection result, string actionName, DateTimeOffset completedOn)
2222
: base(actionName, completedOn)
2323
{
2424
_documentsResults = result;
2525
}
2626

2727
/// <summary>
28-
/// Initializes an <see cref="AbstractSummaryActionResult"/> with an error.
28+
/// Initializes an <see cref="AbstractiveSummarizeActionResult"/> with an error.
2929
/// </summary>
30-
internal AbstractSummaryActionResult(string actionName, DateTimeOffset completedOn, Error error)
30+
internal AbstractiveSummarizeActionResult(string actionName, DateTimeOffset completedOn, Error error)
3131
: base(actionName, completedOn, error) { }
3232

3333
/// <summary>
3434
/// The collection of results corresponding to each input document.
3535
/// </summary>
36-
public AbstractSummaryResultCollection DocumentsResults
36+
public AbstractiveSummarizeResultCollection DocumentsResults
3737
{
3838
get
3939
{

0 commit comments

Comments
 (0)