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/migration/api-changes.mdx
+17 -17
View File
@@ -1,13 +1,13 @@
---
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"
iconType: "solid"
---
## 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
@@ -28,7 +28,7 @@ config = {
m = Memory.from_config(config)
```
#### v1.0 Beta
#### v1.0.0 Beta
```python
from mem0 import Memory
@@ -66,7 +66,7 @@ def add(
) -> Union[List[dict], dict]
```
#### v1.0 Beta Signature
#### v1.0.0 Beta Signature
```python
def add(
self,
@@ -82,7 +82,7 @@ def add(
#### Changes Summary
| Parameter | v0.x | v1.0 Beta | Change |
| Parameter | v0.x | v1.0.0 Beta | Change |
|-----------|------|-----------|---------|
| `messages` | ✅ | ✅ | Unchanged |
| `user_id` | ✅ | ✅ | Unchanged |
@@ -120,7 +120,7 @@ def add(
}
```
**v1.0 Beta Response (standardized):**
**v1.0.0 Beta Response (standardized):**
```python
# Always returns this format
{
@@ -152,7 +152,7 @@ def search(
) -> Union[List[dict], dict]
```
#### v1.0 Beta Signature
#### v1.0.0 Beta Signature
```python
def search(
self,
@@ -177,7 +177,7 @@ filters = {
}
```
**v1.0 Beta Filters (enhanced):**
**v1.0.0 Beta Filters (enhanced):**
```python
# Advanced filtering with operators
filters = {
@@ -221,7 +221,7 @@ def get_all(
) -> Union[List[dict], dict]
```
#### v1.0 Beta Signature
#### v1.0.0 Beta Signature
```python
def get_all(
self,
@@ -279,7 +279,7 @@ async_m = AsyncMemory()
result = await async_m.add("content", user_id="alice", async_mode=True)
```
#### v1.0 Beta (Optimized)
#### v1.0.0 Beta (Optimized)
```python
from mem0 import AsyncMemory
@@ -308,7 +308,7 @@ config = {
}
```
#### v1.0 Beta Config Options
#### v1.0.0 Beta Config Options
```python
config = {
"vector_store": {...},
@@ -386,7 +386,7 @@ except Exception as e:
print(f"Error: {e}")
```
#### v1.0 Beta Errors
#### v1.0.0 Beta Errors
```python
# More specific error handling
try:
@@ -416,7 +416,7 @@ except Exception as e:
result = m.add("content", user_id="alice", unknown_param="value")
```
**v1.0 Beta (Strict):**
**v1.0.0 Beta (Strict):**
```python
# Unknown parameters raise TypeError
try:
@@ -442,7 +442,7 @@ except TypeError as e:
}
```
#### v1.0 Beta Schema (Enhanced)
#### v1.0.0 Beta Schema (Enhanced)
```python
{
"id": "mem_123",
@@ -488,7 +488,7 @@ for memory in memories:
print(memory["memory"])
```
#### After (v1.0 Beta)
#### After (v1.0.0 Beta)
```python
from mem0 import Memory
@@ -518,7 +518,7 @@ results = m.search(
)
```
#### After (v1.0 Beta)
#### After (v1.0.0 Beta)
```python
# Enhanced filtering with reranking
results = m.search(
@@ -536,7 +536,7 @@ results = m.search(
## Summary
| Component | v0.x | v1.0 Beta | Status |
| Component | v0.x | v1.0.0 Beta | Status |
|-----------|------|-----------|---------|
| `add()` method | Variable response | Standardized response | ⚠️ 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
description: 'Complete list of breaking changes when upgrading from v0.x to 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.0 Beta'
icon: "triangle-exclamation"
iconType: "solid"
---
@@ -29,7 +29,7 @@ result = m.add(
)
```
#### After (v1.0 Beta)
#### After (v1.0.0 Beta)
```python
# v1.1 is the minimum supported version
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")
```
#### After (v1.0 Beta)
#### After (v1.0.0 Beta)
```python
result = m.add("content", 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")
```
#### After (v1.0 Beta)
#### After (v1.0.0 Beta)
```python
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
```
#### After (v1.0 Beta)
#### After (v1.0.0 Beta)
```python
# Always async by design, parameter removed
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"}]}
```
#### After (v1.0 Beta)
#### After (v1.0.0 Beta)
```python
# Always returns standardized format
result = m.add("content", user_id="alice")
@@ -149,7 +149,7 @@ config = {
}
```
#### After (v1.0 Beta)
#### After (v1.0.0 Beta)
```python
# v1.1 is minimum, v1.1 is default
config = {
@@ -174,11 +174,11 @@ from mem0 import Memory
m = Memory() # Used default settings suitable for v0.x
```
#### After (v1.0 Beta)
#### After (v1.0.0 Beta)
```python
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
# Explicit configuration recommended
@@ -210,7 +210,7 @@ results = m.search(
)
```
#### After (v1.0 Beta)
#### After (v1.0.0 Beta)
```python
# Basic usage remains the same
results = m.search("query", user_id="alice")
@@ -243,7 +243,7 @@ except Exception as e:
print(f"Generic error: {e}")
```
#### After (v1.0 Beta)
#### After (v1.0.0 Beta)
```python
try:
result = m.add("content", user_id="alice")
@@ -271,7 +271,7 @@ result = m.add(
)
```
#### After (v1.0 Beta)
#### After (v1.0.0 Beta)
```python
# Strict validation - unknown parameters cause errors
try:
@@ -291,7 +291,7 @@ except TypeError as e:
**Good News:** Import statements remain the same.
```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 MemoryConfig
```
@@ -305,7 +305,7 @@ from mem0 import MemoryConfig
#### Before (v0.x)
- Python 3.8+ supported
#### After (v1.0 Beta)
#### After (v1.0.0 Beta)
- Python 3.9+ required (check current requirements)
### Package Dependencies
@@ -332,7 +332,7 @@ pip check # Verify no dependency conflicts
**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
- No re-indexing required
@@ -350,7 +350,7 @@ def test_add_memory():
assert len(result) > 0
```
#### After (v1.0 Beta)
#### After (v1.0.0 Beta)
```python
def test_add_memory():
result = m.add("content", user_id="alice")
@@ -378,7 +378,7 @@ python test_mem0_functionality.py
### 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:** 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'
icon: "arrow-right"
iconType: "solid"