Skip to content

A programming framework for agentic AI

7.4 KB
Raw Blame
// Copyright (c) Microsoft Corporation. All rights reserved.
// GroupChat.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;

namespace AutoGen.Core;

public class GroupChat : IGroupChat
{
    private IAgent? admin;
    private List<IAgent> agents = new List<IAgent>();
    private IEnumerable<IMessage> initializeMessages = new List<IMessage>();
    private Graph? workflow;
    private readonly IOrchestrator orchestrator;

    public IEnumerable<IMessage>? Messages { get; private set; }

    /// <summary>
    /// Create a group chat. The next speaker will be decided by a combination effort of the admin and the workflow.
    /// </summary>
    /// <param name="admin">admin agent. If provided, the admin will be invoked to decide the next speaker.</param>
    /// <param name="workflow">workflow of the group chat. If provided, the next speaker will be decided by the workflow.</param>
    /// <param name="members">group members.</param>
    /// <param name="initializeMessages"></param>
    public GroupChat(
        IEnumerable<IAgent> members,
        IAgent? admin = null,
        IEnumerable<IMessage>? initializeMessages = null,
        Graph? workflow = null)
    {
        this.admin = admin;
        this.agents = members.ToList();
        this.initializeMessages = initializeMessages ?? new List<IMessage>();
        this.workflow = workflow;

        if (admin is not null)
        {
            this.orchestrator = new RolePlayOrchestrator(admin, workflow);
        }
        else if (workflow is not null)
        {
            this.orchestrator = new WorkflowOrchestrator(workflow);
        }
        else
        {
            this.orchestrator = new RoundRobinOrchestrator();
        }

        this.Validation();
    }

    /// <summary>
    /// Create a group chat which uses the <paramref name="orchestrator"/> to decide the next speaker(s).
    /// </summary>
    /// <param name="members"></param>
    /// <param name="orchestrator"></param>
    /// <param name="initializeMessages"></param>
    public GroupChat(
        IEnumerable<IAgent> members,
        IOrchestrator orchestrator,
        IEnumerable<IMessage>? initializeMessages = null)
    {
        this.agents = members.ToList();
        this.initializeMessages = initializeMessages ?? new List<IMessage>();
        this.orchestrator = orchestrator;

        this.Validation();
    }

    private void Validation()
    {
        // check if all agents has a name
        if (this.agents.Any(x => string.IsNullOrEmpty(x.Name)))
        {
            throw new ArgumentException("All agents must have a name.");
        }

        // check if any agents has the same name
        var names = this.agents.Select(x => x.Name).ToList();
        if (names.Distinct().Count() != names.Count)
        {
            throw new ArgumentException("All agents must have a unique name.");
        }

        // if there's a workflow
        // check if the agents in that workflow are in the group chat
        if (this.workflow != null)
        {
            var agentNamesInWorkflow = this.workflow.Transitions.Select(x => x.From.Name!).Concat(this.workflow.Transitions.Select(x => x.To.Name!)).Distinct();
            if (agentNamesInWorkflow.Any(x => !this.agents.Select(a => a.Name).Contains(x)))
            {
                throw new ArgumentException("All agents in the workflow must be in the group chat.");
            }
        }
    }

    /// <summary>
    /// Select the next speaker based on the conversation history.
    /// The next speaker will be decided by a combination effort of the admin and the workflow.
    /// Firstly, a group of candidates will be selected by the workflow. If there's only one candidate, then that candidate will be the next speaker.
    /// Otherwise, the admin will be invoked to decide the next speaker using role-play prompt.
    /// </summary>
    /// <param name="currentSpeaker">current speaker</param>
    /// <param name="conversationHistory">conversation history</param>
    /// <returns>next speaker.</returns>
    [Obsolete("Please use RolePlayOrchestrator or WorkflowOrchestrator")]
    public async Task<IAgent> SelectNextSpeakerAsync(IAgent currentSpeaker, IEnumerable<IMessage> conversationHistory)
    {
        var agentNames = this.agents.Select(x => x.Name).ToList();
        if (this.workflow != null)
        {
            var nextAvailableAgents = await this.workflow.TransitToNextAvailableAgentsAsync(currentSpeaker, conversationHistory);
            agentNames = nextAvailableAgents.Select(x => x.Name).ToList();
            if (agentNames.Count == 0)
            {
                throw new ArgumentException("No next available agents found in the current workflow");
            }

            if (agentNames.Count == 1)
            {
                return this.agents.First(x => x.Name == agentNames.First());
            }
        }

        if (this.admin == null)
        {
            throw new ArgumentException("No admin is provided.");
        }

        var systemMessage = new TextMessage(Role.System,
            content: $@"You are in a role play game. Carefully read the conversation history and carry on the conversation.
The available roles are:
{string.Join(",", agentNames)}

Each message will start with 'From name:', e.g:
From {agentNames.First()}:
//your message//.");

        var conv = this.ProcessConversationsForRolePlay(this.initializeMessages, conversationHistory);

        var messages = new IMessage[] { systemMessage }.Concat(conv);
        var response = await this.admin.GenerateReplyAsync(
            messages: messages,
            options: new GenerateReplyOptions
            {
                Temperature = 0,
                MaxToken = 128,
                StopSequence = [":"],
                Functions = [],
            });

        var name = response?.GetContent() ?? throw new ArgumentException("No name is returned.");

        // remove From
        name = name!.Substring(5);
        return this.agents.First(x => x.Name!.ToLower() == name.ToLower());
    }

    /// <inheritdoc />
    public void AddInitializeMessage(IMessage message)
    {
        this.SendIntroduction(message);
    }

    public async Task<IEnumerable<IMessage>> CallAsync(
        IEnumerable<IMessage>? chatHistory = null,
        int maxRound = 10,
        CancellationToken ct = default)
    {
        var conversationHistory = new List<IMessage>();
        conversationHistory.AddRange(this.initializeMessages);
        if (chatHistory != null)
        {
            conversationHistory.AddRange(chatHistory);
        }
        var roundLeft = maxRound;

        while (roundLeft > 0)
        {
            var orchestratorContext = new OrchestrationContext
            {
                Candidates = this.agents,
                ChatHistory = conversationHistory,
            };
            var nextSpeaker = await this.orchestrator.GetNextSpeakerAsync(orchestratorContext, ct);
            if (nextSpeaker == null)
            {
                break;
            }

            var result = await nextSpeaker.GenerateReplyAsync(conversationHistory, cancellationToken: ct);
            conversationHistory.Add(result);

            if (result.IsGroupChatTerminateMessage())
            {
                return conversationHistory;
            }

            roundLeft--;
        }

        return conversationHistory;
    }

    public void SendIntroduction(IMessage message)
    {
        this.initializeMessages = this.initializeMessages.Append(message);
    }
}