Struct ChatCompletionStreamOptions 

pub struct ChatCompletionStreamOptions {
    pub include_usage: Option<bool>,
    pub include_obfuscation: Option<bool>,
}

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

Fields

include_usage: Option<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. NOTE: If the stream is interrupted, you may not receive the final usage chunk which contains the total token usage for the request.

include_obfuscation: Option<bool>

When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an obfuscation field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set include_obfuscation to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.

Implementations

impl ChatCompletionStreamOptions

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

Create a builder for building ChatCompletionStreamOptions. On the builder, call .include_usage(...)(optional), .include_obfuscation(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ChatCompletionStreamOptions.

Trait Implementations

impl Clone for ChatCompletionStreamOptions

fn clone(&self) -> ChatCompletionStreamOptions

Returns a duplicate 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 Default for ChatCompletionStreamOptions

fn default() -> ChatCompletionStreamOptions

Returns the “default value” for a type.

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