Package chat.octet.model.enums

Enum Class FinishReason

java.lang.Object

java.lang.Enum<FinishReason>

chat.octet.model.enums.FinishReason

All Implemented Interfaces:

Serializable, Comparable<FinishReason>, java.lang.constant.Constable

public enum FinishReason
extends Enum<FinishReason>

Token generate status

Author:

William

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
FINISHED	Completed generation.
LENGTH	Generation has exceeded the maximum token limit and has been truncated.
NONE	Default type.
STOP	Generation stopped by StoppingCriteria.
TRUNCATED	Generation has exceeded the maximum context limit and has been truncated.
UNKNOWN	Unknown type, no available token state.

Method Summary

Modifier and Type	Method	Description
boolean	isFinished()	Check if the token has been completed else return false.
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

FINISHED

public static final FinishReason FINISHED

Completed generation.

LENGTH

public static final FinishReason LENGTH

Generation has exceeded the maximum token limit and has been truncated.

STOP

public static final FinishReason STOP

Generation stopped by StoppingCriteria.

See Also:

• StoppingCriteria

NONE

public static final FinishReason NONE

Default type.

UNKNOWN

public static final FinishReason UNKNOWN

Unknown type, no available token state.

TRUNCATED

public static final FinishReason TRUNCATED

Generation has exceeded the maximum context limit and has been truncated.

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

isFinished

public boolean isFinished()

Check if the token has been completed else return false. Finished reason: FINISHED / LENGTH / STOP / TRUNCATED

Returns:

boolean