Class MessageWindowChatMemory

java.lang.Object

dev.langchain4j.memory.chat.MessageWindowChatMemory

All Implemented Interfaces:

dev.langchain4j.memory.ChatMemory

public class MessageWindowChatMemory
extends Object
implements dev.langchain4j.memory.ChatMemory

This chat memory operates as a sliding window of maxMessages messages. It retains as many of the most recent messages as can fit into the window. If there isn't enough space for a new message, the oldest one is evicted.

Once added, a SystemMessage is always retained. Only one SystemMessage can be held at a time. If a new SystemMessage with the same content is added, it is ignored. If a new SystemMessage with different content is added, the previous SystemMessage is removed.

If an AiMessage containing ToolExecutionRequest(s) is evicted, the following orphan ToolExecutionResultMessage(s) are also automatically evicted to avoid problems with some LLM providers (such as OpenAI) that prohibit sending orphan ToolExecutionResultMessage(s) in the request.

The state of chat memory is stored in ChatMemoryStore (SingleSlotChatMemoryStore is used by default).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MessageWindowChatMemory.Builder

Method Summary

Modifier and Type	Method	Description
void	add(dev.langchain4j.data.message.ChatMessage message)
static MessageWindowChatMemory.Builder	builder()
void	clear()
Object	id()
List<dev.langchain4j.data.message.ChatMessage>	messages()
static MessageWindowChatMemory	withMaxMessages(int maxMessages)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.langchain4j.memory.ChatMemory

add, add

Method Details

id

public Object id()

Specified by:

id in interface dev.langchain4j.memory.ChatMemory

add

public void add(dev.langchain4j.data.message.ChatMessage message)

Specified by:

add in interface dev.langchain4j.memory.ChatMemory

messages

public List<dev.langchain4j.data.message.ChatMessage> messages()

Specified by:

messages in interface dev.langchain4j.memory.ChatMemory

clear

public void clear()

Specified by:

clear in interface dev.langchain4j.memory.ChatMemory

builder

public static MessageWindowChatMemory.Builder builder()

withMaxMessages

public static MessageWindowChatMemory withMaxMessages(int maxMessages)