Add AddMessages Extension Method for IList<ChatMessage>

[jeffhandley]

Our existing AddMessages/AddMessagesAsync extension methods don't help because they only work on they complete set of output, whereas for an interactive UI app it's necessary to process the updates as they arrive incrementally. This results in undesired boilerplate code in chat applications.

We could improve MEAI to make this nicer, especially given how it would need to be more complex still if they wanted to receive other content types or to retain other information from the updates, such as AuthorName, AdditionalProperties, RawRepresentation).

One option would be adding to MEAI's ChatResponseExtensions another extension method like this:

public static void AddMessages(this IList<ChatMessage> messages, ChatResponseUpdate update, Func<AIContent, bool>? filter = null)
{
    var contentsList = filter is null ? update.Contents : update.Contents.Where(filter).ToList();
    if (contentsList.Any())
    {
        messages.Add(new ChatMessage(update.Role ?? ChatRole.Assistant, contentsList)
        {
            AuthorName = update.AuthorName,
            RawRepresentation = update.RawRepresentation,
            AdditionalProperties = update.AdditionalProperties,
        });
    }
}

This is more general since it works with any content type and preserves the other metadata properties.

Then in application code, the call to AddNonTextContentToConversation would be replaced by a one-liner inside the await foreach above:

messages.AddMessages(update, filter: u => u is not TextContent);

• @MackinnonBuck If you think this is better, would you be interested in adding this extension method to MEAI as part of this change? It's quite nice that the template code can now directly use MEAI updates in the same PR!
• @stephentoub Do you have any opinions on this proposed extension method? If you have concerns like "it's too specific to this one scenario" please say so. In my view it is pretty specific to this one scenario, but also, UI applications are a critical scenario we need to have clean patterns for.

Originally posted by @SteveSandersonMS in #6096 (comment)

[stephentoub]

Do you have any opinions on this proposed extension method? If you have concerns like "it's too specific to this one scenario" please say so.

It does seem fairly niche. We think this will actually be meaningful in general and not just for the one app we wrote that followed this pattern thus far?

If we do decide to keep it, AddMessages (plural) is a bit strange, as it'll never add more than one message.

We could also consider instead exposing it in a different form, such as a ToChatMessage(this ChatResponseUpdate, ...) extension method, the result of which could then just be Add'd to a list.

[jeffhandley]

While #6096 contributed the AddMessages helper as described, I'm leaving this issue open for another look at the API shape per @stephentoub's comment above.

[stephentoub]

@jeffhandley, I assume at this point you're planning to leave it as-is and this should be closed?