Class OpenAIAuthentication

Namespace

OpenAI

Assembly

OpenAI-DotNet.dll

Represents authentication to the OpenAI API endpoint

public sealed class OpenAIAuthentication

Inheritance

object

OpenAIAuthentication

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OpenAIAuthentication(string)

Instantiates a new Authentication object with the given apiKey, which may be null.

public OpenAIAuthentication(string apiKey)

Parameters

apiKey string

The API key, required to access the API endpoint.

OpenAIAuthentication(string, string, string)

Instantiates a new Authentication object with the given apiKey, which may be null.

public OpenAIAuthentication(string apiKey, string organization, string projectId = null)

Parameters

apiKey string

The API key, required to access the API endpoint.

organization string

For users who belong to multiple organizations, you can pass a header to specify which organization is used for an API request. Usage from these API requests will count against the specified organization's subscription quota.

projectId string

Optional, Project id to specify.

Properties

ApiKey

The API key, required to access the API endpoint.

public string ApiKey { get; }

Property Value

string

Default

The default authentication to use when no other auth is specified. This can be set manually, or automatically loaded via environment variables or a config file. LoadFromEnv(string)LoadFromDirectory(string, string, bool)

public static OpenAIAuthentication Default { get; }

Property Value

OpenAIAuthentication

OrganizationId

For users who belong to multiple organizations, you can pass a header to specify which organization is used for an API request. Usage from these API requests will count against the specified organization's subscription quota.

public string OrganizationId { get; }

Property Value

string

ProjectId

For users that specify specific projects.

public string ProjectId { get; }

Property Value

string

Methods

LoadFromDirectory(string, string, bool)

Attempts to load api keys from a configuration file, by default ".openai" in the current directory, optionally traversing up the directory tree.

public static OpenAIAuthentication LoadFromDirectory(string directory = null, string filename = ".openai", bool searchUp = true)

Parameters

directory string

The directory to look in, or null for the current directory.

filename string

The filename of the config file.

searchUp bool

Whether to recursively traverse up the directory tree if the filename is not found in the directory.

Returns

OpenAIAuthentication

Returns the loaded OpenAIAuthentication any api keys were found, or null if it was not successful in finding a config (or if the config file didn't contain correctly formatted API keys)

LoadFromEnv(string)

Attempts to load api keys from environment variables, as "OPENAI_KEY" (or "OPENAI_SECRET_KEY", for backwards compatibility)

public static OpenAIAuthentication LoadFromEnv(string organizationId = null)

Parameters

organizationId string

For users who belong to multiple organizations, you can pass a header to specify which organization is used for an API request. Usage from these API requests will count against the specified organization's subscription quota.

Returns

OpenAIAuthentication

Returns the loaded OpenAIAuthentication any api keys were found, or null if there were no matching environment vars.

LoadFromPath(string)

Attempts to load api keys from a specified configuration file.

public static OpenAIAuthentication LoadFromPath(string path)

Parameters

path string

The specified path to the configuration file.

Returns

OpenAIAuthentication

Returns the loaded OpenAIAuthentication any api keys were found, or null if it was not successful in finding a config (or if the config file didn't contain correctly formatted API keys)

Operators

implicit operator OpenAIAuthentication(string)

Allows implicit casting from a string, so that a simple string API key can be provided in place of an instance of OpenAIAuthentication.

public static implicit operator OpenAIAuthentication(string key)

Parameters

key string

The API key to convert into a OpenAIAuthentication.

Returns

OpenAIAuthentication