Skip to main content

ChatRequest

Struct ChatRequest 

Source
pub struct ChatRequest {
    pub messages: Vec<Message>,
    pub tools: Vec<ToolSpec>,
    pub tool_declarations: Vec<ToolDeclaration>,
    pub server_tools: Vec<ServerTool>,
    pub tool_choice: Option<ToolChoice>,
    pub response_format: Option<ResponseFormat>,
    pub stop: Vec<String>,
    pub seed: Option<u64>,
    pub temperature: Option<f32>,
    pub max_output_tokens: Option<u32>,
    pub reasoning: Option<ReasoningConfig>,
    pub extra_body: Map<String, Value>,
}
Expand description

A request sent to a model adapter.

extra_body is an escape hatch for provider-specific wire fields. The SDK merges it into the final JSON object but refuses to let it overwrite canonical fields such as model, messages, input, or stream.

Fields§

§messages: Vec<Message>

The conversation so far.

§tools: Vec<ToolSpec>

Client-side tools the model may call.

§tool_declarations: Vec<ToolDeclaration>

Native client declarations. Currently rejected by all wire adapters; this gate prevents exposing tools before call/result replay is complete.

§server_tools: Vec<ServerTool>

Provider-hosted tools such as web search.

§tool_choice: Option<ToolChoice>

How the model should choose among tools.

§response_format: Option<ResponseFormat>

Requested output format.

§stop: Vec<String>

Sequences that stop generation.

§seed: Option<u64>

Sampling seed for reproducibility.

§temperature: Option<f32>

Sampling temperature.

§max_output_tokens: Option<u32>

Upper bound on generated tokens.

§reasoning: Option<ReasoningConfig>

Reasoning behavior, for providers that support it.

§extra_body: Map<String, Value>

Escape hatch for provider-specific wire fields. Reserved canonical fields cannot be overwritten.

Implementations§

Source§

impl ChatRequest

Source

pub fn new(messages: impl IntoIterator<Item = Message>) -> Self

Creates a request from the given messages; all other fields default.

Source

pub fn user(text: impl Into<String>) -> Self

Creates a request with a single user text message.

Source

pub fn push(self, message: Message) -> Self

Appends a message.

Source

pub fn tools(self, tools: impl IntoIterator<Item = ToolSpec>) -> Self

Replaces the client-side tool list.

Source

pub fn tool_declarations( self, tools: impl IntoIterator<Item = ToolDeclaration>, ) -> Self

Replaces the native client declarations; the legacy function list is retained separately and participates in top-level conflict validation.

Source

pub fn server_tools(self, tools: impl IntoIterator<Item = ServerTool>) -> Self

Replaces the provider-hosted tool list.

Source

pub fn tool_choice(self, tool_choice: ToolChoice) -> Self

Sets how the model should choose among tools.

Source

pub fn response_format(self, response_format: ResponseFormat) -> Self

Sets the requested output format.

Source

pub fn stop<I, S>(self, stop: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Replaces the stop sequences.

Source

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

Sets the sampling seed.

Source

pub fn temperature(self, temperature: f32) -> Self

Sets the sampling temperature.

Source

pub fn max_output_tokens(self, max_output_tokens: u32) -> Self

Sets the output token limit.

Source

pub fn reasoning(self, reasoning: ReasoningConfig) -> Self

Sets the reasoning configuration.

Source

pub fn extra_body(self, key: impl Into<String>, value: impl Into<Value>) -> Self

Add one provider-specific request body field.

Reserved canonical fields are rejected by the adapter at request time, not silently overwritten.

Trait Implementations§

Source§

impl Clone for ChatRequest

Source§

fn clone(&self) -> Self

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 ChatRequest

Source§

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

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

impl Default for ChatRequest

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for ChatRequest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ChatRequest

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for ChatRequest

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ChatRequest

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

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.
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