[DOCS] Changing 1.0 to 1.0.0 (#3486)
This commit is contained in:
@@ -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 |
|
||||
|
||||
Reference in New Issue
Block a user