mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Eduard van Valkenburg
50fdcbaf57
* chore(python): improve dependency range automation - tighten dependency bounds and coding standards guidance\n- add dependency range validation workflow, reporting, and issue automation\n- update related tests and dependency pins for compatibility Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * updated text and pyarrow * new lock * fixed workflow * updated deps * fix tiktoken * chore(python): refine dependency validation workflows Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs(python): add high-level dependency validation comments Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * WIP * added additional comments and excludes * added dev dependency handling and workflow and updates to package ranges * added readme and simplified commands * fix markers * chore(python): address dependency review feedback Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Tighten dependency bounds, remove stale overrides, restore Python 3.10 support - Apply dependency bound policy across all packages: stable >=1.0 deps use >=floor,<next_major; pre-1.0/prerelease deps use validated hard-bounded ranges - Remove stale root tool.uv.override-dependencies (uvicorn, websockets, grpcio) - Lower github_copilot requires-python to >=3.10 with github-copilot-sdk gated behind python_version >= 3.11 marker; import raises ImportError on 3.10 - Skip github_copilot pyright/mypy/test tasks on Python <3.11 - Use version-conditional pyrightconfig for samples on Python 3.10 - Add compatibility fix in core responses client for older openai typed dicts - Normalize uv.lock prerelease mode and refresh dev dependencies - Update CODING_STANDARD.md, DEV_SETUP.md, and package management skill docs Closes #902 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * small tweaks * add note in workflow * fix workflows and several versions * fix duplicate --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
54 lines
1.9 KiB
Markdown
54 lines
1.9 KiB
Markdown
# Get Started with Microsoft Agent Framework Redis
|
|
|
|
Please install this package via pip:
|
|
|
|
```bash
|
|
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](../../samples/02-agents/context_providers/redis/README.md) 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](../../samples/02-agents/conversations/redis_history_provider.py) 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
|
|
```bash
|
|
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
|