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.

• includeUsage

   final Optional<Boolean> includeUsage()

  If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array.

  All other chunks will also include a usage field, but with a null value. NOTE: If the stream is interrupted, you may not receive the final usage chunk which contains the total token usage for the request.

• _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.

• _includeUsage

   final JsonField<Boolean> _includeUsage()

  Returns the raw JSON value of includeUsage.

  Unlike includeUsage, this method doesn't throw if the JSON field has an unexpected type.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final ChatCompletionStreamOptions.Builder toBuilder()

• validate

   final ChatCompletionStreamOptions validate()

  Validates that the types of all values in this object match their expected types recursively.

  This method is not forwards compatible with new types from the API for existing fields.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static ChatCompletionStreamOptions.Builder builder()

  Returns a mutable builder for constructing an instance of ChatCompletionStreamOptions.