Struct ChatCompletionRequest 

pub struct ChatCompletionRequest {

    pub model: String,
    pub messages: Vec<Message>,
    pub frequency_penalty: Option<f64>,
    pub logprobs: Option<bool>,
    pub max_completion_tokens: Option<u64>,
    pub max_tokens: Option<u64>,
    pub n: Option<u32>,
    pub presence_penalty: Option<f64>,
    pub response_format: Option<ResponseFormat>,
    pub seed: Option<i64>,
    pub stop: Option<Stop>,
    pub stream: Option<bool>,
    pub stream_options: Option<StreamOptions>,
    pub temperature: Option<f64>,
    pub tool_choice: Option<ToolChoice>,
    pub tools: Option<Vec<Tool>>,
    pub top_logprobs: Option<u32>,
    pub top_p: Option<f64>,
    pub user: Option<String>,
    pub reasoning_effort: Option<String>,
    pub parallel_tool_calls: Option<bool>,
    pub logit_bias: Option<HashMap<String, i32>>,
    pub metadata: Option<HashMap<String, String>>,
    pub store: Option<bool>,
    pub service_tier: Option<String>,
    pub modalities: Option<Vec<String>>,
    pub audio: Option<Value>,
    pub extra: HashMap<String, Value>,
}

Request body for POST /chat/completions, mirroring the parameter list in resources/chat/completions/completions.py::create.

Fields

model: String

messages: Vec<Message>

frequency_penalty: Option<f64>

logprobs: Option<bool>

max_completion_tokens: Option<u64>

max_tokens: Option<u64>

Deprecated upstream in favor of max_completion_tokens, but still widely supported by OpenAI-compatible providers.

n: Option<u32>

presence_penalty: Option<f64>

response_format: Option<ResponseFormat>

seed: Option<i64>

stop: Option<Stop>

stream: Option<bool>

stream_options: Option<StreamOptions>

temperature: Option<f64>

tool_choice: Option<ToolChoice>

tools: Option<Vec<Tool>>

top_logprobs: Option<u32>

top_p: Option<f64>

user: Option<String>

reasoning_effort: Option<String>

Reasoning effort for reasoning models ("minimal", "low", "medium", "high").

parallel_tool_calls: Option<bool>

logit_bias: Option<HashMap<String, i32>>

metadata: Option<HashMap<String, String>>

store: Option<bool>

service_tier: Option<String>

modalities: Option<Vec<String>>

Output modalities, e.g. ["text", "audio"].

audio: Option<Value>

Audio output configuration ({"voice": ..., "format": ...}).

extra: HashMap<String, Value>

Escape hatch: additional request parameters flattened into the JSON body, for provider-specific or newly-added params not yet typed.

Implementations

impl ChatCompletionRequest

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

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

pub fn max_completion_tokens(self, max: u64) -> Self

pub fn max_tokens(self, max: u64) -> Self

pub fn top_p(self, top_p: f64) -> Self

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

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

pub fn frequency_penalty(self, penalty: f64) -> Self

pub fn presence_penalty(self, penalty: f64) -> Self

pub fn logprobs(self, logprobs: bool) -> Self

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

pub fn stop(self, stop: Stop) -> Self

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

pub fn tools(self, tools: Vec<Tool>) -> Self

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

pub fn stream_options(self, stream_options: StreamOptions) -> Self

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

pub fn reasoning_effort(self, effort: impl Into<String>) -> Self

Reasoning effort for reasoning models: "minimal", "low", "medium", or "high".

pub fn parallel_tool_calls(self, parallel: bool) -> Self

pub fn metadata(self, metadata: HashMap<String, String>) -> Self

pub fn store(self, store: bool) -> Self

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

Set an arbitrary extra parameter on the request body (escape hatch for provider-specific or newly-added params).

Trait Implementations

impl Clone for ChatCompletionRequest

fn clone(&self) -> ChatCompletionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatCompletionRequest

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

Formats the value using the given formatter.

impl Default for ChatCompletionRequest

fn default() -> ChatCompletionRequest

Returns the “default value” for a type.

impl Serialize for ChatCompletionRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.