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