Struct CapiSessionOptions 

pub struct CapiSessionOptions {
    pub auto_tier: Option<AutoTier>,
    pub enable_web_socket_responses: Option<bool>,
}

Options scoped to the built-in CAPI (Copilot API) provider.

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

Fields

auto_tier: Option<AutoTier>

Routing preference for sessions whose model is auto. On create or cold resume, this establishes the preference sent as tier on CAPI /auto requests; when omitted on cold resume, the runtime restores the last committed preference. On resident resume, a different value requests a safe switch after resume succeeds and cannot change an in-flight turn. Successful switches are persisted for later cold resume. When no preference is supplied or restored, CAPI default routing is used.

enable_web_socket_responses: Option<bool>

Whether to use WebSocket transport for the CAPI Responses API. Enabled by default when the model advertises ws:/responses support; set to false to force the HTTP Responses transport in environments where WebSockets are blocked (e.g. behind a proxy). Setting this to false is equivalent to the COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES environment variable.

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