Share via


TextAnalyticsClient.ExtractiveSummarizeAsync Method

Definition

Overloads

ExtractiveSummarizeAsync(WaitUntil, IEnumerable<TextDocumentInput>, ExtractiveSummarizeOptions, CancellationToken)

Performs extractive summarization on the given documents, which consists of extracting sentences that collectively represent the most important or relevant information within the original content. 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.

ExtractiveSummarizeAsync(WaitUntil, IEnumerable<String>, String, ExtractiveSummarizeOptions, CancellationToken)

Performs extractive summarization on the given documents, which consists of extracting sentences that collectively represent the most important or relevant information within the original content. 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.

ExtractiveSummarizeAsync(WaitUntil, IEnumerable<TextDocumentInput>, ExtractiveSummarizeOptions, CancellationToken)

Source:
TextAnalyticsClient.cs

Performs extractive summarization on the given documents, which consists of extracting sentences that collectively represent the most important or relevant information within the original content. 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.

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

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
ExtractiveSummarizeOptions

The additional ExtractiveSummarizeOptions 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 extractive summarization. Upon completion, the operation will contain the collections of extracted summary sentences 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

ExtractiveSummarizeAsync(WaitUntil, IEnumerable<String>, String, ExtractiveSummarizeOptions, CancellationToken)

Source:
TextAnalyticsClient.cs

Performs extractive summarization on the given documents, which consists of extracting sentences that collectively represent the most important or relevant information within the original content. 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.

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

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
ExtractiveSummarizeOptions

The additional ExtractiveSummarizeOptions 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 extractive summarization. Upon completion, the operation will contain the collections of extracted summary sentences 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