Class AIServiceCredentials

Inheritance

System.Object

AIServiceCredentials

Namespace: Syncfusion.Blazor.SmartComponents

Assembly: Syncfusion.Blazor.SmartComponents.dll

Syntax

public class AIServiceCredentials : Object

Constructors

AIServiceCredentials()

Initializes a new instance of the AIServiceCredentials class where properties are set individually.

Declaration

public AIServiceCredentials()

AIServiceCredentials(String, String, String)

Initializes a new instance of the AIServiceCredentials class with specified values.

Declaration

public AIServiceCredentials(string apiKey, string deploymentName, string endpoint = null)

Parameters

Type	Name	Description
System.String	apiKey	The API key used to authenticate requests to the AI service.
System.String	deploymentName	The name of the AI model deployment, such as an OpenAI model version or an Azure deployment name.
System.String	endpoint	The endpoint URL of the AI service.

Properties

ApiKey

The API key used to authenticate requests to the Azure OpenAI service. This key provides the necessary permissions to access the OpenAI models hosted within your Azure resource.

Declaration

public string ApiKey { get; set; }

Property Value

Type
System.String

DeploymentName

In general, it represents the instance of the AI model you are using, such as a specific version of GPT. If azure, it represents the name of the specific deployment within the Azure OpenAI resource.

Declaration

public string DeploymentName { get; set; }

Property Value

Type
System.String

Endpoint

The Endpoint of your azure AI service.

Declaration

public Uri Endpoint { get; set; }

Property Value

Type
System.Uri

SelfHosted

Specifies whether the application is configured to use a self-hosted AI service. When set to true, the application will connect to a self-hosted instance rather than a cloud-hosted AI service.

Declaration

public bool SelfHosted { get; set; }

Property Value

Type
System.Boolean