ChatGPT-Java-API/com.cjcrafter.openai.chat/ChatChoiceChunk

ChatChoiceChunk

data class ChatChoiceChunk(val index: Int, var delta: ChatMessageDelta? = null, var finishReason: FinishReason?)

The OpenAI API returns a list of ChatChoiceChunk. The "new content" is saved to the delta property. To access everything that is currently generated, use message.

By default, only 1 ChatChoiceChunk is generated (since ChatRequest.n == 1). When you increase n, more options are generated. The more options you generate, the more tokens you use. In general, it is best to ONLY generate 1 response, and to let the user regenerate the response.

Since

1.2.0

Constructors

ChatChoiceChunk

constructor(index: Int, delta: ChatMessageDelta? = null, finishReason: FinishReason?)

Create a new chat choice, for internal usage.

Functions

isFinished

fun isFinished(): Boolean

Returns true if this message chunk is complete. Once complete, no more tokens will be generated, and ChatChoiceChunk.message will contain the complete message.