Skip to main content

//clika-runtime/io.clika.modelverse/FinishReason

FinishReason

[common]
enum FinishReason : Enum<FinishReason>

How a generation ended.

Entries​

STOP[common]
STOP
The model ended its reply on its own.
LENGTH[common]
LENGTH
The reply stopped at the token budget or the context window and may be incomplete.
TOOL_CALLS[common]
TOOL_CALLS
The reply called one or more tools (GenerationReport.toolCalls); its text is the user-facing part.
CANCELED[common]
CANCELED
GenerationHandle.cancel stopped it; the tokens streamed so far stand.
ERROR[common]
ERROR
The runtime failed; GenerationListener.onError carried the message.

Properties​

NameSummary
name[common]
val name: String
ordinal[common]
val ordinal: Int

Functions​

NameSummary
valueOf[common]
fun valueOf(value: String): FinishReason
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
values[common]
fun values(): Array<FinishReason>
Returns an array containing the constants of this enum type, in the order they're declared.