Skip to content

working_memory

WorkingMemory

Bases: BaseModelDict

Represents the volatile memory of a cat, functioning similarly to a dictionary to store temporary custom data.

Attributes:

Name Type Description
history List[HistoryMessage]

A list that maintains the conversation history between the Human and the AI.
user_message_json Optional[UserMessage], default=None

An optional UserMessage object representing the last user message.
active_form Optional[CatForm], default=None

An optional reference to a CatForm currently in use.
recall_query str, default=""

A string that stores the last recall query.
episodic_memories List

A list for storing episodic memories.
declarative_memories List

A list for storing declarative memories.
procedural_memories List

A list for storing procedural memories.
model_interactions List[ModelInteraction]

A list of interactions with models.
Source code in cat/memory/working_memory.py 
 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
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
class WorkingMemory(BaseModelDict):
    """
    Represents the volatile memory of a cat, functioning similarly to a dictionary to store temporary custom data.

    Attributes
    ----------
    history : List[HistoryMessage]
        A list that maintains the conversation history between the Human and the AI.
    user_message_json : Optional[UserMessage], default=None
        An optional UserMessage object representing the last user message.
    active_form : Optional[CatForm], default=None
        An optional reference to a CatForm currently in use.
    recall_query : str, default=""
        A string that stores the last recall query.
    episodic_memories : List
        A list for storing episodic memories.
    declarative_memories : List
        A list for storing declarative memories.
    procedural_memories : List
        A list for storing procedural memories.
    model_interactions : List[ModelInteraction]
        A list of interactions with models.
    """

    history: List[ConversationMessage] = []

    user_message_json: Optional[UserMessage] = None

    active_form: Optional[CatForm] = None
    recall_query: str = ""

    episodic_memories: List = []
    declarative_memories: List = []
    procedural_memories: List = []

    model_interactions: List[ModelInteraction] = []

    def update_conversation_history(self, message: str, who: str, why = {}):
        """
        This method is deprecated. Use `update_history` instead.

        Updates the conversation history with the most recent message.

        Parameters
        ----------
        message :str
            The text content of the message.
        who : str
            The name of the message author.
        why : Optional[Dict[str, Any]], default=None
            Optional explanation for the message.

        Notes
        -----
        This method is deprecated and will be removed in future versions. Use `update_history` instead.
        """

        deprecation_warning(
            "update_conversation_history is deprecated and will be removed in a future release. Use update_history instead."
        )
        role = Role.AI if who == "AI" else Role.Human

        if role == Role.AI:
            content = CatMessage(
                user_id=self.user_message_json.user_id,
                who=who,
                text=message,
                why=why,
            )
        else:
            content = UserMessage(
                user_id=self.user_message_json.user_id,
                who=who,
                text=message
            )

        self.history.append(content)

    def update_history(self, message: ConversationMessage):
        """
        Adds a message to the history.

        Parameters
        ----------
        message : ConversationMessage
            The message, must be of type `ConversationMessage` (typically a subclass like `UserMessage` or `CatMessage`).
        """
        self.history.append(message)


    def stringify_chat_history(self, latest_n: int = 10) -> str:
        """Serialize chat history.
        Converts to text the recent conversation turns.
        Useful for retrocompatibility with old non-chat models, and to easily insert convo into a prompt without using dedicated objects and libraries.

        Parameters
        ----------
        latest_n : int
            How many latest turns to stringify.

        Returns
        -------
        history : str
            String with recent conversation turns.
        """

        history = self.history[-latest_n:]

        history_string = ""
        for turn in history:
            history_string += f"\n - {turn.who}: {turn.text}"

        return history_string

    def langchainfy_chat_history(self, latest_n: int = 10) -> List[BaseMessage]: 
        """Convert chat history in working memory to langchain objects.

        Parameters
        ----------
        latest_n : int
            How many latest turns to convert.

        Returns
        -------
        history : List[BaseMessage]
            List of langchain HumanMessage / AIMessage.
        """
        chat_history = self.history[-latest_n:]
        recent_history = chat_history[-latest_n:]
        langchain_chat_history = []

        for message in recent_history:
            langchain_chat_history.append(
                message.langchainfy()    
            )

        return langchain_chat_history

