StreamOptions 4.23.0 API

All Implemented Interfaces:


public final class ResponsesClientEvent.StreamOptions

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

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ResponsesClientEvent.StreamOptions.Builder`	A builder for StreamOptions.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<Boolean>`	`includeObfuscation()`	When true, stream obfuscation will be enabled.
`final JsonField<Boolean>`	`_includeObfuscation()`	Returns the raw JSON value of includeObfuscation.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final ResponsesClientEvent.StreamOptions.Builder`	`toBuilder()`
`final ResponsesClientEvent.StreamOptions`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ResponsesClientEvent.StreamOptions.Builder`	`builder()`	Returns a mutable builder for constructing an instance of StreamOptions.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - includeObfuscation
```
 final Optional<Boolean> includeObfuscation()
```
    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.
  - _includeObfuscation
```
 final JsonField<Boolean> _includeObfuscation()
```
    Returns the raw JSON value of includeObfuscation.
    Unlike includeObfuscation, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - toBuilder
```
 final ResponsesClientEvent.StreamOptions.Builder toBuilder()
```
  - validate
```
 final ResponsesClientEvent.StreamOptions validate()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static ResponsesClientEvent.StreamOptions.Builder builder()
```
    Returns a mutable builder for constructing an instance of StreamOptions.