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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for agent_framework_redis-1.0.0b251016.tar.gz
Algorithm Hash digest
SHA256 e45690f5a045eba23f97fc11da6618a82c1483a1033aa9b1ef8a4ae76173fbaf
MD5 3e075f928ec2564dc1985963207e1116
BLAKE2b-256 7c228526ff6f5382cf1c62a2a053f572292dce6d678919be2901b075d204b8e9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for agent_framework_redis-1.0.0b251016-py3-none-any.whl
Algorithm Hash digest
SHA256 e39f0bbf59680bfb047fb2548ccca3c83648f036be455531a1689bdba071b44d
MD5 429a2ae177f5aab157db8bc50c97db29
BLAKE2b-256 dc09061e6aacb88ade83186a99546b6d2c907c5cee0b791ecbc6b619cd5f7f13

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