Skip to main content
Pre-release

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

Metadata

Release files for agent-framework-redis 1.0.0b260402

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for agent-framework-redis 1.0.0b260402
File Size Uploaded
agent_framework_redis-1.0.0b260402.tar.gz 10.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for agent-framework-redis 1.0.0b260402
File Interpreter ABI Platform
agent_framework_redis-1.0.0b260402-py3-none-any.whl Python 3 none any Details

Total release size: 21.1 kB

Release files / agent_framework_redis-1.0.0b260402.tar.gz

Download URL agent_framework_redis-1.0.0b260402.tar.gz
Size 10.5 kB
Tags Source
SHA-256 checksum
How to use checksums
9b842225bceb50186c655a54534e9c68f253bad790792296cd6efd573a42c949
BLAKE2b-256 checksum
How to use checksums
c23be91666f267268d6956be636196385fa04952700d532a235744f01141519d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","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}

Release files / agent_framework_redis-1.0.0b260402-py3-none-any.whl

Download URL agent_framework_redis-1.0.0b260402-py3-none-any.whl
Size 10.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1e0744fb6c11ba98e57e33c8f33c3e752bf8f4e3dc790b999f1ebc79645835b9
BLAKE2b-256 checksum
How to use checksums
71b9c93d52d1a05ba02c6a0ee461b363b0b469956a75df0768eed455ebdbc82c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","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}

Release history Release notifications | RSS feed

This release

1.0.0b260402 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page