[BREAKING] Python: Standardize orchestration outputs as list of ChatMessage. Allow agent as group chat manager. #2291
+1,720
−569
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tions to group chat prompt manager
moonbox3
added
agent orchestration
markwallace-microsoft
added
documentation
moonbox3
changed the title
Member
Copilot finished reviewing on behalf of
moonbox3
November 18, 2025 06:08
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR standardizes orchestration outputs in the Python agent framework to consistently return list[ChatMessage] instead of a single ChatMessage. Previously, group chat and magentic orchestrations returned a single message while other orchestrations (sequential, concurrent, handoff) returned lists, creating inconsistency. The PR also adds the ability to configure ChatOptions for the group chat prompt-based manager, allowing fine-tuned control over LLM parameters like temperature and seed for reproducible manager decisions.
Key changes:
- Group chat and magentic orchestrations now yield the full conversation history as
list[ChatMessage]instead of just the final message - Added
chat_optionsparameter toGroupChatBuilder.set_prompt_based_manager()and_PromptBasedGroupChatManager - Updated all tests and samples to handle the new list output format
Reviewed Changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| python/uv.lock | Version bump for ag-ui package |
| python/samples/semantic-kernel-migration/orchestrations/group_chat.py | Updated to handle both list and single message outputs for migration compatibility |
| python/samples/getting_started/workflows/orchestration/group_chat_with_chat_options.py | New sample demonstrating ChatOptions configuration for prompt-based manager |
| python/samples/getting_started/workflows/orchestration/group_chat_simple_selector.py | Updated to iterate over full conversation list instead of single message |
| python/samples/getting_started/workflows/orchestration/group_chat_prompt_based_manager.py | Updated to display full conversation history instead of single response |
| python/samples/getting_started/workflows/README.md | Added entry for new ChatOptions sample |
| python/packages/core/tests/workflow/test_magentic.py | Updated assertions to expect list output and verify conversation structure |
| python/packages/core/tests/workflow/test_group_chat.py | Updated test expectations for list outputs and added test for chat_options passthrough |
| python/packages/core/agent_framework/_workflows/_magentic.py | Changed output type from ChatMessage to list[ChatMessage], yields full conversation with final answer |
| python/packages/core/agent_framework/_workflows/_group_chat.py | Added chat_options support to prompt manager, changed yield_output to return full conversation list |
python/samples/getting_started/workflows/orchestration/group_chat_with_chat_options.py
Outdated
Show resolved
Hide resolved
python/samples/semantic-kernel-migration/orchestrations/group_chat.py
Outdated
Show resolved
Hide resolved
moonbox3
changed the title
python/samples/getting_started/workflows/orchestration/group_chat_philosophical_debate.py
Outdated
Show resolved
Hide resolved
eavanvalkenburg
approved these changes
Nov 24, 2025
Member
eavanvalkenburg
left a comment
eavanvalkenburg
left a comment
There was a problem hiding this comment.
Approved with one small comment on the add_manager method
python/samples/getting_started/workflows/orchestration/group_chat_agent_manager.py
Show resolved
Hide resolved
TaoChenOSU
reviewed
Nov 24, 2025
TaoChenOSU
reviewed
Nov 26, 2025
TaoChenOSU
approved these changes
Nov 26, 2025
eavanvalkenburg
approved these changes
Nov 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
Currently there is a divergence in the types returned from some orchestrations - for example, group chat/magentic return a ChatMessage versus others (sequential, concurrent, handoff) return a list[ChatMessage]. To standardize, also to what an agent can return, we're adjusting the output for group chat/magentic to be a list[ChatMessage].
Additionally, for a group chat, when configuring a manager, allow for the use of an Agent or an Executor. The underlying group chat architecture was refactored to allow for the agent / executor manager to actually be a node in the group chat graph in place of the previous PromptManager class.
Caution
This is a breaking change. Will hold this PR until after Ignite.
Description
Closes: #2272, #2228, #2350
Contribution Checklist