Package com.openai.models
Class ChatCompletionStreamOptions
-
- All Implemented Interfaces:
public final class ChatCompletionStreamOptionsOptions for streaming response. Only set this when you set
stream: true.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classChatCompletionStreamOptions.Builder
-
Method Summary
Modifier and Type Method Description final Optional<Boolean>includeUsage()If set, an additional chunk will be streamed before the data: [DONE]message.final JsonField<Boolean>_includeUsage()If set, an additional chunk will be streamed before the data: [DONE]message.final Map<String, JsonValue>_additionalProperties()final ChatCompletionStreamOptionsvalidate()final ChatCompletionStreamOptions.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ChatCompletionStreamOptions.Builderbuilder()-
-
Method Detail
-
includeUsage
final Optional<Boolean> includeUsage()
If set, an additional chunk will be streamed before the
data: [DONE]message. Theusagefield on this chunk shows the token usage statistics for the entire request, and thechoicesfield will always be an empty array. All other chunks will also include ausagefield, but with a null value.
-
_includeUsage
final JsonField<Boolean> _includeUsage()
If set, an additional chunk will be streamed before the
data: [DONE]message. Theusagefield on this chunk shows the token usage statistics for the entire request, and thechoicesfield will always be an empty array. All other chunks will also include ausagefield, but with a null value.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
validate
final ChatCompletionStreamOptions validate()
-
toBuilder
final ChatCompletionStreamOptions.Builder toBuilder()
-
builder
final static ChatCompletionStreamOptions.Builder builder()
-
-
-
-