microsoft-agents-hosting-aiohttp (original) (raw)

Integration library for hosting Microsoft 365 Agents using aiohttp. This library provides HTTP adapters, middleware, and utilities for building web-based agent applications with the popular aiohttp framework.

This library bridges the Microsoft 365 Agents SDK with aiohttp, allowing you to create HTTP endpoints that handle agent conversations. It provides everything you need to host agents as web services, including request processing, authentication, and routing.

What is this?

This library is part of the Microsoft 365 Agents SDK for Python - a comprehensive framework for building enterprise-grade conversational AI agents. The SDK enables developers to create intelligent agents that work across multiple platforms including Microsoft Teams, M365 Copilot, Copilot Studio, and web chat, with support for third-party integrations like Slack, Facebook Messenger, and Twilio.

Release Notes

Packages Overview

We offer the following PyPI packages to create conversational experiences based on Agents:

Package Name	PyPI Version	Description
microsoft-agents-activity		Types and validators implementing the Activity protocol spec.
microsoft-agents-hosting-core		Core library for Microsoft Agents hosting.
microsoft-agents-hosting-aiohttp		Configures aiohttp to run the Agent.
microsoft-agents-hosting-teams		Provides classes to host an Agent for Teams.
microsoft-agents-storage-blob		Extension to use Azure Blob as storage.
microsoft-agents-storage-cosmos		Extension to use CosmosDB as storage.
microsoft-agents-authentication-msal		MSAL-based authentication for Microsoft Agents.

Additionally we provide a Copilot Studio Client, to interact with Agents created in CopilotStudio:

Package Name	PyPI Version	Description
microsoft-agents-copilotstudio-client		Direct to Engine client to interact with Agents created in CopilotStudio

Installation

pip install microsoft-agents-hosting-aiohttp

Simple Echo Agent

See the Quickstart sample for full working code.

agents_sdk_config = load_configuration_from_env(environ)

STORAGE = MemoryStorage() CONNECTION_MANAGER = MsalConnectionManager(**agents_sdk_config) ADAPTER = CloudAdapter(connection_manager=CONNECTION_MANAGER) AUTHORIZATION = Authorization(STORAGE, CONNECTION_MANAGER, **agents_sdk_config)

AGENT_APP = AgentApplication[TurnState]( storage=STORAGE, adapter=ADAPTER, authorization=AUTHORIZATION, **agents_sdk_config )

@AGENT_APP.activity("message") async def on_message(context: TurnContext, state: TurnState): await context.send_activity(f"You said: {context.activity.text}")

...

start_server( agent_application=AGENT_APP, auth_configuration=CONNECTION_MANAGER.get_default_connection_configuration(), )

Error Handling

Customize error responses. Code take from the Quickstart sample.

@AGENT_APP.error async def on_error(context: TurnContext, error: Exception): # This check writes out errors to console log # NOTE: In production environment, you should consider logging this to Azure # application insights. print(f"\n [on_turn_error] unhandled error: {error}", file=sys.stderr) traceback.print_exc()

# Send a message to the user
await context.send_activity("The bot encountered an error or bug.")

Features

✅ HTTP hosting - Full aiohttp integration for web hosting
✅ JWT authentication - Built-in security with middleware
✅ Agent-to-agent - Support for multi-agent communication
✅ Streaming - Real-time response streaming
✅ Error handling - Comprehensive error management
✅ Development friendly - Hot reload and debugging support

Requirements

• Python 3.10+ (supports 3.10, 3.11, 3.12, 3.13, 3.14)
• aiohttp 3.11.11+
• Microsoft Agents hosting core library

Best Practices

1. Use middleware for cross-cutting concerns like auth and logging
2. Handle errors gracefully with custom error handlers
3. Secure your endpoints with JWT middleware in production
4. Structure routes logically for agent communication

Quick Links

• 📦 All SDK Packages on PyPI
• 📖 Complete Documentation
• 💡 Python Samples Repository
• 🐛 Report Issues

Sample Applications