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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for agent_framework_redis-1.0.0b251105.tar.gz
Algorithm Hash digest
SHA256 1afb4bd60e4e1bcccc42d7daff120b62944a6e53a10d34d2fa02835b660a884b
MD5 6c8887fa4a886b6374733ff7cd4ea3a2
BLAKE2b-256 3332f4e9682c68aefca8b031cfe670edccc036a734f16369bf2747c1ac9cde3b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for agent_framework_redis-1.0.0b251105-py3-none-any.whl
Algorithm Hash digest
SHA256 f39c06bb548f5a7f0057b9531bd26ec923d84ccec222d6f909079880c298b9dc
MD5 71dc9aad5a1dacdfd51315b8432efa7e
BLAKE2b-256 52dfbcab2c9b02d78dd0e5a48cd8227c40272dba6182c0ea9d8fda75c5a2b175

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