Merged PR 48301: Fix grouping of ChatResponseUpdate into ChatMessage (#6074)

Fix grouping of ChatResponseUpdate into ChatMessage (#6074)

* For Ollama client, ensure ToChatResponseAsync coalesces text chunks into a single message

* Fix OpenAI case by not treating empty-string response IDs as message boundaries

Author: stephentoub

src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatResponseExtensions.cs

@@ -171,7 +171,7 @@ private static void ProcessUpdate(ChatResponseUpdate update, ChatResponse respon
         // response ID than the newest update, create a new message.
         ChatMessage message;
         if (response.Messages.Count == 0 ||
-            (update.ResponseId is string updateId && response.ResponseId is string responseId && updateId != responseId))
+            (update.ResponseId is { Length: > 0 } updateId && response.ResponseId is string responseId && updateId != responseId))
         {
             message = new ChatMessage(ChatRole.Assistant, []);
             response.Messages.Add(message);
@@ -213,7 +213,7 @@ private static void ProcessUpdate(ChatResponseUpdate update, ChatResponse respon
         // Other members on a ChatResponseUpdate map to members of the ChatResponse.
         // Update the response object with those, preferring the values from later updates.
 
-        if (update.ResponseId is not null)
+        if (update.ResponseId is { Length: > 0 })
         {
             // Note that this must come after the message checks earlier, as they depend
             // on this value for change detection.

src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatResponseUpdate.cs

@@ -99,6 +99,12 @@ public IList<AIContent> Contents
     public AdditionalPropertiesDictionary? AdditionalProperties { get; set; }
 
     /// <summary>Gets or sets the ID of the response of which this update is a part.</summary>
+    /// <remarks>
+    /// This value is used when <see cref="ChatResponseExtensions.ToChatResponseAsync(IAsyncEnumerable{ChatResponseUpdate}, System.Threading.CancellationToken)"/>
+    /// groups <see cref="ChatResponseUpdate"/> instances into <see cref="ChatMessage"/> instances.
+    /// The value must be unique to each call to the underlying provider, and must be shared by
+    /// all updates that are part of the same response.
+    /// </remarks>
     public string? ResponseId { get; set; }
 
     /// <summary>Gets or sets the chat thread ID associated with the chat response of which this update is a part.</summary>

src/Libraries/Microsoft.Extensions.AI.Ollama/OllamaChatClient.cs

@@ -132,6 +132,9 @@ public async IAsyncEnumerable<ChatResponseUpdate> GetStreamingResponseAsync(
             await OllamaUtilities.ThrowUnsuccessfulOllamaResponseAsync(httpResponse, cancellationToken).ConfigureAwait(false);
         }
 
+        // Ollama doesn't set a response ID on streamed chunks, so we need to generate one.
+        var responseId = Guid.NewGuid().ToString("N");
+
         using var httpResponseStream = await httpResponse.Content
 #if NET
             .ReadAsStreamAsync(cancellationToken)
@@ -160,7 +163,7 @@ public async IAsyncEnumerable<ChatResponseUpdate> GetStreamingResponseAsync(
                 CreatedAt = DateTimeOffset.TryParse(chunk.CreatedAt, CultureInfo.InvariantCulture, DateTimeStyles.None, out DateTimeOffset createdAt) ? createdAt : null,
                 FinishReason = ToFinishReason(chunk),
                 ModelId = modelId,
-                ResponseId = chunk.CreatedAt,
+                ResponseId = responseId,
                 Role = chunk.Message?.Role is not null ? new ChatRole(chunk.Message.Role) : null,
             };
 

test/Libraries/Microsoft.Extensions.AI.Abstractions.Tests/ChatCompletion/ChatResponseUpdateExtensionsTests.cs

@@ -51,7 +51,7 @@ public async Task ToChatResponse_SuccessfullyCreatesResponse(bool useAsync)
 
         Assert.Equal("123", response.ChatThreadId);
 
-        ChatMessage message = response.Messages.Last();
+        ChatMessage message = response.Messages.Single();
         Assert.Equal(new ChatRole("human"), message.Role);
         Assert.Equal("Someone", message.AuthorName);
         Assert.Null(message.AdditionalProperties);

test/Libraries/Microsoft.Extensions.AI.Integration.Tests/ChatClientIntegrationTests.cs

@@ -130,6 +130,25 @@ public virtual async Task GetStreamingResponseAsync_UsageDataAvailable()
         Assert.Equal(usage.Details.InputTokenCount + usage.Details.OutputTokenCount, usage.Details.TotalTokenCount);
     }
 
+    [ConditionalFact]
+    public virtual async Task GetStreamingResponseAsync_AppendToHistory()
+    {
+        SkipIfNotEnabled();
+
+        List<ChatMessage> history = [new(ChatRole.User, "Explain in 100 words how AI works")];
+
+        var streamingResponse = _chatClient.GetStreamingResponseAsync(history);
+
+        Assert.Single(history);
+        await history.AddMessagesAsync(streamingResponse);
+        Assert.Equal(2, history.Count);
+        Assert.Equal(ChatRole.Assistant, history[1].Role);
+
+        var singleTextContent = (TextContent)history[1].Contents.Single();
+        Assert.NotEmpty(singleTextContent.Text);
+        Assert.Equal(history[1].Text, singleTextContent.Text);
+    }
+
     protected virtual string? GetModel_MultiModal_DescribeImage() => null;
 
     [ConditionalFact]

test/Libraries/Microsoft.Extensions.AI.Ollama.Tests/OllamaChatClientTests.cs

@@ -171,11 +171,12 @@ public async Task BasicRequestResponse_Streaming()
         using IChatClient client = new OllamaChatClient("http://localhost:11434", "llama3.1", httpClient);
 
         List<ChatResponseUpdate> updates = [];
-        await foreach (var update in client.GetStreamingResponseAsync("hello", new()
+        var streamingResponse = client.GetStreamingResponseAsync("hello", new()
         {
             MaxOutputTokens = 20,
             Temperature = 0.5f,
-        }))
+        });
+        await foreach (var update in streamingResponse)
         {
             updates.Add(update);
         }
@@ -201,6 +202,10 @@ public async Task BasicRequestResponse_Streaming()
         Assert.Equal(11, usage.Details.InputTokenCount);
         Assert.Equal(20, usage.Details.OutputTokenCount);
         Assert.Equal(31, usage.Details.TotalTokenCount);
+
+        var chatResponse = await streamingResponse.ToChatResponseAsync();
+        Assert.Single(Assert.Single(chatResponse.Messages).Contents);
+        Assert.Equal("Hello! How are you today? Is there something I can help you with or would you like to", chatResponse.Text);
     }
 
     [Fact]