Class AssistantSettings
- Namespace
- Glitch9.AIDevKit.OpenAI.Assistants
Represents configuration options for creating and interacting with an OpenAI Assistant tool.
public class AssistantSettings- Inheritance
-
objectAssistantSettings
Properties
AssistantId
Required. Unique identifier for the Assistant used for AssistantsAPI. This is used to locally identify the AssistantsAPI instance and is not related to the OpenAI API.
public string AssistantId { get; set; }Property Value
- string
AutoCancelOnRequiredAction
public bool AutoCancelOnRequiredAction { get; set; }Property Value
- bool
DebugMode
Optional. If true, the AssistantController will log debug information. This is useful for debugging and development purposes. It is recommended to disable this in production builds to avoid performance overhead.
public bool DebugMode { get; set; }Property Value
- bool
ErrorEvent
public IServerSentErrorEventHandler ErrorEvent { get; set; }Property Value
ForcedTool
Optional. Forces the assistants to use the specified tool on every request.
public ToolChoice ForcedTool { get; set; }Property Value
FunctionManager
public IFunctionManager FunctionManager { get; set; }Property Value
MaxRequestLength
Optional. The maximum number of characters the assistant's responses can contain. Use -1 for no limit.
public int MaxRequestLength { get; set; }Property Value
- int
OnAssistantCreated
public UnityEvent<Assistant> OnAssistantCreated { get; set; }Property Value
- UnityEvent<Assistant>
OnAssistantRetrieved
public UnityEvent<Assistant> OnAssistantRetrieved { get; set; }Property Value
- UnityEvent<Assistant>
OnAssistantStatusChanged
public UnityEvent<AssistantStatus> OnAssistantStatusChanged { get; set; }Property Value
- UnityEvent<AssistantStatus>
OnAssistantUpdated
public UnityEvent<Assistant> OnAssistantUpdated { get; set; }Property Value
- UnityEvent<Assistant>
OnMessageCompleted
public UnityEvent<ThreadMessage> OnMessageCompleted { get; set; }Property Value
- UnityEvent<ThreadMessage>
OnMessageCreated
public UnityEvent<ThreadMessage> OnMessageCreated { get; set; }Property Value
- UnityEvent<ThreadMessage>
OnMessageDelta
public UnityEvent<ThreadMessageDelta> OnMessageDelta { get; set; }Property Value
- UnityEvent<ThreadMessageDelta>
OnReceiveToolCalls
public UnityEvent<ToolCall[]> OnReceiveToolCalls { get; set; }Property Value
- UnityEvent<ToolCall[]>
OnRequiredAction
public UnityEvent<FunctionCall> OnRequiredAction { get; set; }Property Value
- UnityEvent<FunctionCall>
OnRequiredActionTimeout
public UnityEvent OnRequiredActionTimeout { get; set; }Property Value
- UnityEvent
OnRunStatusChanged
public UnityEvent<RunStatus> OnRunStatusChanged { get; set; }Property Value
- UnityEvent<RunStatus>
OnThreadCreated
public UnityEvent<Thread> OnThreadCreated { get; set; }Property Value
- UnityEvent<Thread>
OnThreadDeleted
public UnityEvent<bool> OnThreadDeleted { get; set; }Property Value
- UnityEvent<bool>
OnThreadRetrieved
public UnityEvent<Thread> OnThreadRetrieved { get; set; }Property Value
- UnityEvent<Thread>
RequiredActionTimeoutSeconds
public int RequiredActionTimeoutSeconds { get; set; }Property Value
- int
RunPollingDelay
Optional. Tthe initial delay in seconds before checking the run status for the first time.
public int RunPollingDelay { get; set; }Property Value
- int
RunPollingInterval
Optional. The recurring interval in seconds for checking the run status.
public int RunPollingInterval { get; set; }Property Value
- int
RunPollingTimeout
Optional. The timeout in seconds for the run operation.
public int RunPollingTimeout { get; set; }Property Value
- int
SaveMessagesToPrefs
Optional. If true, AssistantController will save the thread messages to PlayerPrefs.
public bool SaveMessagesToPrefs { get; set; }Property Value
- bool
Stream
Whether the assistant should stream responses. Defaults to false.
public bool Stream { get; set; }Property Value
- bool
ThreadId
public string ThreadId { get; set; }Property Value
- string
UsageEvent
public IUsageEventHandler UsageEvent { get; set; }Property Value
Methods
Validate()
public void Validate()