Skip to main content

ModelRequest

Struct ModelRequest 

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

Immutable provider-neutral snapshot for one model request.

Implementations§

Source§

impl ModelRequest

Source

pub fn new( model_id: ModelId, messages: Vec<CanonicalMessage>, ) -> Result<Self, ModelRequestError>

Creates a request for a non-empty canonical transcript.

§Errors

Returns an error when messages are empty, too numerous, or invalid at the canonical protocol wire boundary.

Source

pub fn with_system_prompt( self, system_prompt: impl Into<String>, ) -> Result<Self, ModelRequestError>

Adds a bounded non-empty system prompt.

§Errors

Returns an error when the prompt is empty, oversized, or contains a null character.

Source

pub fn with_tools( self, tools: Vec<ModelToolDefinition>, allow_parallel: bool, ) -> Result<Self, ModelRequestError>

Adds model-visible tools in deterministic source order.

§Errors

Returns an error for an oversized list or duplicate tool names.

Source

pub const fn with_reasoning(self, reasoning: ReasoningOptions) -> Self

Adds provider-neutral reasoning options.

Source

pub const fn with_max_output_tokens(self, max_output_tokens: TokenCount) -> Self

Adds a requested output-token limit.

Source

pub fn with_metadata(self, metadata: ProtocolMetadata) -> Self

Adds bounded namespaced request metadata.

Source

pub fn validate_for(&self, model: &ModelSpec) -> Result<(), ModelRequestError>

Validates this request against one advertised model.

§Errors

Returns an error when model identity, capability, or output limits do not satisfy the request.

Source

pub const fn model_id(&self) -> &ModelId

Returns the selected model.

Source

pub fn system_prompt(&self) -> Option<&str>

Returns the optional system prompt.

Source

pub fn messages(&self) -> &[CanonicalMessage]

Returns canonical messages in source order.

Source

pub fn tools(&self) -> &[ModelToolDefinition]

Returns model-visible tools in source order.

Source

pub const fn allow_parallel_tool_calls(&self) -> bool

Returns whether the model may request several tools in one response.

Source

pub const fn reasoning(&self) -> Option<ReasoningOptions>

Returns reasoning options.

Source

pub const fn max_output_tokens(&self) -> Option<TokenCount>

Returns the request-specific output limit.

Source

pub const fn metadata(&self) -> &ProtocolMetadata

Returns bounded request metadata.

Trait Implementations§

Source§

impl Clone for ModelRequest

Source§

fn clone(&self) -> ModelRequest

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 ModelRequest

Source§

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

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

impl PartialEq for ModelRequest

Source§

fn eq(&self, other: &ModelRequest) -> 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 ModelRequest

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.