Class OpenAIClientSettings

Namespace

OpenAI

Assembly

OpenAI-DotNet.dll

The client settings for configuring Azure OpenAI or custom domain.

public sealed class OpenAIClientSettings

Inheritance

object

OpenAIClientSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OpenAIClientSettings()

Creates a new instance of OpenAIClientSettings for use with OpenAI.

public OpenAIClientSettings()

OpenAIClientSettings(string, string)

Creates a new instance of OpenAIClientSettings for use with OpenAI.

public OpenAIClientSettings(string domain, string apiVersion = "v1")

Parameters

domain string

Base api domain.

apiVersion string

The version of the OpenAI api you want to use.

OpenAIClientSettings(string, string, string, bool)

Creates a new instance of the OpenAIClientSettings for use with Azure OpenAI.
https://learn.microsoft.com/en-us/azure/cognitive-services/openai/

public OpenAIClientSettings(string resourceName, string deploymentId, string apiVersion = "2023-05-01", bool useActiveDirectoryAuthentication = false)

Parameters

resourceName string

The name of your Azure OpenAI Resource.

deploymentId string

The name of your model deployment. You're required to first deploy a model before you can make calls.

apiVersion string

Optional, defaults to 2022-12-01

useActiveDirectoryAuthentication bool

Optional, set to true if you want to use Azure Active Directory for Authentication.

Properties

ApiVersion

public string ApiVersion { get; }

Property Value

string

BaseRequest

public string BaseRequest { get; }

Property Value

string

Default

public static OpenAIClientSettings Default { get; }

Property Value

OpenAIClientSettings

DeploymentId

public string DeploymentId { get; }

Property Value

string

IsAzureOpenAI

public bool IsAzureOpenAI { get; }

Property Value

bool

ResourceName

public string ResourceName { get; }

Property Value

string