License
- OSI Approved :: MIT License
Development Status
- 4 - Beta
Intended Audience
- Developers
Programming Language
- Python :: 3
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
- Python :: 3.13
- Python :: 3.14
Typing
- Typed
Get Started with Microsoft Agent Framework Redis
Please install this package via pip:
pip install agent-framework-redis --pre
Components
Memory Context Provider
The RedisContextProvider enables persistent context and memory capabilities for your agents, allowing them to remember user preferences and conversation context across sessions and threads.
Basic Usage Examples
Review the set of getting started examples for using the Redis context provider.
Redis History Provider
The RedisHistoryProvider provides persistent conversation storage using Redis Lists, enabling chat history to survive application restarts and support distributed applications.
Key Features
- Persistent Storage: Messages survive application restarts
- Thread Isolation: Each conversation thread has its own Redis key
- Message Limits: Configurable automatic trimming of old messages
- Serialization Support: Full compatibility with Agent Framework thread serialization
- Production Ready: Connection pooling, error handling, and performance optimized
Basic Usage Examples
See the complete Redis history provider examples including:
- User session management
- Conversation persistence across restarts
- Session serialization and deserialization
- Automatic message trimming
- Error handling patterns
Installing and running Redis
You have 3 options to set-up Redis:
Option A: Local Redis with Docker
docker run --name redis -p 6379:6379 -d redis:8.0.3
Option B: Redis Cloud
Get a free db at https://redis.io/cloud/
Option C: Azure Managed Redis
Here's a quickstart guide to create Azure Managed Redis for as low as $12 monthly: https://learn.microsoft.com/en-us/azure/redis/quickstart-create-managed-redis
Wheel compatibility matrix
Files in release
agent-framework-core
(<2,>=1.13.0)
redis
(<7.2.1,>=6.4.0)
redisvl
(<0.16,>=0.11.0)
numpy
(<3,>=2.2.6)