Constructor Detail

Method Detail

• includeObfuscation

   final ResponsesClientEvent.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 set include_obfuscation to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.

• includeObfuscation

   final ResponsesClientEvent.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 ResponsesClientEvent.StreamOptions.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final ResponsesClientEvent.StreamOptions.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final ResponsesClientEvent.StreamOptions.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final ResponsesClientEvent.StreamOptions.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final ResponsesClientEvent.StreamOptions.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final ResponsesClientEvent.StreamOptions build()

  Returns an immutable instance of StreamOptions.

  Further updates to this Builder will not mutate the returned instance.