JDSS/mem0
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[DOCS] Changing 1.0 to 1.0.0 (#3486)

Browse Source
This commit is contained in:
Parshva Daftari
2025-09-20 20:07:23 +05:30
committed by GitHub
parent 9df392b26a
commit 88ae952483
7 changed files with 60 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs.json
+1 -1
View File
@@ -12,7 +12,7 @@
"navigation": { "navigation": {
"versions": [ "versions": [
{ {
"version": "v1.0 Beta", "version": "v1.0.0 Beta",
"anchors": [ "anchors": [
{ {
"anchor": "Documentation", "anchor": "Documentation",
docs/migration/api-changes.mdx
+17 -17
View File
@@ -1,13 +1,13 @@
--- ---
title: API Reference Changes title: API Reference Changes
description: 'Complete API changes between v0.x and v1.0 Beta' description: 'Complete API changes between v0.x and v1.0.0 Beta'
icon: "code" icon: "code"
iconType: "solid" iconType: "solid"
--- ---
## Overview ## Overview
This page documents all API changes between Mem0 v0.x and v1.0 Beta, organized by component and method. This page documents all API changes between Mem0 v0.x and v1.0.0 Beta, organized by component and method.
## Memory Class Changes ## Memory Class Changes
@@ -28,7 +28,7 @@ config = {
m = Memory.from_config(config) m = Memory.from_config(config)
``` ```
#### v1.0 Beta #### v1.0.0 Beta
```python ```python
from mem0 import Memory from mem0 import Memory
@@ -66,7 +66,7 @@ def add(
) -> Union[List[dict], dict] ) -> Union[List[dict], dict]
``` ```
#### v1.0 Beta Signature #### v1.0.0 Beta Signature
```python ```python
def add( def add(
self, self,
@@ -82,7 +82,7 @@ def add(
#### Changes Summary #### Changes Summary
| Parameter | v0.x | v1.0 Beta | Change | | Parameter | v0.x | v1.0.0 Beta | Change |
|-----------|------|-----------|---------| |-----------|------|-----------|---------|
| `messages` | ✅ | ✅ | Unchanged | | `messages` | ✅ | ✅ | Unchanged |
| `user_id` | ✅ | ✅ | Unchanged | | `user_id` | ✅ | ✅ | Unchanged |
@@ -120,7 +120,7 @@ def add(
} }
``` ```
**v1.0 Beta Response (standardized):** **v1.0.0 Beta Response (standardized):**
```python ```python
# Always returns this format # Always returns this format
{ {
@@ -152,7 +152,7 @@ def search(
) -> Union[List[dict], dict] ) -> Union[List[dict], dict]
``` ```
#### v1.0 Beta Signature #### v1.0.0 Beta Signature
```python ```python
def search( def search(
self, self,
@@ -177,7 +177,7 @@ filters = {
} }
``` ```
**v1.0 Beta Filters (enhanced):** **v1.0.0 Beta Filters (enhanced):**
```python ```python
# Advanced filtering with operators # Advanced filtering with operators
filters = { filters = {
@@ -221,7 +221,7 @@ def get_all(
) -> Union[List[dict], dict] ) -> Union[List[dict], dict]
``` ```
#### v1.0 Beta Signature #### v1.0.0 Beta Signature
```python ```python
def get_all( def get_all(
self, self,
@@ -279,7 +279,7 @@ async_m = AsyncMemory()
result = await async_m.add("content", user_id="alice", async_mode=True) result = await async_m.add("content", user_id="alice", async_mode=True)
``` ```
#### v1.0 Beta (Optimized) #### v1.0.0 Beta (Optimized)
```python ```python
from mem0 import AsyncMemory from mem0 import AsyncMemory
@@ -308,7 +308,7 @@ config = {
} }
``` ```
#### v1.0 Beta Config Options #### v1.0.0 Beta Config Options
```python ```python
config = { config = {
"vector_store": {...}, "vector_store": {...},
@@ -386,7 +386,7 @@ except Exception as e:
print(f"Error: {e}") print(f"Error: {e}")
``` ```
#### v1.0 Beta Errors #### v1.0.0 Beta Errors
```python ```python
# More specific error handling # More specific error handling
try: try:
@@ -416,7 +416,7 @@ except Exception as e:
result = m.add("content", user_id="alice", unknown_param="value") result = m.add("content", user_id="alice", unknown_param="value")
``` ```
**v1.0 Beta (Strict):** **v1.0.0 Beta (Strict):**
```python ```python
# Unknown parameters raise TypeError # Unknown parameters raise TypeError
try: try:
@@ -442,7 +442,7 @@ except TypeError as e:
} }
``` ```
#### v1.0 Beta Schema (Enhanced) #### v1.0.0 Beta Schema (Enhanced)
```python ```python
{ {
"id": "mem_123", "id": "mem_123",
@@ -488,7 +488,7 @@ for memory in memories:
print(memory["memory"]) print(memory["memory"])
``` ```
#### After (v1.0 Beta) #### After (v1.0.0 Beta)
```python ```python
from mem0 import Memory from mem0 import Memory
@@ -518,7 +518,7 @@ results = m.search(
) )
``` ```
#### After (v1.0 Beta) #### After (v1.0.0 Beta)
```python ```python
# Enhanced filtering with reranking # Enhanced filtering with reranking
results = m.search( results = m.search(
@@ -536,7 +536,7 @@ results = m.search(
## Summary ## Summary
| Component | v0.x | v1.0 Beta | Status | | Component | v0.x | v1.0.0 Beta | Status |
|-----------|------|-----------|---------| |-----------|------|-----------|---------|
| `add()` method | Variable response | Standardized response | ⚠️ Breaking | | `add()` method | Variable response | Standardized response | ⚠️ Breaking |
| `search()` method | Basic filtering | Enhanced filtering + reranking | ⚠️ Breaking | | `search()` method | Basic filtering | Enhanced filtering + reranking | ⚠️ Breaking |
docs/migration/breaking-changes.mdx
+18 -18
View File
@@ -1,6 +1,6 @@
--- ---
title: Breaking Changes in v1.0 Beta title: Breaking Changes in v1.0.0 Beta
description: 'Complete list of breaking changes when upgrading from v0.x to v1.0 Beta' description: 'Complete list of breaking changes when upgrading from v0.x to v1.0.0 Beta'
icon: "triangle-exclamation" icon: "triangle-exclamation"
iconType: "solid" iconType: "solid"
--- ---
@@ -29,7 +29,7 @@ result = m.add(
) )
``` ```
#### After (v1.0 Beta) #### After (v1.0.0 Beta)
```python ```python
# v1.1 is the minimum supported version # v1.1 is the minimum supported version
config = { config = {
@@ -65,7 +65,7 @@ search_results = m.search("query", user_id="alice", output_format="v1.1")
all_memories = m.get_all(user_id="alice", output_format="v1.1") all_memories = m.get_all(user_id="alice", output_format="v1.1")
``` ```
#### After (v1.0 Beta) #### After (v1.0.0 Beta)
```python ```python
result = m.add("content", user_id="alice") result = m.add("content", user_id="alice")
search_results = m.search("query", user_id="alice") search_results = m.search("query", user_id="alice")
@@ -81,7 +81,7 @@ all_memories = m.get_all(user_id="alice")
result = m.add("content", user_id="alice", version="v1.0") result = m.add("content", user_id="alice", version="v1.0")
``` ```
#### After (v1.0 Beta) #### After (v1.0.0 Beta)
```python ```python
result = m.add("content", user_id="alice") result = m.add("content", user_id="alice")
``` ```
@@ -97,7 +97,7 @@ result = m.add("content", user_id="alice", async_mode=True)
result = m.add("content", user_id="alice", async_mode=False) # Sync mode result = m.add("content", user_id="alice", async_mode=False) # Sync mode
``` ```
#### After (v1.0 Beta) #### After (v1.0.0 Beta)
```python ```python
# Always async by design, parameter removed # Always async by design, parameter removed
result = m.add("content", user_id="alice") result = m.add("content", user_id="alice")
@@ -124,7 +124,7 @@ result = m.add("content", user_id="alice", output_format="v1.1")
# Returns: {"results": [{"id": "...", "memory": "...", "event": "ADD"}]} # Returns: {"results": [{"id": "...", "memory": "...", "event": "ADD"}]}
``` ```
#### After (v1.0 Beta) #### After (v1.0.0 Beta)
```python ```python
# Always returns standardized format # Always returns standardized format
result = m.add("content", user_id="alice") result = m.add("content", user_id="alice")
@@ -149,7 +149,7 @@ config = {
} }
``` ```
#### After (v1.0 Beta) #### After (v1.0.0 Beta)
```python ```python
# v1.1 is minimum, v1.1 is default # v1.1 is minimum, v1.1 is default
config = { config = {
@@ -174,11 +174,11 @@ from mem0 import Memory
m = Memory() # Used default settings suitable for v0.x m = Memory() # Used default settings suitable for v0.x
``` ```
#### After (v1.0 Beta) #### After (v1.0.0 Beta)
```python ```python
from mem0 import Memory from mem0 import Memory
# Default configuration optimized for v1.0 Beta # Default configuration optimized for v1.0.0 Beta
m = Memory() # Uses v1.1+ optimized defaults m = Memory() # Uses v1.1+ optimized defaults
# Explicit configuration recommended # Explicit configuration recommended
@@ -210,7 +210,7 @@ results = m.search(
) )
``` ```
#### After (v1.0 Beta) #### After (v1.0.0 Beta)
```python ```python
# Basic usage remains the same # Basic usage remains the same
results = m.search("query", user_id="alice") results = m.search("query", user_id="alice")
@@ -243,7 +243,7 @@ except Exception as e:
print(f"Generic error: {e}") print(f"Generic error: {e}")
``` ```
#### After (v1.0 Beta) #### After (v1.0.0 Beta)
```python ```python
try: try:
result = m.add("content", user_id="alice") result = m.add("content", user_id="alice")
@@ -271,7 +271,7 @@ result = m.add(
) )
``` ```
#### After (v1.0 Beta) #### After (v1.0.0 Beta)
```python ```python
# Strict validation - unknown parameters cause errors # Strict validation - unknown parameters cause errors
try: try:
@@ -291,7 +291,7 @@ except TypeError as e:
**Good News:** Import statements remain the same. **Good News:** Import statements remain the same.
```python ```python
# These imports work in both v0.x and v1.0 Beta # These imports work in both v0.x and v1.0.0 Beta
from mem0 import Memory, AsyncMemory from mem0 import Memory, AsyncMemory
from mem0 import MemoryConfig from mem0 import MemoryConfig
``` ```
@@ -305,7 +305,7 @@ from mem0 import MemoryConfig
#### Before (v0.x) #### Before (v0.x)
- Python 3.8+ supported - Python 3.8+ supported
#### After (v1.0 Beta) #### After (v1.0.0 Beta)
- Python 3.9+ required (check current requirements) - Python 3.9+ required (check current requirements)
### Package Dependencies ### Package Dependencies
@@ -332,7 +332,7 @@ pip check # Verify no dependency conflicts
**Good News:** Memory storage format unchanged. **Good News:** Memory storage format unchanged.
- Existing memories work with v1.0 Beta - Existing memories work with v1.0.0 Beta
- Search continues to work with old memories - Search continues to work with old memories
- No re-indexing required - No re-indexing required
@@ -350,7 +350,7 @@ def test_add_memory():
assert len(result) > 0 assert len(result) > 0
``` ```
#### After (v1.0 Beta) #### After (v1.0.0 Beta)
```python ```python
def test_add_memory(): def test_add_memory():
result = m.add("content", user_id="alice") result = m.add("content", user_id="alice")
@@ -378,7 +378,7 @@ python test_mem0_functionality.py
### Data Safety ### Data Safety
- **Safe:** Memories stored in v0.x format work with v1.0 Beta - **Safe:** Memories stored in v0.x format work with v1.0.0 Beta
- **Safe:** Rollback doesn't lose data - **Safe:** Rollback doesn't lose data
- **Safe:** Vector store data remains intact - **Safe:** Vector store data remains intact
docs/migration/v0-to-v1.mdx
+1 -1
View File
@@ -1,5 +1,5 @@
--- ---
title: Migrating from v0.x to v1.0 Beta title: Migrating from v0.x to v1.0.0 Beta
description: 'Complete guide to upgrade your Mem0 implementation to version 1.0.0 Beta' description: 'Complete guide to upgrade your Mem0 implementation to version 1.0.0 Beta'
icon: "arrow-right" icon: "arrow-right"
iconType: "solid" iconType: "solid"
docs/v0x/faqs.mdx
+17 -17
View File
@@ -6,18 +6,18 @@ iconType: "solid"
--- ---
<Warning> <Warning>
**This is legacy documentation for Mem0 v0.x.** For the latest FAQs, please refer to [v1.0 Beta FAQs](/faqs). **This is legacy documentation for Mem0 v0.x.** For the latest FAQs, please refer to [v1.0.0 Beta FAQs](/faqs).
</Warning> </Warning>
## General Questions ## General Questions
### What is Mem0 v0.x? ### What is Mem0 v0.x?
Mem0 v0.x is the legacy version of Mem0's memory layer for LLMs. While still functional, it lacks the advanced features and optimizations available in v1.0 Beta. Mem0 v0.x is the legacy version of Mem0's memory layer for LLMs. While still functional, it lacks the advanced features and optimizations available in v1.0.0 Beta.
### Should I upgrade to v1.0 Beta? ### Should I upgrade to v1.0.0 Beta?
Yes! v1.0 Beta offers significant improvements: Yes! v1.0.0 Beta offers significant improvements:
- Enhanced filtering with logical operators - Enhanced filtering with logical operators
- Reranking support for better search relevance - Reranking support for better search relevance
- Improved async performance - Improved async performance
@@ -28,7 +28,7 @@ See our [migration guide](/migration/v0-to-v1) for upgrade instructions.
### Is v0.x still supported? ### Is v0.x still supported?
v0.x receives minimal maintenance but no new features. We recommend upgrading to v1.0 Beta for the latest improvements and active support. v0.x receives minimal maintenance but no new features. We recommend upgrading to v1.0.0 Beta for the latest improvements and active support.
## API Questions ## API Questions
@@ -128,17 +128,17 @@ No! Most changes are simple parameter removals:
# Before (v0.x) # Before (v0.x)
result = m.add("memory", user_id="alice", output_format="v1.1", version="v1.0") result = m.add("memory", user_id="alice", output_format="v1.1", version="v1.0")
# After (v1.0 Beta) # After (v1.0.0 Beta)
result = m.add("memory", user_id="alice") result = m.add("memory", user_id="alice")
``` ```
### Will I lose my data? ### Will I lose my data?
No! Your existing memories remain fully compatible with v1.0 Beta. No! Your existing memories remain fully compatible with v1.0.0 Beta.
### Do I need to re-index my vectors? ### Do I need to re-index my vectors?
No! Existing vector data works with v1.0 Beta without changes. No! Existing vector data works with v1.0.0 Beta without changes.
### Can I rollback if needed? ### Can I rollback if needed?
@@ -152,10 +152,10 @@ pip install mem0ai==0.1.20 # Last stable v0.x
### Does v0.x support reranking? ### Does v0.x support reranking?
No, reranking is only available in v1.0 Beta: No, reranking is only available in v1.0.0 Beta:
```python ```python
# v1.0 Beta only # v1.0.0 Beta only
results = m.search("query", user_id="alice", rerank=True) results = m.search("query", user_id="alice", rerank=True)
``` ```
@@ -167,7 +167,7 @@ No, only basic key-value filtering:
# v0.x - basic only # v0.x - basic only
filters = {"category": "food", "user_id": "alice"} filters = {"category": "food", "user_id": "alice"}
# v1.0 Beta - advanced operators # v1.0.0 Beta - advanced operators
filters = { filters = {
"AND": [ "AND": [
{"category": "food"}, {"category": "food"},
@@ -191,9 +191,9 @@ results = m.search(
## Performance Questions ## Performance Questions
### Is v0.x slower than v1.0 Beta? ### Is v0.x slower than v1.0.0 Beta?
Yes, v1.0 Beta includes several performance optimizations: Yes, v1.0.0 Beta includes several performance optimizations:
- Better async handling - Better async handling
- Optimized vector operations - Optimized vector operations
- Improved memory management - Improved memory management
@@ -203,11 +203,11 @@ Yes, v1.0 Beta includes several performance optimizations:
1. Use async mode when possible 1. Use async mode when possible
2. Configure appropriate vector store settings 2. Configure appropriate vector store settings
3. Use efficient metadata filters 3. Use efficient metadata filters
4. Consider upgrading to v1.0 Beta 4. Consider upgrading to v1.0.0 Beta
### Can I batch operations in v0.x? ### Can I batch operations in v0.x?
Limited support. Better batch processing available in v1.0 Beta. Limited support. Better batch processing available in v1.0.0 Beta.
## Troubleshooting ## Troubleshooting
@@ -251,7 +251,7 @@ async_m = AsyncMemory()
### Documentation ### Documentation
- [v0.x Quickstart](/v0x/quickstart) - [v0.x Quickstart](/v0x/quickstart)
- [Migration Guide](/migration/v0-to-v1) - [Migration Guide](/migration/v0-to-v1)
- [v1.0 Beta Docs](/) - [v1.0.0 Beta Docs](/)
### Community ### Community
- [GitHub Discussions](https://github.com/mem0ai/mem0/discussions) - [GitHub Discussions](https://github.com/mem0ai/mem0/discussions)
@@ -263,5 +263,5 @@ async_m = AsyncMemory()
- [API Changes](/migration/api-changes) - [API Changes](/migration/api-changes)
<Info> <Info>
**Ready to upgrade?** Check out our [migration guide](/migration/v0-to-v1) to move to v1.0 Beta and access the latest features! **Ready to upgrade?** Check out our [migration guide](/migration/v0-to-v1) to move to v1.0.0 Beta and access the latest features!
</Info> </Info>
docs/v0x/introduction.mdx
+1 -1
View File
@@ -6,7 +6,7 @@ iconType: "solid"
--- ---
<Warning> <Warning>
**This is legacy documentation for Mem0 v0.x.** For the latest features and improvements, please refer to [v1.0 Beta documentation](/). **This is legacy documentation for Mem0 v0.x.** For the latest features and improvements, please refer to [v1.0.0 Beta documentation](/).
</Warning> </Warning>
## Welcome to Mem0 v0.x ## Welcome to Mem0 v0.x
docs/v0x/quickstart.mdx
+5 -5
View File
@@ -6,7 +6,7 @@ iconType: "solid"
--- ---
<Warning> <Warning>
**This is legacy documentation for Mem0 v0.x.** For the latest features, please refer to [v1.0 Beta documentation](/quickstart). **This is legacy documentation for Mem0 v0.x.** For the latest features, please refer to [v1.0.0 Beta documentation](/quickstart).
</Warning> </Warning>
## Installation ## Installation
@@ -167,14 +167,14 @@ result = m.add("I love coffee", user_id="alice", output_format="v1.1")
## Migration Path ## Migration Path
To upgrade to v1.0 Beta: To upgrade to v1.0.0 Beta:
1. **Remove deprecated parameters:** 1. **Remove deprecated parameters:**
```python ```python
# Old (v0.x) # Old (v0.x)
m.add("memory", user_id="alice", output_format="v1.0", version="v1.0") m.add("memory", user_id="alice", output_format="v1.0", version="v1.0")
# New (v1.0 Beta) # New (v1.0.0 Beta)
m.add("memory", user_id="alice") m.add("memory", user_id="alice")
``` ```
@@ -186,7 +186,7 @@ To upgrade to v1.0 Beta:
for item in result: for item in result:
print(item["memory"]) print(item["memory"])
# New (v1.0 Beta) # New (v1.0.0 Beta)
result = m.add("memory", user_id="alice") result = m.add("memory", user_id="alice")
for item in result["results"]: for item in result["results"]:
print(item["memory"]) print(item["memory"])
@@ -242,5 +242,5 @@ print("Previous context:", history)
</CardGroup> </CardGroup>
<Info> <Info>
**Ready to upgrade?** Check out the [migration guide](/migration/v0-to-v1) to move to v1.0 Beta and access new features like reranking and enhanced filtering. **Ready to upgrade?** Check out the [migration guide](/migration/v0-to-v1) to move to v1.0.0 Beta and access new features like reranking and enhanced filtering.
</Info> </Info>