Struct ChatCompletionsRequest 

#[non_exhaustive]
pub struct ChatCompletionsRequest {
    pub model: String,
    pub messages: Vec<ChatMessage>,
    pub max_tokens: Option<u32>,
    pub temperature: Option<f32>,
    pub stream: Option<bool>,
    pub n: Option<u32>,
    pub tools: Option<Value>,
    pub user: Option<String>,
}

Body of POST /v1/chat/completions.

Mirrors the public OpenAI REST contract documented at https://platform.openai.com/docs/api-reference/chat/create.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

model: String

Model identifier. See CompletionsRequest::model.

messages: Vec<ChatMessage>

Conversation history. Required by OpenAI; the scaffold rejects at the 501 step so an empty vector still parses.

max_tokens: Option<u32>

Maximum tokens to generate per response.

temperature: Option<f32>

Sampling temperature in [0.0, 2.0].

stream: Option<bool>

Stream the response as SSE if true.

n: Option<u32>

Number of completions to generate per prompt.

tools: Option<Value>

Optional tools array (OpenAI tool-calling). v0.4 wires.

user: Option<String>

Caller-supplied opaque user identifier.

Trait Implementations

impl Clone for ChatCompletionsRequest

fn clone(&self) -> ChatCompletionsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatCompletionsRequest

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

Formats the value using the given formatter.

impl Default for ChatCompletionsRequest

fn default() -> ChatCompletionsRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChatCompletionsRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ChatCompletionsRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.