Skip to main content

Redis integration for Microsoft Agent Framework.

Project description

Get Started with Microsoft Agent Framework Redis

Please install this package via pip:

pip install agent-framework-redis --pre

Components

Memory Context Provider

The RedisProvider enables persistent context & 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 Chat Message Store

The RedisChatMessageStore 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 chat message store examples including:

  • User session management
  • Conversation persistence across restarts
  • Thread 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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agent_framework_redis-1.0.0b251112.tar.gz (22.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agent_framework_redis-1.0.0b251112-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file agent_framework_redis-1.0.0b251112.tar.gz.

File metadata

File hashes

Hashes for agent_framework_redis-1.0.0b251112.tar.gz
Algorithm Hash digest
SHA256 900afba80fceba3faea7d84f41e056405aabae2b3767625630a4cd743c303dd8
MD5 179b3d3756096afebbe1c4cdac42ffed
BLAKE2b-256 2044ca9cfed870780d33ec58ff76eabf31c1c4a0047ac99333636d14d116ff7f

See more details on using hashes here.

File details

Details for the file agent_framework_redis-1.0.0b251112-py3-none-any.whl.

File metadata

File hashes

Hashes for agent_framework_redis-1.0.0b251112-py3-none-any.whl
Algorithm Hash digest
SHA256 46c6f29bc1fb5913593ca953d0217c99f627f808bfc30f53cb9c150790679e97
MD5 ab98a62022cf922b848e1fca1458c0c5
BLAKE2b-256 2f5e211455ded92bb38893f2c43f8a37e3daa2729ce33d1d401fc9c334e3dba7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page