langchainfy_chat_history(latest_n=10)

Convert chat history in working memory to langchain objects.

Parameters:

Name Type Description Default
latest_n int

How many latest turns to convert.

 10

Returns:

Name Type Description
history List[BaseMessage]

List of langchain HumanMessage / AIMessage.
Source code in cat/memory/working_memory.py 
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
def langchainfy_chat_history(self, latest_n: int = 10) -> List[BaseMessage]: 
    """Convert chat history in working memory to langchain objects.

    Parameters
    ----------
    latest_n : int
        How many latest turns to convert.

    Returns
    -------
    history : List[BaseMessage]
        List of langchain HumanMessage / AIMessage.
    """
    chat_history = self.history[-latest_n:]
    recent_history = chat_history[-latest_n:]
    langchain_chat_history = []

    for message in recent_history:
        langchain_chat_history.append(
            message.langchainfy()    
        )

    return langchain_chat_history

stringify_chat_history(latest_n=10)

Serialize chat history. Converts to text the recent conversation turns. Useful for retrocompatibility with old non-chat models, and to easily insert convo into a prompt without using dedicated objects and libraries.

Parameters:

Name Type Description Default
latest_n int

How many latest turns to stringify.

 10

Returns:

Name Type Description
history str

String with recent conversation turns.
Source code in cat/memory/working_memory.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
def stringify_chat_history(self, latest_n: int = 10) -> str:
    """Serialize chat history.
    Converts to text the recent conversation turns.
    Useful for retrocompatibility with old non-chat models, and to easily insert convo into a prompt without using dedicated objects and libraries.

    Parameters
    ----------
    latest_n : int
        How many latest turns to stringify.

    Returns
    -------
    history : str
        String with recent conversation turns.
    """

    history = self.history[-latest_n:]

    history_string = ""
    for turn in history:
        history_string += f"\n - {turn.who}: {turn.text}"

    return history_string

update_conversation_history(message, who, why={})

This method is deprecated. Use update_history instead.

Updates the conversation history with the most recent message.

Parameters:

Name Type Description Default
message str

The text content of the message.

 required
who str

The name of the message author.

 required
why Optional[Dict[str, Any]]

Optional explanation for the message.

 None
Notes

This method is deprecated and will be removed in future versions. Use update_history instead.

Source code in cat/memory/working_memory.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def update_conversation_history(self, message: str, who: str, why = {}):
    """
    This method is deprecated. Use `update_history` instead.

    Updates the conversation history with the most recent message.

    Parameters
    ----------
    message :str
        The text content of the message.
    who : str
        The name of the message author.
    why : Optional[Dict[str, Any]], default=None
        Optional explanation for the message.

    Notes
    -----
    This method is deprecated and will be removed in future versions. Use `update_history` instead.
    """

    deprecation_warning(
        "update_conversation_history is deprecated and will be removed in a future release. Use update_history instead."
    )
    role = Role.AI if who == "AI" else Role.Human

    if role == Role.AI:
        content = CatMessage(
            user_id=self.user_message_json.user_id,
            who=who,
            text=message,
            why=why,
        )
    else:
        content = UserMessage(
            user_id=self.user_message_json.user_id,
            who=who,
            text=message
        )

    self.history.append(content)

update_history(message)

Adds a message to the history.

Parameters:

Name Type Description Default
message ConversationMessage

The message, must be of type ConversationMessage (typically a subclass like UserMessage or CatMessage).

 required
Source code in cat/memory/working_memory.py 
88
89
90
91
92
93
94
95
96
97
def update_history(self, message: ConversationMessage):
    """
    Adds a message to the history.

    Parameters
    ----------
    message : ConversationMessage
        The message, must be of type `ConversationMessage` (typically a subclass like `UserMessage` or `CatMessage`).
    """
    self.history.append(message)