Back to Devexpress

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

officefileapi-devexpress-dot-aiintegration-dot-docs-dot-iaidocprocessingservice-dot-summarizeasync-x28-pdfdocumentprocessor-pdfdocumentposition-pdfdocumentposition-summarizationmode-cancellationtoken-x29.md

latest3.1 KB
Original Source

IAIDocProcessingService.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

csharp
Task<string> SummarizeAsync(
    PdfDocumentProcessor processor,
    PdfDocumentPosition startPosition,
    PdfDocumentPosition endPosition,
    SummarizationMode mode = SummarizationMode.Abstractive,
    CancellationToken cancellationToken = default(CancellationToken)
)
vb
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

NameTypeDescription
processorPdfDocumentProcessor

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

NameTypeDefaultDescription
modeSummarizationModeAbstractive

An enumeration value that indicates summarization mode.

| | cancellationToken | CancellationToken | null |

The token that cancels the task.

|

Returns

TypeDescription
Task<String>

The response that contains AI-generated summary.

|

See Also

IAIDocProcessingService Interface

IAIDocProcessingService Members

DevExpress.AIIntegration.Docs Namespace