Class CoherenceChatMemoryStore

java.lang.Object

dev.langchain4j.store.memory.chat.coherence.CoherenceChatMemoryStore

All Implemented Interfaces:

ChatMemoryStore

public class CoherenceChatMemoryStore
extends Object
implements ChatMemoryStore

A ChatMemoryStore backed by an Oracle Coherence named map.

The CoherenceChatMemoryStore supports memory identifiers of any type that is a valid Coherence NamedMap key. The key type must properly implement equals() and hashCode() and be serializable by the configured Coherence serializer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CoherenceChatMemoryStore.Builder	A builder to create CoherenceChatMemoryStore instances.

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.tangosol.net.NamedMap<Object,String>	chatMemory	The NamedMap used to store the chat messages.
static final String	DEFAULT_MAP_NAME	The default NamedMap name.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CoherenceChatMemoryStore(com.tangosol.net.NamedMap<Object,String> chatMemory)	Create a CoherenceChatMemoryStore.

Method Summary

Modifier and Type	Method	Description
static CoherenceChatMemoryStore.Builder	builder()	Return a CoherenceChatMemoryStore.Builder to use to build a CoherenceChatMemoryStore.
static CoherenceChatMemoryStore	create()	Create a default CoherenceChatMemoryStore.
static CoherenceChatMemoryStore	create(com.tangosol.net.NamedMap<Object,String> map)	Create a CoherenceChatMemoryStore that uses the specified Coherence NamedMap name.
static CoherenceChatMemoryStore	create(String name)	Create a CoherenceChatMemoryStore that uses the specified Coherence NamedMap name.
void	deleteMessages(Object memoryId)	Deletes all messages for a specified chat memory.
List<ChatMessage>	getMessages(Object memoryId)	Retrieves messages for a specified chat memory.
void	updateMessages(Object memoryId, List<ChatMessage> messages)	Updates messages for a specified chat memory.

Methods inherited from class Object

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

Field Details

DEFAULT_MAP_NAME

public static final String DEFAULT_MAP_NAME

The default NamedMap name.

See Also:

• Constant Field Values

chatMemory

protected final com.tangosol.net.NamedMap<Object,String> chatMemory

The NamedMap used to store the chat messages.

Constructor Details

CoherenceChatMemoryStore

protected CoherenceChatMemoryStore(com.tangosol.net.NamedMap<Object,String> chatMemory)

Create a CoherenceChatMemoryStore.

This method is protected, instances of CoherenceChatMemoryStore are created using the builder.

Parameters:

chatMemory - the NamedMap to store the chat history.

Method Details

getMessages

public List<ChatMessage> getMessages(Object memoryId)

Description copied from interface: ChatMemoryStore

Retrieves messages for a specified chat memory.

Specified by:

getMessages in interface ChatMemoryStore

Parameters:

memoryId - The ID of the chat memory.

Returns:

List of messages for the specified chat memory. Must not be null. Can be deserialized from JSON using ChatMessageDeserializer.

updateMessages

public void updateMessages(Object memoryId,
 List<ChatMessage> messages)

Description copied from interface: ChatMemoryStore

Updates messages for a specified chat memory.

Specified by:

updateMessages in interface ChatMemoryStore

Parameters:

memoryId - The ID of the chat memory.

messages - List of messages for the specified chat memory, that represent the current state of the ChatMemory. Can be serialized to JSON using ChatMessageSerializer.

deleteMessages

public void deleteMessages(Object memoryId)

Description copied from interface: ChatMemoryStore

Deletes all messages for a specified chat memory.

Specified by:

deleteMessages in interface ChatMemoryStore

Parameters:

memoryId - The ID of the chat memory.

create

public static CoherenceChatMemoryStore create()

Create a default CoherenceChatMemoryStore.

Returns:

a default CoherenceChatMemoryStore

create

public static CoherenceChatMemoryStore create(String name)

Create a CoherenceChatMemoryStore that uses the specified Coherence NamedMap name.

Parameters:

name - the name of the Coherence NamedMap used to store chat messages

Returns:

a CoherenceChatMemoryStore

create

public static CoherenceChatMemoryStore create(com.tangosol.net.NamedMap<Object,String> map)

Create a CoherenceChatMemoryStore that uses the specified Coherence NamedMap name.

Parameters:

map - the NamedMap used to store chat messages

Returns:

a CoherenceChatMemoryStore

builder

public static CoherenceChatMemoryStore.Builder builder()

Return a CoherenceChatMemoryStore.Builder to use to build a CoherenceChatMemoryStore.

Returns:

a CoherenceChatMemoryStore.Builder to use to build a CoherenceChatMemoryStore