Struct CreateChatCompletionStreamResponse

pub struct CreateChatCompletionStreamResponse {
    pub id: String,
    pub choices: Vec<CreateChatCompletionStreamResponseChoice>,
    pub created: i64,
    pub model: String,
    pub service_tier: Option<ServiceTier>,
    pub system_fingerprint: Option<String>,
    pub usage: Option<CompletionUsage>,
}

Represents a streamed chunk of a chat completion response returned by the model, based on the provided input. Learn more.

Fields

id: String

A unique identifier for the chat completion. Each chunk has the same ID.

choices: Vec<CreateChatCompletionStreamResponseChoice>

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

created: i64

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

model: String

The model to generate the completion.

service_tier: Option<ServiceTier>

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.

Implementations

impl CreateChatCompletionStreamResponse

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

Create a builder for building CreateChatCompletionStreamResponse. On the builder, call .id(...), .choices(...), .created(...), .model(...), .service_tier(...)(optional), .system_fingerprint(...)(optional), .usage(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CreateChatCompletionStreamResponse.

Trait Implementations

impl Clone for CreateChatCompletionStreamResponse

fn clone(&self) -> CreateChatCompletionStreamResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateChatCompletionStreamResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateChatCompletionStreamResponse

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateChatCompletionStreamResponse

fn eq(&self, other: &CreateChatCompletionStreamResponse) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 CreateChatCompletionStreamResponse

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateChatCompletionStreamResponse