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)
After (v1.0 Beta)
Parameter Removals
1. output_format Parameter
Removed from all methods:add()
search()
get_all()
Before (v0.x)
After (v1.0 Beta)
2. version Parameter in Method Calls
Breaking Change: Version parameter removed from method calls.Before (v0.x)
After (v1.0 Beta)
3. async_mode Parameter
Breaking Change: Async mode is now default and the parameter is removed.Before (v0.x)
After (v1.0 Beta)
Response Format Changes
Standardized Response Structure
Breaking Change: All responses now return a standardized dictionary format.Before (v0.x)
After (v1.0 Beta)
Configuration Changes
Version Configuration
Breaking Change: Default API version changed.Before (v0.x)
After (v1.0 Beta)
Memory Configuration
Breaking Change: Some configuration options have changed defaults.Before (v0.x)
After (v1.0 Beta)
Method Signature Changes
Search Method
Enhanced but backward compatible:Before (v0.x)
After (v1.0 Beta)
Error Handling Changes
New Error Types
Breaking Change: More specific error types and messages.Before (v0.x)
After (v1.0 Beta)
Validation Changes
Breaking Change: Stricter parameter validation.Before (v0.x)
After (v1.0 Beta)
Import Changes
No Breaking Changes in Imports
Good News: Import statements remain the same.Dependency Changes
Minimum Python Version
Potential Breaking Change: Check Python version requirements.Before (v0.x)
- Python 3.8+ supported
After (v1.0 Beta)
- Python 3.9+ required (check current requirements)
Package Dependencies
Breaking Change: Some dependencies updated with potential breaking changes.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 Beta
- 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)
After (v1.0 Beta)
Rollback Considerations
Safe Rollback Process
If you need to rollback:Data Safety
- Safe: Memories stored in v0.x format work with v1.0 Beta
- Safe: Rollback doesn’t lose data
- Safe: Vector store data remains intact
Next Steps
- Review all breaking changes in your codebase
- Update method calls to remove deprecated parameters
- Update response handling to use standardized format
- Test thoroughly with your existing data
- Update error handling for new error types
Need Help? If you encounter issues during migration, check our GitHub Discussions or community support channels.