IntelligenceX

API Reference

Class

ChatOptions

Namespace IntelligenceX.OpenAI.Chat
Assembly IntelligenceX
Modifiers sealed

Options for chat requests.

Inheritance

  • Object
  • ChatOptions

Usage

Explore 8 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 7

Constructors

ChatOptions 2 overloads
public ChatOptions(ChatOptions other) #

Initializes a new instance of ChatOptions by copying values from other.

Parameters

other IntelligenceX.OpenAI.Chat.ChatOptions requiredposition: 0
Options to copy.
public ChatOptions() #

Initializes a new ChatOptions instance.

Methods

public ChatOptions Clone() #
Returns: ChatOptions

Creates a copy of this instance.

Properties

public String? Model { get; set; } #

Model name override.

public String? Instructions { get; set; } #

System instructions.

public ReasoningEffort? ReasoningEffort { get; set; } #

Reasoning effort hint.

public ReasoningSummary? ReasoningSummary { get; set; } #

Reasoning summary hint.

public TextVerbosity? TextVerbosity { get; set; } #

Text verbosity hint.

public ImageGenerationOptions? ImageGeneration { get; set; } #

Image generation built-in tool options.

public Double? Temperature { get; set; } #

Sampling temperature.

public String? WorkingDirectory { get; set; } #

Working directory for file operations.

public String? Workspace { get; set; } #

Workspace path for tool access.

public IReadOnlyList<ToolDefinition>? Tools { get; set; } #

Tool definitions available to the model.

public ToolChoice? ToolChoice { get; set; } #

Tool choice override.

public Boolean? ParallelToolCalls { get; set; } #

Whether tool calls can run in parallel when supported.

public String? PreviousResponseId { get; set; } #

Previous response id for continuing a response chain.

public Boolean AllowNetwork { get; set; } #

Whether network access is allowed.

public String? ApprovalPolicy { get; set; } #

Approval policy string passed to the app-server.

public SandboxPolicy? SandboxPolicy { get; set; } #

Sandbox policy for the request.

public Boolean NewThread { get; set; } #

Whether to force a new thread.

public String? TelemetryFeature { get; set; } #

Optional feature label used for internal IntelligenceX telemetry.

public String? TelemetrySurface { get; set; } #

Optional surface label used for internal IntelligenceX telemetry.

public Int64? MaxImageBytes { get; set; } #

Maximum allowed image size in bytes.

public ChatResponseFormat? ResponseFormat { get; set; } #

Optional provider-enforced JSON schema; unsupported transports reject this instead of silently ignoring it.

public Int64? MaxResponseBytes { get; set; } #

Optional maximum response wire bytes, including streaming protocol overhead. Supported by Native and CompatibleHttp.

public Boolean Ephemeral { get; set; } #

Starts an isolated request and forgets its local thread state after completion, failure or cancellation. Native and CompatibleHttp only.

public Boolean RequireWorkspaceForFileAccess { get; set; } #

Whether a workspace is required for file access.