The Memory Layer for AI Agents - Drop-in memory infrastructure for AI agents and apps. Context that persists. Built for production.
Python agentic-memoryagentic-memory-systemagentsaiai-agentschatgptgenaillmlong-term-memorymemorymemory-managementpythonragstate-management
Update docs and README (#1546)
Deshraj Yadav04b0297ae457
diff --git a/README.md b/README.mdindex 360802cf3..c3d38b59e 100644--- a/README.md+++ b/README.md@@ -1,5 +1,5 @@<p align="center">- <img src="docs/images/mem0-bg.png" width="500px" alt="Mem0 Logo">+ <img src="docs/images/banner.png" width="800px" alt="Mem0 Logo"></p><p align="center">@@ -12,6 +12,9 @@<a href="https://x.com/mem0ai"><img src="https://img.shields.io/twitter/follow/mem0ai" alt="Mem0 Twitter"></a>+ <a href="https://www.ycombinator.com/companies/mem0"><img src="https://img.shields.io/badge/Y%20Combinator-S24-orange?style=flat-square" alt="Y Combinator S24"></a>+ <a href="https://www.npmjs.com/package/mem0ai"><img src="https://img.shields.io/npm/v/mem0ai?style=flat-square&label=npm+mem0ai" alt="mem0ai npm package"></a>+ <a href="https://pypi.python.org/pypi/mem0ai"><img src="https://img.shields.io/pypi/v/mem0ai.svg?style=flat-square&label=pypi+mem0ai" alt="mem0ai Python package on PyPi"></a></p># Mem0: The Memory Layer for Personalized AIdiff --git a/docs/images/banner.png b/docs/images/banner.pngnew file mode 100644index 000000000..fa91210b6Binary files /dev/null and b/docs/images/banner.png differdiff --git a/docs/overview.mdx b/docs/overview.mdxindex 83fc107e3..317d09644 100644--- a/docs/overview.mdx+++ b/docs/overview.mdx@@ -16,11 +16,14 @@ description: 'Welcome to the Mem0 docs!'If you are looking to quick start, jump to one of the following links:<CardGroup cols={2}>- <Card title="Quickstart" icon="square-1" href="/quickstart/">- Jump to quickstart section to get started+ <Card title="Open Source Quickstart" icon="square-1" href="/quickstart/">+ Get started with Mem0 open source</Card>- <Card title="Examples" icon="square-2" href="/examples/overview/">- Checkout curated examples+ <Card title="Mem0 Platform Quickstart" icon="square-2" href="/platform/quickstart/">+ Begin with Mem0 Platform+ </Card>+ <Card title="Examples" icon="square-3" href="/examples/overview/">+ Explore practical use cases</Card></CardGroup>diff --git a/docs/platform/quickstart.mdx b/docs/platform/quickstart.mdxindex 7c75a2a3d..27617c8c6 100644--- a/docs/platform/quickstart.mdx+++ b/docs/platform/quickstart.mdx@@ -5,12 +5,17 @@ description: 'Get started with Mem0 Platform in minutes'## 1. Installation-Install the Mem0 Python package:--```bash+<CodeGroup>+```bash pippip install mem0ai```+```bash npm+npm install mem0ai+```++</CodeGroup>+## 2. API Key Setup1. Sign in to [Mem0 Platform](https://app.mem0.ai/dashboard/api-keys)@@ -20,26 +25,32 @@ pip install mem0ai## 3. Instantiate Client-```python+<CodeGroup>+```python Pythonfrom mem0 import MemoryClientclient = MemoryClient(api_key="your-api-key")```+```javascript JavaScript+const MemoryClient = require('mem0ai');+const client = new MemoryClient('your-api-key');+```++</CodeGroup>+## 4. Memory OperationsMem0 provides a simple and customizable interface for performing CRUD operations on memory.-### 4.1 Create MemoriesYou can create long-term and short-term memories for your users, AI Agents, etc. Here are some examples:#### Long-term memory for a user-```python Code-from mem0 import MemoryClient-client = MemoryClient(api_key="your-api-key")+<CodeGroup>+```python Pythonmessages = [{"role": "user", "content": "Hi, I'm Alex. I'm a vegetarian and I'm allergic to nuts."},{"role": "assistant", "content": "Hello Alex! I've noted that you're a vegetarian and have a nut allergy. I'll keep this in mind for any food-related recommendations or discussions."}@@ -47,12 +58,35 @@ messages = [client.add(messages, user_id="alex")```+```javascript JavaScript+const messages = [+ {"role": "user", "content": "Hi, I'm Alex. I'm a vegetarian and I'm allergic to nuts."},+ {"role": "assistant", "content": "Hello Alex! I've noted that you're a vegetarian and have a nut allergy. I'll keep this in mind for any food-related recommendations or discussions."}+];+client.add(messages, { user_id: "alex" })+ .then(response => console.log(response))+ .catch(error => console.error(error));+```++```bash cURL+curl -X POST "https://api.mem0.ai/v1/memories/" \+ -H "Authorization: Token your-api-key" \+ -H "Content-Type: application/json" \+ -d '{+ "messages": [+ {"role": "user", "content": "Hi, I'm Alex. I'm a vegetarian and I'm allergic to nuts."},+ {"role": "assistant", "content": "Hello Alex! I've noted that you're a vegetarian and have a nut allergy. I'll keep this in mind for any food-related recommendations or discussions."}+ ],+ "user_id": "alex"+ }'+```+</CodeGroup>+#### Short-term memory for a user session-```python Code-from mem0 import MemoryClient-client = MemoryClient(api_key="your-api-key")+<CodeGroup>+```python Pythonmessages = [{"role": "user", "content": "I'm planning a trip to Japan next month."},{"role": "assistant", "content": "That's exciting, Alex! A trip to Japan next month sounds wonderful. Would you like some recommendations for vegetarian-friendly restaurants in Japan?"},@@ -62,12 +96,40 @@ messages = [client.add(messages, user_id="alex123", session_id="trip-planning-2024")```+```javascript JavaScript+const messages = [+ {"role": "user", "content": "I'm planning a trip to Japan next month."},+ {"role": "assistant", "content": "That's exciting, Alex! A trip to Japan next month sounds wonderful. Would you like some recommendations for vegetarian-friendly restaurants in Japan?"},+ {"role": "user", "content": "Yes, please! Especially in Tokyo."},+ {"role": "assistant", "content": "Great! I'll remember that you're interested in vegetarian restaurants in Tokyo for your upcoming trip. I'll prepare a list for you in our next interaction."}+];+client.add(messages, { user_id: "alex123", session_id: "trip-planning-2024" })+ .then(response => console.log(response))+ .catch(error => console.error(error));+```++```bash cURL+curl -X POST "https://api.mem0.ai/v1/memories/" \+ -H "Authorization: Token your-api-key" \+ -H "Content-Type: application/json" \+ -d '{+ "messages": [+ {"role": "user", "content": "I'm planning a trip to Japan next month."},+ {"role": "assistant", "content": "That's exciting, Alex! A trip to Japan next month sounds wonderful. Would you like some recommendations for vegetarian-friendly restaurants in Japan?"},+ {"role": "user", "content": "Yes, please! Especially in Tokyo."},+ {"role": "assistant", "content": "Great! I'll remember that you're interested in vegetarian restaurants in Tokyo for your upcoming trip. I'll prepare a list for you in our next interaction."}+ ],+ "user_id": "alex123",+ "session_id": "trip-planning-2024"+ }'+```+</CodeGroup>+#### Long-term memory for agents-```python Code-from mem0 import MemoryClient-client = MemoryClient(api_key="your-api-key")+<CodeGroup>+```python Pythonmessages = [{"role": "system", "content": "You are a personalized travel assistant. Remember user preferences and provide tailored recommendations."},{"role": "assistant", "content": "Understood. I'll maintain personalized travel preferences for each user and provide customized recommendations based on their dietary restrictions, interests, and past interactions."}@@ -75,21 +137,62 @@ messages = [client.add(messages, agent_id="travel-assistant")```+```javascript JavaScript+const messages = [+ {"role": "system", "content": "You are a personalized travel assistant. Remember user preferences and provide tailored recommendations."},+ {"role": "assistant", "content": "Understood. I'll maintain personalized travel preferences for each user and provide customized recommendations based on their dietary restrictions, interests, and past interactions."}+];+client.add(messages, { agent_id: "travel-assistant" })+ .then(response => console.log(response))+ .catch(error => console.error(error));+```++```bash cURL+curl -X POST "https://api.mem0.ai/v1/memories/" \+ -H "Authorization: Token your-api-key" \+ -H "Content-Type: application/json" \+ -d '{+ "messages": [+ {"role": "system", "content": "You are a personalized travel assistant. Remember user preferences and provide tailored recommendations."},+ {"role": "assistant", "content": "Understood. I'll maintain personalized travel preferences for each user and provide customized recommendations based on their dietary restrictions, interests, and past interactions."}+ ],+ "agent_id": "travel-assistant"+ }'+```+</CodeGroup>+You can monitor memory operations on the platform:-### 4.2 Search Relevant MemoriesYou can also get related memories for a given natural language question using our search method.<CodeGroup>-```python Code++```python Pythonquery = "What do you know about me?"client.search(query, user_id="alex")```+```javascript JavaScript+const query = "What do you know about me?";+client.search(query, { user_id: "alex" })+ .then(results => console.log(results))+ .catch(error => console.error(error));+```++```bash cURL+curl -X POST "https://api.mem0.ai/v1/memories/search/" \+ -H "Authorization: Token your-api-key" \+ -H "Content-Type: application/json" \+ -d '{+ "query": "What do you know about me?",+ "user_id": "alex"+ }'+```+```json Output[{@@ -115,78 +218,46 @@ client.search(query, user_id="alex")```</CodeGroup>-Similarly, you can search for agent memories by passing the `agent_id` argument.--```python Code-client.search("What are the learnings from previous runs?", agent_id="travel-assistant")-```-### 4.3 Get All Memories-Fetch all memories for a user, agent, or session using the get_all() method.+Fetch all memories for a user, agent, or session using the getAll() method.#### Get all memories of an AI Agent<CodeGroup>--```python Code+```python Pythonclient.get_all(agent_id="travel-assistant")```-```json Output-[- {- "id": "48677fae-16c4-4d57-9c27-f984f290722a",- "memory": "Will remember personalized travel preferences for each user.",- "input": [- {- "role": "system",- "content": "You are a personalized travel assistant. Remember user preferences and provide tailored recommendations."- },- {- "role": "assistant",- "content": "Understood. I'll maintain personalized travel preferences for each user and provide customized recommendations based on their dietary restrictions, interests, and past interactions."- }- ],- "agent_id": "travel-assistant",- "hash": "644d5f40af13d0525305d8dfadc00fd1",- "metadata": null,- "created_at": "2024-07-20T01:25:22.122299-07:00",- "updated_at": "2024-07-20T01:25:22.122327-07:00"- }-]+```javascript JavaScript+client.getAll({ agent_id: "travel-assistant" })+ .then(memories => console.log(memories))+ .catch(error => console.error(error));+```++```bash cURL+curl -X GET "https://api.mem0.ai/v1/memories/?agent_id=travel-assistant" \+ -H "Authorization: Token your-api-key"```</CodeGroup>#### Get all memories of user<CodeGroup>-```python Code++```python Pythonuser_memories = client.get_all(user_id="alex")```-```json Output-[- {- "id": "7f165f7e-b411-4afe-b7e5-35789b72c4a5",- "memory": "Name: Alex. Vegetarian. Allergic to nuts.",- "input": [- {- "role": "user",- "content": "Hi, I'm Alex. I'm a vegetarian and I'm allergic to nuts."- },- {- "role": "assistant",- "content": "Hello Alex! I've noted that you're a vegetarian and have a nut allergy. I'll keep this in mind for any food-related recommendations or discussions."- }- ],- "user_id": "alex",- "hash": "9ee7e1455e84d1dab700ed8749aed75a",- "metadata": null,- "created_at": "2024-07-20T01:30:36.275141-07:00",- "updated_at": "2024-07-20T01:30:36.275172-07:00"- }-]+```javascript JavaScript+client.getAll({ user_id: "alex" })+ .then(memories => console.log(memories))+ .catch(error => console.error(error));+```++```bash cURL+curl -X GET "https://api.mem0.ai/v1/memories/?user_id=alex" \+ -H "Authorization: Token your-api-key"```</CodeGroup>@@ -194,80 +265,39 @@ user_memories = client.get_all(user_id="alex")<CodeGroup>-```python Code+```python Pythonshort_term_memories = client.get_all(user_id="alex123", session_id="trip-planning-2024")```-```python Output-[- {- "id": "582bbe6d-506b-48c6-a4c6-5df3b1e63428",- "memory": "Planning a trip to Japan next month. Interested in vegetarian restaurants in Tokyo.",- "input": [- {- "role": "user",- "content": "I'm planning a trip to Japan next month."- },- {- "role": "assistant",- "content": "That's exciting, Alex! A trip to Japan next month sounds wonderful. Would you like some recommendations for vegetarian-friendly restaurants in Japan?"- },- {- "role": "user",- "content": "Yes, please! Especially in Tokyo."- },- {- "role": "assistant",- "content": "Great! I'll remember that you're interested in vegetarian restaurants in Tokyo for your upcoming trip. I'll prepare a list for you in our next interaction."- }- ],- "user_id": "alex123",- "hash": "d2088c936e259f2f5d2d75543d31401c",- "metadata": null,- "created_at": "2024-07-20T01:34:09.748379-07:00",- "updated_at": "2024-07-20T01:34:09.748391-07:00"- }-]+```javascript JavaScript+client.getAll({ user_id: "alex123", session_id: "trip-planning-2024" })+ .then(memories => console.log(memories))+ .catch(error => console.error(error));```-</CodeGroup>+```bash cURL+curl -X GET "https://api.mem0.ai/v1/memories/?user_id=alex123&session_id=trip-planning-2024" \+ -H "Authorization: Token your-api-key"+```+</CodeGroup>#### Get specific memory<CodeGroup>-```python Code+```python Pythonmemory = client.get(memory_id="582bbe6d-506b-48c6-a4c6-5df3b1e63428")```-```python Output-{- "id": "582bbe6d-506b-48c6-a4c6-5df3b1e63428",- "memory": "Planning a trip to Japan next month. Interested in vegetarian restaurants in Tokyo.",- "input": [- {- "role": "user",- "content": "I'm planning a trip to Japan next month."- },- {- "role": "assistant",- "content": "That's exciting, Alex! A trip to Japan next month sounds wonderful. Would you like some recommendations for vegetarian-friendly restaurants in Japan?"- },- {- "role": "user",- "content": "Yes, please! Especially in Tokyo."- },- {- "role": "assistant",- "content": "Great! I'll remember that you're interested in vegetarian restaurants in Tokyo for your upcoming trip. I'll prepare a list for you in our next interaction."- }- ],- "user_id": "alex123",- "hash": "d2088c936e259f2f5d2d75543d31401c",- "metadata": null,- "created_at": "2024-07-20T01:34:09.748379-07:00",- "updated_at": "2024-07-20T01:34:09.748391-07:00"-}+```javascript JavaScript+client.get("582bbe6d-506b-48c6-a4c6-5df3b1e63428")+ .then(memory => console.log(memory))+ .catch(error => console.error(error));+```++```bash cURL+curl -X GET "https://api.mem0.ai/v1/memories/582bbe6d-506b-48c6-a4c6-5df3b1e63428" \+ -H "Authorization: Token your-api-key"```</CodeGroup>@@ -277,7 +307,7 @@ Get history of how a memory has changed over time<CodeGroup>-```python Code+```python Python# Add some message to create historymessages = [{"role": "user", "content": "I recently tried chicken and I loved it. I'm thinking of trying more non-vegetarian dishes.."}]client.add(messages, user_id="alex")@@ -292,48 +322,51 @@ history = client.history(memory_id)print(history)```-```json Output-[- {- 'id': '5a718c7e-7ed2-4c72-8c55-d7896dc61ca3',- 'memory_id': 'c6c5da66-d851-4653-8a09-ec7b2c1c9cc9',- 'input': [- {- 'role': 'user',- 'content': "I recently tried chicken and I loved it. I'm thinking of trying more non-vegetarian dishes.."- }- ],- 'old_memory': None,- 'new_memory': 'Recently tried chicken and loved it. Interested in trying more non-vegetarian dishes.',- 'event': 'ADD',- 'metadata': None,- 'created_at': '2024-07-20T02:13:35.842720-07:00',- 'updated_at': '2024-07-20T02:13:35.818065-07:00'- },- {- 'id': 'e52e2c73-4b97-4154-9844-aa44c6ee57f5',- 'memory_id': 'c6c5da66-d851-4653-8a09-ec7b2c1c9cc9',- 'input': [- {- 'role': 'user',- 'content': "I recently tried chicken and I loved it. I'm thinking of trying more non-vegetarian dishes.."- },- {- 'role': 'user',- 'content': 'I turned vegetarian now.'- }- ],- 'old_memory': 'Recently tried chicken and loved it. Interested in trying more non-vegetarian dishes.',- 'new_memory': '',- 'event': 'DELETE',- 'metadata': None,- 'created_at': '2024-07-20T02:13:38.070492-07:00',- 'updated_at': '2024-07-20T02:13:38.060219-07:00'- }-]+```javascript JavaScript+// Add some message to create history+let messages = [{ role: "user", content: "I recently tried chicken and I loved it. I'm thinking of trying more non-vegetarian dishes.." }];+client.add(messages, { user_id: "alex" })+ .then(result => {+ // Add second message to update history+ messages.push({ role: 'user', content: 'I turned vegetarian now.' });+ return client.add(messages, { user_id: "alex" });+ })+ .then(result => {+ // Get history of how memory changed over time+ const memoryId = result.id; // Assuming the API returns the memory ID+ return client.history(memoryId);+ })+ .then(history => console.log(history))+ .catch(error => console.error(error));```-</CodeGroup>+```bash cURL+# First, add the initial memory+curl -X POST "https://api.mem0.ai/v1/memories/" \+ -H "Authorization: Token your-api-key" \+ -H "Content-Type: application/json" \+ -d '{+ "messages": [{"role": "user", "content": "I recently tried chicken and I loved it. I'm thinking of trying more non-vegetarian dishes.."}],+ "user_id": "alex"+ }'++# Then, update the memory+curl -X POST "https://api.mem0.ai/v1/memories/" \+ -H "Authorization: Token your-api-key" \+ -H "Content-Type: application/json" \+ -d '{+ "messages": [+ {"role": "user", "content": "I recently tried chicken and I loved it. I'm thinking of trying more non-vegetarian dishes.."},+ {"role": "user", "content": "I turned vegetarian now."}+ ],+ "user_id": "alex"+ }'++# Finally, get the history (replace <memory-id-here> with the actual memory ID)+curl -X GET "https://api.mem0.ai/v1/memories/<memory-id-here>/history/" \+ -H "Authorization: Token your-api-key"+```+</CodeGroup>### 4.5 Delete Memory@@ -341,33 +374,66 @@ Delete specific memory:<CodeGroup>-```python Code+```python Pythonclient.delete(memory_id)```-```python Output-{'message': 'Memory deleted successfully!'}+```javascript JavaScript+client.delete("memory-id-here")+ .then(result => console.log(result))+ .catch(error => console.error(error));```-</CodeGroup>+```bash cURL+curl -X DELETE "https://api.mem0.ai/v1/memories/memory-id-here" \+ -H "Authorization: Token your-api-key"+```+</CodeGroup>Delete all memories of a user:<CodeGroup>-```python Code+```python Pythonclient.delete_all(user_id="alex")```-```python Output-{'message': 'Memories deleted successfully!'}+```javascript JavaScript+client.deleteAll({ user_id: "alex" })+ .then(result => console.log(result))+ .catch(error => console.error(error));+```++```bash cURL+curl -X DELETE "https://api.mem0.ai/v1/memories/?user_id=alex" \+ -H "Authorization: Token your-api-key"```</CodeGroup>-Fun fact: You can also delete the memory using the `add()` method by passing natural language command.+Fun fact: You can also delete the memory using the `add()` method by passing a natural language command:-```python Code+<CodeGroup>++```python Pythonclient.add("Delete all of my food preferences", user_id="alex")+```++```javascript JavaScript+client.add("Delete all of my food preferences", { user_id: "alex" })+ .then(result => console.log(result))+ .catch(error => console.error(error));+```++```bash cURL+curl -X POST "https://api.mem0.ai/v1/memories/" \+ -H "Authorization: Token your-api-key" \+ -H "Content-Type: application/json" \+ -d '{+ "messages": [{"role": "user", "content": "Delete all of my food preferences"}],+ "user_id": "alex"+ }'+```+</CodeGroup>If you have any questions, please feel free to reach out to us using one of the following methods: