Package com.composum.ai.backend.base.service.chat

Enum GPTFinishReason

java.lang.Object

java.lang.Enum<GPTFinishReason>

com.composum.ai.backend.base.service.chat.GPTFinishReason

All Implemented Interfaces:

Serializable, Comparable<GPTFinishReason>

public enum GPTFinishReason
extends Enum<GPTFinishReason>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTENT_FILTER	Omitted content due to a flag from our content filters.
FUNCTION_CALL	Deprecated.
LENGTH	The response is not complete, but the maximum length has been reached.
STOP	The response is complete.
TOOL_CALLS	Model decided to call one or more tools.

Method Summary

Modifier and Type	Method	Description
static GPTFinishReason	fromChatGPT(String chatGptRepresentation)
static GPTFinishReason	valueOf(String name)	Returns the enum constant of this type with the specified name.
static GPTFinishReason[]	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 GPTFinishReason STOP

The response is complete.

LENGTH

public static final GPTFinishReason LENGTH

The response is not complete, but the maximum length has been reached.

FUNCTION_CALL

@Deprecated
public static final GPTFinishReason FUNCTION_CALL

Deprecated.

Model decided to call a function.

TOOL_CALLS

public static final GPTFinishReason TOOL_CALLS

Model decided to call one or more tools.

CONTENT_FILTER

public static final GPTFinishReason CONTENT_FILTER

Omitted content due to a flag from our content filters.

Method Detail

values

public static GPTFinishReason[] 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 (GPTFinishReason c : GPTFinishReason.values())
    System.out.println(c);

Returns:

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

valueOf

public static GPTFinishReason 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

fromChatGPT

@Nullable
public static GPTFinishReason fromChatGPT(@Nullable
                                          String chatGptRepresentation)