Skip to content

working_memory

WorkingMemory

Bases: BaseModelDict

Cat's volatile memory.

Handy class that behaves like a dict to store temporary custom data.

Returns:

Type Description
dict[str, list]

Default instance is a dictionary with history key set to an empty list.
Notes

The constructor instantiates a dictionary with a history key set to an empty list that is further used to store the conversation turns between the Human and the AI.

Source code in cat/memory/working_memory.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
class WorkingMemory(BaseModelDict):
    """Cat's volatile memory.

    Handy class that behaves like a `dict` to store temporary custom data.

    Returns
    -------
    dict[str, list]
        Default instance is a dictionary with `history` key set to an empty list.

    Notes
    -----
    The constructor instantiates a dictionary with a `history` key set to an empty list that is further used to store
    the conversation turns between the Human and the AI.
    """

    # stores conversation history
    history: List = []
    user_message_json: None | UserMessage = None
    active_form: None | CatForm = None

    # recalled memories attributes
    recall_query: str = ""
    episodic_memories: List = []
    declarative_memories: List = []
    procedural_memories: List = []

    # track models usage
    model_interactions: List[ModelInteraction] = []

    def update_conversation_history(self, who, message, why={}):
        """Update the conversation history.

        The methods append to the history key the last three conversation turns.

        Parameters
        ----------
        who : str
            Who said the message. Can either be `Human` or `AI`.
        message : str
            The message said.

        """
        # append latest message in conversation
        # TODO: Message should be of type CatMessage or UserMessage. For retrocompatibility we put a new key
        # we are sure that who is not change in the current call
        self.history.append(
            {
                "who": who,
                "message": message,
                "why": why,
                "when": time.time(),
                "role": Role.AI if who == "AI" else Role.Human,
            }
        )

update_conversation_history(who, message, why={})

Update the conversation history.

The methods append to the history key the last three conversation turns.

Parameters:

Name Type Description Default
who str

Who said the message. Can either be Human or AI.

 required
message str

The message said.

 required
Source code in cat/memory/working_memory.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def update_conversation_history(self, who, message, why={}):
    """Update the conversation history.

    The methods append to the history key the last three conversation turns.

    Parameters
    ----------
    who : str
        Who said the message. Can either be `Human` or `AI`.
    message : str
        The message said.

    """
    # append latest message in conversation
    # TODO: Message should be of type CatMessage or UserMessage. For retrocompatibility we put a new key
    # we are sure that who is not change in the current call
    self.history.append(
        {
            "who": who,
            "message": message,
            "why": why,
            "when": time.time(),
            "role": Role.AI if who == "AI" else Role.Human,
        }
    )