agent-framework/python/samples/02-agents/conversations

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 BaseHistoryProvider, 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.
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_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