--- title: Breaking Changes in v1.0.0 description: 'Complete list of breaking changes when upgrading from v0.x to v1.0.0 ' icon: "triangle-exclamation" iconType: "solid" --- **Important:** This page lists all breaking changes. Please review carefully before upgrading. ## API Version Changes ### Removed v1.0 API Support **Breaking Change:** The v1.0 API format is completely removed and no longer supported. #### Before (v0.x) ```python # This was supported in v0.x config = { "version": "v1.0" # ❌ No longer supported } result = m.add( "memory content", user_id="alice" ) ``` #### After (v1.0.0 ) ```python # v1.1 is the minimum supported version config = { "version": "v1.1" # ✅ Required minimum } result = m.add( "memory content", user_id="alice" ) ``` **Error Message:** ``` ValueError: The v1.0 API format is no longer supported in mem0ai 1.0.0+. Please use v1.1 format which returns a dict with 'results' key. ``` ## Parameter Removals ### 1. version Parameter in Method Calls **Breaking Change:** Version parameter removed from method calls. #### Before (v0.x) ```python result = m.add("content", user_id="alice", version="v1.0") ``` #### After (v1.0.0 ) ```python result = m.add("content", user_id="alice") ``` ### 2. async_mode Parameter (Platform Client) **Change:** For `MemoryClient` (Platform API), `async_mode` now defaults to `True` but can still be configured. #### Before (v0.x) ```python from mem0 import MemoryClient client = MemoryClient(api_key="your-key") result = client.add("content", user_id="alice", async_mode=True) result = client.add("content", user_id="alice", async_mode=False) ``` #### After (v1.0.0 ) ```python from mem0 import MemoryClient client = MemoryClient(api_key="your-key") # async_mode now defaults to True, but you can still override it result = client.add("content", user_id="alice") # Uses async_mode=True by default # You can still explicitly set it to False if needed result = client.add("content", user_id="alice", async_mode=False) ``` ## Response Format Changes ### Standardized Response Structure **Breaking Change:** All responses now return a standardized dictionary format. #### Before (v0.x) ```python # Could return different formats based on version configuration result = m.add("content", user_id="alice") # With v1.0: Returns [{"id": "...", "memory": "...", "event": "ADD"}] # With v1.1: Returns {"results": [{"id": "...", "memory": "...", "event": "ADD"}]} ``` #### After (v1.0.0 ) ```python # Always returns standardized format result = m.add("content", user_id="alice") # Always returns: {"results": [{"id": "...", "memory": "...", "event": "ADD"}]} # Access results consistently for memory in result["results"]: print(memory["memory"]) ``` ## Configuration Changes ### Version Configuration **Breaking Change:** Default API version changed. #### Before (v0.x) ```python # v1.0 was supported config = { "version": "v1.0" # ❌ No longer supported } ``` #### After (v1.0.0 ) ```python # v1.1 is minimum, v1.1 is default config = { "version": "v1.1" # ✅ Minimum supported } # Or omit for default config = { # version defaults to v1.1 } ``` ### Memory Configuration **Breaking Change:** Some configuration options have changed defaults. #### Before (v0.x) ```python from mem0 import Memory # Default configuration in v0.x m = Memory() # Used default settings suitable for v0.x ``` #### After (v1.0.0 ) ```python from mem0 import Memory # Default configuration optimized for v1.0.0 m = Memory() # Uses v1.1+ optimized defaults # Explicit configuration recommended config = { "version": "v1.1", "vector_store": { "provider": "qdrant", "config": { "host": "localhost", "port": 6333 } } } m = Memory.from_config(config) ``` ## Method Signature Changes ### Search Method **Enhanced but backward compatible:** #### Before (v0.x) ```python results = m.search( "query", user_id="alice", filters={"key": "value"} # Simple key-value only ) ``` #### After (v1.0.0 ) ```python # Basic usage remains the same results = m.search("query", user_id="alice") # Enhanced filtering available (optional) results = m.search( "query", user_id="alice", filters={ "AND": [ {"key": "value"}, {"score": {"gte": 0.8}} ] }, rerank=True # New parameter ) ``` ## Error Handling Changes ### New Error Types **Breaking Change:** More specific error types and messages. #### Before (v0.x) ```python try: result = m.add("content", user_id="alice", version="v1.0") except Exception as e: print(f"Generic error: {e}") ``` #### After (v1.0.0 ) ```python try: result = m.add("content", user_id="alice") except ValueError as e: if "v1.0 API format is no longer supported" in str(e): # Handle version error specifically print("Please upgrade your code to use v1.1+ format") else: print(f"Value error: {e}") except Exception as e: print(f"Unexpected error: {e}") ``` ### Validation Changes **Breaking Change:** Stricter parameter validation. #### Before (v0.x) ```python # Some invalid parameters might have been ignored result = m.add( "content", user_id="alice", invalid_param="ignored" # Might have been silently ignored ) ``` #### After (v1.0.0 ) ```python # Strict validation - unknown parameters cause errors try: result = m.add( "content", user_id="alice", invalid_param="value" # ❌ Will raise TypeError ) except TypeError as e: print(f"Invalid parameter: {e}") ``` ## Import Changes ### No Breaking Changes in Imports **Good News:** Import statements remain the same. ```python # These imports work in both v0.x and v1.0.0 from mem0 import Memory, AsyncMemory from mem0 import MemoryConfig ``` ## Dependency Changes ### Minimum Python Version **Potential Breaking Change:** Check Python version requirements. #### Before (v0.x) - Python 3.8+ supported #### After (v1.0.0 ) - Python 3.9+ required (check current requirements) ### Package Dependencies **Breaking Change:** Some dependencies updated with potential breaking changes. ```bash # Check for conflicts after upgrade pip install --upgrade mem0ai pip check # Verify no dependency conflicts ``` ## Data Migration ### Database Schema **Good News:** No database schema changes required. - Existing memories remain compatible - No data migration required - Vector store data unchanged ### Memory Format **Good News:** Memory storage format unchanged. - Existing memories work with v1.0.0 - Search continues to work with old memories - No re-indexing required ## Testing Changes ### Test Updates Required **Breaking Change:** Update tests for new response format. #### Before (v0.x) ```python def test_add_memory(): result = m.add("content", user_id="alice") assert isinstance(result, list) # ❌ No longer true assert len(result) > 0 ``` #### After (v1.0.0 ) ```python def test_add_memory(): result = m.add("content", user_id="alice") assert isinstance(result, dict) # ✅ Always dict assert "results" in result # ✅ Always has results key assert len(result["results"]) > 0 ``` ## Rollback Considerations ### Safe Rollback Process If you need to rollback: ```bash # 1. Rollback package pip install mem0ai==0.1.20 # Last stable v0.x # 2. Revert code changes git checkout previous_commit # 3. Test functionality python test_mem0_functionality.py ``` ### Data Safety - **Safe:** Memories stored in v0.x format work with v1.0.0 - **Safe:** Rollback doesn't lose data - **Safe:** Vector store data remains intact ## Next Steps 1. **Review all breaking changes** in your codebase 2. **Update method calls** to remove deprecated parameters 3. **Update response handling** to use standardized format 4. **Test thoroughly** with your existing data 5. **Update error handling** for new error types Step-by-step migration instructions Complete API reference changes **Need Help?** If you encounter issues during migration, check our [GitHub Discussions](https://github.com/mem0ai/mem0/discussions) or community support channels.