Struct ResponseStreamOptions 

pub struct ResponseStreamOptions {
    pub include_obfuscation: Option<bool>,
}

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

Fields

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 ResponseStreamOptions

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

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

Trait Implementations

impl Clone for ResponseStreamOptions

fn clone(&self) -> ResponseStreamOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseStreamOptions

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

Formats the value using the given formatter.

impl Default for ResponseStreamOptions

fn default() -> ResponseStreamOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ResponseStreamOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ResponseStreamOptions

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

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 ResponseStreamOptions

impl StructuralPartialEq for ResponseStreamOptions