agents::Memory Class Reference

Interface for agent memory storage. More...

#include <memory.h>

Public Member Functions
virtual void	add (const std::string &key, const JsonObject &value, MemoryType type=MemoryType::SHORT_TERM)=0
	Add a memory entry.
virtual std::optional< JsonObject >	get (const std::string &key, MemoryType type=MemoryType::SHORT_TERM) const =0
	Get a memory entry by key.
virtual bool	has (const std::string &key, MemoryType type=MemoryType::SHORT_TERM) const =0
	Check if a memory entry exists.
virtual void	remove (const std::string &key, MemoryType type=MemoryType::SHORT_TERM)=0
	Remove a memory entry.
virtual void	clear (MemoryType type=MemoryType::SHORT_TERM)=0
	Clear all memory of a specific type.
virtual void	addMessage (const Message &message)=0
	Add a conversation message to memory.
virtual std::vector< Message >	getMessages () const =0
	Get all conversation messages.
virtual std::string	getConversationSummary (int max_length=0) const =0
	Get conversation summary as a string.
virtual JsonObject	getConversationHistory () const =0
	Get conversation history as a JSON object.
virtual void	flushToPersistent (std::shared_ptr< LLMInterface > llm=nullptr)=0
	Flush ephemeral memory to persistent storage (pre-compaction hook). If an LLM is provided, performs a silent agentic turn to intelligently extract and persist key facts from the conversation before compaction.
virtual std::vector< std::pair< JsonObject, float > >	search (const std::string &query, MemoryType type=MemoryType::LONG_TERM, int max_results=5) const =0
	Semantic search in memory with hybrid scoring (vector + BM25 + temporal decay).
virtual void	addFact (const std::string &key, const JsonObject &value)=0
	Add a fact to long-term memory (persistent facts).
virtual std::optional< JsonObject >	getFact (const std::string &key) const =0
	Get a fact from long-term memory.

Detailed Description

Interface for agent memory storage.

Memory stores information that can be retrieved by the agent, such as conversation history, retrieved documents, or intermediate results.

Member Function Documentation

add()

virtual void agents::Memory::add ( const std::string & key, const JsonObject & value, MemoryType type = MemoryType::SHORT_TERM )

pure virtual

Add a memory entry.

Parameters

key	The key to add
value	The value to add
type	The type of memory to add

addFact()

virtual void agents::Memory::addFact ( const std::string & key, const JsonObject & value )

pure virtual

Add a fact to long-term memory (persistent facts).

Parameters

key	The key to add
value	The value to add

addMessage()

virtual void agents::Memory::addMessage ( const Message & message )

pure virtual

Add a conversation message to memory.

Parameters

message

The message to add

clear()

virtual void agents::Memory::clear ( MemoryType type = MemoryType::SHORT_TERM )

pure virtual

Clear all memory of a specific type.

Parameters

type	The type of memory to clear

flushToPersistent()

virtual void agents::Memory::flushToPersistent ( std::shared_ptr< LLMInterface > llm = nullptr )

pure virtual

Flush ephemeral memory to persistent storage (pre-compaction hook). If an LLM is provided, performs a silent agentic turn to intelligently extract and persist key facts from the conversation before compaction.

Parameters

llm	Optional LLM to use for intelligent fact extraction

get()

virtual std::optional< JsonObject > agents::Memory::get ( const std::string & key, MemoryType type = MemoryType::SHORT_TERM ) const

pure virtual

Get a memory entry by key.

Parameters

key	The key to get
type	The type of memory to get

Returns

The memory entry

getConversationHistory()

virtual JsonObject agents::Memory::getConversationHistory ( ) const

pure virtual

Get conversation history as a JSON object.

Returns

The conversation history

getConversationSummary()

virtual std::string agents::Memory::getConversationSummary ( int max_length = 0 ) const

pure virtual

Get conversation summary as a string.

Parameters

max_length

The maximum length of the summary

Returns

The conversation summary

getFact()

virtual std::optional< JsonObject > agents::Memory::getFact ( const std::string & key ) const

pure virtual

Get a fact from long-term memory.

Parameters

key	The key to get

Returns

The fact

getMessages()

virtual std::vector< Message > agents::Memory::getMessages ( ) const

pure virtual

Get all conversation messages.

Returns

The conversation messages

has()

virtual bool agents::Memory::has ( const std::string & key, MemoryType type = MemoryType::SHORT_TERM ) const

pure virtual

Check if a memory entry exists.

Parameters

key	The key to check
type	The type of memory to check

Returns

true if exists, otherwise false

remove()

virtual void agents::Memory::remove ( const std::string & key, MemoryType type = MemoryType::SHORT_TERM )

pure virtual

Remove a memory entry.

Parameters

key	The key to remove
type	The type of memory to remove

search()

virtual std::vector< std::pair< JsonObject, float > > agents::Memory::search ( const std::string & query, MemoryType type = MemoryType::LONG_TERM, int max_results = 5 ) const

pure virtual

Semantic search in memory with hybrid scoring (vector + BM25 + temporal decay).

Parameters

query	The query to search for
type	The type of memory to search
max_results	The maximum number of results to return

Returns

The search results