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 RedisContextProvider enables persistent context and 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 History Provider

The RedisHistoryProvider 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 history provider examples including:

  • User session management
  • Conversation persistence across restarts
  • Session 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.0b260319.tar.gz (10.5 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.0b260319-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: agent_framework_redis-1.0.0b260319.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for agent_framework_redis-1.0.0b260319.tar.gz
Algorithm Hash digest
SHA256 15befd808cd64df278b80cb0a159e26d61ad85832a2fdacdb4621c71099a1e1f
MD5 0e760dbabe55de4f956b696c5b34a38b
BLAKE2b-256 a8532b244bf3fb347ce226695eae20861dc0ea924b19c18499a1859fb58dec5e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: agent_framework_redis-1.0.0b260319-py3-none-any.whl
  • Upload date:
  • Size: 10.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for agent_framework_redis-1.0.0b260319-py3-none-any.whl
Algorithm Hash digest
SHA256 84507f4590832761c7ef950013ccc78afdf9fe8c72f04b2ef3c9cbb59a49c665
MD5 91c2fd94fde8c5b80884292a12559443
BLAKE2b-256 d17c2eeb150b1cdbcef9562f3e6a94957b95ce82f4550ab2448ad58e395294c3

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