Struct CallOptions 

pub struct CallOptions {

    pub prompt: LanguageModelPrompt,
    pub max_output_tokens: Option<u32>,
    pub temperature: Option<f64>,
    pub stop_sequences: Option<Vec<String>>,
    pub top_p: Option<f64>,
    pub top_k: Option<f64>,
    pub presence_penalty: Option<f64>,
    pub frequency_penalty: Option<f64>,
    pub response_format: Option<ResponseFormat>,
    pub seed: Option<u64>,
    pub tools: Option<Vec<Tool>>,
    pub tool_choice: ToolChoice,
    pub headers: Option<HashMap<String, String>>,
    pub provider_options: Option<HashMap<String, Value>>,
    pub reasoning: Option<ReasoningEffort>,
    pub body_overrides: Option<Value>,
    pub max_retries: Option<u32>,
    pub timeout: Option<TimeoutConfiguration>,
    pub session_id: Option<String>,
    pub abort_signal: Option<AbortSignal>,
    pub call_id: Option<String>,
    pub recording_context: Option<RecordingContext>,
    pub include_raw_chunks: Option<bool>,
}

Options passed to LanguageModel::do_generate / do_stream.

This is the provider-facing options struct. Users interact with GenerateTextOptions (user-facing) which is converted to CallOptions by the generate_text / stream_text functions.

Fields

prompt: LanguageModelPrompt

The standardized prompt (message array). Required.

max_output_tokens: Option<u32>

Maximum tokens to generate.

temperature: Option<f64>

Sampling temperature.

stop_sequences: Option<Vec<String>>

Stop sequences.

top_p: Option<f64>

Nucleus sampling top_p.

top_k: Option<f64>

Top-k sampling.

presence_penalty: Option<f64>

Presence penalty.

frequency_penalty: Option<f64>

Frequency penalty.

response_format: Option<ResponseFormat>

Response format (text or JSON).

seed: Option<u64>

Seed for reproducibility.

tools: Option<Vec<Tool>>

Tools available to the model (function tools and/or provider-defined tools).

tool_choice: ToolChoice

How the model should choose tools.

headers: Option<HashMap<String, String>>

Extra HTTP headers.

provider_options: Option<HashMap<String, Value>>

Provider-specific options (keyed by provider name).

reasoning: Option<ReasoningEffort>

Top-level reasoning effort. Maps to OpenAI reasoning_effort and Anthropic thinking config.

body_overrides: Option<Value>

Per-call request body overrides. Deep-merged into the provider-built request body (after any built-in vendor override) before sending. null values delete the corresponding key. See RFC-0017.

max_retries: Option<u32>

Per-call retry count override. None uses the provider’s configured Core operation retry. Some(0) disables retries.

timeout: Option<TimeoutConfiguration>

Per-call timeout configuration (total / first-chunk / chunk idle). None = no timeouts (provider defaults still apply at the HTTP layer).

session_id: Option<String>

Session identifier, for grouping consecutive calls into a session (observability, see RFC-0024). Explicit values take precedence; when None and the optional session inferer is enabled, one may be inferred. Orthogonal to RFC-0019 session-affinity headers: this field is for local grouping, while session headers in headers are for upstream routing — both may share an id value but travel different paths.

abort_signal: Option<AbortSignal>

Abort signal for cancelling the call.

Runtime handle — never crosses the JSON boundary (bindings that only pass JSON cannot set it; Node bridges a JS AbortSignal natively).

call_id: Option<String>

RFC-0023 recording correlation id (internal; never serialized).

recording_context: Option<RecordingContext>

RFC-0023 recording context (R7 快照绑定;internal;never serialized)。 层 A 入口构造一次,provider 复制到 HttpRequest。None = 不录制。

include_raw_chunks: Option<bool>

Emit raw provider stream chunks as StreamPart::Raw (debugging aid). When Some(true), streaming providers yield one Raw part per JSON SSE event, carrying the parsed JSON payload of the event, emitted before the parsed parts. Excludes the [DONE] sentinel; unparsable chunks emit only Error. null/Some(false) = off. Currently honored by the OpenAI-compatible family (openai / azure / openai-compatible registry providers); other provider families ignore it for now (RFC-0016 M2).

Implementations

impl CallOptions

pub fn for_step(&self, step: impl Into<String>) -> Self

Clone these options for one composite child step (Router child, MoA reference or aggregator): the recording context, when present, is replaced by a child context labeled step, so the child’s exchanges and retry attempts are recorded as their own step instead of blending into the parent operation’s.

pub fn new(prompt: LanguageModelPrompt) -> Self

Create a CallOptions with the given prompt and all other fields set to their defaults (None / ToolChoice::Auto).

This is the recommended construction baseline in tests — combined with struct-update syntax (CallOptions { tools: Some(..), ..CallOptions::new(prompt) }) it avoids spelling out every None field, so adding a new optional field to CallOptions no longer requires batch-editing every test.

Trait Implementations

impl Clone for CallOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CallOptions

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

Formats the value using the given formatter.

impl Default for CallOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CallOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CallOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for CallOptions

type WithoutGenerics = CallOptions

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = CallOptions

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.