Class
AzureOpenAISummaryProvider

Provides summary and question-answering functionality using Azure OpenAI services.

Definition

Namespace:Telerik.Windows.Controls.FixedDocumentViewersUI.AIProviders

Assembly:Telerik.Windows.Controls.FixedDocumentViewersUI.dll

Syntax:

cs-api-definition
[CLSCompliant(false)]
public class AzureOpenAISummaryProvider : BaseSummaryProvider, ISummaryProvider

Inheritance: objectBaseSummaryProviderAzureOpenAISummaryProvider

Implements: ISummaryProvider

Inherited Members BaseSummaryProvider.GetSummary(SimpleTextDocument)BaseSummaryProvider.AskQuestion(string, SimpleTextDocument)BaseSummaryProvider.SummarizationProcessor_SummaryResourcesCalculated(object, SummaryResourcesCalculatedEventArgs)BaseSummaryProvider.OnSummaryResourcesCalculated(object, SummaryResourcesCalculatedEventArgs)BaseSummaryProvider.SecureStringToString(SecureString)BaseSummaryProvider.PromptAdditionBaseSummaryProvider.ChatClientBaseSummaryProvider.ModelBaseSummaryProvider.MaxTokenCountBaseSummaryProvider.SummaryResourcesCalculated

Constructors

AzureOpenAISummaryProvider(SecureString, string, string)

Initializes a new instance of the AzureOpenAISummaryProvider class with the specified API key, endpoint, and model.

Declaration

cs-api-definition
public AzureOpenAISummaryProvider(SecureString key, string endpoint, string model)

Parameters

key

SecureString

The API key used to authenticate requests to the Azure OpenAI service. Cannot be null or empty.

endpoint

string

The endpoint URL of the Azure OpenAI service. Must be a valid URI and cannot be null or empty.

model

string

The name of the OpenAI model to use for generating summaries. Cannot be null or empty.

Remarks

This constructor initializes the provider and creates an internal chat client for interacting with the Azure OpenAI service. Ensure that the provided API key and endpoint are valid and have the necessary permissions to access the specified model.

Methods

CreateChatClient()

Initializes and configures the chat client for interacting with the Azure OpenAI service.

Declaration

cs-api-definition
protected override void CreateChatClient()

Overrides BaseSummaryProvider.CreateChatClient()

Remarks

This method creates an instance of the Azure OpenAI chat client using the specified endpoint, API key, and model. The resulting client is assigned to the property.