Skip to content

Commit 01a8291

Browse files
MEAI gives the same MessageId for reasoning and text content because they are part of the same logical model response. Create a new GUID for reasoning messages to be consistent with AGUI protocol and establish no link between reasoning and text messages
1 parent 40dc779 commit 01a8291

2 files changed

Lines changed: 57 additions & 15 deletions

File tree

‎dotnet/src/Microsoft.Agents.AI.AGUI/Shared/ChatResponseUpdateAGUIExtensions.cs‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -448,6 +448,8 @@ public static async IAsyncEnumerable<BaseEvent> AsAGUIEventStreamAsync(
448448
};
449449

450450
string? currentMessageId = null;
451+
string? currentReasoningBaseId = null;
452+
string? currentReasoningId = null;
451453
string? currentReasoningMessageId = null;
452454
await foreach (var chatResponse in updates.WithCancellation(cancellationToken).ConfigureAwait(false))
453455
{
@@ -480,7 +482,7 @@ chatResponse.Contents[0] is TextContent &&
480482
{
481483
yield return new TextMessageContentEvent
482484
{
483-
MessageId = chatResponse.MessageId!,
485+
MessageId = currentMessageId!,
484486
Delta = textContent.Text
485487
};
486488
}
@@ -525,7 +527,7 @@ chatResponse.Contents[0] is TextContent &&
525527
else if (content is TextReasoningContent reasoningContent
526528
&& (!string.IsNullOrEmpty(reasoningContent.Text) || !string.IsNullOrEmpty(reasoningContent.ProtectedData)))
527529
{
528-
if (!string.Equals(currentReasoningMessageId, chatResponse.MessageId, StringComparison.Ordinal))
530+
if (!string.Equals(currentReasoningBaseId, chatResponse.MessageId, StringComparison.Ordinal))
529531
{
530532
if (currentReasoningMessageId is not null)
531533
{
@@ -535,19 +537,22 @@ chatResponse.Contents[0] is TextContent &&
535537
};
536538
yield return new ReasoningEndEvent
537539
{
538-
MessageId = currentReasoningMessageId
540+
MessageId = currentReasoningId!
539541
};
540542
}
541543

544+
currentReasoningBaseId = chatResponse.MessageId;
545+
currentReasoningId = Guid.NewGuid().ToString("N");
546+
currentReasoningMessageId = Guid.NewGuid().ToString("N");
547+
542548
yield return new ReasoningStartEvent
543549
{
544-
MessageId = chatResponse.MessageId!
550+
MessageId = currentReasoningId
545551
};
546552
yield return new ReasoningMessageStartEvent
547553
{
548-
MessageId = chatResponse.MessageId!
554+
MessageId = currentReasoningMessageId
549555
};
550-
currentReasoningMessageId = chatResponse.MessageId;
551556
}
552557

553558
if (!string.IsNullOrEmpty(reasoningContent.Text))
@@ -630,7 +635,7 @@ chatResponse.Contents[0] is TextContent &&
630635
};
631636
yield return new ReasoningEndEvent
632637
{
633-
MessageId = currentReasoningMessageId
638+
MessageId = currentReasoningId!
634639
};
635640
}
636641

‎dotnet/tests/Microsoft.Agents.AI.AGUI.UnitTests/ChatResponseUpdateAGUIExtensionsTests.cs‎

Lines changed: 45 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -820,16 +820,18 @@ public async Task AsAGUIEventStreamAsync_WithReasoningContent_EmitsCorrectReason
820820
// Assert
821821
Assert.IsType<RunStartedEvent>(outputEvents[0]);
822822
var reasoningStart = Assert.IsType<ReasoningStartEvent>(outputEvents[1]);
823-
Assert.Equal("reason1", reasoningStart.MessageId);
823+
var reasoningId = reasoningStart.MessageId;
824+
Assert.NotEqual("reason1", reasoningId);
824825
var reasoningMessageStart = Assert.IsType<ReasoningMessageStartEvent>(outputEvents[2]);
825-
Assert.Equal("reason1", reasoningMessageStart.MessageId);
826+
var reasoningMessageId = reasoningMessageStart.MessageId;
827+
Assert.NotEqual(reasoningId, reasoningMessageId);
826828
var reasoningContent = Assert.IsType<ReasoningMessageContentEvent>(outputEvents[3]);
827-
Assert.Equal("reason1", reasoningContent.MessageId);
829+
Assert.Equal(reasoningMessageId, reasoningContent.MessageId);
828830
Assert.Equal("I need to think about this", reasoningContent.Delta);
829831
var reasoningMessageEnd = Assert.IsType<ReasoningMessageEndEvent>(outputEvents[4]);
830-
Assert.Equal("reason1", reasoningMessageEnd.MessageId);
832+
Assert.Equal(reasoningMessageId, reasoningMessageEnd.MessageId);
831833
var reasoningEnd = Assert.IsType<ReasoningEndEvent>(outputEvents[5]);
832-
Assert.Equal("reason1", reasoningEnd.MessageId);
834+
Assert.Equal(reasoningId, reasoningEnd.MessageId);
833835
Assert.IsType<RunFinishedEvent>(outputEvents[6]);
834836
}
835837

