Package org.springframework.ai.openai.api

Enum Class OpenAiApi.ChatCompletionMessage.Role

java.lang.Object

java.lang.Enum<OpenAiApi.ChatCompletionMessage.Role>

org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.Role

All Implemented Interfaces:

Serializable, Comparable<OpenAiApi.ChatCompletionMessage.Role>, Constable

Enclosing class:

OpenAiApi.ChatCompletionMessage

public static enum OpenAiApi.ChatCompletionMessage.Role
extends Enum<OpenAiApi.ChatCompletionMessage.Role>

The role of the author of this message.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSISTANT	Assistant message.
SYSTEM	System message.
TOOL	Tool message.
USER	User message.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SYSTEM

public static final OpenAiApi.ChatCompletionMessage.Role SYSTEM

System message.

USER

public static final OpenAiApi.ChatCompletionMessage.Role USER

User message.

ASSISTANT

public static final OpenAiApi.ChatCompletionMessage.Role ASSISTANT

Assistant message.

TOOL

public static final OpenAiApi.ChatCompletionMessage.Role TOOL

Tool message.

Method Details

values

public static OpenAiApi.ChatCompletionMessage.Role[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static OpenAiApi.ChatCompletionMessage.Role valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null