interface ResponseRetrieveParamsStreaming {
    include?: ResponseIncludable[];
    include_obfuscation?: boolean;
    starting_after?: number;
    stream: true;
}

Hierarchy

  • ResponseRetrieveParamsBase
    • ResponseRetrieveParamsStreaming

Properties

include?: ResponseIncludable[]

Additional fields to include in the response. See the include parameter for Response creation above for more information.

include_obfuscation?: boolean

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.

starting_after?: number

The sequence number of the event after which to start streaming.

stream: true

If set to true, the model response data will be streamed to the client as it is generated using server-sent events. See the Streaming section below for more information.