TextAnalyticsClient.ExtractiveSummarize 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

ExtractiveSummarize(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.

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

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

Source:: TextAnalyticsClient.cs

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

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

ExtractiveSummarizeOperation

An ExtractiveSummarizeOperation that can be used to monitor the status of extractive summarization. Upon completion, the operation will contain the collections of extracted summary sentences 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

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

Source:: TextAnalyticsClient.cs

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

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