Skip to content

Mem0

Mem0Memory #

Bases: BaseMem0

Source code in llama-index-integrations/memory/llama-index-memory-mem0/llama_index/memory/mem0/base.py 
 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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
class Mem0Memory(BaseMem0):
    primary_memory: SerializeAsAny[BaseMemory] = Field(
        description="Primary memory source for chat agent."
    )
    context: Optional[Mem0Context] = None
    search_msg_limit: int = Field(
        default=5,
        description="Limit of chat history messages to use for context in search API",
    )

    def __init__(self, context: Optional[Mem0Context] = None, **kwargs) -> None:
        super().__init__(**kwargs)
        if context is not None:
            self.context = context

    @classmethod
    def class_name(cls) -> str:
        """Class name."""
        return "Mem0Memory"

    @classmethod
    def from_defaults(cls, **kwargs: Any) -> "Mem0Memory":
        raise NotImplementedError("Use either from_client or from_config")

    @classmethod
    def from_client(
        cls,
        context: Dict[str, Any],
        api_key: Optional[str] = None,
        host: Optional[str] = None,
        organization: Optional[str] = None,
        project: Optional[str] = None,
        search_msg_limit: int = 5,
        **kwargs: Any,
    ):
        primary_memory = ChatMemoryBuffer.from_defaults()

        try:
            context = Mem0Context(**context)
        except ValidationError as e:
            raise ValidationError(f"Context validation error: {e}")

        client = MemoryClient(
            api_key=api_key, host=host, organization=organization, project=project
        )
        return cls(
            primary_memory=primary_memory,
            context=context,
            client=client,
            search_msg_limit=search_msg_limit,
        )

    @classmethod
    def from_config(
        cls,
        context: Dict[str, Any],
        config: Dict[str, Any],
        search_msg_limit: int = 5,
        **kwargs: Any,
    ):
        primary_memory = ChatMemoryBuffer.from_defaults()

        try:
            context = Mem0Context(**context)
        except Exception as e:
            raise ValidationError(f"Context validation error: {e}")

        client = Memory.from_config(config_dict=config)
        return cls(
            primary_memory=primary_memory,
            context=context,
            client=client,
            search_msg_limit=search_msg_limit,
        )

    def get(self, input: Optional[str] = None, **kwargs: Any) -> List[ChatMessage]:
        """Get chat history. With memory system message."""
        messages = self.primary_memory.get(input=input, **kwargs)
        input = convert_messages_to_string(messages, input, limit=self.search_msg_limit)

        search_results = self.search(query=input, **self.context.get_context())

        version = (
            self._client.api_version
            if hasattr(self._client, "api_version")
            else self._client.version
        )
        if isinstance(self._client, Memory) and version == "v1.1":
            search_results = search_results["results"]

        system_message = convert_memory_to_system_message(search_results)

        # If system message is present
        if len(messages) > 0 and messages[0].role == MessageRole.SYSTEM:
            assert messages[0].content is not None
            system_message = convert_memory_to_system_message(
                response=search_results, existing_system_message=messages[0]
            )
        messages.insert(0, system_message)
        return messages

    def get_all(self) -> List[ChatMessage]:
        """Returns all chat history."""
        return self.primary_memory.get_all()

    def _add_msgs_to_client_memory(self, messages: List[ChatMessage]) -> None:
        """Add new user and assistant messages to client memory."""
        self.add(
            messages=convert_chat_history_to_dict(messages),
            **self.context.get_context(),
        )

    def put(self, message: ChatMessage) -> None:
        """Add message to chat history and client memory."""
        self._add_msgs_to_client_memory([message])
        self.primary_memory.put(message)

    def set(self, messages: List[ChatMessage]) -> None:
        """Set chat history and add new messages to client memory."""
        initial_chat_len = len(self.primary_memory.get_all())
        # Insert only new chat messages
        self._add_msgs_to_client_memory(messages[initial_chat_len:])
        self.primary_memory.set(messages)

    def reset(self) -> None:
        """Only reset chat history."""
        self.primary_memory.reset()

class_name classmethod #

class_name() -> str

Class name.

Source code in llama-index-integrations/memory/llama-index-memory-mem0/llama_index/memory/mem0/base.py 
80
81
82
83
@classmethod
def class_name(cls) -> str:
    """Class name."""
    return "Mem0Memory"

get #

get(input: Optional[str] = None, **kwargs: Any) -> List[ChatMessage]

Get chat history. With memory system message.

Source code in llama-index-integrations/memory/llama-index-memory-mem0/llama_index/memory/mem0/base.py 
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
def get(self, input: Optional[str] = None, **kwargs: Any) -> List[ChatMessage]:
    """Get chat history. With memory system message."""
    messages = self.primary_memory.get(input=input, **kwargs)
    input = convert_messages_to_string(messages, input, limit=self.search_msg_limit)

    search_results = self.search(query=input, **self.context.get_context())

    version = (
        self._client.api_version
        if hasattr(self._client, "api_version")
        else self._client.version
    )
    if isinstance(self._client, Memory) and version == "v1.1":
        search_results = search_results["results"]

    system_message = convert_memory_to_system_message(search_results)

    # If system message is present
    if len(messages) > 0 and messages[0].role == MessageRole.SYSTEM:
        assert messages[0].content is not None
        system_message = convert_memory_to_system_message(
            response=search_results, existing_system_message=messages[0]
        )
    messages.insert(0, system_message)
    return messages

get_all #

get_all() -> List[ChatMessage]

Returns all chat history.

Source code in llama-index-integrations/memory/llama-index-memory-mem0/llama_index/memory/mem0/base.py 
166
167
168
def get_all(self) -> List[ChatMessage]:
    """Returns all chat history."""
    return self.primary_memory.get_all()

put #

put(message: ChatMessage) -> None

Add message to chat history and client memory.

Source code in llama-index-integrations/memory/llama-index-memory-mem0/llama_index/memory/mem0/base.py 
177
178
179
180
def put(self, message: ChatMessage) -> None:
    """Add message to chat history and client memory."""
    self._add_msgs_to_client_memory([message])
    self.primary_memory.put(message)

set #

set(messages: List[ChatMessage]) -> None

Set chat history and add new messages to client memory.

Source code in llama-index-integrations/memory/llama-index-memory-mem0/llama_index/memory/mem0/base.py 
182
183
184
185
186
187
def set(self, messages: List[ChatMessage]) -> None:
    """Set chat history and add new messages to client memory."""
    initial_chat_len = len(self.primary_memory.get_all())
    # Insert only new chat messages
    self._add_msgs_to_client_memory(messages[initial_chat_len:])
    self.primary_memory.set(messages)

reset #

reset() -> None

Only reset chat history.

Source code in llama-index-integrations/memory/llama-index-memory-mem0/llama_index/memory/mem0/base.py 
189
190
191
def reset(self) -> None:
    """Only reset chat history."""
    self.primary_memory.reset()