Back to Devexpress

IAIDocProcessingService.SummarizeAsync(Slide, SummarizationMode, CancellationToken) Method

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

latest3.3 KB
Original Source

IAIDocProcessingService.SummarizeAsync(Slide, SummarizationMode, CancellationToken) Method

Generates a brief summary of a slide content.

Namespace : DevExpress.AIIntegration.Docs

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

NuGet Package : DevExpress.AIIntegration.Docs

Declaration

csharp
Task<string> SummarizeAsync(
    Slide slide,
    SummarizationMode mode = SummarizationMode.Abstractive,
    CancellationToken cancellationToken = default(CancellationToken)
)
vb
Function SummarizeAsync(
    slide As Slide,
    mode As SummarizationMode = SummarizationMode.Abstractive,
    cancellationToken As CancellationToken = Nothing
) As Task(Of String)

Parameters

NameTypeDescription
slideSlide

The Slide object which content 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.

|

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SummarizeAsync(Slide, 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.

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

csharp
var slide = presentation.Slides[0];
summaryText = await docProcessingService.SummarizeAsync(slide, summarizationMode);
break;

See Also

IAIDocProcessingService Interface

IAIDocProcessingService Members

DevExpress.AIIntegration.Docs Namespace