API Reference
EasySessionOptions
Options for creating EasySession instances.
Inheritance
- Object
- EasySessionOptions
Usage
Explore 6 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
Accepted by parameters 5
- Method OpenAIConfig.ApplyTo
- Method Easy.ChatAsync
- Method Easy.ChatWithImagePathAsync
- Method Easy.ChatWithImageUrlAsync
- Method EasySession.StartAsync
Constructors
public EasySessionOptions() #Methods
public static EasySessionOptions FromConfig(String? path = null, String? baseDirectory = null) #EasySessionOptionsCreates 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) #BooleanAttempts 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.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public AppServerOptions AppServerOptions { get; } #App-server transport options.
public OpenAINativeOptions NativeOptions { get; } #Native transport options.
public OpenAICompatibleHttpOptions CompatibleHttpOptions { get; } #OpenAI-compatible HTTP transport options (for example local providers such as Ollama/LM Studio).
public CopilotNativeOptions CopilotOptions { get; set; } #Native Copilot authentication and HTTP transport options.
public Action<GitHubDeviceAuthorization>? OnCopilotLoginCode { get; set; } #Displays the GitHub verification URL and user code when native Copilot needs interactive sign-in.
public OpenAITransportKind TransportKind { get; set; } #Selected transport kind.
public ClientInfo ClientInfo { get; set; } #Client identity for native calls.
public String? ApiKey { get; set; } #API key to use when EasySessionOptions.Login is EasyLoginMode.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 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? WorkingDirectory { get; set; } #Default working directory for file operations.
public Boolean AllowNetwork { get; set; } #Whether network access is allowed.
public String? ApprovalPolicy { get; set; } #Approval policy string passed to the app-server.
public Boolean EnableUsageTelemetry { get; set; } #Enables persistent usage telemetry for IntelligenceX-owned turns.
public String? UsageTelemetryDatabasePath { get; set; } #Optional SQLite database path used for usage telemetry persistence.
public String? UsageTelemetryMachineId { get; set; } #Optional machine identifier stored with usage telemetry events.
public String? UsageTelemetryAccountLabel { get; set; } #Optional account label stored with usage telemetry events.
public String? UsageTelemetryProviderAccountId { get; set; } #Optional provider account identifier stored with usage telemetry events.
public String? UsageTelemetrySourcePath { get; set; } #Optional logical source path used for the usage telemetry root.
public IIntelligenceXUsageTelemetrySessionFactory? UsageTelemetrySessionFactory { get; set; } #Optional factory used to attach persistent usage telemetry storage.