Struct GenerateTextOptions 

pub struct GenerateTextOptions {

    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: Option<ToolChoice>,
    pub headers: Option<HashMap<String, String>>,
    pub provider_options: Option<HashMap<String, Value>>,
    pub reasoning: Option<ReasoningEffort>,
    pub instructions: Option<String>,
    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 include_raw_chunks: Option<bool>,
    pub repair_tool_call: Option<ToolCallRepair>,
}

User-facing options for generate_text and stream_text.

Unlike CallOptions (provider-facing), this does not include prompt (passed separately) and defaults are more ergonomic.

Fields

max_output_tokens: Option<u32>

temperature: Option<f64>

stop_sequences: Option<Vec<String>>

top_p: Option<f64>

top_k: Option<f64>

presence_penalty: Option<f64>

frequency_penalty: Option<f64>

response_format: Option<ResponseFormat>

seed: Option<u64>

tools: Option<Vec<Tool>>

tool_choice: Option<ToolChoice>

headers: Option<HashMap<String, String>>

provider_options: Option<HashMap<String, Value>>

reasoning: Option<ReasoningEffort>

Top-level reasoning effort.

instructions: Option<String>

System instructions prepended to the prompt.

body_overrides: Option<Value>

Per-call request body overrides (deep-merged). See RFC-0017.

max_retries: Option<u32>

Per-call retry count override. None = provider default, Some(0) = disable.

timeout: Option<TimeoutConfiguration>

Per-call timeout configuration (total / first-chunk / chunk idle).

session_id: Option<String>

Session identifier, for grouping consecutive calls into a session (observability, see RFC-0024). Orthogonal to RFC-0019 session-affinity headers. When None and the optional session inferer is enabled, one may be inferred from prompt-prefix continuation.

abort_signal: Option<AbortSignal>

Abort signal for cancelling the call.

Runtime handle — never crosses the JSON boundary. Rust callers set it directly; the Node binding bridges a JS AbortSignal natively.

include_raw_chunks: Option<bool>

Emit raw provider stream chunks as StreamPart::Raw (debugging aid).

repair_tool_call: Option<ToolCallRepair>

Optional one-shot repair callback for unknown, malformed, or schema-invalid tool calls.

Implementations

impl GenerateTextOptions

pub fn into_call_options(self, prompt: LanguageModelPrompt) -> CallOptions

Build the provider-facing CallOptions from user-facing options.

Trait Implementations

impl Clone for GenerateTextOptions

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 GenerateTextOptions

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

Formats the value using the given formatter.

impl Default for GenerateTextOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GenerateTextOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GenerateTextOptions

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 GenerateTextOptions

type WithoutGenerics = GenerateTextOptions

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 = GenerateTextOptions

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.