Class AssistantChatbot

Inheritance
object
AIComponent
AIAssistant
Chatbot
ChatbotBase<Thread, ThreadMessage, ThreadMessageDelta>
AssistantChatbot
Inherited Members
Namespace: Glitch9.AIDevKit.Components
Assembly: .dll
Syntax
public class AssistantChatbot : ChatbotBase<Thread, ThreadMessage, ThreadMessageDelta>

Fields

onAssistantStatusChanged

Declaration
public UnityEvent<AssistantStatus> onAssistantStatusChanged
Field Value
Type Description
UnityEvent<AssistantStatus>

onRequiredAction

Declaration
public UnityEvent<FunctionCall> onRequiredAction
Field Value
Type Description
UnityEvent<FunctionCall>

onRequiredActionTimeout

Declaration
public UnityEvent onRequiredActionTimeout
Field Value
Type Description
UnityEvent

onRunStatusChanged

Declaration
public UnityEvent<RunStatus> onRunStatusChanged
Field Value
Type Description
UnityEvent<RunStatus>

Properties

Controller

Declaration
public AssistantController Controller { get; }
Property Value
Type Description
AssistantController

IsInitialized

Indicates whether the assistant is initialized and ready to process requests.
This property should be overridden by derived classes to provide specific initialization logic.

Declaration
public override bool IsInitialized { get; }
Property Value
Type Description
bool
Overrides

Messages

The list of messages in the chatbot's conversation history.
This property should be set to the messages that the chatbot has processed, including user messages and responses.
It is used to maintain the context of the conversation and provide a history of interactions.

Declaration
public override List<ChatMessage> Messages { get; }
Property Value
Type Description
List<ChatMessage>
Overrides

Model

The model used by the chatbot for processing requests and generating responses.
This property should be set to the model that provides the necessary capabilities for the chatbot.

Declaration
public override Model Model { get; set; }
Property Value
Type Description
Model
Overrides

Name

The name of the chatbot.

Declaration
public override string Name { get; set; }
Property Value
Type Description
string
Overrides

Profile

Declaration
public override ChatbotProfile Profile { get; }
Property Value
Type Description
ChatbotProfile
Overrides

ThreadId

The unique identifier for the currently active assistant thread.
This ID is used to manage the conversation state and retrieve messages from the assistant.

Declaration
public string ThreadId { get; }
Property Value
Type Description
string

UtilityModel

The utility model used for resolving intents and processing requests.
This property should be set to the model that provides the necessary capabilities for the chatbot.

Declaration
public override Model UtilityModel { get; set; }
Property Value
Type Description
Model
Overrides

Methods

CreateConversationAsyncINTERNAL()

Declaration
protected override UniTask<Thread> CreateConversationAsyncINTERNAL()
Returns
Type Description
UniTask<Thread>
Overrides

DeleteConversationAsyncINTERNAL(string)

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

GetSavedThreads()

Declaration
public List<Thread> GetSavedThreads()
Returns
Type Description
List<Thread>

InitializeAsync()

Declaration
public override UniTask InitializeAsync()
Returns
Type Description
UniTask
Overrides

LoadConversationAsyncINTERNAL(string)

Declaration
protected override UniTask<Thread> LoadConversationAsyncINTERNAL(string conversationId)
Parameters
Type Name Description
string conversationId
Returns
Type Description
UniTask<Thread>
Overrides

OnReceiveMessage(ChatMessage)

Declaration
protected override void OnReceiveMessage(ChatMessage response)
Parameters
Type Name Description
ChatMessage response
Overrides

ProcessChatRequestAsyncINTERNAL(ChatMessage)

Declaration
protected override UniTask<ChatMessage> ProcessChatRequestAsyncINTERNAL(ChatMessage inputMessage)
Parameters
Type Name Description
ChatMessage inputMessage
Returns
Type Description
UniTask<ChatMessage>
Overrides