Skip to main content

SamplingParams

Struct SamplingParams 

Source
pub struct SamplingParams {
    pub temperature: Option<f32>,
    pub max_tokens: Option<u32>,
    pub stop: Vec<String>,
}
Expand description

Sampling knobs forwarded to an OpenAI-compatible provider.

Why (issue #3758): the streaming request wire previously sent only model/messages/tools, so a streamed reply’s style, verbosity, and stopping behaviour were NOT equivalent to the blocking path’s for the same turn — the caller silently got provider defaults instead of its configured temperature, token ceiling, and stop sequences. Carrying them in one struct (rather than three provider constructor arguments) keeps new() stable for existing callers and lets the set grow without churning call sites. What: every field is optional — None/empty means “omit from the request body and let the provider default apply”, which is exactly the pre-#3758 behaviour, so a caller that does not opt in is unaffected. stop maps to the OpenAI stop array (the direct-Anthropic dialect calls the same thing stop_sequences). Test: sampling_params_serialize_into_request_body, default_sampling_omits_fields.

Fields§

§temperature: Option<f32>

Sampling temperature; None omits the field.

§max_tokens: Option<u32>

Maximum tokens to generate; None omits the field.

§stop: Vec<String>

Stop sequences; empty omits the field.

Implementations§

Source§

impl SamplingParams

Source

pub fn stop_slice(&self) -> Option<&[String]>

The stop sequences as a request-body-ready Option<&[String]>.

Why: an EMPTY stop array is not the same as an absent one — some OpenAI-compatible servers reject "stop": [] outright, which is the same trap ChatProvider already documents for an empty tools array. Collapsing empty to None at the boundary keeps that decision in one place instead of at each provider. What: None when empty, Some(slice) otherwise. Test: default_sampling_omits_fields.

Trait Implementations§

Source§

impl Clone for SamplingParams

Source§

fn clone(&self) -> SamplingParams

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 SamplingParams

Source§

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

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

impl Default for SamplingParams

Source§

fn default() -> SamplingParams

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

impl PartialEq for SamplingParams

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SamplingParams

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
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