Skip to main content

GenerationOptions

Struct GenerationOptions 

Source
pub struct GenerationOptions { /* private fields */ }
Expand description

Generation knobs. All fields are optional; unset fields keep the model’s defaults.

Implementations§

Source§

impl GenerationOptions

Source

pub const fn new() -> Self

Create options with all fields set to their defaults.

Source

pub const fn with_temperature(self, temperature: f64) -> Self

Sampling temperature; higher values produce more varied output. FoundationModels accepts values in 0.0..=2.0.

Source

pub const fn with_maximum_response_tokens(self, tokens: u32) -> Self

Hard cap on the number of tokens the model may emit.

Source

pub const fn with_sampling(self, mode: SamplingMode) -> Self

Override the sampling strategy.

Source

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

Use a deterministic random seed for non-greedy sampling.

Source

pub const fn temperature(self) -> Option<f64>

Sampling temperature, if explicitly set.

Source

pub const fn maximum_response_tokens(self) -> Option<u32>

The explicit token cap, if any.

Source

pub const fn sampling(self) -> SamplingMode

The configured sampling strategy.

Source

pub const fn sampling_seed(self) -> Option<u64>

The deterministic random seed for top-k / top-p sampling.

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

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 PartialEq for GenerationOptions

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for GenerationOptions

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.