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

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)

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

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

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)