Package com.openai.models
Class ChatCompletionStreamOptions
-
- All Implemented Interfaces:
public final class ChatCompletionStreamOptions
Options for streaming response. Only set this when you set
stream: true
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ChatCompletionStreamOptions.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 ChatCompletionStreamOptions
validate()
final ChatCompletionStreamOptions.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ChatCompletionStreamOptions.Builder
builder()
-
-
Method Detail
-
includeUsage
final Optional<Boolean> includeUsage()
If set, an additional chunk will be streamed before the
data: [DONE]
message. Theusage
field on this chunk shows the token usage statistics for the entire request, and thechoices
field will always be an empty array. All other chunks will also include ausage
field, but with a null value.
-
_includeUsage
final JsonField<Boolean> _includeUsage()
If set, an additional chunk will be streamed before the
data: [DONE]
message. Theusage
field on this chunk shows the token usage statistics for the entire request, and thechoices
field will always be an empty array. All other chunks will also include ausage
field, 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()
-
-
-
-