Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Text Analytics] Rename ExtractSummary and AbstractSummary #36555

Merged
merged 3 commits into from
May 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions sdk/textanalytics/Azure.AI.TextAnalytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -756,8 +756,8 @@ 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]
* [Abstractive Summarization][abstract_summary_sample]
* [Extractive Summarization][extractive_summarize_sample]
* [Abstractive Summarization][abstractive_summarize_sample]

### Advanced samples

Expand Down Expand Up @@ -823,8 +823,8 @@ 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
[abstract_summary_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractSummary.md
[extractive_summarize_sample]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample11_ExtractiveSummarize.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/
Expand Down

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions sdk/textanalytics/Azure.AI.TextAnalytics/samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ 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)
* [Abstractive Summarization](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/textanalytics/Azure.AI.TextAnalytics/samples/Sample12_AbstractSummary.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_AbstractiveSummarize.md)

## Advanced samples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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<string>` parameter or an `IEnumerable<TextDocumentInput>` 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<string>` parameter or an `IEnumerable<TextDocumentInput>` 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"
Expand Down Expand Up @@ -64,13 +64,13 @@ List<string> 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}");
Expand All @@ -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)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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<string>` parameter or an `IEnumerable<TextDocumentInput>` 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<string>` parameter or an `IEnumerable<TextDocumentInput>` 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"
Expand Down Expand Up @@ -64,13 +64,13 @@ List<string> 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}");
Expand All @@ -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)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
Loading