Struct CreateChatCompletionRequest 

pub struct CreateChatCompletionRequest {
    pub model: String,
    pub messages: Vec<Message>,
    pub max_tokens: Option<usize>,
    pub max_completion_tokens: Option<usize>,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub stop: Option<Vec<String>>,
    pub tools: Option<Vec<Tool>>,
    pub stream: Option<bool>,
    pub n: Option<usize>,
    pub presence_penalty: Option<f32>,
    pub frequency_penalty: Option<f32>,
}

Request to create a chat completion.

Fields

model: String

Model to use.

messages: Vec<Message>

Messages in the conversation.

max_tokens: Option<usize>

Maximum tokens to generate.

max_completion_tokens: Option<usize>

Maximum completion tokens (for o1/o3 models).

temperature: Option<f32>

Temperature for sampling.

top_p: Option<f32>

Top-p sampling.

stop: Option<Vec<String>>

Stop sequences.

tools: Option<Vec<Tool>>

Available tools.

stream: Option<bool>

Whether to stream the response.

n: Option<usize>

Number of completions to generate.

presence_penalty: Option<f32>

Presence penalty.

frequency_penalty: Option<f32>

Frequency penalty.

Implementations

impl CreateChatCompletionRequest

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

Create a new chat completion request.

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

Set max tokens.

pub fn with_max_completion_tokens(self, max_tokens: usize) -> Self

Set max completion tokens (for o1/o3 models).

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

Set temperature.

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

Set top-p sampling.

pub fn with_stop(self, stop: Vec<String>) -> Self

Set stop sequences.

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

Set available tools.

Trait Implementations

impl Clone for CreateChatCompletionRequest

fn clone(&self) -> CreateChatCompletionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateChatCompletionRequest

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

Formats the value using the given formatter.

impl Serialize for CreateChatCompletionRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.