AI Dev Kit
Search Results for

    Show / Hide Table of Contents

    Class AssistantSettings

    Represents configuration options for creating and interacting with an OpenAI Assistant tool.

    Inheritance
    object
    AssistantSettings
    Namespace: Glitch9.AIDevKit.OpenAI.Assistants
    Assembly: .dll
    Syntax
    public class AssistantSettings

    Properties

    AssistantEventReceiver

    Declaration
    public IAssistantEventReceiver AssistantEventReceiver { get; set; }
    Property Value
    Type Description
    IAssistantEventReceiver

    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.

    Declaration
    public string AssistantId { get; set; }
    Property Value
    Type Description
    string

    AutoCancelOnRequiredAction

    Declaration
    public bool AutoCancelOnRequiredAction { get; set; }
    Property Value
    Type Description
    bool

    ForcedTool

    Optional. Forces the AssistantsAPI to use the specified tool on every request.

    Declaration
    public ToolChoice ForcedTool { get; set; }
    Property Value
    Type Description
    ToolChoice

    FunctionManager

    Declaration
    public IFunctionManager FunctionManager { get; set; }
    Property Value
    Type Description
    IFunctionManager

    MaxRequestLength

    Optional. Gets or sets the maximum number of characters the assistant's responses can contain. Use -1 for no limit.

    Declaration
    public int MaxRequestLength { get; set; }
    Property Value
    Type Description
    int

    MessageEventReceiver

    Declaration
    public IThreadMessageEventReceiver MessageEventReceiver { get; set; }
    Property Value
    Type Description
    IThreadMessageEventReceiver

    RequiredActionListener

    Declaration
    public IRequiredActionListener RequiredActionListener { get; set; }
    Property Value
    Type Description
    IRequiredActionListener

    RequiredActionTimeoutSeconds

    Declaration
    public int RequiredActionTimeoutSeconds { get; set; }
    Property Value
    Type Description
    int

    RunEventReceiver

    Declaration
    public IRunEventReceiver RunEventReceiver { get; set; }
    Property Value
    Type Description
    IRunEventReceiver

    RunPollingDelay

    Optional. Gets or sets the initial delay in seconds before checking the run status for the first time.

    Declaration
    public int RunPollingDelay { get; set; }
    Property Value
    Type Description
    int

    RunPollingInterval

    Optional. Gets or sets the recurring interval in seconds for checking the run status.

    Declaration
    public int RunPollingInterval { get; set; }
    Property Value
    Type Description
    int

    RunPollingTimeout

    Optional. Gets or sets the timeout in seconds for the run operation.

    Declaration
    public int RunPollingTimeout { get; set; }
    Property Value
    Type Description
    int

    SaveMessages

    Optional. If true, AssistantController will save the thread messages to PlayerPrefs.

    Declaration
    public bool SaveMessages { get; set; }
    Property Value
    Type Description
    bool

    Stream

    Optional. Gets or sets a value indicating whether the assistant should stream responses. [ASSISTANTS API STREAM IS NOT SUPPORTED YET] Defaults to false.

    Declaration
    public bool Stream { get; set; }
    Property Value
    Type Description
    bool

    TextEventReceiver

    Declaration
    public IStreamingTextEventReceiver TextEventReceiver { get; set; }
    Property Value
    Type Description
    IStreamingTextEventReceiver

    ThreadEventReceiver

    Declaration
    public IThreadEventReceiver ThreadEventReceiver { get; set; }
    Property Value
    Type Description
    IThreadEventReceiver

    ToolCallReceiver

    Declaration
    public IToolCallReceiver ToolCallReceiver { get; set; }
    Property Value
    Type Description
    IToolCallReceiver

    ToolResources

    Optional. Give the tools like code_interpreter and file_search access to files. Files are uploaded using the File upload endpoint and must have the purpose set to assistants to be used with this API.

    Declaration
    public ToolResources ToolResources { get; set; }
    Property Value
    Type Description
    ToolResources
    In this article
    Back to top Generated by DocFX