TextAnalyticsClient.AbstractiveSummarize Method

Reference

Definition

Namespace:: Azure.AI.TextAnalytics

Assembly:: Azure.AI.TextAnalytics.dll

Package:: Azure.AI.TextAnalytics v5.3.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

AbstractiveSummarize(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://learn.microsoft.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.

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

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

Source:: TextAnalyticsClient.cs

public virtual Azure.AI.TextAnalytics.AbstractiveSummarizeOperation AbstractiveSummarize (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 AbstractiveSummarize : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AbstractiveSummarizeOperation
override this.AbstractiveSummarize : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AbstractiveSummarizeOperation

Public Overridable Function AbstractiveSummarize (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), Optional options As AbstractiveSummarizeOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

AbstractiveSummarizeOperation

An AbstractiveSummarizeOperation 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

NotSupportedException

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

RequestFailedException

The service returned a non-success status code.

ArgumentException

documents is an empty collection.

ArgumentNullException

documents is null.

Remarks

This method is only available for V2023_04_01, and newer.

Applies to

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

Source:: TextAnalyticsClient.cs

public virtual Azure.AI.TextAnalytics.AbstractiveSummarizeOperation AbstractiveSummarize (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 AbstractiveSummarize : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AbstractiveSummarizeOperation
override this.AbstractiveSummarize : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AbstractiveSummarizeOperation

Public Overridable Function AbstractiveSummarize (waitUntil As WaitUntil, documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As AbstractiveSummarizeOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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.