Address feedback from PR review

Author: ViveliDuCh

src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/.template.config/template.json

@@ -60,15 +60,15 @@
           "ChatWithCustomData-CSharp.AppHost/**",
           "ChatWithCustomData-CSharp.ServiceDefaults/**",
           "ChatWithCustomData-CSharp.Web/Program.Aspire.cs",
-          "ChatWithCustomData-CSharp.Web/ResponseClientHelper.cs",
+          "ChatWithCustomData-CSharp.Web/AspireOpenAIClientBuilderResponsesChatClientExtensions.cs",
           "README.Aspire.md",
           "*.sln"
         ]
       },
       {
         "condition": "(IsAspire && !IsOpenAI && !IsAzureOpenAI)",
         "exclude": [
-          "ChatWithCustomData-CSharp.Web/ResponseClientHelper.cs"
+          "ChatWithCustomData-CSharp.Web/AspireOpenAIClientBuilderResponsesChatClientExtensions.cs"
         ]
       },
       {

src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/AspireOpenAIClientBuilderResponsesChatClientExtensions.cs

@@ -0,0 +1,74 @@
+using Microsoft.Extensions.AI;
+using Aspire.OpenAI;
+using OpenAI;
+using System.Data.Common;
+
+namespace ChatWithCustomData_CSharp.Web.Services;
+
+public static class AspireOpenAIClientBuilderResponsesChatClientExtensions
+{
+    private const string DeploymentKey = "Deployment";
+    private const string ModelKey = "Model";
+
+    public static ChatClientBuilder AddResponsesChatClient(this AspireOpenAIClientBuilder builder, string? deploymentName)
+    {
+        ArgumentNullException.ThrowIfNull(builder, "builder");
+
+        return builder.HostBuilder.Services.AddChatClient((IServiceProvider services) => CreateInnerChatClient(services, builder, deploymentName));
+    }
+    private static IChatClient CreateInnerChatClient(IServiceProvider services, AspireOpenAIClientBuilder builder, string? deploymentName)
+    {
+        OpenAIClient openAIClient = builder.ServiceKey is null ? services.GetRequiredService<OpenAIClient>() : services.GetRequiredKeyedService<OpenAIClient>(builder.ServiceKey);
+
+        deploymentName ??= GetRequiredDeploymentName(builder);
+
+        IChatClient chatClient = openAIClient.GetOpenAIResponseClient(deploymentName).AsIChatClient();
+
+        if (builder.DisableTracing)
+        {
+            return chatClient;
+        }
+
+        var loggerFactory = services.GetService<ILoggerFactory>();
+        return new OpenTelemetryChatClient(chatClient, loggerFactory?.CreateLogger(typeof(OpenTelemetryChatClient)));
+    }
+
+    private static string GetRequiredDeploymentName(this AspireOpenAIClientBuilder builder)
+    {
+        string? deploymentName = null;
+
+        var configuration = builder.HostBuilder.Configuration;
+        if (configuration.GetConnectionString(builder.ConnectionName) is string connectionString)
+        {
+            // The reason we accept either 'Deployment' or 'Model' as the key is because some hosting solutions
+            // require specific named deployments (Azure Foundry AI) while others may use a generic model name (OpenAI, GitHub Models).
+            var connectionBuilder = new DbConnectionStringBuilder { ConnectionString = connectionString };
+            var deploymentValue = ConnectionStringValue(connectionBuilder, DeploymentKey);
+            var modelValue = ConnectionStringValue(connectionBuilder, ModelKey);
+            if (deploymentValue is not null && modelValue is not null)
+            {
+                throw new InvalidOperationException(
+                    $"The connection string '{builder.ConnectionName}' contains both '{DeploymentKey}' and '{ModelKey}' keys. Either of these may be specified, but not both.");
+            }
+
+            deploymentName = deploymentValue ?? modelValue;
+        }
+
+        if (string.IsNullOrEmpty(deploymentName))
+        {
+            var configSection = configuration.GetSection(builder.ConfigurationSectionName);
+            deploymentName = configSection[DeploymentKey];
+        }
+
+        if (string.IsNullOrEmpty(deploymentName))
+        {
+            throw new InvalidOperationException($"The deployment could not be determined. Ensure a '{DeploymentKey}' or '{ModelKey}' value is provided in 'ConnectionStrings:{builder.ConnectionName}', or specify a '{DeploymentKey}' in the '{builder.ConfigurationSectionName}' configuration section, or specify a '{nameof(deploymentName)}' in the call.");
+        }
+
+        return deploymentName;
+    }
+
+    private static string? ConnectionStringValue(DbConnectionStringBuilder connectionString, string key)
+        => connectionString.TryGetValue(key, out var value) ? value as string : null;
+
+}

src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/Components/Pages/Chat/Chat.razor

@@ -67,7 +67,7 @@
         currentResponseMessage = new ChatMessage(ChatRole.Assistant, [responseText]);
         currentResponseCancellation = new();
 @*#if (IsAzureOpenAI || IsOpenAI)
-        await foreach (var update in ChatClient.GetStreamingResponseAsync([userMessage], chatOptions, currentResponseCancellation.Token))
+        await foreach (var update in ChatClient.GetStreamingResponseAsync(userMessage, chatOptions, currentResponseCancellation.Token))
         {
             messages.AddMessages(update, filter: c => c is not TextContent);
             responseText.Text += update.Text;

src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/Program.Aspire.cs

@@ -27,10 +27,17 @@
 #else
 var openai = builder.AddAzureOpenAIClient("openai");
 #endif
+#if (IsGHModels)
+openai.AddChatClient("gpt-4o-mini")
+    .UseFunctionInvocation()
+    .UseOpenTelemetry(configure: c =>
+        c.EnableSensitiveData = builder.Environment.IsDevelopment());
+#else  // (IsOpenAI || IsAzureOpenAI)
 openai.AddResponsesChatClient("gpt-4o-mini")
     .UseFunctionInvocation()
     .UseOpenTelemetry(configure: c =>
         c.EnableSensitiveData = builder.Environment.IsDevelopment());
+#endif
 openai.AddEmbeddingGenerator("text-embedding-3-small");
 #endif
 

src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/ResponseClientHelper.cs

@@ -0,0 +1,74 @@
+using Microsoft.Extensions.AI;
+using Aspire.OpenAI;
+using OpenAI;
+using System.Data.Common;
+
+namespace aichatweb.Web.Services;
+
+public static class AspireOpenAIClientBuilderResponsesChatClientExtensions
+{
+    private const string DeploymentKey = "Deployment";
+    private const string ModelKey = "Model";
+
+    public static ChatClientBuilder AddResponsesChatClient(this AspireOpenAIClientBuilder builder, string? deploymentName)
+    {
+        ArgumentNullException.ThrowIfNull(builder, "builder");
+
+        return builder.HostBuilder.Services.AddChatClient((IServiceProvider services) => CreateInnerChatClient(services, builder, deploymentName));
+    }
+    private static IChatClient CreateInnerChatClient(IServiceProvider services, AspireOpenAIClientBuilder builder, string? deploymentName)
+    {
+        OpenAIClient openAIClient = builder.ServiceKey is null ? services.GetRequiredService<OpenAIClient>() : services.GetRequiredKeyedService<OpenAIClient>(builder.ServiceKey);
+
+        deploymentName ??= GetRequiredDeploymentName(builder);
+
+        IChatClient chatClient = openAIClient.GetOpenAIResponseClient(deploymentName).AsIChatClient();
+
+        if (builder.DisableTracing)
+        {
+            return chatClient;
+        }
+
+        var loggerFactory = services.GetService<ILoggerFactory>();
+        return new OpenTelemetryChatClient(chatClient, loggerFactory?.CreateLogger(typeof(OpenTelemetryChatClient)));
+    }
+
+    private static string GetRequiredDeploymentName(this AspireOpenAIClientBuilder builder)
+    {
+        string? deploymentName = null;
+
+        var configuration = builder.HostBuilder.Configuration;
+        if (configuration.GetConnectionString(builder.ConnectionName) is string connectionString)
+        {
+            // The reason we accept either 'Deployment' or 'Model' as the key is because some hosting solutions
+            // require specific named deployments (Azure Foundry AI) while others may use a generic model name (OpenAI, GitHub Models).
+            var connectionBuilder = new DbConnectionStringBuilder { ConnectionString = connectionString };
+            var deploymentValue = ConnectionStringValue(connectionBuilder, DeploymentKey);
+            var modelValue = ConnectionStringValue(connectionBuilder, ModelKey);
+            if (deploymentValue is not null && modelValue is not null)
+            {
+                throw new InvalidOperationException(
+                    $"The connection string '{builder.ConnectionName}' contains both '{DeploymentKey}' and '{ModelKey}' keys. Either of these may be specified, but not both.");
+            }
+
+            deploymentName = deploymentValue ?? modelValue;
+        }
+
+        if (string.IsNullOrEmpty(deploymentName))
+        {
+            var configSection = configuration.GetSection(builder.ConfigurationSectionName);
+            deploymentName = configSection[DeploymentKey];
+        }
+
+        if (string.IsNullOrEmpty(deploymentName))
+        {
+            throw new InvalidOperationException($"The deployment could not be determined. Ensure a '{DeploymentKey}' or '{ModelKey}' value is provided in 'ConnectionStrings:{builder.ConnectionName}', or specify a '{DeploymentKey}' in the '{builder.ConfigurationSectionName}' configuration section, or specify a '{nameof(deploymentName)}' in the call.");
+        }
+
+        return deploymentName;
+    }
+
+    private static string? ConnectionStringValue(DbConnectionStringBuilder connectionString, string key)
+        => connectionString.TryGetValue(key, out var value) ? value as string : null;
+
+}

test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/AspireOpenAIClientBuilderResponsesChatClientExtensions.cs

@@ -66,7 +66,7 @@
         var responseText = new TextContent("");
         currentResponseMessage = new ChatMessage(ChatRole.Assistant, [responseText]);
         currentResponseCancellation = new();
-        await foreach (var update in ChatClient.GetStreamingResponseAsync([userMessage], chatOptions, currentResponseCancellation.Token))
+        await foreach (var update in ChatClient.GetStreamingResponseAsync(userMessage, chatOptions, currentResponseCancellation.Token))
         {
             messages.AddMessages(update, filter: c => c is not TextContent);
             responseText.Text += update.Text;

test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/Chat.razor

@@ -4,7 +4,6 @@
 using aichatweb.Web.Services.Ingestion;
 
 var builder = WebApplication.CreateBuilder(args);
-
 builder.AddServiceDefaults();
 builder.Services.AddRazorComponents().AddInteractiveServerComponents();
 

test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Program.cs

@@ -9,7 +9,7 @@
 builder.Services.AddRazorComponents().AddInteractiveServerComponents();
 
 var openai = builder.AddAzureOpenAIClient("openai");
-openai.AddResponsesChatClient("gpt-4o-mini")
+openai.AddChatClient("gpt-4o-mini")
     .UseFunctionInvocation()
     .UseOpenTelemetry(configure: c =>
         c.EnableSensitiveData = builder.Environment.IsDevelopment());