@@ -880,8 +882,10 @@ public async Task AsAGUIEventStreamAsync_WithReasoningAndProtectedData_EmitsEncr
880882
}
881883

882884
// Assert
885+
var reasoningMessageId = outputEvents.OfType<ReasoningMessageStartEvent>().Single().MessageId;
886+
Assert.NotEqual("reason1", reasoningMessageId);
883887
var encryptedEvent = outputEvents.OfType<ReasoningEncryptedValueEvent>().Single();
884-
Assert.Equal("reason1", encryptedEvent.EntityId);
888+
Assert.Equal(reasoningMessageId, encryptedEvent.EntityId);
885889
Assert.Equal("encrypted-abc", encryptedEvent.EncryptedValue);
886890
}
887891

@@ -911,6 +915,37 @@ public async Task AsAGUIEventStreamAsync_WithReasoningFollowedByText_EmitsBothEv
911915
Assert.Contains(outputEvents, e => e is TextMessageEndEvent);
912916
}
913917

918+
[Fact]
919+
public async Task AsAGUIEventStreamAsync_WithReasoningAndTextSharingSameMessageId_EmitsDistinctEventIdsAsync()
920+
{
921+
// Arrange
922+
List<ChatResponseUpdate> updates =
923+
[
924+
new(ChatRole.Assistant, [new TextReasoningContent("thinking")]) { MessageId = "shared1" },
925+
new(ChatRole.Assistant, [new TextContent("Hello")]) { MessageId = "shared1" }
926+
];
927+
928+
// Act
929+
List<BaseEvent> outputEvents = [];
930+
await foreach (BaseEvent evt in updates.ToAsyncEnumerableAsync().AsAGUIEventStreamAsync("thread1", "run1", AGUIJsonSerializerContext.Default.Options))
931+
{
932+
outputEvents.Add(evt);
933+
}
934+
935+
// Assert
936+
var reasoningId = outputEvents.OfType<ReasoningStartEvent>().Single().MessageId;
937+
var reasoningMessageId = outputEvents.OfType<ReasoningMessageStartEvent>().Single().MessageId;
938+
var textMessageId = outputEvents.OfType<TextMessageStartEvent>().Single().MessageId;
939+
Assert.NotEqual(reasoningId, reasoningMessageId);
940+
Assert.NotEqual(reasoningId, textMessageId);
941+
Assert.NotEqual(reasoningMessageId, textMessageId);
942+
Assert.Equal("shared1", textMessageId);
943+
Assert.All(outputEvents.OfType<ReasoningMessageContentEvent>(), e => Assert.Equal(reasoningMessageId, e.MessageId));
944+
Assert.Equal(reasoningMessageId, outputEvents.OfType<ReasoningMessageEndEvent>().Single().MessageId);
945+
Assert.Equal(reasoningId, outputEvents.OfType<ReasoningEndEvent>().Single().MessageId);
946+
Assert.All(outputEvents.OfType<TextMessageContentEvent>(), e => Assert.Equal("shared1", e.MessageId));
947+
}
948+
914949
[Fact]
915950
public async Task AsChatResponseUpdatesAsync_WithReasoningMessageSequence_ProducesTextReasoningContentPerDeltaAsync()
916951
{
@@ -1089,12 +1124,14 @@ public async Task AsAGUIEventStreamAsync_WithProtectedDataOnly_EmitsEncryptedVal
10891124
outputEvents.Add(evt);
10901125
}
10911126

1092-
// Assert — encrypted value should not be silently dropped
1127+
// Assert
10931128
Assert.Contains(outputEvents, e => e is ReasoningStartEvent);
10941129
Assert.Contains(outputEvents, e => e is ReasoningMessageStartEvent);
10951130
Assert.DoesNotContain(outputEvents, e => e is ReasoningMessageContentEvent);
1131+
var reasoningMessageId = outputEvents.OfType<ReasoningMessageStartEvent>().Single().MessageId;
1132+
Assert.NotEqual("reason1", reasoningMessageId);
10961133
var encryptedEvent = outputEvents.OfType<ReasoningEncryptedValueEvent>().Single();
1097-
Assert.Equal("reason1", encryptedEvent.EntityId);
1134+
Assert.Equal(reasoningMessageId, encryptedEvent.EntityId);
10981135
Assert.Equal("encrypted-only", encryptedEvent.EncryptedValue);
10991136
Assert.Contains(outputEvents, e => e is ReasoningMessageEndEvent);
11001137
Assert.Contains(outputEvents, e => e is ReasoningEndEvent);

0 commit comments

Comments
 (0)