Struct CompletionRequest

pub struct CompletionRequest<'a> {
    pub model: &'a str,
    pub messages: &'a Vec<ChatMessage>,
    pub stream: bool,
    pub temperature: f32,
    pub top_p: f32,
    pub max_tokens: Option<u32>,
    pub frequency_penalty: f32,
    pub presence_penalty: f32,
    pub reply_count: u32,
    pub functions: &'a Vec<Value>,
}

A request struct sent to the API to request a message completion

Fields

model: &'a str

The model to be used, currently gpt-3.5-turbo, but may change in future

messages: &'a Vec<ChatMessage>

The message history, including the message that requires completion, which should be the last one

stream: bool

Whether the message response should be gradually streamed

temperature: f32

The extra randomness of response

top_p: f32

Controls diversity via nucleus sampling, not recommended to use with temperature

max_tokens: Option<u32>

Controls the maximum number of tokens to generate in the completion

frequency_penalty: f32

Determines how much to penalize new tokens based on their existing frequency so far

presence_penalty: f32

Determines how much to penalize new tokens pased on their existing presence so far

reply_count: u32

Determines the amount of output responses

functions: &'a Vec<Value>

All functions that can be called by ChatGPT

Trait Implementations

impl<'a> Clone for CompletionRequest<'a>

fn clone(&self) -> CompletionRequest<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CompletionRequest<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for CompletionRequest<'a>

fn eq(&self, other: &CompletionRequest<'a>) -> 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<'a> Serialize for CompletionRequest<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for CompletionRequest<'a>