Package dev.langchain4j.data.message

Enum Class ChatMessageType

java.lang.Object

java.lang.Enum<ChatMessageType>

dev.langchain4j.data.message.ChatMessageType

All Implemented Interfaces:

Serializable, Comparable<ChatMessageType>, Constable

public enum ChatMessageType
extends Enum<ChatMessageType>

The type of content, e.g. text or image. Maps to implementations of ChatMessage.

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
AI	A message from the AI.
CUSTOM	A custom message.
SYSTEM	A message from the system, typically defined by a developer.
TOOL_EXECUTION_RESULT	A message from a tool.
USER	A message from the user.

Method Summary

Modifier and Type	Method	Description
Class<? extends ChatMessage>	messageClass()	Returns the class of the message type.
static ChatMessageType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ChatMessageType[]	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 ChatMessageType SYSTEM

A message from the system, typically defined by a developer.

USER

public static final ChatMessageType USER

A message from the user.

AI

public static final ChatMessageType AI

A message from the AI.

TOOL_EXECUTION_RESULT

public static final ChatMessageType TOOL_EXECUTION_RESULT

A message from a tool.

CUSTOM

public static final ChatMessageType CUSTOM

A custom message.

Method Details

values

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

messageClass

public Class<? extends ChatMessage> messageClass()

Returns the class of the message type.

Returns:

the class of the message type.