TextAnalyticsClient.AbstractiveSummarizeAsync Method

Definition

Overloads

AbstractiveSummarizeAsync(WaitUntil, IEnumerable<TextDocumentInput>, AbstractiveSummarizeOptions, CancellationToken)

Performs abstractive summarization on a given set of documents, which consists of generating a summary with concise, coherent sentences or words which are not simply extract sentences from the original document. For a list of languages supported by this operation, see https://video2.skills-academy.com/azure/cognitive-services/language-service/summarization/language-support. For document length limits, maximum batch size, and supported text encoding, see https://aka.ms/azsdk/textanalytics/data-limits.

AbstractiveSummarizeAsync(WaitUntil, IEnumerable<String>, String, AbstractiveSummarizeOptions, CancellationToken)

Performs abstractive summarization on a given set of documents, which consists of generating a summary with concise, coherent sentences or words which are not simply extract sentences from the original document. For a list of languages supported by this operation, see https://video2.skills-academy.com/azure/cognitive-services/language-service/summarization/language-support. For document length limits, maximum batch size, and supported text encoding, see https://aka.ms/azsdk/textanalytics/data-limits.

AbstractiveSummarizeAsync(WaitUntil, IEnumerable<TextDocumentInput>, AbstractiveSummarizeOptions, CancellationToken)

Source:
TextAnalyticsClient.cs

Performs abstractive summarization on a given set of documents, which consists of generating a summary with concise, coherent sentences or words which are not simply extract sentences from the original document. For a list of languages supported by this operation, see https://video2.skills-academy.com/azure/cognitive-services/language-service/summarization/language-support. For document length limits, maximum batch size, and supported text encoding, see https://aka.ms/azsdk/textanalytics/data-limits.

public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AbstractiveSummarizeOperation> AbstractiveSummarizeAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.AbstractiveSummarizeOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member AbstractiveSummarizeAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AbstractiveSummarizeOperation>
override this.AbstractiveSummarizeAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AbstractiveSummarizeOperation>
Public Overridable Function AbstractiveSummarizeAsync (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), Optional options As AbstractiveSummarizeOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AbstractiveSummarizeOperation)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation.

documents
IEnumerable<TextDocumentInput>

The documents to analyze.

options
AbstractiveSummarizeOptions

The additional AbstractiveSummarizeOptions used to configure the operation.

cancellationToken
CancellationToken

The CancellationToken controlling the lifetime of the request.

Returns

A Task<TResult> 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.

Exceptions

This method is only supported in service API version 2023-04-01 and newer.

The service returned a non-success status code.

documents is an empty collection.

documents is null.

Remarks

This method is only available for V2023_04_01, and newer.

Applies to

AbstractiveSummarizeAsync(WaitUntil, IEnumerable<String>, String, AbstractiveSummarizeOptions, CancellationToken)

Source:
TextAnalyticsClient.cs

Performs abstractive summarization on a given set of documents, which consists of generating a summary with concise, coherent sentences or words which are not simply extract sentences from the original document. For a list of languages supported by this operation, see https://video2.skills-academy.com/azure/cognitive-services/language-service/summarization/language-support. For document length limits, maximum batch size, and supported text encoding, see https://aka.ms/azsdk/textanalytics/data-limits.

public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AbstractiveSummarizeOperation> AbstractiveSummarizeAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.AbstractiveSummarizeOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member AbstractiveSummarizeAsync : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AbstractiveSummarizeOperation>
override this.AbstractiveSummarizeAsync : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AbstractiveSummarizeOperation>
Public Overridable Function AbstractiveSummarizeAsync (waitUntil As WaitUntil, documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As AbstractiveSummarizeOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AbstractiveSummarizeOperation)

Parameters

waitUntil
WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation.

documents
IEnumerable<String>

The documents to analyze.

language
String

The language that the documents are written in.

options
AbstractiveSummarizeOptions

The additional AbstractiveSummarizeOptions used to configure the operation.

cancellationToken
CancellationToken

The CancellationToken controlling the lifetime of the request.

Returns

A Task<TResult> 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.

Exceptions

This method is only supported in service API version 2023-04-01 and newer.

The service returned a non-success status code.

documents is an empty collection.

documents is null.

Remarks

This method is only available for V2023_04_01, and newer.

Applies to