AIDocProcessingService.SummarizeAsync(PdfDocumentProcessor, PdfDocumentPosition, PdfDocumentPosition, SummarizationMode, CancellationToken) Method

Generates a brief summary of a document content.

Namespace: DevExpress.AIIntegration.Docs

Assembly: DevExpress.AIIntegration.Docs.v25.2.dll

NuGet Package: DevExpress.AIIntegration.Docs

Declaration

C#

public Task<string> SummarizeAsync(
    PdfDocumentProcessor processor,
    PdfDocumentPosition startPosition,
    PdfDocumentPosition endPosition,
    SummarizationMode mode = SummarizationMode.Abstractive,
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

Public Function SummarizeAsync(
    processor As PdfDocumentProcessor,
    startPosition As PdfDocumentPosition,
    endPosition As PdfDocumentPosition,
    mode As SummarizationMode = SummarizationMode.Abstractive,
    cancellationToken As CancellationToken = Nothing
) As Task(Of String)

Parameters

Name	Type	Description
processor	PdfDocumentProcessor	The PdfDocumentProcessor instance which content should be summarized.
startPosition	PdfDocumentPosition	The start position of a content that should be summarized.
endPosition	PdfDocumentPosition	The end position of a content that should be summarized.

Optional Parameters

Name	Type	Default	Description
mode	SummarizationMode	Abstractive	An enumeration value that indicates summarization mode.
cancellationToken	CancellationToken	null	The token that cancels the task.

Returns

Type	Description
Task<String>	The response that contains AI-generated summary.

Implements

SummarizeAsync(PdfDocumentProcessor, PdfDocumentPosition, PdfDocumentPosition, SummarizationMode, CancellationToken)