AI DevKit
Search Results for

    Show / Hide Table of Contents

    Class AIComponent

    Inheritance
    object
    AIComponent
    AIAssistant
    AIGenerative<TOptions, TProfile, TInput, TOutput>
    Namespace: Glitch9.AIDevKit.Components
    Assembly: .dll
    Syntax
    public abstract class AIComponent : MonoBehaviour

    Fields

    onErrorOccured

    Declaration
    public UnityEvent_OnErrorOccured onErrorOccured
    Field Value
    Type Description
    UnityEvent_OnErrorOccured

    onReceiveUsage

    Declaration
    public UnityEvent_OnReceiveUsage onReceiveUsage
    Field Value
    Type Description
    UnityEvent_OnReceiveUsage

    streaming

    Declaration
    protected bool streaming
    Field Value
    Type Description
    bool

    Properties

    Api

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

    DebugMode

    Declaration
    protected bool DebugMode { get; }
    Property Value
    Type Description
    bool

    IsProcessing

    Declaration
    public bool IsProcessing { get; }
    Property Value
    Type Description
    bool

    IsSubcomponent

    Declaration
    public bool IsSubcomponent { get; }
    Property Value
    Type Description
    bool

    Logger

    Declaration
    protected IDebugLogger Logger { get; }
    Property Value
    Type Description
    IDebugLogger

    Methods

    Awake()

    Declaration
    protected virtual void Awake()

    CancelAllRequests()

    Declaration
    public void CancelAllRequests()

    CancelLastRequest()

    Declaration
    public void CancelLastRequest()

    Enqueue(Func<UniTask>)

    Declaration
    protected void Enqueue(Func<UniTask> taskFactory)
    Parameters
    Type Name Description
    Func<UniTask> taskFactory

    IsInvalidFile(IFile)

    Declaration
    protected bool IsInvalidFile(IFile file)
    Parameters
    Type Name Description
    IFile file
    Returns
    Type Description
    bool

    IsInvalidFiles(IList<IFile>)

    Declaration
    protected bool IsInvalidFiles(IList<IFile> files)
    Parameters
    Type Name Description
    IList<IFile> files
    Returns
    Type Description
    bool

    IsInvalidPrompt(TextPrompt, List<ChatMessage>)

    Declaration
    protected bool IsInvalidPrompt(TextPrompt textPrompt, List<ChatMessage> messages)
    Parameters
    Type Name Description
    TextPrompt textPrompt
    List<ChatMessage> messages
    Returns
    Type Description
    bool

    IsInvalidPrompt(string)

    Declaration
    protected bool IsInvalidPrompt(string promptText)
    Parameters
    Type Name Description
    string promptText
    Returns
    Type Description
    bool

    IsInvalidPrompt<T>(T)

    Declaration
    protected bool IsInvalidPrompt<T>(T nonTextPrompt) where T : class
    Parameters
    Type Name Description
    T nonTextPrompt
    Returns
    Type Description
    bool
    Type Parameters
    Name Description
    T

    LogError(string)

    Declaration
    protected void LogError(string message)
    Parameters
    Type Name Description
    string message

    LogInfo(string)

    Declaration
    protected void LogInfo(string message)
    Parameters
    Type Name Description
    string message

    LogWarning(string)

    Declaration
    protected void LogWarning(string message)
    Parameters
    Type Name Description
    string message

    NoRequiredComponent(MonoBehaviour)

    Declaration
    protected bool NoRequiredComponent(MonoBehaviour component)
    Parameters
    Type Name Description
    MonoBehaviour component
    Returns
    Type Description
    bool

    OnReceiveUsageData(Usage)

    Declaration
    protected void OnReceiveUsageData(Usage usage)
    Parameters
    Type Name Description
    Usage usage

    SetParentComponent(AIComponent)

    Declaration
    public void SetParentComponent(AIComponent parent)
    Parameters
    Type Name Description
    AIComponent parent
    In this article
    Back to top Generated by DocFX