iragent.memory.BaseMemory Class Reference

Inheritance diagram for iragent.memory.BaseMemory:

Public Member Functions
None	__init__ (self)
None	add_history (self, dict|list[dict] msg)
list[dict]	get_history (self)
None	clear_history (self)
None	add_message (self, Message msg)
list[dict]	get_messages (self)
None	clear_messages (self)

Public Attributes
list	history = []
list	messages = []

Detailed Description

BaseMemory is a foundational memory management class for conversational agents.

It stores two types of information:
- `history`: a list of message dictionaries representing role-based dialogue turns 
             (e.g., user and assistant messages).
- `messages`: a list of raw Message objects, useful for storing additional metadata or original input/output.

This class supports adding, retrieving, and clearing both types of memory and 
is designed to be extended for more advanced memory strategies.

Attributes:
    history (list[dict]): List of role-content dictionaries used in LLM context (e.g., {"role": "user", "content": "Hi"}).
    messages (list[Message]): List of Message objects (structured user inputs/outputs).

Methods:
    add_history(msg): Adds a single dict or list of dicts to the conversation history.
    get_history(): Returns the stored conversation history as a list of dicts.
    clear_history(): Clears the conversation history.

    add_message(msg): Adds a Message object to the internal message list.
    get_messages(): Returns the stored messages as a list.
    clear_messages(): Clears all stored messages.

Constructor & Destructor Documentation

__init__()

None iragent.memory.BaseMemory.__init__

(

self

)

Member Function Documentation

add_history()

None iragent.memory.BaseMemory.add_history	(		self,
		dict | list[dict]	msg )

Reimplemented in iragent.memory.SummarizerMemory.

add_message()

None iragent.memory.BaseMemory.add_message	(		self,
		Message	msg )

clear_history()

None iragent.memory.BaseMemory.clear_history

(

self

)

clear_messages()

None iragent.memory.BaseMemory.clear_messages

(

self

)

get_history()

list[dict] iragent.memory.BaseMemory.get_history

(

self

)

get_messages()

list[dict] iragent.memory.BaseMemory.get_messages

(

self

)

Member Data Documentation

history

list iragent.memory.BaseMemory.history = []

messages

list iragent.memory.BaseMemory.messages = []

---

The documentation for this class was generated from the following file:

• iragent/memory.py