AI DevKit
Search Results for

    Show / Hide Table of Contents

    Class ChatbotBase<TConversation, TMessage, TDelta>

    Inheritance
    object
    AIComponent
    AIAssistant
    Chatbot
    ChatbotBase<TConversation, TMessage, TDelta>
    AssistantChatbot
    LocalChatbot
    Inherited Members
    Chatbot.speechTranscriber
    Chatbot.speechGenerator
    Chatbot.imageGenerator
    Chatbot.contentModerator
    Chatbot.onSendMessage
    Chatbot.Messages
    Chatbot.Api
    Chatbot.Name
    Chatbot.Model
    Chatbot.UtilityModel
    Chatbot.IsStreamEnabled
    Chatbot.Profile
    Chatbot.InitializeAsync()
    Chatbot.EnterChatText(string)
    Chatbot.EnterChatMessage(ChatMessage)
    Chatbot.AttachFile(IFile)
    Chatbot.AttachFiles(IList<IFile>)
    Chatbot.StartRecording()
    Chatbot.StopRecording()
    Chatbot.ProcessChatRequestAsyncINTERNAL(ChatMessage)
    Chatbot.OnReceiveMessage(ChatMessage)
    Chatbot.ProcessPendingMessageAsyncINTERNAL()
    Chatbot.IsInvalidResponse(ChatMessage)
    Chatbot.IsNotInitialized()
    AIAssistant.functionManager
    AIAssistant.autoStart
    AIAssistant.onInitialized
    AIAssistant.onReceiveToolCalls
    AIAssistant.IsInitialized
    AIAssistant.Start()
    AIComponent.streaming
    AIComponent.onReceiveUsage
    AIComponent.onErrorOccured
    AIComponent.DebugMode
    AIComponent.Logger
    AIComponent.IsProcessing
    AIComponent.IsSubcomponent
    AIComponent.Awake()
    AIComponent.SetParentComponent(AIComponent)
    AIComponent.Enqueue(Func<UniTask>)
    AIComponent.CancelAllRequests()
    AIComponent.CancelLastRequest()
    AIComponent.OnReceiveUsageData(Usage)
    AIComponent.LogInfo(string)
    AIComponent.LogWarning(string)
    AIComponent.LogError(string)
    AIComponent.IsInvalidPrompt(string)
    AIComponent.IsInvalidFile(IFile)
    AIComponent.IsInvalidFiles(IList<IFile>)
    AIComponent.NoRequiredComponent(MonoBehaviour)
    AIComponent.IsInvalidPrompt<T>(T)
    AIComponent.IsInvalidPrompt(TextPrompt, List<ChatMessage>)
    Namespace: Glitch9.AIDevKit.Components
    Assembly: .dll
    Syntax
    public abstract class ChatbotBase<TConversation, TMessage, TDelta> : Chatbot where TConversation : class, IChatConversation<TMessage> where TMessage : ChatMessage where TDelta : class
    Type Parameters
    Name Description
    TConversation
    TMessage
    TDelta

    Fields

    conversationEvents

    Event triggered when a conversation is created, loaded, or deleted.
    This is useful for managing conversation state and updating the UI or other components accordingly.

    Declaration
    public UnityEvent_Conversation<TConversation, TMessage> conversationEvents
    Field Value
    Type Description
    UnityEvent_Conversation<TConversation, TMessage>

    onReceiveMessage

    Event triggered when a complete message is received.

    • If streaming is enabled, this event will be called once the entire message has been received.
    • If streaming is disabled, this event will be called immediately after the message is processed.
    Declaration
    public UnityEvent_OnReceiveMessage<TMessage> onReceiveMessage
    Field Value
    Type Description
    UnityEvent_OnReceiveMessage<TMessage>

    onReceiveStreamingMessage

    Event triggered when a new message is received during streaming.
    This allows for real-time updates to the UI or other components as the message is being streamed.

    Declaration
    public UnityEvent_OnReceiveStreamingMessage<TDelta> onReceiveStreamingMessage
    Field Value
    Type Description
    UnityEvent_OnReceiveStreamingMessage<TDelta>

    onStartStreamingMessage

    Event triggered when a new message starts streaming.
    This is useful for UI updates or other actions that need to occur when a message starts streaming.

    Declaration
    public UnityEvent onStartStreamingMessage
    Field Value
    Type Description
    UnityEvent

    Methods

    CreateConversationAsyncINTERNAL()

    Declaration
    protected abstract UniTask<TConversation> CreateConversationAsyncINTERNAL()
    Returns
    Type Description
    UniTask<TConversation>

    DeleteConversationAsync(string)

    Declaration
    public UniTask<bool> DeleteConversationAsync(string conversationId)
    Parameters
    Type Name Description
    string conversationId
    Returns
    Type Description
    UniTask<bool>

    DeleteConversationAsyncINTERNAL(string)

    Declaration
    protected abstract UniTask<bool> DeleteConversationAsyncINTERNAL(string conversationId)
    Parameters
    Type Name Description
    string conversationId
    Returns
    Type Description
    UniTask<bool>

    LoadConversationAsync(string)

    Declaration
    public UniTask<TConversation> LoadConversationAsync(string conversationId)
    Parameters
    Type Name Description
    string conversationId
    Returns
    Type Description
    UniTask<TConversation>

    LoadConversationAsyncINTERNAL(string)

    Declaration
    protected abstract UniTask<TConversation> LoadConversationAsyncINTERNAL(string conversationId)
    Parameters
    Type Name Description
    string conversationId
    Returns
    Type Description
    UniTask<TConversation>

    StartNewConversationAsync()

    Declaration
    public UniTask<TConversation> StartNewConversationAsync()
    Returns
    Type Description
    UniTask<TConversation>
    In this article
    Back to top Generated by DocFX