Skip to main content

StreamOptions

Struct StreamOptions 

Source
pub struct StreamOptions {
    pub temperature: Option<f64>,
    pub max_tokens: Option<u64>,
    pub api_key: Option<String>,
    pub headers: HashMap<String, String>,
    pub thinking_budget: Option<u64>,
    pub thinking_enabled: Option<bool>,
    pub thinking_effort: Option<ThinkingEffort>,
    pub thinking_display: Option<ThinkingDisplay>,
    pub session_id: Option<String>,
    pub cache_retention: Option<CacheRetention>,
}

Fields§

§temperature: Option<f64>§max_tokens: Option<u64>§api_key: Option<String>§headers: HashMap<String, String>§thinking_budget: Option<u64>

Extended thinking budget (Anthropic-specific non-adaptive path).

§thinking_enabled: Option<bool>

Explicit on/off for extended thinking.

None means provider default: if thinking_budget is set or (for adaptive-thinking models) an effort is set, thinking is enabled. Some(true) forces thinking on; on adaptive-thinking models this triggers the adaptive path even without a budget. Some(false) forces thinking off regardless of the other fields.

§thinking_effort: Option<ThinkingEffort>

Effort level for adaptive thinking (Anthropic-specific for now).

§thinking_display: Option<ThinkingDisplay>

Controls how thinking content is returned in the response (Anthropic-specific for now). Defaults to Summarized when thinking is enabled on the Anthropic provider.

§session_id: Option<String>

Opaque session identifier for provider-side prompt-cache affinity.

Currently used by the OpenAI provider as prompt_cache_key so consecutive turns of the same conversation hit the same cache shard.

§cache_retention: Option<CacheRetention>

Prompt-cache retention hint. None defers to the provider default (currently Short, with PI_CACHE_RETENTION=long env override honoured by the OpenAI provider).

Trait Implementations§

Source§

impl Clone for StreamOptions

Source§

fn clone(&self) -> StreamOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StreamOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for StreamOptions

Source§

fn default() -> StreamOptions

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for StreamOptions

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for StreamOptions

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,