Struct StreamOptions 

pub struct StreamOptions {
    pub temperature: Option<f64>,
    pub max_tokens: Option<usize>,
    pub api_key: Option<String>,
    pub cache_retention: Option<CacheRetention>,
    pub session_id: Option<String>,
    pub headers: HashMap<String, String>,
    pub thinking_level: Option<ThinkingLevel>,
    pub thinking_budgets: Option<ThinkingBudgets>,
    pub tool_choice: Option<ToolChoice>,
    pub provider_options: Option<ProviderOptions>,
}

Stable since 0.63.0

Options for streaming requests

Fields

temperature: Option<f64>

Sampling temperature (0.0 to 2.0)

max_tokens: Option<usize>

Maximum tokens to generate

api_key: Option<String>

API key (overrides environment variable) This field is excluded from serialization and Debug output to prevent leakage.

cache_retention: Option<CacheRetention>

Cache retention preference

session_id: Option<String>

Session ID for providers that support session-based caching

headers: HashMap<String, String>

Custom HTTP headers to include

thinking_level: Option<ThinkingLevel>

Thinking/reasoning level

thinking_budgets: Option<ThinkingBudgets>

Custom token budgets for thinking levels

tool_choice: Option<ToolChoice>

Forces the next assistant turn’s tool choice. None/Auto = no change from today’s behavior. See crate::tools::ToolChoice.

provider_options: Option<ProviderOptions>

Per-provider options for fine-grained control.

Each provider reads only its own section. For example, the Anthropic provider reads provider_options.anthropic, OpenAI reads provider_options.openai. This allows a single request to carry options for multiple providers without conflicts.

Implementations

impl StreamOptions

pub fn new() -> StreamOptions

Create new stream options

pub fn temperature(self, temp: f64) -> StreamOptions

Set temperature

pub fn max_tokens(self, tokens: usize) -> StreamOptions

Set max tokens

pub fn api_key(self, key: impl Into<String>) -> StreamOptions

Set API key

pub fn cache_retention(self, retention: CacheRetention) -> StreamOptions

Set cache retention

pub fn session_id(self, id: impl Into<String>) -> StreamOptions

Set session ID

pub fn thinking_level(self, level: ThinkingLevel) -> StreamOptions

Set thinking level

Trait Implementations

impl Clone for StreamOptions

fn clone(&self) -> StreamOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamOptions

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

Formats the value using the given formatter.

impl Default for StreamOptions

fn default() -> StreamOptions

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StreamOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.