com.theokanning.openai.completion.chat

Enum ChatMessageRole

java.lang.Object

java.lang.Enum<ChatMessageRole>

com.theokanning.openai.completion.chat.ChatMessageRole

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ChatMessageRole>

public enum ChatMessageRole
extends java.lang.Enum<ChatMessageRole>

see ChatMessage documentation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASSISTANT
FUNCTION
SYSTEM
USER

Method Summary

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

SYSTEM

public static final ChatMessageRole SYSTEM

USER

public static final ChatMessageRole USER

ASSISTANT

public static final ChatMessageRole ASSISTANT

FUNCTION

public static final ChatMessageRole FUNCTION

Method Detail

values

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

Returns:

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

valueOf

public static ChatMessageRole valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

value

public java.lang.String value()