Package org.springframework.ai.chat.messages

Enum Class MessageType

java.lang.Object

java.lang.Enum<MessageType>

org.springframework.ai.chat.messages.MessageType

All Implemented Interfaces:

Serializable, Comparable<MessageType>, Constable

public enum MessageType
extends Enum<MessageType>

Enumeration representing types of Messages in a chat application. It can be one of the following: USER, ASSISTANT, SYSTEM, FUNCTION.

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	A Message of type assistant passed in subsequent input Messages as the Message generated in response to the user.
SYSTEM	A Message of type system passed as input Messages containing high-level instructions for the conversation, such as behave like a certain character or provide answers in a specific format.
TOOL	A Message of type function passed as input Messages with function content in a chat application.
USER	A Message of type user, having the user role and originating from an end-user or developer.

Method Summary

Modifier and Type	Method	Description
static MessageType	fromValue(String value)
String	getValue()
static MessageType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MessageType[]	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

USER

public static final MessageType USER

A Message of type user, having the user role and originating from an end-user or developer.

See Also:

• UserMessage

ASSISTANT

public static final MessageType ASSISTANT

A Message of type assistant passed in subsequent input Messages as the Message generated in response to the user.

See Also:

• AssistantMessage

SYSTEM

public static final MessageType SYSTEM

A Message of type system passed as input Messages containing high-level instructions for the conversation, such as behave like a certain character or provide answers in a specific format.

See Also:

• SystemMessage

TOOL

public static final MessageType TOOL

A Message of type function passed as input Messages with function content in a chat application.

See Also:

• ToolResponseMessage

Method Details

values

public static MessageType[] 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 MessageType 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

fromValue

public static MessageType fromValue(String value)

getValue

public String getValue()