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

Enum ChatCompletionRequest.Role

java.lang.Object

java.lang.Enum<ChatCompletionRequest.Role>

com.composum.ai.backend.base.service.chat.impl.chatmodel.ChatCompletionRequest.Role

All Implemented Interfaces:

Serializable, Comparable<ChatCompletionRequest.Role>

Enclosing class:

ChatCompletionRequest

public static enum ChatCompletionRequest.Role
extends Enum<ChatCompletionRequest.Role>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSISTANT
SYSTEM
TOOL
USER

Method Summary

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

USER

@SerializedName("user")
public static final ChatCompletionRequest.Role USER

ASSISTANT

@SerializedName("assistant")
public static final ChatCompletionRequest.Role ASSISTANT

SYSTEM

@SerializedName("system")
public static final ChatCompletionRequest.Role SYSTEM

TOOL

@SerializedName("tool")
public static final ChatCompletionRequest.Role TOOL

Method Detail

values

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

Returns:

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

valueOf

public static ChatCompletionRequest.Role 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

make

public static ChatCompletionRequest.Role make(GPTMessageRole role)