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

Files

T

Dmytro Struk eec7f192eb Python: Added chat middleware and more examples (#883 )

* Added example with stateful middleware

* Added chat middleware

* Updated middleware example with override scenario

* Small revert

* Small fixes

* Added kwargs to context objects

* Added README

* Added function middleware to chat client

* Small refactoring

* Reverted example files

* Made MiddlewareWrapper generic

* Added Middleware exception

* Small refactoring

* Small fix

eec7f192eb · 2025-09-26 15:10:56 +00:00

History

custom_agent.py

Python: Add custom agent and chat client implementation examples (#849 )

2025-09-22 04:42:33 +00:00

custom_chat_client.py

Python: Added chat middleware and more examples (#883 )

2025-09-26 15:10:56 +00:00

README.md

Python: Add custom agent and chat client implementation examples (#849 )

2025-09-22 04:42:33 +00:00

README.md

Custom Agent and Chat Client Examples

This folder contains examples demonstrating how to implement custom agents and chat clients using the Microsoft Agent Framework.

Examples

File	Description
`custom_agent.py`	Shows how to create custom agents by extending the `BaseAgent` class. Demonstrates the `EchoAgent` implementation with both streaming and non-streaming responses, proper thread management, and message history handling.
`custom_chat_client.py`	Demonstrates how to create custom chat clients by extending the `BaseChatClient` class. Shows the `EchoingChatClient` implementation and how to integrate it with `ChatAgent` using the `create_agent()` method.

Key Takeaways

Custom Agents

Custom agents give you complete control over the agent's behavior
You must implement both run() (for complete responses) and run_stream() (for streaming responses)
Use self._normalize_messages() to handle different input message formats
Use self._notify_thread_of_new_messages() to properly manage conversation history

Custom Chat Clients

Custom chat clients allow you to integrate any backend service or create new LLM providers
You must implement both _inner_get_response() and _inner_get_streaming_response()
Custom chat clients can be used with ChatAgent to leverage all agent framework features
Use the create_agent() method to easily create agents from your custom chat clients

Both approaches allow you to extend the framework for your specific use cases while maintaining compatibility with the broader Agent Framework ecosystem.