Skip to main content

ModelSelection

Struct ModelSelection 

Source
pub struct ModelSelection<'a> {
    pub prompt: &'a Message,
    pub history: &'a [Message],
    pub request_patch: Option<&'a RequestPatch>,
    pub previous_model: Option<&'a ModelHandle>,
    pub default_model: &'a ModelHandle,
    pub selected_model: &'a ModelHandle,
}
Expand description

Model-selection event resolved after completion-call hooks and before request preparation.

The runner default is the first candidate. A HookStack threads every ModelSelectionAction::Select into later hooks in registration order, so selected_model always reflects all earlier decisions for this event.

Ordering per CallModel step: completion-call hooks resolve first; only if they proceed does this event fire, carrying the merged RequestPatch in request_patch; only after selection resolves does request preparation run against the selected model’s captured ProviderCapabilities, and only then is the attempt issued. Selection therefore runs once per CallModel step whose completion-call hooks proceed — including model-turn retries and post-tool calls — and never after a completion-call stop.

Selection is synchronous, local, and non-blocking: a hook may read and write the run Scratchpad, but must not perform blocking I/O. In-flight attempts never rebind — the selected handle is cloned into the prepared attempt and executes it to completion.

previous_model reflects issued attempts only: it advances immediately before the selected model’s unary or streaming operation is invoked, so a provider attempt that returns an error still counts, while a completion-call stop, a selection stop, or a request-preparation failure does not. An extraction or run default set via using_model(...) is the default candidate for every retry, not a hard pin: selection hooks may override it on each retry.

Fields§

§prompt: &'a Message

Prompt for the pending model call.

§history: &'a [Message]

Canonical history visible to the pending model call.

§request_patch: Option<&'a RequestPatch>

Merged per-turn request patch from this step’s completion-call hooks (in hook registration order), when any hook patched the request.

§previous_model: Option<&'a ModelHandle>

Model that executed the preceding issued attempt in this run, if any.

§default_model: &'a ModelHandle

Runner default used as the initial candidate for this call.

§selected_model: &'a ModelHandle

Candidate after all earlier model-selection hooks.

Implementations§

Source§

impl<'a> ModelSelection<'a>

Source

pub fn new( prompt: &'a Message, history: &'a [Message], request_patch: Option<&'a RequestPatch>, previous_model: Option<&'a ModelHandle>, default_model: &'a ModelHandle, selected_model: &'a ModelHandle, ) -> Self

Construct a ModelSelection event from its parts.

Provided so that custom model-selection routers can be unit-tested outside this crate without restating every field.

Trait Implementations§

Source§

impl<'a> Clone for ModelSelection<'a>

Source§

fn clone(&self) -> ModelSelection<'a>

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<'a> Copy for ModelSelection<'a>

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for ModelSelection<'a>

§

impl<'a> !UnwindSafe for ModelSelection<'a>

§

impl<'a> Freeze for ModelSelection<'a>

§

impl<'a> Send for ModelSelection<'a>

§

impl<'a> Sync for ModelSelection<'a>

§

impl<'a> Unpin for ModelSelection<'a>

§

impl<'a> UnsafeUnpin for ModelSelection<'a>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> CloneableStorage for T
where T: Any + Send + Sync + Clone,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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