Struct ChatCompletions

pub struct ChatCompletions {

    pub messages: Vec<Message>,
    pub model: String,
    pub store: bool,
    pub metadata: Option<Value>,
    pub logit_bias: Option<Value>,
    pub logprobs: bool,
    pub top_logprobs: Option<usize>,
    pub max_tokens: Option<usize>,
    pub max_completion_tokens: Option<usize>,
    pub n: Option<usize>,
    pub presence_penalty: Option<f32>,
    pub response_format: Option<ResponseFormat>,
    pub seed: Option<u32>,
    pub service_tier: Option<String>,
    pub stop: Option<Stop>,
    pub stream: bool,
    pub user: Option<String>,
}

Chat completions structure.

For reference, see: https://platform.openai.com/docs/api-reference/chat

To construct this structure easily use the default trait:

let request = mini_openai::ChatCompletions {
  messages: vec![
    mini_openai::Message{
        role: mini_openai::ROLE_SYSTEM.into(),
        content: "Who are you?".into()
    }
  ],
  ..Default::default()
};

Fields

messages: Vec<Message>

model: String

store: bool

metadata: Option<Value>

logit_bias: Option<Value>

logprobs: bool

top_logprobs: Option<usize>

max_tokens: Option<usize>

max_completion_tokens: Option<usize>

n: Option<usize>

presence_penalty: Option<f32>

response_format: Option<ResponseFormat>

seed: Option<u32>

service_tier: Option<String>

stop: Option<Stop>

stream: bool

Must be ‘false’: Only non-streaming is supported.

user: Option<String>

Trait Implementations

impl Clone for ChatCompletions

fn clone(&self) -> ChatCompletions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatCompletions

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

Formats the value using the given formatter.

impl Default for ChatCompletions

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for ChatCompletions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.