Struct CompletionResponse

pub struct CompletionResponse {
    pub message_id: Option<String>,
    pub created_timestamp: Option<u64>,
    pub model: String,
    pub usage: TokenUsage,
    pub message_choices: Vec<MessageChoice>,
}

A response struct received from the API after requesting a message completion

Fields

message_id: Option<String>

Unique ID of the message, but not in a UUID format. Example: chatcmpl-6p5FEv1JHictSSnDZsGU4KvbuBsbu

created_timestamp: Option<u64>

Unix seconds timestamp of when the response was created

model: String

The model that was used for this completion

usage: TokenUsage

Token usage of this completion

message_choices: Vec<MessageChoice>

Message choices for this response, guaranteed to contain at least one message response

Implementations

impl CompletionResponse

pub fn message(&self) -> &ChatMessage

A shortcut to access the message response

Trait Implementations

impl Clone for CompletionResponse

fn clone(&self) -> CompletionResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompletionResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CompletionResponse

fn eq(&self, other: &CompletionResponse) -> 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 PartialOrd for CompletionResponse

fn partial_cmp(&self, other: &CompletionResponse) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for CompletionResponse