mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00

Files

T

Aayush Kataria 30a2bc3dcb Python: Add Cosmos DB NoSQL Checkpoint Storage for Python Workflows (#4916 )

* Add CosmosCheckpointStorage for Python workflow checkpointing

Add native Cosmos DB NoSQL support for workflow checkpoint storage in the
Python agent-framework-azure-cosmos package, achieving parity with the
existing .NET CosmosCheckpointStore.

New files:
- _checkpoint_storage.py: CosmosCheckpointStorage implementing the
  CheckpointStorage protocol with 6 methods (save, load, list_checkpoints,
  delete, get_latest, list_checkpoint_ids)
- test_cosmos_checkpoint_storage.py: Unit and integration tests
- workflow_checkpointing.py: Sample demonstrating Cosmos DB-backed
  workflow checkpoint/resume

Auth support:
- Managed identity / RBAC via Azure credential objects
  (DefaultAzureCredential, ManagedIdentityCredential, etc.)
- Key-based auth via account key string or AZURE_COSMOS_KEY env var
- Pre-created CosmosClient or ContainerProxy

Key design decisions:
- Partition key: /workflow_name for efficient per-workflow queries
- Serialization: Reuses encode/decode_checkpoint_value for full Python
  object fidelity (hybrid JSON + pickle approach)
- Container auto-creation via create_container_if_not_exists

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Adding cosmos checkpointer

* Resolving comments

* Fixing builds

* Adding sample for history provider and checkpoint storage

* Resolving comments

* fixing builds

* Resolving comments

---------

Co-authored-by: Aayush Kataria <aayushkataria@Aayushs-MacBook-Pro-2.local>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com>

2026-04-09 05:01:41 +00:00

2.8 KiB

Raw Permalink Blame History

Conversation & Session Management Samples

These samples demonstrate different approaches to managing conversation history and session state in Agent Framework.

Samples

File	Description
`suspend_resume_session.py`	Suspend and resume conversation sessions, comparing service-managed sessions (Azure AI Foundry) with in-memory sessions (OpenAI).
`custom_history_provider.py`	Implement a custom history provider by extending `HistoryProvider`, enabling conversation persistence in your preferred storage backend.
`cosmos_history_provider.py`	Use Azure Cosmos DB as a history provider for durable conversation storage with `CosmosHistoryProvider`.
`cosmos_history_provider_conversation_persistence.py`	Persist and resume conversations across application restarts using `CosmosHistoryProvider` — serialize session state, restore it, and continue with full Cosmos DB history.
`cosmos_history_provider_messages.py`	Direct message history operations — retrieve stored messages as a transcript, clear session history, and verify data deletion.
`cosmos_history_provider_sessions.py`	Multi-session and multi-tenant management — per-tenant session isolation, `list_sessions()` to enumerate, switch between sessions, and resume specific conversations.
`redis_history_provider.py`	Use Redis as a history provider for persistent conversation history storage across sessions.

Prerequisites

For suspend_resume_session.py:

FOUNDRY_PROJECT_ENDPOINT: Your Azure AI Foundry project endpoint (service-managed session)
FOUNDRY_MODEL: The Foundry model deployment name
OPENAI_API_KEY: Your OpenAI API key (in-memory session)
Azure CLI authentication (az login)

For custom_history_provider.py:

OPENAI_API_KEY: Your OpenAI API key

For Cosmos DB samples (cosmos_history_provider*.py):

FOUNDRY_PROJECT_ENDPOINT: Your Azure AI Foundry project endpoint
FOUNDRY_MODEL: The Foundry model deployment name
AZURE_COSMOS_ENDPOINT: Your Azure Cosmos DB account endpoint
AZURE_COSMOS_DATABASE_NAME: The database that stores conversation history
AZURE_COSMOS_CONTAINER_NAME: The container that stores conversation history
Either AZURE_COSMOS_KEY or Azure CLI authentication (az login)

For redis_history_provider.py:

OPENAI_API_KEY: Your OpenAI API key
A running Redis server — default URL is redis://localhost:6379
- Override via the REDIS_URL environment variable for remote or authenticated instances
- Quickstart with Docker: docker run -d --name redis-stack -p 6379:6379 redis/redis-stack-server:latest

2.8 KiB Raw Permalink Blame History

Conversation & Session Management Samples

Samples

Prerequisites

2.8 KiB

Raw Permalink Blame History