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

AzureOpenAISummaryProvider

Class

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

Definition

Namespace:Telerik.WinControls.UI.AIProviders

Assembly:Telerik.WinControls.PdfViewer.dll

Syntax:

[CLSCompliant(false)]
public class AzureOpenAISummaryProvider : BaseSummaryProvider, ISummaryProvider

Inheritance: objectBaseSummaryProviderAzureOpenAISummaryProvider

Implements: ISummaryProvider

Constructors

AzureOpenAISummaryProvider(SecureString, string, string)

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

public AzureOpenAISummaryProvider(SecureString key, string endpoint, string model)

Parameters:keySecureString

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

endpointstring

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

modelstring

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.

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.