class

OpenAI::ResponseStreamOptionsVariant1

Inherits JSON::Serializable < Reference < Object

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

Constructors

new(pull : JSON::PullParser)

Source

new(include_obfuscation : Bool | Nil = nil)

Source

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Source

Instance methods

include_obfuscation

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.

Source

include_obfuscation=(include_obfuscation : Bool | Nil)

Source