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

Enum GPTMessageRole

java.lang.Object

java.lang.Enum<GPTMessageRole>

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

All Implemented Interfaces:

Serializable, Comparable<GPTMessageRole>

public enum GPTMessageRole
extends Enum<GPTMessageRole>

Role of a GPTChatMessage in a dialog with ChatGPT.

See Also:

"https://platform.openai.com/docs/guides/chat"

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSISTANT	The assistant messages help store prior responses.
SYSTEM	The system message helps set the behavior of the assistant.
TOOL	A result of a tool call the assistant made.
USER	The user messages help instruct the assistant.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SYSTEM

@SerializedName("system")
public static final GPTMessageRole SYSTEM

The system message helps set the behavior of the assistant.

USER

@SerializedName("user")
public static final GPTMessageRole USER

The user messages help instruct the assistant.

ASSISTANT

@SerializedName("assistant")
public static final GPTMessageRole ASSISTANT

The assistant messages help store prior responses. It can also serve as an example of desired behavior.

TOOL

@SerializedName("tool")
public static final GPTMessageRole TOOL

A result of a tool call the assistant made.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<GPTMessageRole>