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

Files

T

Eduard van Valkenburg 0521f5bed8 Python: [BREAKING] Simplify API: ChatAgent -> Agent, ChatMessage -> Message (#3747 )

* [BREAKING] Rename ChatAgent -> Agent, ChatMessage -> Message, ChatClientProtocol -> SupportsChatGetResponse

Simplify the public API by removing redundant 'Chat' prefix from core types:
- ChatAgent -> Agent
- RawChatAgent -> RawAgent
- ChatMessage -> Message
- ChatClientProtocol -> SupportsChatGetResponse

Also renamed internal WorkflowMessage (was Message in _runner_context) to avoid collision.

No backward compatibility aliases - this is a clean breaking change.

* [BREAKING] Rename Agent chat_client parameter to client

* Fix rebase issues: WorkflowMessage references and broken markdown links

* Fix formatting and lint issues from code quality checks

* Fix import ordering in workflow sample files

* fixed rebase

* Fix test failures: use WorkflowMessage and A2AMessage after ChatMessage→Message rename

- Replace Message(data=..., source_id=...) with WorkflowMessage(...) in workflow tests
- Fix isinstance check in A2A agent to use A2AMessage instead of Message
- Fix import in test_workflow_observability.py (Message→WorkflowMessage)

* Fix lint, fmt, and sample errors after ChatMessage→Message rename

- Auto-fix 70+ ruff lint issues across samples (ChatMessage→Message refs)
- Fix HostedVectorStoreContent→Content.from_hosted_vector_store in file search sample
- Fix _normalize_messages→normalize_messages in custom agent sample
- Fix context.terminate→raise MiddlewareTermination in middleware samples
- Fix with_update_hook→with_transform_hook in override middleware sample
- Add TOptions_co import back to custom_chat_client sample
- Add noqa for FastAPI File() default in chatkit sample
- Fix B023 loop variable capture in weather agent sample

* fix: update Agent constructor calls from chat_client to client in declaration-only tool tests

* fix: add register_cleanup to devui lazy-loading proxy and type stub

* fixed tests and updated new pieces

* fix agui typevar

* fix merge errors

* fix merge conflicts

* fiux merge

* Remove unused links

---------

Co-authored-by: Evan Mattson <evan.mattson@microsoft.com>

0521f5bed8 · 2026-02-10 23:04:32 +00:00

History

orchestrations

Python: [BREAKING] Simplify API: ChatAgent -> Agent, ChatMessage -> Message (#3747 )

2026-02-10 23:04:32 +00:00

single_agent

Python: [BREAKING] Simplify API: ChatAgent -> Agent, ChatMessage -> Message (#3747 )

2026-02-10 23:04:32 +00:00

.gitignore

Python: AutoGen migration samples (#1738 )

2025-10-28 00:47:31 +00:00

pyrightconfig.json

Python: AutoGen migration samples (#1738 )

2025-10-28 00:47:31 +00:00

README.md

Python: [BREAKING] Simplify API: ChatAgent -> Agent, ChatMessage -> Message (#3747 )

2026-02-10 23:04:32 +00:00

README.md

AutoGen → Microsoft Agent Framework Migration Samples

This gallery helps AutoGen developers move to the Microsoft Agent Framework (AF) with minimal guesswork. Each script pairs AutoGen code with its AF equivalent so you can compare primitives, tooling, and orchestration patterns side by side while you migrate production workloads.

What's Included

Single-Agent Parity

01_basic_assistant_agent.py — Minimal AutoGen AssistantAgent and AF Agent comparison.
02_assistant_agent_with_tool.py — Function tool integration in both SDKs.
03_assistant_agent_thread_and_stream.py — Thread management and streaming responses.
04_agent_as_tool.py — Using agents as tools (hierarchical agent pattern) and streaming with tools.

Multi-Agent Orchestration

01_round_robin_group_chat.py — AutoGen RoundRobinGroupChat → AF GroupChatBuilder/SequentialBuilder.
02_selector_group_chat.py — AutoGen SelectorGroupChat → AF GroupChatBuilder.
03_swarm.py — AutoGen Swarm pattern → AF HandoffBuilder.
04_magentic_one.py — AutoGen MagenticOneGroupChat → AF MagenticBuilder.

Each script is fully async and the main() routine runs both implementations back to back so you can observe their outputs in a single execution.

Prerequisites

Python 3.10 or later.
Access to the necessary model endpoints (Azure OpenAI, OpenAI, etc.).
Installed SDKs: Install AutoGen and the Microsoft Agent Framework with:
```
pip install "autogen-agentchat autogen-ext[openai] agent-framework"
```
Service credentials exposed through environment variables (e.g., OPENAI_API_KEY).

Running Single-Agent Samples

From the repository root:

python samples/autogen-migration/single_agent/01_basic_assistant_agent.py

Every script accepts no CLI arguments and will first call the AutoGen implementation, followed by the AF version. Adjust the prompt or credentials inside the file as necessary before running.

Running Orchestration Samples

Advanced comparisons are in autogen-migration/orchestrations (RoundRobin, Selector, Swarm, Magentic). You can run them directly:

python samples/autogen-migration/orchestrations/01_round_robin_group_chat.py
python samples/autogen-migration/orchestrations/04_magentic_one.py

Tips for Migration

Default behavior differences: AutoGen's AssistantAgent is single-turn by default (max_tool_iterations=1), while AF's Agent is multi-turn and continues tool execution automatically.
Thread management: AF agents are stateless by default. Use agent.get_new_thread() and pass it to run() to maintain conversation state, similar to AutoGen's conversation context.
Tools: AutoGen uses FunctionTool wrappers; AF uses @tool decorators with automatic schema inference.
Orchestration patterns:
- RoundRobinGroupChat → SequentialBuilder or WorkflowBuilder
- SelectorGroupChat → GroupChatBuilder with LLM-based speaker selection
- Swarm → HandoffBuilder for agent handoff coordination
- MagenticOneGroupChat → MagenticBuilder for orchestrated multi-agent workflows