Class ApiClientSettings
Base class for AI client settings. This class is used to store API keys and other settings related to AI clients.
public abstract class ApiClientSettings : ScriptableObject
- Inheritance
-
objectApiClientSettings
- Derived
Constructors
ApiClientSettings()
protected ApiClientSettings()
Fields
apiKey
protected ApiKey apiKey
Field Value
baseUrl
protected string baseUrl
Field Value
- string
betaVersion
protected string betaVersion
Field Value
- string
connectionCheckUrl
protected string connectionCheckUrl
Field Value
- string
isEnabled
protected bool isEnabled
Field Value
- bool
isShowingAdvancedSettings
protected bool isShowingAdvancedSettings
Field Value
- bool
version
protected string version
Field Value
- string
Properties
Api
public abstract Api Api { get; }
Property Value
DefaultBaseUrl
protected abstract string DefaultBaseUrl { get; }
Property Value
- string
DefaultBetaVersion
protected virtual string DefaultBetaVersion { get; }
Property Value
- string
DefaultConnectionCheckUrl
protected virtual string DefaultConnectionCheckUrl { get; }
Property Value
- string
DefaultIsEnabled
protected virtual bool DefaultIsEnabled { get; }
Property Value
- bool
DefaultVersion
protected virtual string DefaultVersion { get; }
Property Value
- string
Methods
CheckConnectionAsync()
public virtual UniTask<bool> CheckConnectionAsync()
Returns
- UniTask<bool>
GetApiKey()
Retrieves the API key.
public string GetApiKey()
Returns
- string
GetBaseUrl()
public string GetBaseUrl()
Returns
- string
GetBetaVersion()
public virtual string GetBetaVersion()
Returns
- string
GetVersion()
public virtual string GetVersion()
Returns
- string
HasApiKey()
Checks if the API key is set.
public virtual bool HasApiKey()
Returns
- bool
IsEnabled()
Returns true if the API client is enabled.
public virtual bool IsEnabled()
Returns
- bool
ResetToDefaults()
public virtual void ResetToDefaults()