agent-framework/python/packages/azure-cosmos

Get Started with Microsoft Agent Framework Azure Cosmos DB

Please install this package via pip:

pip install agent-framework-azure-cosmos --pre

Azure Cosmos DB History Provider

The Azure Cosmos DB integration provides CosmosHistoryProvider for persistent conversation history storage.

Basic Usage Example

from azure.identity.aio import DefaultAzureCredential
from agent_framework_azure_cosmos import CosmosHistoryProvider

provider = CosmosHistoryProvider(
    endpoint="https://<account>.documents.azure.com:443/",
    credential=DefaultAzureCredential(),
    database_name="agent-framework",
    container_name="chat-history",
)

Credentials follow the same pattern used by other Azure connectors in the repository:

• Pass a credential object (for example DefaultAzureCredential)
• Or pass a key string directly
• Or set AZURE_COSMOS_KEY in the environment

Container naming behavior:

• Container name is configured on the provider (container_name or AZURE_COSMOS_CONTAINER_NAME)
• session_id is used as the Cosmos partition key for reads/writes

See samples/cosmos_history_provider.py for a runnable package-local example.