IntelligenceX
Class

EasySessionOptions

Namespace IntelligenceX.OpenAI
Assembly IntelligenceX
Modifiers sealed

Options for creating EasySession instances.

Inheritance

  • Object
  • EasySessionOptions

Constructors

Methods

public static EasySessionOptions FromConfig(String path = null, String baseDirectory = null) #
Returns: EasySessionOptions

Creates new options and applies configuration from disk when available.

Parameters

path System.String = null
Optional config path.
baseDirectory System.String = null
Optional base directory for resolving the default config path.
public Boolean TryApplyConfig(String path = null, String baseDirectory = null) #
Returns: Boolean

Attempts to apply configuration from disk to these options.

Parameters

path System.String = null
Optional config path.
baseDirectory System.String = null
Optional base directory for resolving the default config path.

Returns

true when a config file was loaded.

public Void Validate() #
Returns: Void

Validates the options and throws on invalid configuration.

Properties

public AppServerOptions AppServerOptions { get; } #

App-server transport options.

public OpenAINativeOptions NativeOptions { get; } #

Native transport options.

public OpenAITransportKind TransportKind { get; set; } #

Selected transport kind.

public ClientInfo ClientInfo { get; set; } #

Client identity for native calls.

public EasyLoginMode Login { get; set; } #

Login mode selection.

public String ApiKey { get; set; } #

API key to use when Login is ApiKey.

public Action<String> OnLoginUrl { get; set; } #

Callback invoked with the login URL.

public Func<String, Task<String>> OnPrompt { get; set; } #

Callback used for prompting the user.

public Boolean UseLocalListener { get; set; } #

Whether to use a local listener during login.

public Boolean OpenBrowser { get; set; } #

Whether to open a browser during login.

public Boolean PrintLoginUrl { get; set; } #

Whether to print the login URL.

public Boolean AutoInitialize { get; set; } #

Whether to initialize the transport automatically.

public Boolean AutoLogin { get; set; } #

Whether to login automatically on initialization.

public Boolean ValidateLoginOnEachRequest { get; set; } #

Whether to validate login before each request.

public Boolean RequireWorkspaceForFileAccess { get; set; } #

Whether to require a workspace for file access.

public Int64 MaxImageBytes { get; set; } #

Maximum allowed image size in bytes.

public String DefaultModel { get; set; } #

Default model name.

public String WorkingDirectory { get; set; } #

Default working directory for file operations.

public String Workspace { get; set; } #

Workspace path for tool access.

public Boolean AllowNetwork { get; set; } #

Whether network access is allowed.

public String ApprovalPolicy { get; set; } #

Approval policy string passed to the app-server.