New to Telerik UI for WinForms? Start a free 30-day trial

BaseSummaryProvider

Class

Base class for summary providers using AI chat clients.

Definition

Namespace:Telerik.WinControls.UI.AIProviders

Assembly:Telerik.WinControls.PdfViewer.dll

Syntax:

[CLSCompliant(false)]
public abstract class BaseSummaryProvider : ISummaryProvider

Inheritance: objectBaseSummaryProvider

Derived Classes: AzureOpenAISummaryProviderLlamaSummaryProviderOpenAISummaryProvider

Implements: ISummaryProvider

Constructors

BaseSummaryProvider()

protected BaseSummaryProvider()

Properties

ChatClient

IChatClient

Gets or sets the AI chat client used for summarization and question answering.

public IChatClient ChatClient { get; set; }

MaxTokenCount

int

Gets or sets the maximum number of tokens that can be processed. Default is 128000.

public int MaxTokenCount { get; set; }

Model

string

Gets or sets the model name used by the AI chat client for processing requests.

public string Model { get; set; }

PromptAddition

string

Gets or sets additional instructions to be appended to the prompt for summarization or question answering.

public string PromptAddition { get; set; }

Implements: ISummaryProvider.PromptAddition

Methods

AskQuestion(string, SimpleTextDocument)

Asks a question about the specified document and returns the AI-generated answer.

public string AskQuestion(string question, SimpleTextDocument simpleDocument)

Parameters:questionstring

The question to ask.

simpleDocumentSimpleTextDocument

The document to use as context for the question.

Returns:

string

The answer string generated by the AI model.

Implements: ISummaryProvider.AskQuestion(string, SimpleTextDocument)

CreateChatClient()

When implemented in a derived class, creates and initializes the AI chat client.

protected abstract void CreateChatClient()

GetSummary(SimpleTextDocument)

Generates a summary for the specified document using the AI chat client.

public string GetSummary(SimpleTextDocument simpleDocument)

Parameters:simpleDocumentSimpleTextDocument

The document to summarize.

Returns:

string

A summary string generated by the AI model.

Implements: ISummaryProvider.GetSummary(SimpleTextDocument)

OnSummaryResourcesCalculated(object, SummaryResourcesCalculatedEventArgs)

Raises the SummaryResourcesCalculated event.

protected virtual void OnSummaryResourcesCalculated(object sender, SummaryResourcesCalculatedEventArgs e)

Parameters:senderobject

The event source.

eSummaryResourcesCalculatedEventArgs

The event data.

SecureStringToString(SecureString)

Returns the actual key.

protected virtual string SecureStringToString(SecureString secureString)

Parameters:secureStringSecureStringReturns:

string

SummarizationProcessor_SummaryResourcesCalculated(object, SummaryResourcesCalculatedEventArgs)

Handles the event when summary resources are calculated, allowing execution to continue. Also raises the SummaryResourcesCalculated event for external subscribers.

protected virtual void SummarizationProcessor_SummaryResourcesCalculated(object sender, SummaryResourcesCalculatedEventArgs e)

Parameters:senderobject

The event source.

eSummaryResourcesCalculatedEventArgs

The event data containing summary resource information.

Events

SummaryResourcesCalculated

EventHandler<SummaryResourcesCalculatedEventArgs>

Occurs when summary resources are calculated during summarization.

public event EventHandler<SummaryResourcesCalculatedEventArgs> SummaryResourcesCalculated