Struct GenerationOptions 

#[non_exhaustive]
pub struct GenerationOptions {
    pub reasoning: Option<Reasoning>,
    pub cache: Option<CacheRetention>,
    pub service_tier: Option<ServiceTier>,
    pub verbosity: Option<Verbosity>,
    pub parallel_tool_calls: Option<bool>,
    pub top_p: Option<f64>,
    pub seed: Option<u64>,
    pub stop: Vec<String>,
    pub on_unsupported: Option<OnUnsupported>,
}

Provider-neutral generation knobs for one request. An unset field leaves the provider’s default. A field the wire or model cannot honour is reported through Self::unsupported_policy, never silently dropped.

This is the reusable value: build it once and hand it to an agent (AgentBuilder::options), overlay a run’s on an agent’s (Self::overlay), or store it serialized with a request. For a single request, CompletionRequest, AgentBuilder and AgentRunner also have a shortcut per field (.seed(7)) that writes that one field into their options.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

reasoning: Option<Reasoning>

How much the model reasons before answering.

cache: Option<CacheRetention>

How long the provider keeps the prompt prefix cached.

service_tier: Option<ServiceTier>

The processing tier the request asks for.

verbosity: Option<Verbosity>

How long the answer should be.

parallel_tool_calls: Option<bool>

Whether the model may call several tools in one turn.

top_p: Option<f64>

Nucleus sampling probability mass.

seed: Option<u64>

Sampling seed, for providers that offer best-effort determinism.

stop: Vec<String>

Sequences that end generation. Empty means none.

on_unsupported: Option<OnUnsupported>

What happens to an option the wire or model cannot honour. None leaves the policy unset, which acts as OnUnsupported::Error (Self::unsupported_policy); a set policy counts as setting an option.

Implementations

impl GenerationOptions

pub fn new() -> Self

No option set and no policy set; the same as Self::default.

pub fn is_default(&self) -> bool

Whether every field holds its default: no option set, and no policy set. A request whose options are default is not checked against its model’s catalog rules; setting any field, the policy included, turns the checks on.

pub fn unsupported_policy(&self) -> OnUnsupported

The policy in effect: the one set, or OnUnsupported::Error.

pub fn reasoning(self, reasoning: impl Into<Reasoning>) -> Self

Set the reasoning level or budget.

pub fn cache(self, cache: CacheRetention) -> Self

Set the cache retention.

pub fn service_tier(self, tier: ServiceTier) -> Self

Set the service tier.

pub fn verbosity(self, verbosity: Verbosity) -> Self

Set the answer verbosity.

pub fn parallel_tool_calls(self, parallel: bool) -> Self

Allow or forbid several tool calls in one turn.

pub fn top_p(self, top_p: f64) -> Self

Set the nucleus sampling probability mass.

pub fn seed(self, seed: u64) -> Self

Set the sampling seed.

pub fn stop<S: Into<String>>(self, stop: impl IntoIterator<Item = S>) -> Self

Replace the stop sequences.

pub fn on_unsupported(self, policy: OnUnsupported) -> Self

Set what happens to an option the wire or model cannot honour.

pub fn fields(&self) -> OptionFields<'_>

Every option but the policy, borrowed, as a wire maps it. Destructures self with no .., so a new field fails to compile here first.

pub fn overlay(self, over: &GenerationOptions) -> GenerationOptions

self with every field over sets put on top: a Some option, a non-empty stop list, a set on_unsupported (so a run can restore Error over an agent’s Ignore). Every other field keeps self’s value. An agent’s options overlaid with a run’s give the run’s where it sets one.

Trait Implementations

impl Clone for GenerationOptions

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 GenerationOptions

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

Formats the value using the given formatter.

impl Default for GenerationOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GenerationOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GenerationOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for GenerationOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GenerationOptions