openai-core/com.aallam.openai.api.chat/StreamOptions

StreamOptions

@Serializable

data class StreamOptions(val includeUsage: Boolean? = null)

Options for streaming response.

Constructors

StreamOptions

constructor(includeUsage: Boolean? = null)

Properties

includeUsage

@SerialName(value = "include_usage")

val includeUsage: Boolean? = null

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.