Fixed speak order by g7xcy · Pull Request #500 · microsoft/autogen

g7xcy · 2023-10-31T10:00:30Z

Why are these changes needed?

Complex Group Chat may face the problem that Group Chat Manager cannot reasonably select the Next Speaker. At the same time, the order of agents in some automated processes is relatively fixed.

This PR adds agent_chat_chain: List[Agent] to the ConversableAgent class and enhances the run_chat method of the GroupChatManager class to ensure a fixed order of speakers in custom procedures.

Related issue number

"Close #485"

Checks

I've included any doc changes needed for https://microsoft.github.io/autogen/. See https://microsoft.github.io/autogen/docs/Contribute#documentation to build and test documentation locally.
I've added tests (if relevant) corresponding to the changes introduced in this PR.
I've made sure all auto checks have passed.

… order.

afourney · 2023-10-31T19:03:17Z

Thanks. This is indeed an issue that needs addressing. I had a quick look at the changes.

I have a couple of questions that you could perhaps answer before I start my review:

Why add agent_chat_chain to ConversibleAgent if the behavior is chiefly something that only the GroupChatManager is concerned with?
Given that the behavior / selection criteria is very different than the default GroupChatManager, why not create a new subclass -- perhaps AgentChainManager or RoundRobinChatManager or something to encapsulate this behavior? The GroupChatManager basically encodes a policy, or strategy, and I think we would invite other alternative strategies to be added in a similar way. Perhaps @gagb can chime in, since I believe he was involved in authoring the original manager.

microsoft-github-policy-service · 2023-10-31T19:03:48Z

@g7xcy 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.

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.
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.
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.
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.
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.

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.
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.
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.
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.
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.

gagb · 2023-11-01T20:11:28Z

Thanks. This is indeed an issue that needs addressing. I had a quick look at the changes.

I have a couple of questions that you could perhaps answer before I start my review:

Why add agent_chat_chain to ConversibleAgent if the behavior is chiefly something that only the GroupChatManager is concerned with?

Given that the behavior / selection criteria is very different than the default GroupChatManager, why not create a new subclass -- perhaps AgentChainManager or RoundRobinChatManager or something to encapsulate this behavior? The GroupChatManager basically encodes a policy, or strategy, and I think we would invite other alternative strategies to be added in a similar way. Perhaps @gagb can chime in, since I believe he was involved in authoring the original manager.

@LittleLittleCloud

g7xcy · 2023-11-02T07:07:07Z

@afourney
Yeah, good questions.
Well, I think it's more natural to encapsulate this behavior in ConversibleAgent. I want to make a ConversibleAgent Object with agent_chat_chain a pipeline for a stable procedure.
But yes, it makes more sense to encapsulate this behavior in a class like AgentChainManager or ProcedureManager or some other thing and put it into a group chat.

afourney · 2023-11-07T21:08:14Z

@g7xcy there is increasing interest on this issue. I think it would be great if you could revise this PR to subclass the GroupChat to ensure a fixed order.

I haven't delved too deeply into the code at this stage, but I think if you just assume a chat order that matches the order of agents provided in the GroupChat constructor, and override select_speaker to call next_agent, this should be enough. You could then pass an instance of this modified class to the GroupChatManager and get the behavior we want.

The CustomGroupChat class in this notebook is a good example: https://github.com/microsoft/autogen/blob/4e0a8972958a955acda65336494f9e02a2fb681f/notebook/agentchat_hierarchy_flow_using_select_speaker.ipynb

afourney · 2023-12-06T07:54:11Z

I believe this has been addressed via the new speaker_selection_method (round_robin).

* starting #520 - readme improvements * more for #520 * tiny announcement * cleanupheader * simplifying * move announcement to top * rearrange logo * we dont need the logo * bumping the date * added faq addressing #500

g7xcy added 2 commits October 31, 2023 14:14

Enhanced AssistantAgent and GroupChatManager to fit a fixed speak…

acb3d4e

… order.

Added unit test. Made conversable_agent fixed-order enable.

3460ba1

g7xcy had a problem deploying to openai October 31, 2023 10:00 — with GitHub Actions Failure

afourney added the group chat/teams group-chat-related issues label Oct 31, 2023

robzsaunders mentioned this pull request Nov 1, 2023

Finding solution for select_speaker and agent_by_name functions: Sterilization or ?? #489

Closed

This was referenced Nov 6, 2023

Improve manager's agent selection logic #565

Closed

How to set multiple agents flow in the Groupchat #584

Closed

afourney closed this Dec 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed speak order#500

Fixed speak order#500
g7xcy wants to merge 2 commits into
microsoft:mainfrom
g7xcy:fixed-speak-order

g7xcy commented Oct 31, 2023

Uh oh!

afourney commented Oct 31, 2023 •

edited

Loading

Uh oh!

microsoft-github-policy-service Bot commented Oct 31, 2023

Contribution License Agreement

Uh oh!

gagb commented Nov 1, 2023

Uh oh!

g7xcy commented Nov 2, 2023

Uh oh!

afourney commented Nov 7, 2023

Uh oh!

afourney commented Dec 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

g7xcy commented Oct 31, 2023

Why are these changes needed?

Related issue number

Checks

Uh oh!

afourney commented Oct 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

microsoft-github-policy-service Bot commented Oct 31, 2023

Contribution License Agreement

Uh oh!

gagb commented Nov 1, 2023

Uh oh!

g7xcy commented Nov 2, 2023

Uh oh!

afourney commented Nov 7, 2023

Uh oh!

afourney commented Dec 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

afourney commented Oct 31, 2023 •

edited

Loading