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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for agent_framework_redis-1.0.0b251104.tar.gz
Algorithm Hash digest
SHA256 922d1f49fcae6797ac95a35b19c5b59863215d87b83f7b92e498729b39f91877
MD5 17372249e3d826c735dbd23d6467d5e5
BLAKE2b-256 71b7db526eaf6f69ba3b677d077c82370840c309ee2984cd0337ba23aed6b23b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for agent_framework_redis-1.0.0b251104-py3-none-any.whl
Algorithm Hash digest
SHA256 ebdcccdd4ac9981ba28ec1fc5c81e4c1148739fa0178a3f9e0e275b356fa2de6
MD5 dee87086122c9e64a395a8e356eb3a28
BLAKE2b-256 e547c156d90791f3bfc9a78a616b439cedc7c716a4521a85e198174f22020974

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