mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
.NET: feat: Improve Support for AIAgent-as-Executor (#432)
* feat: Support Executor-targeted messages This adds support for only sending a message to a given executor. Messages will still only route through connected edges. * feat: Support sending all valid input types after starting a run * feat: Normalize AIAgent-as-Executor Message Protocol to use MEAI types
This commit is contained in:
Jacob Alber
@@ -0,0 +1,292 @@
|
||||
// Copyright (c) Microsoft. All rights reserved.
|
||||
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Diagnostics;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Text;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.Extensions.AI;
|
||||
using Microsoft.Extensions.AI.Agents;
|
||||
|
||||
namespace Microsoft.Agents.Workflows.UnitTests.Sample;
|
||||
|
||||
internal static class Step6EntryPoint
|
||||
{
|
||||
internal static int MaxSteps { get; set; }
|
||||
|
||||
public static async ValueTask RunAsync(TextWriter writer, int maxSteps = 2)
|
||||
{
|
||||
Step6EntryPoint.MaxSteps = maxSteps;
|
||||
|
||||
GroupChatBuilder builder = GroupChatBuilder.Create<RoundRobinGroupChatManager>()
|
||||
.AddParticipant(new HelloAgent(), shouldEmitEvents: true)
|
||||
.AddParticipant(new EchoAgent(), shouldEmitEvents: true);
|
||||
|
||||
Workflow<List<ChatMessage>> workflow = builder.ReduceToWorkflow();
|
||||
|
||||
StreamingRun run = await InProcessExecution.StreamAsync(workflow, [])
|
||||
.ConfigureAwait(false);
|
||||
await run.TrySendMessageAsync(new TurnToken(emitEvents: true));
|
||||
|
||||
await foreach (WorkflowEvent evt in run.WatchStreamAsync().ConfigureAwait(false))
|
||||
{
|
||||
if (evt is ExecutorCompleteEvent executorComplete)
|
||||
{
|
||||
Debug.WriteLine($"{executorComplete.ExecutorId}: {executorComplete.Data}");
|
||||
}
|
||||
else if (evt is AgentRunEvent agentRun && agentRun.Data is AgentRunResponse response)
|
||||
{
|
||||
foreach (ChatMessage message in response.Messages)
|
||||
{
|
||||
writer.WriteLine($"{agentRun.ExecutorId}: {message.Text}");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private sealed class RoundRobinGroupChatManager : GroupChatManager
|
||||
{
|
||||
public int TurnCount { get; private set; } = 0;
|
||||
public int MaxTurns { get; init; } = Step6EntryPoint.MaxSteps;
|
||||
|
||||
public override int? GetNextTurnExecutor(GroupChatHistory history)
|
||||
{
|
||||
if (this.ParticipantIds.Length == 0)
|
||||
{
|
||||
throw new InvalidOperationException("No participants in the group chat.");
|
||||
}
|
||||
|
||||
if (this.TurnCount >= this.MaxTurns)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
return this.TurnCount++ % this.ParticipantIds.Length;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
internal sealed class HelloAgent(string id = nameof(HelloAgent)) : AIAgent
|
||||
{
|
||||
public const string Greeting = "Hello World!";
|
||||
public const string DefaultId = nameof(HelloAgent);
|
||||
|
||||
public override string Id => id;
|
||||
|
||||
public override Task<AgentRunResponse> RunAsync(IReadOnlyCollection<ChatMessage> messages, AgentThread? thread = null, AgentRunOptions? options = null, CancellationToken cancellationToken = default)
|
||||
{
|
||||
AgentRunResponse response = new(new ChatMessage(ChatRole.Assistant, "Hello World!"));
|
||||
|
||||
return Task.FromResult(response);
|
||||
}
|
||||
|
||||
public override IAsyncEnumerable<AgentRunResponseUpdate> RunStreamingAsync(IReadOnlyCollection<ChatMessage> messages, AgentThread? thread = null, AgentRunOptions? options = null, CancellationToken cancellationToken = default)
|
||||
{
|
||||
throw new NotImplementedException();
|
||||
}
|
||||
}
|
||||
|
||||
internal sealed class EchoAgent(string id = nameof(EchoAgent)) : AIAgent
|
||||
{
|
||||
public const string Prefix = "You said: ";
|
||||
public const string DefaultId = nameof(EchoAgent);
|
||||
|
||||
public override string Id => id;
|
||||
|
||||
public override Task<AgentRunResponse> RunAsync(IReadOnlyCollection<ChatMessage> messages, AgentThread? thread = null, AgentRunOptions? options = null, CancellationToken cancellationToken = default)
|
||||
{
|
||||
if (messages.Count == 0)
|
||||
{
|
||||
throw new ArgumentException("No messages provided to echo.", nameof(messages));
|
||||
}
|
||||
|
||||
StringBuilder collectedText = new(Prefix);
|
||||
foreach (string messageText in messages.Select(message => message.Text)
|
||||
.Where(text => !string.IsNullOrEmpty(text)))
|
||||
{
|
||||
collectedText.AppendLine(messageText);
|
||||
}
|
||||
|
||||
AgentRunResponse result = new(new ChatMessage(ChatRole.Assistant, collectedText.ToString()));
|
||||
return Task.FromResult(result);
|
||||
}
|
||||
|
||||
public override IAsyncEnumerable<AgentRunResponseUpdate> RunStreamingAsync(IReadOnlyCollection<ChatMessage> messages, AgentThread? thread = null, AgentRunOptions? options = null, CancellationToken cancellationToken = default)
|
||||
{
|
||||
throw new NotImplementedException();
|
||||
}
|
||||
}
|
||||
|
||||
internal sealed class GroupChatHistory
|
||||
{
|
||||
private readonly List<ChatMessage> _messages = new();
|
||||
private int _bookmark = 0;
|
||||
|
||||
public void AddMessage(ChatMessage message)
|
||||
{
|
||||
this._messages.Add(message);
|
||||
}
|
||||
|
||||
public void AddMessages(IEnumerable<ChatMessage> messages)
|
||||
{
|
||||
this._messages.AddRange(messages);
|
||||
}
|
||||
|
||||
public void UpdateBookmark()
|
||||
{
|
||||
this._bookmark = this._messages.Count;
|
||||
}
|
||||
|
||||
public IReadOnlyList<ChatMessage> FullHistory => this._messages.AsReadOnly();
|
||||
public IEnumerable<ChatMessage> NewMessagesThisTurn => this._messages.Skip(this._bookmark);
|
||||
}
|
||||
|
||||
internal abstract class GroupChatManager
|
||||
{
|
||||
public string[] ParticipantIds { get; internal init; } = [];
|
||||
|
||||
public abstract int? GetNextTurnExecutor(GroupChatHistory history);
|
||||
}
|
||||
|
||||
internal sealed class GroupChatBuilder
|
||||
{
|
||||
private readonly List<ExecutorIsh> _participants = new();
|
||||
private readonly List<bool> _shouldEmitEvents = new();
|
||||
private readonly Func<string[], GroupChatManager> _managerFactory;
|
||||
|
||||
private GroupChatBuilder(Func<string[], GroupChatManager> managerFactory)
|
||||
{
|
||||
this._managerFactory = managerFactory;
|
||||
}
|
||||
|
||||
public static GroupChatBuilder Create<TManager>() where TManager : GroupChatManager, new()
|
||||
{
|
||||
return new GroupChatBuilder(participantIds => new TManager() { ParticipantIds = participantIds });
|
||||
}
|
||||
|
||||
public GroupChatBuilder AddParticipant(ExecutorIsh executor, bool shouldEmitEvents = false)
|
||||
{
|
||||
this._participants.Add(executor);
|
||||
this._shouldEmitEvents.Add(shouldEmitEvents);
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
public GroupChatBuilder AddParticipants(params ExecutorIsh[] executors)
|
||||
{
|
||||
this._participants.AddRange(executors);
|
||||
return this;
|
||||
}
|
||||
|
||||
public Workflow<List<ChatMessage>> ReduceToWorkflow()
|
||||
{
|
||||
string[] participantIds = this._participants.Select(identified => identified.Id).ToArray();
|
||||
GroupChatHost host = new(this._shouldEmitEvents.ToArray(), this._managerFactory(participantIds));
|
||||
|
||||
WorkflowBuilder builder = new WorkflowBuilder(host)
|
||||
.AddFanOutEdge(host, targets: this._participants.ToArray());
|
||||
|
||||
foreach (ExecutorIsh participant in this._participants)
|
||||
{
|
||||
builder.AddEdge(participant, host);
|
||||
}
|
||||
|
||||
return builder.Build<List<ChatMessage>>();
|
||||
|
||||
//bool IsMessageType(object? message) => message is ChatMessage || message is IEnumerable<ChatMessage>;
|
||||
}
|
||||
|
||||
private sealed class TurnAssignedEvent(string executorId, string nextSpeakerId) : ExecutorEvent(executorId, data: nextSpeakerId);
|
||||
|
||||
private sealed class GroupChatHost : Executor
|
||||
{
|
||||
private readonly bool[] _shouldEmitEvents;
|
||||
private readonly GroupChatManager _manager;
|
||||
private readonly bool _autoStartConversation;
|
||||
|
||||
private readonly GroupChatHistory _history = new();
|
||||
|
||||
public GroupChatHost(bool[] shouldEmitEvents, GroupChatManager manager, bool autoStartConversation = false) : base(nameof(GroupChatHost))
|
||||
{
|
||||
this._shouldEmitEvents = shouldEmitEvents;
|
||||
this._manager = manager ?? throw new ArgumentNullException(nameof(manager));
|
||||
this._autoStartConversation = autoStartConversation;
|
||||
}
|
||||
|
||||
protected override RouteBuilder ConfigureRoutes(RouteBuilder routeBuilder)
|
||||
{
|
||||
return routeBuilder.AddHandler<List<ChatMessage>>(this.HandleChatMessagesAsync)
|
||||
.AddHandler<ChatMessage>(this.HandleChatMessageAsync)
|
||||
.AddHandler<TurnToken>(this.AssignNextTurnAsync);
|
||||
}
|
||||
|
||||
private async Task TryAutoStartConversationAsync(IWorkflowContext context)
|
||||
{
|
||||
if (this._autoStartConversation && this.TryEnterConversation())
|
||||
{
|
||||
await this.AssignNextTurnAsync(new TurnToken(emitEvents: false), context).ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
|
||||
private async ValueTask HandleChatMessagesAsync(List<ChatMessage> initialMessages, IWorkflowContext context)
|
||||
{
|
||||
this._history.AddMessages(initialMessages);
|
||||
|
||||
await context.SendMessageAsync(initialMessages).ConfigureAwait(false);
|
||||
await this.TryAutoStartConversationAsync(context).ConfigureAwait(false);
|
||||
}
|
||||
|
||||
private async ValueTask HandleChatMessageAsync(ChatMessage message, IWorkflowContext context)
|
||||
{
|
||||
// First, add the message to the history, then forward to all executors
|
||||
this._history.AddMessage(message);
|
||||
|
||||
await context.SendMessageAsync(message).ConfigureAwait(false);
|
||||
await this.TryAutoStartConversationAsync(context).ConfigureAwait(false);
|
||||
}
|
||||
|
||||
private int _inConversationFlag = 0;
|
||||
|
||||
/// <summary>
|
||||
/// Atomically switches to "in conversation" state if not already in that state.
|
||||
/// </summary>
|
||||
/// <returns><see langword="true"/> if the state was changed, <see langword="false"/> otherwise.</returns>
|
||||
private bool TryEnterConversation()
|
||||
{
|
||||
return Interlocked.CompareExchange(ref this._inConversationFlag, 1, 0) == 0;
|
||||
}
|
||||
|
||||
private bool _shouldHostEmitEvents = false;
|
||||
private async ValueTask AssignNextTurnAsync(TurnToken token, IWorkflowContext context)
|
||||
{
|
||||
if (this.TryEnterConversation())
|
||||
{
|
||||
// Capture the initial turn token's EmitEvents setting
|
||||
this._shouldHostEmitEvents = token.EmitEvents;
|
||||
}
|
||||
|
||||
int? nextSpeakerIndex = this._manager.GetNextTurnExecutor(this._history);
|
||||
if (nextSpeakerIndex == null)
|
||||
{
|
||||
await context.AddEventAsync(new WorkflowCompletedEvent())
|
||||
.ConfigureAwait(false);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
string nextSpeakerId = this._manager.ParticipantIds[nextSpeakerIndex.Value];
|
||||
|
||||
if (this._shouldHostEmitEvents)
|
||||
{
|
||||
await context.AddEventAsync(new TurnAssignedEvent(this.Id, nextSpeakerId))
|
||||
.ConfigureAwait(false);
|
||||
}
|
||||
|
||||
await context.SendMessageAsync(new TurnToken(this._shouldEmitEvents[nextSpeakerIndex.Value]), nextSpeakerId)
|
||||
.ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -5,6 +5,7 @@ using System.IO;
|
||||
using System.Linq;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.Agents.Workflows.Sample;
|
||||
using Microsoft.Agents.Workflows.UnitTests.Sample;
|
||||
|
||||
namespace Microsoft.Agents.Workflows.UnitTests;
|
||||
|
||||
@@ -83,6 +84,22 @@ public class SampleSmokeTest
|
||||
string guessResult = await Step5EntryPoint.RunAsync(writer, userGuessCallback: responder.InvokeNext);
|
||||
Assert.Equal("You guessed correctly! You Win!", guessResult);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public async Task Test_RunSample_Step6Async()
|
||||
{
|
||||
using StringWriter writer = new();
|
||||
|
||||
await Step6EntryPoint.RunAsync(writer);
|
||||
|
||||
string result = writer.ToString();
|
||||
string[] lines = result.Split([Environment.NewLine], StringSplitOptions.RemoveEmptyEntries);
|
||||
|
||||
Assert.Collection(lines,
|
||||
line => Assert.Contains($"{HelloAgent.DefaultId}: {HelloAgent.Greeting}", line),
|
||||
line => Assert.Contains($"{EchoAgent.DefaultId}: {EchoAgent.Prefix}{HelloAgent.Greeting}", line)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
internal sealed class VerifyingPlaybackResponder<TInput, TResponse>
|
||||
|
||||
Reference in New Issue
Block a user