Class SystemMessage

java.lang.Object

dev.langchain4j.data.message.SystemMessage

All Implemented Interfaces:

ChatMessage

public class SystemMessage
extends Object
implements ChatMessage

Represents a system message, typically defined by a developer. This type of message usually provides instructions regarding the AI's actions, such as its behavior or response style.

Optionally, system message can contain custom attributes represented by a mutable Map. Attributes are not sent to the model, but they are stored in the ChatMemory.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SystemMessage.Builder

Constructor Summary

Constructors

Constructor	Description
SystemMessage(SystemMessage.Builder builder)	Creates a SystemMessage from a builder.
SystemMessage(String text)	Creates a new system message.

Method Summary

Modifier and Type	Method	Description
<T> T	attribute(String key, Class<T> type)	Returns additional attribute by it's key.
Map<String,Object>	attributes()	Returns additional attributes.
static SystemMessage.Builder	builder()
boolean	equals(Object o)
static List<SystemMessage>	findAll(List<ChatMessage> messages)
static Optional<SystemMessage>	findFirst(List<ChatMessage> messages)
static Optional<SystemMessage>	findLast(List<ChatMessage> messages)
static SystemMessage	from(String text)	Creates a new system message.
int	hashCode()
static SystemMessage	systemMessage(String text)	Creates a new system message.
String	text()	Returns the message text.
SystemMessage.Builder	toBuilder()
String	toString()
ChatMessageType	type()	The type of the message.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SystemMessage

public SystemMessage(String text)

Creates a new system message.

Parameters:

text - the message text.

SystemMessage

public SystemMessage(SystemMessage.Builder builder)

Creates a SystemMessage from a builder.

Since:

1.21.0

Method Details

text

public String text()

Returns the message text.

Returns:

the message text.

attributes

@Experimental
public Map<String,Object> attributes()

Returns additional attributes.

Since:

1.21.0

See Also:

• attribute(String, Class)

attribute

@Experimental
public <T> T attribute(String key,
 Class<T> type)

Returns additional attribute by it's key.

Since:

1.21.0

See Also:

• attributes()

type

public ChatMessageType type()

Description copied from interface: ChatMessage

The type of the message.

Specified by:

type in interface ChatMessage

Returns:

the type of the message

toBuilder

public SystemMessage.Builder toBuilder()

Since:

1.21.0

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static SystemMessage.Builder builder()

Since:

1.21.0

from

public static SystemMessage from(String text)

Creates a new system message.

Parameters:

text - the message text.

Returns:

the system message.

systemMessage

public static SystemMessage systemMessage(String text)

Creates a new system message.

Parameters:

text - the message text.

Returns:

the system message.

findFirst

public static Optional<SystemMessage> findFirst(List<ChatMessage> messages)

findLast

public static Optional<SystemMessage> findLast(List<ChatMessage> messages)

findAll

public static List<SystemMessage> findAll(List<ChatMessage> messages)