Skip to main content

LLMRequest

Struct LLMRequest 

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

Builder-style request passed into LanguageModel::respond.

Wraps the full conversation, model parameters, and tool definitions a provider needs in order to execute a call.

Implementations§

Source§

impl LLMRequest

Source

pub fn new(messages: impl Into<Vec<Message>>) -> Self

Creates a request from the provided messages using default parameters.

Source

pub fn with_tool_definitions(self, definitions: Vec<ToolDefinition>) -> Self

Adds tool definitions to the request.

These define what tools the model can request. The model will emit Event::ToolCall events when it wants to use a tool.

Source

pub fn with_tool<T: Tool>(self, tool: &T) -> Self

Adds a single tool definition.

Source

pub fn with_parameters(self, parameters: Parameters) -> Self

Overrides the sampling parameters used for this call.

Source

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

Returns the current conversation messages.

Source

pub const fn messages_mut(&mut self) -> &mut Vec<Message>

Returns a mutable reference to messages for modification.

Source

pub const fn parameters(&self) -> &Parameters

Returns the current parameter snapshot.

Source

pub fn tool_definitions(&self) -> &[ToolDefinition]

Returns the tool definitions.

Source

pub fn into_parts(self) -> (Vec<Message>, Parameters, Vec<ToolDefinition>)

Breaks the request into owned components.

Source§

impl LLMRequest

Source

pub fn with_tools(self, tools: &mut Tools) -> LLMRequestWithTools<'_>

Attaches a mutable tool registry to the request.

This is for providers that execute tools internally (e.g., built-in tools). For agent-controlled tool execution, use with_tool_definitions instead.

Trait Implementations§

Source§

impl Clone for LLMRequest

Source§

fn clone(&self) -> LLMRequest

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 LLMRequest

Source§

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

Formats the value using the given formatter. Read more

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> 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, 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 = !

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.