Class AssistantSettings
Represents configuration options for creating and interacting with an OpenAI Assistant tool.
Inheritance
object
AssistantSettings
Assembly: .dll
Syntax
public class AssistantSettings
Properties
AssistantEventReceiver
Declaration
public IAssistantEventReceiver AssistantEventReceiver { get; set; }
Property Value
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
AutoCancelOnRequiredAction
Declaration
public bool AutoCancelOnRequiredAction { get; set; }
Property Value
Optional. Forces the AssistantsAPI to use the specified tool on every request.
Declaration
public ToolChoice ForcedTool { get; set; }
Property Value
FunctionManager
Declaration
public IFunctionManager FunctionManager { get; set; }
Property Value
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
MessageEventReceiver
Declaration
public IThreadMessageEventReceiver MessageEventReceiver { get; set; }
Property Value
RequiredActionListener
Declaration
public IRequiredActionListener RequiredActionListener { get; set; }
Property Value
RequiredActionTimeoutSeconds
Declaration
public int RequiredActionTimeoutSeconds { get; set; }
Property Value
RunEventReceiver
Declaration
public IRunEventReceiver RunEventReceiver { get; set; }
Property Value
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
RunPollingInterval
Optional. Gets or sets the recurring interval in seconds for checking the run status.
Declaration
public int RunPollingInterval { get; set; }
Property Value
RunPollingTimeout
Optional. Gets or sets the timeout in seconds for the run operation.
Declaration
public int RunPollingTimeout { get; set; }
Property Value
SaveMessages
Declaration
public bool SaveMessages { get; set; }
Property Value
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
TextEventReceiver
Declaration
public IStreamingTextEventReceiver TextEventReceiver { get; set; }
Property Value
ThreadEventReceiver
Declaration
public IThreadEventReceiver ThreadEventReceiver { get; set; }
Property Value
Declaration
public IToolCallReceiver ToolCallReceiver { get; set; }
Property Value
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