AI DevKit
Search Results for

    Show / Hide Table of Contents

    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
    AnthropicSettings
    ElevenLabsSettings
    GenerativeAISettings
    GroqCloudSettings
    MicrosoftAzureSettings
    MubertSettings
    OllamaSettings
    OpenAISettings
    OpenRouterSettings
    PixelLabSettings
    PlayHTSettings
    Namespace: Glitch9.AIDevKit
    Assembly: .dll
    Syntax
    public abstract class ApiClientSettings : ScriptableObject

    Constructors

    ApiClientSettings()

    Declaration
    protected ApiClientSettings()

    Fields

    apiKey

    Declaration
    protected ApiKey apiKey
    Field Value
    Type Description
    ApiKey

    baseUrl

    Declaration
    protected string baseUrl
    Field Value
    Type Description
    string

    betaVersion

    Declaration
    protected string betaVersion
    Field Value
    Type Description
    string

    connectionCheckUrl

    Declaration
    protected string connectionCheckUrl
    Field Value
    Type Description
    string

    isEnabled

    Declaration
    protected bool isEnabled
    Field Value
    Type Description
    bool

    isShowingAdvancedSettings

    Declaration
    protected bool isShowingAdvancedSettings
    Field Value
    Type Description
    bool

    version

    Declaration
    protected string version
    Field Value
    Type Description
    string

    Properties

    Api

    Declaration
    public abstract Api Api { get; }
    Property Value
    Type Description
    Api

    DefaultBaseUrl

    Declaration
    protected abstract string DefaultBaseUrl { get; }
    Property Value
    Type Description
    string

    DefaultBetaVersion

    Declaration
    protected virtual string DefaultBetaVersion { get; }
    Property Value
    Type Description
    string

    DefaultConnectionCheckUrl

    Declaration
    protected virtual string DefaultConnectionCheckUrl { get; }
    Property Value
    Type Description
    string

    DefaultIsEnabled

    Declaration
    protected virtual bool DefaultIsEnabled { get; }
    Property Value
    Type Description
    bool

    DefaultVersion

    Declaration
    protected virtual string DefaultVersion { get; }
    Property Value
    Type Description
    string

    Methods

    CheckConnectionAsync()

    Declaration
    public virtual UniTask<bool> CheckConnectionAsync()
    Returns
    Type Description
    UniTask<bool>

    GetApiKey()

    Retrieves the API key.

    Declaration
    public string GetApiKey()
    Returns
    Type Description
    string

    GetBaseUrl()

    Declaration
    public string GetBaseUrl()
    Returns
    Type Description
    string

    GetBetaVersion()

    Declaration
    public virtual string GetBetaVersion()
    Returns
    Type Description
    string

    GetVersion()

    Declaration
    public virtual string GetVersion()
    Returns
    Type Description
    string

    HasApiKey()

    Checks if the API key is set.

    Declaration
    public virtual bool HasApiKey()
    Returns
    Type Description
    bool

    IsEnabled()

    Returns true if the API client is enabled.

    Declaration
    public virtual bool IsEnabled()
    Returns
    Type Description
    bool

    ResetToDefaults()

    Declaration
    public virtual void ResetToDefaults()
    In this article
    Back to top Generated by DocFX