Struct openai_rust::chat::ChatArguments

pub struct ChatArguments {
    pub model: String,
    pub messages: Vec<Message>,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub n: Option<u32>,
    pub stream: Option<bool>,
    pub stop: Option<String>,
    pub max_tokens: Option<u32>,
    pub presence_penalty: Option<f32>,
    pub frequency_penalty: Option<f32>,
    pub user: Option<String>,
}

Request arguments for chat completion.

See https://platform.openai.com/docs/api-reference/chat/create.

let args = openai_rust::chat::ChatArguments::new("gpt-3.5-turbo", vec![
    openai_rust::chat::Message {
        role: "user".to_owned(),
        content: "Hello GPT!".to_owned(),
    }
]);

Fields

model: String

messages: Vec<Message>

temperature: Option<f32>

top_p: Option<f32>

n: Option<u32>

stream: Option<bool>

stop: Option<String>

max_tokens: Option<u32>

presence_penalty: Option<f32>

frequency_penalty: Option<f32>

user: Option<String>

Implementations

impl ChatArguments

pub fn new(model: impl AsRef<str>, messages: Vec<Message>) -> ChatArguments

Trait Implementations

impl Clone for ChatArguments

fn clone(&self) -> ChatArguments

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChatArguments

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

Formats the value using the given formatter.

impl Serialize for ChatArguments

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

Serialize this value into the given Serde serializer.