Struct ChatCompletionStreamOptions

pub struct ChatCompletionStreamOptions {
    pub include_usage: bool,
}

Options for streaming response. Only set this when you set stream: true.

Fields

include_usage: bool

If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value.

Trait Implementations

impl Clone for ChatCompletionStreamOptions

fn clone(&self) -> ChatCompletionStreamOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChatCompletionStreamOptions

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatCompletionStreamOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChatCompletionStreamOptions

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

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 ChatCompletionStreamOptions

impl StructuralPartialEq for ChatCompletionStreamOptions