IntelligenceX

API Reference

Class

IntelligenceXClientOptions

Namespace IntelligenceX.OpenAI
Assembly IntelligenceX
Modifiers sealed

Configuration for creating an IntelligenceXClient.

Inheritance

  • Object
  • IntelligenceXClientOptions

Usage

Explore 3 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.

Accepted by parameters 3

Examples

var options = new IntelligenceXClientOptions {
    TransportKind = OpenAITransportKind.Native,
    DefaultModel = OpenAIModelCatalog.DefaultModel
};

Constructors

public IntelligenceXClientOptions() #

Methods

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 optionalposition: 0
Optional config path.
baseDirectory System.String? = null optionalposition: 1
Optional base directory for resolving the default config path.

Returns

true when a config file was loaded.

public Void Validate() #
Returns: Void

Validates the configuration and throws on invalid values.

Properties

public AppServerOptions AppServerOptions { get; } #

Options for the app-server transport.

public OpenAINativeOptions NativeOptions { get; } #

Options for the native ChatGPT transport.

public OpenAICompatibleHttpOptions CompatibleHttpOptions { get; } #

Options for OpenAI-compatible HTTP transports (for example local providers such as Ollama/LM Studio).

public CopilotNativeOptions CopilotOptions { get; set; } #

Options for native Copilot authentication and inference.

public OpenAITransportKind TransportKind { get; set; } #

Selected transport for API calls.

public ClientInfo ClientInfo { get; set; } #

Client identity metadata sent to providers.

public Boolean AutoInitialize { get; set; } #

Whether to auto-initialize the transport.

public String DefaultModel { get; set; } #

Default model name used for requests when none is provided.

public String? DefaultWorkingDirectory { get; set; } #

Default working directory for file operations.

public String? DefaultApprovalPolicy { get; set; } #

Default approval policy used by the app-server.

public SandboxPolicy? DefaultSandboxPolicy { get; set; } #

Default sandbox policy used by 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. When omitted, telemetry persistence is skipped.