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

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.0b251001.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.0b251001-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for agent_framework_redis-1.0.0b251001.tar.gz
Algorithm Hash digest
SHA256 a0ca7cff1be8034e727de3c28c121051c7a0a2d5d1844b2ec31837b7d614ea11
MD5 6f73e227170741ce97275633dad0ea98
BLAKE2b-256 3ff53fab9cbc956e75bbef531306af629e5c6860198e6b54aa216a268a1a188e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for agent_framework_redis-1.0.0b251001-py3-none-any.whl
Algorithm Hash digest
SHA256 7ee2b73e1812764e86a92c369510d65c66e0d93ddc6080c51d8927534424b3fa
MD5 2e65534652a1acabd8933cc48770f6d6
BLAKE2b-256 a6cbc36617dc9954b3fb75eedea8d3f23055b83cd6590a3f65a1f6394d2b5aac

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