IAIDocProcessingService.SummarizeAsync(PdfDocumentProcessor, PdfDocumentArea, 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#
• VB.NET

Task<string> SummarizeAsync(
    PdfDocumentProcessor processor,
    PdfDocumentArea area,
    SummarizationMode mode = SummarizationMode.Abstractive,
    CancellationToken cancellationToken = default(CancellationToken)
)

Function SummarizeAsync(
    processor As PdfDocumentProcessor,
    area As PdfDocumentArea,
    mode As SummarizationMode = SummarizationMode.Abstractive,
    cancellationToken As CancellationToken = Nothing
) As Task(Of String)

Parameters

The PdfDocumentProcessor instance which content should be summarized.

| | area | PdfDocumentArea |

The area of a content that should be summarized.

|

Optional Parameters

An enumeration value that indicates summarization mode.

| | cancellationToken | CancellationToken | null |

The token that cancels the task.

|

Returns

The response that contains AI-generated summary.

|

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SummarizeAsync(PdfDocumentProcessor, PdfDocumentArea, SummarizationMode, CancellationToken) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

• C#

office-file-api-ai-implementation/CS/Controllers/SummarizeController.cs#L79

var pageArea = PdfDocumentArea.Create(pagePosition1, pagePosition2);
summaryText = await docProcessingService.SummarizeAsync(pdfDocumentProcessor, pageArea, summarizationMode);
break;

See Also

IAIDocProcessingService Interface

IAIDocProcessingService Members

DevExpress.AIIntegration.Docs Namespace