dev.langchain4j.model.output

Enum FinishReason

java.lang.Object

java.lang.Enum<FinishReason>

dev.langchain4j.model.output.FinishReason

All Implemented Interfaces:

Serializable, Comparable<FinishReason>

public enum FinishReason
extends Enum<FinishReason>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTENT_FILTER
LENGTH
STOP
TOOL_EXECUTION

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STOP

public static final FinishReason STOP

LENGTH

public static final FinishReason LENGTH

TOOL_EXECUTION

public static final FinishReason TOOL_EXECUTION

CONTENT_FILTER

public static final FinishReason CONTENT_FILTER

Method Detail

values

public static FinishReason[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FinishReason c : FinishReason.values())
    System.out.println(c);

Returns:

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

valueOf

public static FinishReason valueOf(String name)

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.)

Parameters:

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

Returns:

the enum constant with the specified name

Throws:

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

NullPointerException - if the argument is null