-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
271 additions
and
282 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -45,161 +45,103 @@ | |
|
|
||
| [Mem0](https://mem0.ai) (pronounced as "mem-zero") enhances AI assistants and agents with an intelligent memory layer, enabling personalized AI interactions. Mem0 remembers user preferences, adapts to individual needs, and continuously improves over time, making it ideal for customer support chatbots, AI assistants, and autonomous systems. | ||
|
|
||
| <!-- Start of Selection --> | ||
| <p style="display: flex;"> | ||
| <span style="font-size: 1.2em;">New Feature: Introducing Graph Memory. Check out our <a href="https://docs.mem0.ai/open-source/graph-memory" target="_blank">documentation</a>.</span> | ||
| </p> | ||
| <!-- End of Selection --> | ||
|
|
||
|
|
||
| ### Core Features | ||
|
|
||
| - **Multi-Level Memory**: User, Session, and AI Agent memory retention | ||
| - **Adaptive Personalization**: Continuous improvement based on interactions | ||
| - **Developer-Friendly API**: Simple integration into various applications | ||
| - **Cross-Platform Consistency**: Uniform behavior across devices | ||
| - **Managed Service**: Hassle-free hosted solution | ||
|
|
||
| ### How Mem0 works? | ||
|
|
||
| Mem0 leverages a hybrid database approach to manage and retrieve long-term memories for AI agents and assistants. Each memory is associated with a unique identifier, such as a user ID or agent ID, allowing Mem0 to organize and access memories specific to an individual or context. | ||
|
|
||
| When a message is added to the Mem0 using add() method, the system extracts relevant facts and preferences and stores it across data stores: a vector database, a key-value database, and a graph database. This hybrid approach ensures that different types of information are stored in the most efficient manner, making subsequent searches quick and effective. | ||
| ### Features & Use Cases | ||
|
|
||
| When an AI agent or LLM needs to recall memories, it uses the search() method. Mem0 then performs search across these data stores, retrieving relevant information from each source. This information is then passed through a scoring layer, which evaluates their importance based on relevance, importance, and recency. This ensures that only the most personalized and useful context is surfaced. | ||
| Core Capabilities: | ||
| - **Multi-Level Memory**: User, Session, and AI Agent memory retention with adaptive personalization | ||
| - **Developer-Friendly**: Simple API integration, cross-platform consistency, and hassle-free managed service | ||
|
|
||
| The retrieved memories can then be appended to the LLM's prompt as needed, enhancing the personalization and relevance of its responses. | ||
|
|
||
| ### Use Cases | ||
|
|
||
| Mem0 empowers organizations and individuals to enhance: | ||
|
|
||
| - **AI Assistants and agents**: Seamless conversations with a touch of déjà vu | ||
| - **Personalized Learning**: Tailored content recommendations and progress tracking | ||
| - **Customer Support**: Context-aware assistance with user preference memory | ||
| - **Healthcare**: Patient history and treatment plan management | ||
| - **Virtual Companions**: Deeper user relationships through conversation memory | ||
| - **Productivity**: Streamlined workflows based on user habits and task history | ||
| - **Gaming**: Adaptive environments reflecting player choices and progress | ||
| Applications: | ||
| - **AI Assistants**: Seamless conversations with context and personalization | ||
| - **Learning & Support**: Tailored content recommendations and context-aware customer assistance | ||
| - **Healthcare & Companions**: Patient history tracking and deeper relationship building | ||
| - **Productivity & Gaming**: Streamlined workflows and adaptive environments based on user behavior | ||
|
|
||
| ## Get Started | ||
|
|
||
| The easiest way to set up Mem0 is through the managed [Mem0 Platform](https://app.mem0.ai). This hosted solution offers automatic updates, advanced analytics, and dedicated support. [Sign up](https://app.mem0.ai) to get started. | ||
| Get started quickly with [Mem0 Platform](https://app.mem0.ai) - our fully managed solution that provides automatic updates, advanced analytics, enterprise security, and dedicated support. [Create a free account](https://app.mem0.ai) to begin. | ||
|
|
||
| If you prefer to self-host, use the open-source Mem0 package. Follow the [installation instructions](#install) to get started. | ||
| For complete control, you can self-host Mem0 using our open-source package. See the [Quickstart guide](#quickstart) below to set up your own instance. | ||
|
|
||
| ## Installation Instructions <a name="install"></a> | ||
| ## Quickstart Guide <a name="quickstart"></a> | ||
|
|
||
| Install the Mem0 package via pip: | ||
|
|
||
| ```bash | ||
| pip install mem0ai | ||
| ``` | ||
|
|
||
| Alternatively, you can use Mem0 with one click on the hosted platform [here](https://app.mem0.ai/). | ||
|
|
||
| ### Basic Usage | ||
|
|
||
| Mem0 requires an LLM to function, with `gpt-4o` from OpenAI as the default. However, it supports a variety of LLMs; for details, refer to our [Supported LLMs documentation](https://docs.mem0.ai/llms). | ||
|
|
||
| First step is to instantiate the memory: | ||
|
|
||
| ```python | ||
| from openai import OpenAI | ||
| from mem0 import Memory | ||
|
|
||
| m = Memory() | ||
| openai_client = OpenAI() | ||
| mem0 = Memory() | ||
|
|
||
| def chat_with_memories(message: str, user_id: str = "default_user") -> str: | ||
| # Retrieve relevant memories | ||
| relevant_memories = mem0.search(query=message, user_id=user_id, limit=3) | ||
| memories_str = "\n".join(f"- {entry['memory']}" for entry in relevant_memories) | ||
|
|
||
| # Generate Assistant response | ||
| system_prompt = f"You are a helpful AI. Answer the question based on query and memories.\nUser Memories:\n{memories_str}" | ||
| messages = [{"role": "system", "content": system_prompt}, {"role": "user", "content": message}] | ||
| response = openai_client.chat.completions.create(model="gpt-4o-mini", messages=messages) | ||
| assistant_response = response.choices[0].message.content | ||
|
|
||
| # Create new memories from the conversation | ||
| messages.append({"role": "assistant", "content": assistant_response}) | ||
| mem0.add(messages, user_id=user_id) | ||
|
|
||
| return assistant_response | ||
|
|
||
| def main(): | ||
| print("Chat with AI (type 'exit' to quit)") | ||
| while True: | ||
| user_input = input("You: ").strip() | ||
| if user_input.lower() == 'exit': | ||
| print("Goodbye!") | ||
| break | ||
| print(f"AI: {chat_with_memories(user_input)}") | ||
|
|
||
| if __name__ == "__main__": | ||
| main() | ||
| ``` | ||
|
|
||
| <details> | ||
| <summary>How to set OPENAI_API_KEY</summary> | ||
|
|
||
| ```python | ||
| import os | ||
| os.environ["OPENAI_API_KEY"] = "sk-xxx" | ||
| ``` | ||
| </details> | ||
|
|
||
|
|
||
| You can perform the following task on the memory: | ||
|
|
||
| 1. Add: Store a memory from any unstructured text | ||
| 2. Update: Update memory of a given memory_id | ||
| 3. Search: Fetch memories based on a query | ||
| 4. Get: Return memories for a certain user/agent/session | ||
| 5. History: Describe how a memory has changed over time for a specific memory ID | ||
|
|
||
| ```python | ||
| # 1. Add: Store a memory from any unstructured text | ||
| result = m.add("I am working on improving my tennis skills. Suggest some online courses.", user_id="alice", metadata={"category": "hobbies"}) | ||
|
|
||
| # Created memory --> 'Improving her tennis skills.' and 'Looking for online suggestions.' | ||
| ``` | ||
|
|
||
| ```python | ||
| # 2. Update: update the memory | ||
| result = m.update(memory_id=<memory_id_1>, data="Likes to play tennis on weekends") | ||
|
|
||
| # Updated memory --> 'Likes to play tennis on weekends.' and 'Looking for online suggestions.' | ||
| ``` | ||
|
|
||
| ```python | ||
| # 3. Search: search related memories | ||
| related_memories = m.search(query="What are Alice's hobbies?", user_id="alice") | ||
|
|
||
| # Retrieved memory --> 'Likes to play tennis on weekends' | ||
| ``` | ||
|
|
||
| ```python | ||
| # 4. Get all memories | ||
| all_memories = m.get_all() | ||
| memory_id = all_memories["memories"][0] ["id"] # get a memory_id | ||
|
|
||
| # All memory items --> 'Likes to play tennis on weekends.' and 'Looking for online suggestions.' | ||
| ``` | ||
|
|
||
| ```python | ||
| # 5. Get memory history for a particular memory_id | ||
| history = m.history(memory_id=<memory_id_1>) | ||
|
|
||
| # Logs corresponding to memory_id_1 --> {'prev_value': 'Working on improving tennis skills and interested in online courses for tennis.', 'new_value': 'Likes to play tennis on weekends' } | ||
| ``` | ||
| For more advanced usage and API documentation, visit our [documentation](https://docs.mem0.ai). | ||
|
|
||
| > [!TIP] | ||
| > If you prefer a hosted version without the need to set up infrastructure yourself, check out the [Mem0 Platform](https://app.mem0.ai/) to get started in minutes. | ||
| > For a hassle-free experience, try our [hosted platform](https://app.mem0.ai) with automatic updates and enterprise features. | ||
| ## Demos | ||
|
|
||
| ### Graph Memory | ||
| To initialize Graph Memory you'll need to set up your configuration with graph store providers. | ||
| Currently, we support Neo4j as a graph store provider. You can setup [Neo4j](https://neo4j.com/) locally or use the hosted [Neo4j AuraDB](https://neo4j.com/product/auradb/). | ||
| Moreover, you also need to set the version to `v1.1` (*prior versions are not supported*). | ||
| Here's how you can do it: | ||
| - AI Companion: Experience personalized conversations with an AI that remembers your preferences and past interactions | ||
|
|
||
| ```python | ||
| from mem0 import Memory | ||
|
|
||
| config = { | ||
| "graph_store": { | ||
| "provider": "neo4j", | ||
| "config": { | ||
| "url": "neo4j+s://xxx", | ||
| "username": "neo4j", | ||
| "password": "xxx" | ||
| } | ||
| }, | ||
| "version": "v1.1" | ||
| } | ||
|  | ||
|
|
||
| m = Memory.from_config(config_dict=config) | ||
| <br/><br/> | ||
|
|
||
| ``` | ||
| - Enhance your AI interactions by storing memories across ChatGPT, Perplexity, and Claude using our browser extension. | ||
|
|
||
| ## Documentation | ||
|  | ||
|
|
||
| For detailed usage instructions and API reference, visit our documentation at [docs.mem0.ai](https://docs.mem0.ai). Here, you can find more information on both the open-source version and the hosted [Mem0 Platform](https://app.mem0.ai). | ||
|
|
||
| ## Star History | ||
| ## Documentation | ||
|
|
||
| [](https://star-history.com/#mem0ai/mem0&Date) | ||
| For detailed usage instructions and API reference, visit our [documentation](https://docs.mem0.ai). You'll find: | ||
| - Complete API reference | ||
| - Integration guides | ||
| - Advanced configuration options | ||
| - Best practices and examples | ||
| - More details about: | ||
| - Open-source version | ||
| - [Hosted Mem0 Platform](https://app.mem0.ai) | ||
|
|
||
| ## Support | ||
|
|
||
|
|
@@ -209,20 +151,6 @@ Join our community for support and discussions. If you have any questions, feel | |
| - [Follow us on Twitter](https://x.com/mem0ai) | ||
| - [Email founders](mailto:[email protected]) | ||
|
|
||
| ## Contributors | ||
|
|
||
| Join our [Discord community](https://mem0.dev/DiG) to learn about memory management for AI agents and LLMs, and connect with Mem0 users and contributors. Share your ideas, questions, or feedback in our [GitHub Issues](https://github.com/mem0ai/mem0/issues). | ||
|
|
||
| We value and appreciate the contributions of our community. Special thanks to our contributors for helping us improve Mem0. | ||
|
|
||
| <a href="https://github.com/mem0ai/mem0/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=mem0ai/mem0" /> | ||
| </a> | ||
|
|
||
| ## Anonymous Telemetry | ||
|
|
||
| We collect anonymous usage metrics to enhance our package's quality and user experience. This includes data like feature usage frequency and system info, but never personal details. The data helps us prioritize improvements and ensure compatibility. If you wish to opt-out, set the environment variable MEM0_TELEMETRY=false. We prioritize data security and don't share this data externally. | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details. | ||
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.