Struct Request 

pub struct Request {
    pub model: String,
    pub messages: Vec<Message>,
    pub temperature: Option<f32>,
    pub max_tokens: Option<u32>,
    pub top_p: Option<f32>,
    pub frequency_penalty: Option<f32>,
    pub presence_penalty: Option<f32>,
    pub stop: Option<Vec<String>>,
    pub stream: Option<bool>,
    pub response_format: Option<ResponseFormat>,
    pub extra: HashMap<String, Value>,
}

A completion request sent to a provider.

Fields

model: String

The model identifier, e.g. "gpt-4o" or "claude-3-5-sonnet-20241022".

messages: Vec<Message>

The conversation history, including any system prompt.

temperature: Option<f32>

Sampling temperature in [0.0, 2.0].

max_tokens: Option<u32>

Maximum tokens to generate.

top_p: Option<f32>

Nucleus sampling parameter.

frequency_penalty: Option<f32>

Frequency penalty in [-2.0, 2.0] (OpenAI only).

presence_penalty: Option<f32>

Presence penalty in [-2.0, 2.0] (OpenAI only).

stop: Option<Vec<String>>

Stop sequences.

stream: Option<bool>

Whether to stream the response. Providers handle this internally.

response_format: Option<ResponseFormat>

Structured output format (json_object etc.).

extra: HashMap<String, Value>

Provider-specific extra parameters (e.g. tools, tool_choice).

Implementations

impl Request

pub fn new() -> Self

Create a new empty request.

pub fn with_model(self, model: impl Into<String>) -> Self

Set the model identifier.

pub fn with_messages(self, messages: Vec<Message>) -> Self

Set the full message list.

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

Append a single message.

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

Set the sampling temperature.

pub fn with_max_tokens(self, max_tokens: u32) -> Self

Set the maximum number of tokens to generate.

pub fn with_top_p(self, top_p: f32) -> Self

Set the top_p nucleus sampling parameter.

pub fn with_json_mode(self) -> Self

Enable JSON mode (structured output).

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

Insert a provider-specific extra parameter.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl Default for Request

fn default() -> Request

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Request

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Request

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

where __S: Serializer,

Serialize this value into the given Serde serializer.