Skip to content

Python: Fix group chat broadcast to include next speaker when it re-speaks#4736

Open
yashy797 wants to merge 4 commits intomicrosoft:mainfrom
yashy797:fix_group_chat_sample
Open

Python: Fix group chat broadcast to include next speaker when it re-speaks#4736
yashy797 wants to merge 4 commits intomicrosoft:mainfrom
yashy797:fix_group_chat_sample

Conversation

@yashy797
Copy link

Motivation and Context

When the orchestrator selects the same participant to speak in consecutive turns, the broadcast step after the first response skips that participant (because it was the one who just responded). This means the participant's AgentExecutor cache is not repopulated with its own response before the follow-up request arrives, causing the agent to miss context or potentially triggering errors from empty message payloads.

Related to #3705 — that issue addressed empty message content in the same _handle_response methods by adding clean_conversation_for_handoff. This fix addresses a separate broadcast filtering bug in the same code path.

Description

Fixes the message broadcasting filter in both GroupChatOrchestrator._handle_response and AgentBasedGroupChatOrchestrator._handle_response so that when the next speaker is the same participant that just responded, it still receives the broadcast.

Changes in _group_chat.py:

  1. GroupChatOrchestrator._handle_response — the participant filter now uses p != participant or p == next_speaker instead of p != participant, ensuring the next speaker is always included in the broadcast even if it just responded.

  2. AgentBasedGroupChatOrchestrator._handle_response — same filtering logic applied. Additionally, next_speaker is extracted into a local variable for clarity and reused in both the broadcast filter and the subsequent _send_request_to_participant call.

Both orchestrators now share the comment explaining the rationale:

"…except the participant that just responded (unless it is also the next speaker, in which case it must receive the broadcast so its executor cache is repopulated before the follow-up request arrives)."

Contribution Checklist

  • The code builds clean without any errors or warnings
  • The PR follows the Contribution Guidelines
  • All unit tests pass, and I have added new tests where possible
  • Is this a breaking change? No — this is a bug fix with no public API changes.

Copilot AI review requested due to automatic review settings March 17, 2026 04:23
@microsoft-github-policy-service

@yashy797 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes a group chat orchestration edge case where the broadcast step incorrectly skipped the next speaker when the same participant was selected to speak twice in a row, which could leave that participant’s executor cache missing its own latest response.

Changes:

  • Adjust participant broadcast filtering in both GroupChatOrchestrator._handle_response and AgentBasedGroupChatOrchestrator._handle_response to always include next_speaker even if it’s the participant who just responded.
  • Update the ChatKit integration sample to generate upload/preview URLs via the frontend dev-server proxy and migrate attachment upload metadata to upload_descriptor.
  • Update several chat client samples to use the newer Message/Content inputs for get_response.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
python/packages/orchestrations/agent_framework_orchestrations/_group_chat.py Fixes broadcast recipient filtering to include the next speaker when it re-speaks.
python/samples/05-end-to-end/chatkit-integration/app.py Adjusts URL generation for attachments + updates function-result handling; introduces an unused import.
python/samples/05-end-to-end/chatkit-integration/attachment_store.py Migrates attachment metadata from upload_url to upload_descriptor.
python/samples/05-end-to-end/chatkit-integration/frontend/vite.config.ts Adds Vite dev-server proxies for /upload and /preview.
python/samples/02-agents/chat_client/custom_chat_client.py Updates sample to call get_response with Message/Content.
python/samples/02-agents/chat_client/chat_response_cancellation.py Updates sample to call get_response with Message/Content (but currently likely violates line-length lint).
python/samples/02-agents/chat_client/built_in_chat_clients.py Updates sample prompt handling to use Message/Content.

Comment on lines +79 to +83
# Use the frontend origin for generated URLs (upload, preview) so that the browser
# sends them through the Vite dev-server proxy instead of directly to the backend,
# avoiding cross-origin issues.
FRONTEND_PORT = 5171
SERVER_BASE_URL = f"http://localhost:{FRONTEND_PORT}"

try:
task = asyncio.create_task(client.get_response(messages=["Tell me a fantasy story."]))
task = asyncio.create_task(client.get_response([Message(role="user", contents=[Content.from_text("Tell me a fantasy story.")])]))
Comment on lines 206 to +218
next_speaker = await self._get_next_speaker()

# Broadcast participant messages to all participants for context, except
# the participant that just responded
# the participant that just responded (unless it is also the next speaker,
# in which case it must receive the broadcast so its executor cache is
# repopulated before the follow-up request arrives).
participant = ctx.get_source_executor_id()
await self._broadcast_messages_to_participants(
messages,
cast(WorkflowContext[AgentExecutorRequest | GroupChatParticipantMessage], ctx),
participants=[p for p in self._participant_registry.participants if p != participant],
participants=[
p for p in self._participant_registry.participants if p != participant or p == next_speaker
],
Comment on lines +31 to +32
#from agent_framework import Agent, AgentResponseUpdate, FunctionResultContent, Message, Role, tool
from agent_framework import Agent, AgentResponseUpdate, Content, Message, Role, tool
Comment on lines 76 to +83
# Server configuration
SERVER_HOST = "127.0.0.1" # Bind to localhost only for security (local dev)
SERVER_PORT = 8001
SERVER_BASE_URL = f"http://localhost:{SERVER_PORT}"
# Use the frontend origin for generated URLs (upload, preview) so that the browser
# sends them through the Vite dev-server proxy instead of directly to the backend,
# avoiding cross-origin issues.
FRONTEND_PORT = 5171
SERVER_BASE_URL = f"http://localhost:{FRONTEND_PORT}"
@TaoChenOSU
Copy link
Contributor

Hi @yashy797,

Thank you for your contribution!

The agent that just responded will have the response in its context, thus we don't need to prepopulate the cache with its own response. Are you an issue where the agent is missing its own response? Could you provide a reproduction?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants