Skip to main content

GenerationOptions

Struct GenerationOptions 

Source
#[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 cache_key: Option<String>, pub on_unsupported: Option<OnUnsupported>, }
Expand description

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)§

This struct is marked as 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.

§cache_key: Option<String>

A key the provider routes prompt-cache lookups by, such as a conversation’s id: requests with the same key reach the server that holds their prefix. A hint: providers that route without one send nothing for it.

§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§

Source§

impl GenerationOptions

Source

pub fn new() -> GenerationOptions

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

Source

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.

Source

pub fn unsupported_policy(&self) -> OnUnsupported

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

Source

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

Set the reasoning level or budget.

Source

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

Set the cache retention.

Source

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

Set the service tier.

Source

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

Set the answer verbosity.

Source

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

Allow or forbid several tool calls in one turn.

Source

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

Set the nucleus sampling probability mass.

Source

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

Set the sampling seed.

Source

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

Replace the stop sequences.

Source

pub fn cache_key(self, key: impl Into<String>) -> GenerationOptions

Set the prompt-cache routing key.

Source

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

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

Source

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.

Source

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§

Source§

impl Clone for GenerationOptions

Source§

fn clone(&self) -> GenerationOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GenerationOptions

Source§

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

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

impl Default for GenerationOptions

Source§

fn default() -> GenerationOptions

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

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

Source§

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

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

impl PartialEq for GenerationOptions

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for GenerationOptions

Source§

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. Read more
Source§

impl StructuralPartialEq for GenerationOptions

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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> IntoToolOutput for T
where T: Serialize + 'static,

Source§

fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>

Convert this value without routing structured data through a string.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

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