Struct ChatRequest 

pub struct ChatRequest {
    pub model: ModelName,
    pub messages: Vec<Message>,
    pub tools: Vec<ToolSpec>,
    pub tool_choice: ToolChoice,
    pub response_format: Option<ResponseFormat>,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub max_output_tokens: Option<u32>,
    pub stop: Vec<String>,
    pub metadata: Value,
}

Request for a complete or streamed chat response.

Fields

model: ModelName

Provider-specific model name.

messages: Vec<Message>

Ordered conversation messages.

tools: Vec<ToolSpec>

Tool definitions available to the model.

tool_choice: ToolChoice

Tool selection policy.

response_format: Option<ResponseFormat>

Optional output format constraint.

temperature: Option<f32>

Sampling temperature.

top_p: Option<f32>

Nucleus sampling probability.

max_output_tokens: Option<u32>

Maximum output tokens.

stop: Vec<String>

Stop sequences.

metadata: Value

Application metadata forwarded to provider adapters.

Implementations

impl ChatRequest

pub fn new(model: ModelName) -> Self

Creates a chat request for the given model with no messages.

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

Appends one message to the request.

pub fn with_user_text(self, text: impl Into<String>) -> Self

Appends a user text message to the request.

pub fn with_tool(self, tool: ToolSpec) -> Self

Adds a tool definition to the request.

Trait Implementations

impl Clone for ChatRequest

fn clone(&self) -> ChatRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChatRequest

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChatRequest

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ChatRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChatRequest