Struct ChatCompletionChunk 

pub struct ChatCompletionChunk {
    pub id: String,
    pub choices: Vec<CompletionChunkChoice>,
    pub created: u64,
    pub model: String,
    pub object: ChatCompletionChunkObject,
    pub service_tier: Option<ServiceTier>,
    pub system_fingerprint: Option<String>,
    pub usage: Option<CompletionUsage>,
}

Fields

id: String

A unique identifier for the chat completion.

choices: Vec<CompletionChunkChoice>

A list of chat completion choices. Can be more than one if n is greater than 1. Can also be empty for the last chunk if you set stream_options: {"include_usage": true}.

created: u64

The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.

model: String

The model used for the chat completion.

object: ChatCompletionChunkObject

The object type, which is always chat.completion.chunk

service_tier: Option<ServiceTier>

This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism.

system_fingerprint: Option<String>

This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism.

usage: Option<CompletionUsage>

An optional field that will only be present when you set stream_options: {"include_usage": true} in your request. When present, it contains a null value except for the last chunk which contains the token usage statistics for the entire request.

NOTE: If the stream is interrupted or cancelled, you may not receive the final usage chunk which contains the total token usage for the request.

Trait Implementations

impl Debug for ChatCompletionChunk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatCompletionChunk

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for ChatCompletionChunk

type Err = ResponseError

The associated error which can be returned from parsing.

fn from_str(content: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.