Package smile.llm

Enum Class FinishReason

java.lang.Object

java.lang.Enum<FinishReason>

smile.llm.FinishReason

All Implemented Interfaces:

Serializable, Comparable<FinishReason>, Constable

public enum FinishReason
extends Enum<FinishReason>

The reasons that the chat completions finish.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
content_filter	Omitted content due to a flag from content filters.
function_call	The model decided to call a function.
length	Incomplete model output due to token limit.
stop	A message terminated by one of the stop tokens.

Method Summary

Modifier and Type	Method	Description
static FinishReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FinishReason[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

stop

public static final FinishReason stop

A message terminated by one of the stop tokens.

length

public static final FinishReason length

Incomplete model output due to token limit.

function_call

public static final FinishReason function_call

The model decided to call a function.

content_filter

public static final FinishReason content_filter

Omitted content due to a flag from content filters.

Method Details

values

public static FinishReason[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FinishReason valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null