Struct ChatCompletionRequest 

pub struct ChatCompletionRequest {
    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 stream: Option<bool>,
    pub tools: Option<Vec<Tool>>,
}

Wire types for chat completion requests, responses, and streaming. Chat completion request, response, and message types. Wire types for chat completion requests, responses, and streaming. Chat completion request, response, and message types. Request body for the POST chat/completions endpoint.

Uses the Former builder pattern for ergonomic construction.

Examples

use api_openai_compatible::{ ChatCompletionRequest, Message };

let req = ChatCompletionRequest::former()
  .model( "gpt-4o".to_string() )
  .messages( vec![ Message::user( "Hello!" ) ] )
  .max_tokens( 100_u32 )
  .form();

Fields

model: String

Model identifier (e.g. "gpt-4o", "grok-2-1212").

messages: Vec<Message>

Ordered list of conversation messages.

temperature: Option<f32>

Sampling temperature in [0.0, 2.0]. Higher = more random.

max_tokens: Option<u32>

Maximum tokens to generate in the completion.

top_p: Option<f32>

Nucleus sampling threshold in [0.0, 1.0].

frequency_penalty: Option<f32>

Frequency penalty in [0.0, 2.0] (reduces token repetition).

presence_penalty: Option<f32>

Presence penalty in [0.0, 2.0] (encourages topic diversity).

stream: Option<bool>

When true, the response is streamed as Server-Sent Events.

tools: Option<Vec<Tool>>

Tool definitions available for function calling.

Implementations

impl ChatCompletionRequest

pub fn former() -> ChatCompletionRequestFormer<ChatCompletionRequestFormerDefinition<(), ChatCompletionRequest, ReturnPreformed>>

Provides a mechanism to initiate the formation process with a default completion behavior.

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<'de> Deserialize<'de> for ChatCompletionRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__Context, __Formed, __End> EntityToDefinition<__Context, __Formed, __End> for ChatCompletionRequest

where __End: FormingEnd<ChatCompletionRequestFormerDefinitionTypes<__Context, __Formed>>,

type Definition = ChatCompletionRequestFormerDefinition<__Context, __Formed, __End>

The specific FormerDefinition associated with this entity.

type Types = ChatCompletionRequestFormerDefinitionTypes<__Context, __Formed>

The specific FormerDefinitionTypes associated with this entity.

impl<__Context, __Formed> EntityToDefinitionTypes<__Context, __Formed> for ChatCompletionRequest

type Types = ChatCompletionRequestFormerDefinitionTypes<__Context, __Formed>

Specifies the FormerDefinitionTypes that define the storage, formed entity, and context types used during formation.

impl<Definition> EntityToFormer<Definition> for ChatCompletionRequest

where Definition: FormerDefinition<Storage = ChatCompletionRequestFormerStorage>,

type Former = ChatCompletionRequestFormer<Definition>

The type of the former (builder) used for constructing the entity.

fn __f(_: &Definition)

A placeholder function to reference the definition without operational logic.

impl EntityToStorage for ChatCompletionRequest

type Storage = ChatCompletionRequestFormerStorage

The storage type used for forming the entity.

impl PartialEq for ChatCompletionRequest

fn eq(&self, other: &ChatCompletionRequest) -> 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 ChatCompletionRequest

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 ChatCompletionRequest