ClassBaseSummaryProvider
Base class for summary providers using AI chat clients.
Definition
Namespace:Telerik.Windows.Controls.FixedDocumentViewersUI.AIProviders
Assembly:Telerik.Windows.Controls.FixedDocumentViewersUI.dll
Syntax:
[CLSCompliant(false)]
public abstract class BaseSummaryProvider : ISummaryProviderInheritance: objectBaseSummaryProvider
Derived Classes:
Implements:
Constructors
BaseSummaryProvider()
Declaration
protected BaseSummaryProvider()Properties
ChatClient
Gets or sets the AI chat client used for summarization and question answering.
Declaration
public IChatClient ChatClient { get; set; }Property Value
IChatClient
MaxTokenCount
Gets or sets the maximum number of tokens that can be processed. Default is 128000.
Model
Gets or sets the model name used by the AI chat client for processing requests.
PromptAddition
Gets or sets additional instructions to be appended to the prompt for summarization or question answering.
Declaration
public string PromptAddition { get; set; }Property Value
Implements
Methods
AskQuestion(string, SimpleTextDocument)
Asks a question about the specified document and returns the AI-generated answer.
Declaration
public string AskQuestion(string question, SimpleTextDocument simpleDocument)Parameters
question
The question to ask.
simpleDocument
SimpleTextDocument
The document to use as context for the question.
Returns
The answer string generated by the AI model.
Implements
CreateChatClient()
When implemented in a derived class, creates and initializes the AI chat client.
Declaration
protected abstract void CreateChatClient()GetSummary(SimpleTextDocument)
Generates a summary for the specified document using the AI chat client.
Declaration
public string GetSummary(SimpleTextDocument simpleDocument)Parameters
simpleDocument
SimpleTextDocument
The document to summarize.
Returns
A summary string generated by the AI model.
Implements
OnSummaryResourcesCalculated(object, SummaryResourcesCalculatedEventArgs)
Raises the SummaryResourcesCalculated event.
Declaration
protected virtual void OnSummaryResourcesCalculated(object sender, SummaryResourcesCalculatedEventArgs e)Parameters
sender
The event source.
e
SummaryResourcesCalculatedEventArgs
The event data.
SecureStringToString(SecureString)
Returns the actual key.
Declaration
protected virtual string SecureStringToString(SecureString secureString)Parameters
secureString
Returns
SummarizationProcessor_SummaryResourcesCalculated(object, SummaryResourcesCalculatedEventArgs)
Handles the event when summary resources are calculated, allowing execution to continue. Also raises the SummaryResourcesCalculated event for external subscribers.
Declaration
protected virtual void SummarizationProcessor_SummaryResourcesCalculated(object sender, SummaryResourcesCalculatedEventArgs e)Parameters
sender
The event source.
e
SummaryResourcesCalculatedEventArgs
The event data containing summary resource information.
Events
SummaryResourcesCalculated
Occurs when summary resources are calculated during summarization.
Declaration
public event EventHandler<SummaryResourcesCalculatedEventArgs> SummaryResourcesCalculatedEvent Value
EventHandler<SummaryResourcesCalculatedEventArgs>