Struct ChatCompletion

pub struct ChatCompletion { /* private fields */ }

OpenAI Chat Completions API client

This structure manages interactions with the OpenAI Chat Completions API. It handles API key management, request parameter configuration, and API calls.

Example

use openai_tools::chat::request::ChatCompletion;
use openai_tools::common::message::Message;
use openai_tools::common::role::Role;

let mut chat = ChatCompletion::new();
let messages = vec![Message::from_string(Role::User, "Hello!")];

let response = chat
    .model_id("gpt-4o-mini")
    .messages(messages)
    .temperature(1.0)
    .chat()
    .await?;

Implementations

impl ChatCompletion

pub fn new() -> Self

Creates a new ChatCompletion instance

Loads the API key from the OPENAI_API_KEY environment variable. If a .env file exists, it will also be loaded.

Panics

Panics if the OPENAI_API_KEY environment variable is not set.

Returns

A new ChatCompletion instance

pub fn model_id<T: AsRef<str>>(&mut self, model_id: T) -> &mut Self

Sets the model ID to use

Arguments

• model_id - OpenAI model ID (e.g., gpt-4o-mini, gpt-4o)

Returns

A mutable reference to self for method chaining

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

Sets the chat message history

Arguments

• messages - Vector of chat messages representing the conversation history

Returns

A mutable reference to self for method chaining

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

Sets whether to store the request and response at OpenAI

Arguments

• store - true to store, false to not store

Returns

A mutable reference to self for method chaining

pub fn frequency_penalty(&mut self, frequency_penalty: f32) -> &mut Self

Sets the frequency penalty

A parameter that penalizes based on word frequency to reduce repetition. Positive values decrease repetition, negative values increase it.

Arguments

• frequency_penalty - Frequency penalty value (range: -2.0 to 2.0)

Returns

A mutable reference to self for method chaining

pub fn logit_bias<T: AsRef<str>>( &mut self, logit_bias: HashMap<T, i32>, ) -> &mut Self

Sets logit bias to adjust the probability of specific tokens

Arguments

• logit_bias - A map of token IDs to adjustment values

Returns

A mutable reference to self for method chaining

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

Sets whether to include probability information for each token

Arguments

• logprobs - true to include probability information

Returns

A mutable reference to self for method chaining

pub fn top_logprobs(&mut self, top_logprobs: u8) -> &mut Self

Sets the number of top probabilities to return for each token

Arguments

• top_logprobs - Number of top probabilities (range: 0-20)

Returns

A mutable reference to self for method chaining

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

Sets the maximum number of tokens to generate

Arguments

• max_completion_tokens - Maximum number of tokens

Returns

A mutable reference to self for method chaining

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

Sets the number of responses to generate

Arguments

• n - Number of responses to generate

Returns

A mutable reference to self for method chaining

pub fn modalities<T: AsRef<str>>(&mut self, modalities: Vec<T>) -> &mut Self

Sets the available modalities for the response

Arguments

• modalities - List of modalities (e.g., ["text", "audio"])

Returns

A mutable reference to self for method chaining

pub fn presence_penalty(&mut self, presence_penalty: f32) -> &mut Self

Sets the presence penalty

A parameter that controls the tendency to include new content in the document. Positive values encourage talking about new topics, negative values encourage staying on existing topics.

Arguments

• presence_penalty - Presence penalty value (range: -2.0 to 2.0)

Returns

A mutable reference to self for method chaining

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

Sets the temperature parameter to control response randomness

Higher values (e.g., 1.0) produce more creative and diverse outputs, while lower values (e.g., 0.2) produce more deterministic and consistent outputs.

Arguments

• temperature - Temperature parameter (range: 0.0 to 2.0)

Returns

A mutable reference to self for method chaining

pub fn json_schema(&mut self, json_schema: Schema) -> &mut Self

Sets structured output using JSON schema

Enables receiving responses in a structured JSON format according to the specified JSON schema.

Arguments

• json_schema - JSON schema defining the response structure

Returns

A mutable reference to self for method chaining

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

Sets the tools that can be called by the model

Enables function calling by providing a list of tools that the model can choose to call. When tools are provided, the model may generate tool calls instead of or in addition to regular text responses.

Arguments

• tools - Vector of tools available for the model to use

Returns

A mutable reference to self for method chaining

pub fn get_message_history(&self) -> Vec<Message>

Gets the current message history

Returns

A vector containing the message history

pub async fn chat(&mut self) -> Result<Response>

Sends the chat completion request to OpenAI API

This method validates the request parameters, constructs the HTTP request, and sends it to the OpenAI Chat Completions endpoint.

Returns

A Result containing the API response on success, or an error on failure.

Errors

Returns an error if:

• API key is not set
• Model ID is not set
• Messages are empty
• Network request fails
• Response parsing fails

Example

use openai_tools::chat::request::ChatCompletion;
use openai_tools::common::message::Message;
use openai_tools::common::role::Role;

let mut chat = ChatCompletion::new();
let messages = vec![Message::from_string(Role::User, "Hello!")];

let response = chat
    .model_id("gpt-4o-mini")
    .messages(messages)
    .temperature(1.0)
    .chat()
    .await?;
     
println!("{}", response.choices[0].message.content.as_ref().unwrap().text.as_ref().unwrap());

Trait Implementations

impl Clone for ChatCompletion

fn clone(&self) -> ChatCompletion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatCompletion

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

Formats the value using the given formatter.

impl Default for ChatCompletion

fn default() -> ChatCompletion

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChatCompletion

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ChatCompletion

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

where __S: Serializer,

Serialize this value into the given Serde serializer.