Struct CapiSessionOptions 

#[non_exhaustive]
pub struct CapiSessionOptions {
    pub auto_tier: Option<AutoTier>,
    pub enable_web_socket_responses: Option<bool>,
}

Provider-scoped Copilot API (CAPI) session options.

WebSocket transport is the default for the CAPI Responses API whenever the model advertises the ws:/responses endpoint. Set enable_web_socket_responses to false to force the HTTP Responses transport instead, which is useful for users behind proxies where WebSockets fail.

Setting it to false is equivalent to setting the COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES environment variable. The option is scoped under the capi namespace because a single session can host multiple providers, so transport choice is provider-level.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

auto_tier: Option<AutoTier>

Routing tier, meaningful only with model auto (Auto mode V2). Requires a runtime version that supports capi.autoTier.

When omitted, the runtime chooses its default on create and preserves the persisted or current tier on resume. An explicit tier overrides the persisted tier on cold resume; the runtime rejects a conflicting tier when resuming a session already resident in memory.

enable_web_socket_responses: Option<bool>

Whether to use WebSocket transport for CAPI Responses API calls.

When Some(false), the runtime uses HTTP Responses transport even if the selected model advertises ws:/responses. When unset, the runtime default applies (WebSocket transport when advertised).

Implementations

impl CapiSessionOptions

pub fn new() -> Self

Construct CAPI session options with all fields unset.

pub fn with_auto_tier(self, auto_tier: AutoTier) -> Self

Set the routing tier for the auto model (Auto mode V2).

pub fn with_enable_web_socket_responses(self, enable: bool) -> Self

Set whether to use WebSocket transport for CAPI Responses API calls.

Trait Implementations

impl Clone for CapiSessionOptions

fn clone(&self) -> CapiSessionOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CapiSessionOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CapiSessionOptions

fn default() -> CapiSessionOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CapiSessionOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CapiSessionOptions

fn eq(&self, other: &CapiSessionOptions) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for CapiSessionOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CapiSessionOptions