This release is a pre-release and may not be stable for production use.
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
4 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file agent_framework_redis-1.0.0b260721.tar.gz.
File metadata
- Download URL: agent_framework_redis-1.0.0b260721.tar.gz
- Upload date:
- Size: 10.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
50b02788c2828bb534dc35d0ef59b9efc3b9539e582aa8af5f9c22f72d9e472c
|
|
| MD5 |
d0a1dfc25b3625e20c4bb07bb3d8feb0
|
|
| BLAKE2b-256 |
a3c87a4046cfaca04e7d7cb5a0cf97bf4b69c80788d3e53f8656ab82a7ee0166
|
File details
Details for the file agent_framework_redis-1.0.0b260721-py3-none-any.whl.
File metadata
- Download URL: agent_framework_redis-1.0.0b260721-py3-none-any.whl
- Upload date:
- Size: 10.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a4f3109d17dcda25107dd73083c388918885a07c1eb55d6b61870b35ab25e8ac
|
|
| MD5 |
807c7155eb67844e8e731a3e3f917eaa
|
|
| BLAKE2b-256 |
7d9e6c9924ab3b61b37837c783a6d65d7cd39a13aa1d600508a56852b8cee9cf
|
