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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for agent_framework_redis-1.0.0b251111.tar.gz
Algorithm Hash digest
SHA256 c0ba7d7aae960f6ec870543715dc496e9d51a9ca8c3520214be2452f0657df96
MD5 728d2aff3f2e8033fbef616ec8fed898
BLAKE2b-256 f8182171cf18e764ba301d87db287bb4a82c21501f2095baac5599ab6e186b18

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for agent_framework_redis-1.0.0b251111-py3-none-any.whl
Algorithm Hash digest
SHA256 4106bcfb59e45fbe4865214a6587e06a3a8061aa52505b0ff2028c6a919787db
MD5 be77ea3325a620b6263184a9f7fb5cf9
BLAKE2b-256 f693695f2d6e22e7da850a094eb5a6764d12134f8d8f6a18dee636e35da77bec

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