Struct CompletionUsage

pub struct CompletionUsage {
    pub completion_tokens: u64,
    pub prompt_tokens: u64,
    pub total_tokens: u64,
    pub completion_tokens_details: Option<CompletionUsageCompletionTokensDetails>,
    pub prompt_tokens_details: Option<CompletionUsagePromptTokensDetails>,
}

Usage statistics for the completion request.

Fields

completion_tokens: u64

Number of tokens in the generated completion.

prompt_tokens: u64

Number of tokens in the prompt.

total_tokens: u64

Total number of tokens used in the request (prompt + completion).

completion_tokens_details: Option<CompletionUsageCompletionTokensDetails>

Breakdown of tokens used in a completion.

prompt_tokens_details: Option<CompletionUsagePromptTokensDetails>

Breakdown of tokens used in the prompt.

Implementations

impl CompletionUsage

pub fn builder() -> CompletionUsageBuilder<((), (), (), (), ())>

Create a builder for building CompletionUsage. On the builder, call .completion_tokens(...), .prompt_tokens(...), .total_tokens(...), .completion_tokens_details(...)(optional), .prompt_tokens_details(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CompletionUsage.

Trait Implementations

impl Clone for CompletionUsage

fn clone(&self) -> CompletionUsage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionUsage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompletionUsage

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CompletionUsage

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for CompletionUsage

impl StructuralPartialEq for CompletionUsage