Class ResponseCreateParams.StreamOptions.Builder
-
- All Implemented Interfaces:
public final class ResponseCreateParams.StreamOptions.Builder
A builder for StreamOptions.
-
-
Method Summary
Modifier and Type Method Description final ResponseCreateParams.StreamOptions.Builder
includeObfuscation(Boolean includeObfuscation)
When true, stream obfuscation will be enabled. final ResponseCreateParams.StreamOptions.Builder
includeObfuscation(JsonField<Boolean> includeObfuscation)
Sets Builder.includeObfuscation to an arbitrary JSON value. final ResponseCreateParams.StreamOptions.Builder
additionalProperties(Map<String, JsonValue> additionalProperties)
final ResponseCreateParams.StreamOptions.Builder
putAdditionalProperty(String key, JsonValue value)
final ResponseCreateParams.StreamOptions.Builder
putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
final ResponseCreateParams.StreamOptions.Builder
removeAdditionalProperty(String key)
final ResponseCreateParams.StreamOptions.Builder
removeAllAdditionalProperties(Set<String> keys)
final ResponseCreateParams.StreamOptions
build()
Returns an immutable instance of StreamOptions. -
-
Method Detail
-
includeObfuscation
final ResponseCreateParams.StreamOptions.Builder includeObfuscation(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 setinclude_obfuscation
to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.
-
includeObfuscation
final ResponseCreateParams.StreamOptions.Builder includeObfuscation(JsonField<Boolean> includeObfuscation)
Sets Builder.includeObfuscation to an arbitrary JSON value.
You should usually call Builder.includeObfuscation with a well-typed Boolean value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final ResponseCreateParams.StreamOptions.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final ResponseCreateParams.StreamOptions.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final ResponseCreateParams.StreamOptions.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final ResponseCreateParams.StreamOptions.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final ResponseCreateParams.StreamOptions.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final ResponseCreateParams.StreamOptions build()
Returns an immutable instance of StreamOptions.
Further updates to this Builder will not mutate the returned instance.
-
-
-
-