ai-mocks-openai/dev.mokksy.aimocks.openai/Choice

Choice

@Serializable
data class Choice(val index: Int, val delta: Delta? = null, val message: Message? = null, val logprobs: String? = null, val finishReason: String? = null)(source)

Represents a single choice in a chat completion response.

See also

Constructors

Link copied to clipboard
constructor(index: Int, delta: Delta? = null, message: Message? = null, logprobs: String? = null, finishReason: String? = null)

Properties

Link copied to clipboard
@EncodeDefault(mode = EncodeDefault.Mode.NEVER)
val delta: Delta?

A delta message for streaming responses.

Link copied to clipboard
@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)
@SerialName(value = "finish_reason")
val finishReason: String?

The reason the model stopped generating tokens.

Link copied to clipboard
val index: Int

The index of this choice in the list of choices.

Link copied to clipboard
@EncodeDefault(mode = EncodeDefault.Mode.ALWAYS)
val logprobs: String?

Log probability information for the choice.

Link copied to clipboard
@EncodeDefault(mode = EncodeDefault.Mode.NEVER)
val message: Message?

The full message for non-streaming responses.

Generated by Dokka
Copyright © 2025-2026 Konstantin Pavlov