.Net: SK integration with MEAI Abstractions (Service Selector + Contents) Phase 1

dotnet/samples/Concepts/Concepts.csproj

@@ -8,7 +8,7 @@
     <IsPackable>false</IsPackable>
     <IsTestProject>true</IsTestProject>
     <!-- Suppress: "Declare types in namespaces", "Require ConfigureAwait", "Experimental" -->
-    <NoWarn>$(NoWarn);CS8618,IDE0009,CA1051,CA1050,CA1707,CA1054,CA2007,VSTHRD111,CS1591,RCS1110,RCS1243,CA5394,SKEXP0001,SKEXP0010,SKEXP0020,SKEXP0040,SKEXP0050,SKEXP0060,SKEXP0070,SKEXP0101,SKEXP0110,OPENAI001,CA1724</NoWarn>
+    <NoWarn>$(NoWarn);CS8618,IDE0009,CA1051,CA1050,CA1707,CA1054,CA2007,VSTHRD111,CS1591,RCS1110,RCS1243,CA5394,SKEXP0001,SKEXP0010,SKEXP0020,SKEXP0040,SKEXP0050,SKEXP0060,SKEXP0070,SKEXP0101,SKEXP0110,OPENAI001,CA1724,IDE1006</NoWarn>
     <OutputType>Library</OutputType>
     <UserSecretsId>5ee045b0-aea3-4f08-8d31-32d1a6f8fed0</UserSecretsId>
   </PropertyGroup>

dotnet/samples/Concepts/Kernel/CustomAIServiceSelector.cs

@@ -1,36 +1,46 @@
 // Copyright (c) Microsoft. All rights reserved.
 
 using System.Diagnostics.CodeAnalysis;
+using Microsoft.Extensions.AI;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.SemanticKernel;
 using Microsoft.SemanticKernel.Connectors.OpenAI;
 using Microsoft.SemanticKernel.Services;
 
 namespace KernelExamples;
 
+/// <summary>
+/// This sample shows how to use a custom AI service selector to select a specific model by matching it's id.
+/// </summary>
 public class CustomAIServiceSelector(ITestOutputHelper output) : BaseTest(output)
 {
-    /// <summary>
-    /// Show how to use a custom AI service selector to select a specific model
-    /// </summary>
     [Fact]
-    public async Task RunAsync()
+    public async Task UsingCustomSelectToSelectServiceByMatchingModelId()
     {
-        Console.WriteLine($"======== {nameof(CustomAIServiceSelector)} ========");
+        Console.WriteLine($"======== {nameof(UsingCustomSelectToSelectServiceByMatchingModelId)} ========");
 
-        // Build a kernel with multiple chat completion services
+        // Use the custom AI service selector to select any registered service starting with "gpt" on it's model id
+        var customSelector = new GptAIServiceSelector(modelNameStartsWith: "gpt", this.Output);
+
+        // Build a kernel with multiple chat services
         var builder = Kernel.CreateBuilder()
             .AddAzureOpenAIChatCompletion(
                 deploymentName: TestConfiguration.AzureOpenAI.ChatDeploymentName,
                 endpoint: TestConfiguration.AzureOpenAI.Endpoint,
                 apiKey: TestConfiguration.AzureOpenAI.ApiKey,
                 serviceId: "AzureOpenAIChat",
-                modelId: TestConfiguration.AzureOpenAI.ChatModelId)
+                modelId: "o1-mini")
             .AddOpenAIChatCompletion(
-                modelId: TestConfiguration.OpenAI.ChatModelId,
+                modelId: "o1-mini",
                 apiKey: TestConfiguration.OpenAI.ApiKey,
                 serviceId: "OpenAIChat");
-        builder.Services.AddSingleton<IAIServiceSelector>(new GptAIServiceSelector(this.Output)); // Use the custom AI service selector to select the GPT model
+
+        // The kernel also allows you to use a IChatClient chat service as well
+        builder.Services
+            .AddSingleton<IAIServiceSelector>(customSelector)
+            .AddKeyedChatClient("OpenAIChatClient", new OpenAI.OpenAIClient(TestConfiguration.OpenAI.ApiKey)
+                .AsChatClient("gpt-4o")); // Add a IChatClient to the kernel
+
         Kernel kernel = builder.Build();
 
         // This invocation is done with the model selected by the custom selector
@@ -45,20 +55,35 @@ public async Task RunAsync()
     /// a completion model whose name starts with "gpt". But this logic could
     /// be as elaborate as needed to apply your own selection criteria.
     /// </summary>
-    private sealed class GptAIServiceSelector(ITestOutputHelper output) : IAIServiceSelector
+    private sealed class GptAIServiceSelector(string modelNameStartsWith, ITestOutputHelper output) : IAIServiceSelector, IChatClientSelector
     {
         private readonly ITestOutputHelper _output = output;
+        private readonly string _modelNameStartsWith = modelNameStartsWith;
 
-        public bool TrySelectAIService<T>(
+        /// <inheritdoc/>
+        private bool TrySelect<T>(
             Kernel kernel, KernelFunction function, KernelArguments arguments,
-            [NotNullWhen(true)] out T? service, out PromptExecutionSettings? serviceSettings) where T : class, IAIService
+            [NotNullWhen(true)] out T? service, out PromptExecutionSettings? serviceSettings) where T : class
         {
             foreach (var serviceToCheck in kernel.GetAllServices<T>())
             {
+                string? serviceModelId = null;
+                string? endpoint = null;
+
+                if (serviceToCheck is IAIService aiService)
+                {
+                    serviceModelId = aiService.GetModelId();
+                    endpoint = aiService.GetEndpoint();
+                }
+                else if (serviceToCheck is IChatClient chatClient)
+                {
+                    var metadata = chatClient.GetService<ChatClientMetadata>();
+                    serviceModelId = metadata?.ModelId;
+                    endpoint = metadata?.ProviderUri?.ToString();
+                }
+
                 // Find the first service that has a model id that starts with "gpt"
-                var serviceModelId = serviceToCheck.GetModelId();
-                var endpoint = serviceToCheck.GetEndpoint();
-                if (!string.IsNullOrEmpty(serviceModelId) && serviceModelId.StartsWith("gpt", StringComparison.OrdinalIgnoreCase))
+                if (!string.IsNullOrEmpty(serviceModelId) && serviceModelId.StartsWith(this._modelNameStartsWith, StringComparison.OrdinalIgnoreCase))
                 {
                     this._output.WriteLine($"Selected model: {serviceModelId} {endpoint}");
                     service = serviceToCheck;
@@ -71,5 +96,23 @@ public bool TrySelectAIService<T>(
             serviceSettings = null;
             return false;
         }
+
+        /// <inheritdoc/>
+        public bool TrySelectAIService<T>(
+            Kernel kernel,
+            KernelFunction function,
+            KernelArguments arguments,
+            [NotNullWhen(true)] out T? service,
+            out PromptExecutionSettings? serviceSettings) where T : class, IAIService
+            => this.TrySelect(kernel, function, arguments, out service, out serviceSettings);
+
+        /// <inheritdoc/>
+        public bool TrySelectChatClient<T>(
+            Kernel kernel,
+            KernelFunction function,
+            KernelArguments arguments,
+            [NotNullWhen(true)] out T? service,
+            out PromptExecutionSettings? serviceSettings) where T : class, IChatClient
+            => this.TrySelect(kernel, function, arguments, out service, out serviceSettings);
     }
 }

dotnet/samples/Demos/HomeAutomation/Program.cs

@@ -21,7 +21,6 @@ Example that demonstrates how to use Semantic Kernel in conjunction with depende
 using Microsoft.SemanticKernel.ChatCompletion;
 // For Azure OpenAI configuration
 #pragma warning disable IDE0005 // Using directive is unnecessary.
-using Microsoft.SemanticKernel.Connectors.AzureOpenAI;
 using Microsoft.SemanticKernel.Connectors.OpenAI;
 
 namespace HomeAutomation;

dotnet/src/Agents/Core/ChatCompletionAgent.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft. All rights reserved.
 
 using System.Collections.Generic;
+using System.Linq;
 using System.Runtime.CompilerServices;
 using System.Text;
 using System.Text.Json;
@@ -9,7 +10,6 @@
 using Microsoft.SemanticKernel.Agents.Extensions;
 using Microsoft.SemanticKernel.ChatCompletion;
 using Microsoft.SemanticKernel.Diagnostics;
-using Microsoft.SemanticKernel.Services;
 
 namespace Microsoft.SemanticKernel.Agents;
 
@@ -101,13 +101,42 @@ internal static (IChatCompletionService service, PromptExecutionSettings? execut
     {
         // Need to provide a KernelFunction to the service selector as a container for the execution-settings.
         KernelFunction nullPrompt = KernelFunctionFactory.CreateFromPrompt("placeholder", arguments?.ExecutionSettings?.Values);
-        (IChatCompletionService chatCompletionService, PromptExecutionSettings? executionSettings) =
-            kernel.ServiceSelector.SelectAIService<IChatCompletionService>(
-                kernel,
-                nullPrompt,
-                arguments ?? []);
 
-        return (chatCompletionService, executionSettings);
+        kernel.ServiceSelector.TrySelectAIService<IChatCompletionService>(kernel, nullPrompt, arguments ?? [], out IChatCompletionService? chatCompletionService, out PromptExecutionSettings? executionSettings);
+
+#pragma warning disable CA2000 // Dispose objects before losing scope
+        if (chatCompletionService is null
+            && kernel.ServiceSelector is IChatClientSelector chatClientSelector
+            && chatClientSelector.TrySelectChatClient<Microsoft.Extensions.AI.IChatClient>(kernel, nullPrompt, arguments ?? [], out var chatClient, out executionSettings)
+            && chatClient is not null)
+        {
+            // This change is temporary until Agents support IChatClient natively in near future.
+            chatCompletionService = chatClient!.AsChatCompletionService();
+        }
+#pragma warning restore CA2000 // Dispose objects before losing scope
+
+        if (chatCompletionService is null)
+        {
+            var message = new StringBuilder().Append("No service was found for any of the supported types: ").Append(typeof(IChatCompletionService)).Append(", ").Append(typeof(Microsoft.Extensions.AI.IChatClient)).Append('.');
+            if (nullPrompt.ExecutionSettings is not null)
+            {
+                string serviceIds = string.Join("|", nullPrompt.ExecutionSettings.Keys);
+                if (!string.IsNullOrEmpty(serviceIds))
+                {
+                    message.Append(" Expected serviceIds: ").Append(serviceIds).Append('.');
+                }
+
+                string modelIds = string.Join("|", nullPrompt.ExecutionSettings.Values.Select(model => model.ModelId));
+                if (!string.IsNullOrEmpty(modelIds))
+                {
+                    message.Append(" Expected modelIds: ").Append(modelIds).Append('.');
+                }
+            }
+
+            throw new KernelException(message.ToString());
+        }
+
+        return (chatCompletionService!, executionSettings);
     }
 
     #region private

dotnet/src/Connectors/Connectors.AzureOpenAI.UnitTests/KernelCore/KernelTests.cs

@@ -62,13 +62,13 @@ public async Task FunctionUsageMetricsAreCapturedByTelemetryAsExpected()
         // Set up a MeterListener to capture the measurements
         using MeterListener listener = EnableTelemetryMeters();
 
-        var measurements = new Dictionary<string, List<int>>
+        var measurements = new Dictionary<string, List<long>>
         {
             ["semantic_kernel.function.invocation.token_usage.prompt"] = [],
             ["semantic_kernel.function.invocation.token_usage.completion"] = [],
         };
 
-        listener.SetMeasurementEventCallback<int>((instrument, measurement, tags, state) =>
+        listener.SetMeasurementEventCallback<long>((instrument, measurement, tags, state) =>
         {
             if (instrument.Name == "semantic_kernel.function.invocation.token_usage.prompt" ||
                 instrument.Name == "semantic_kernel.function.invocation.token_usage.completion")

dotnet/src/Connectors/Connectors.OpenAI.UnitTests/KernelCore/KernelTests.cs

@@ -63,13 +63,13 @@ public async Task FunctionUsageMetricsAreCapturedByTelemetryAsExpected()
         // Set up a MeterListener to capture the measurements
         using MeterListener listener = EnableTelemetryMeters();
 
-        var measurements = new Dictionary<string, List<int>>
+        var measurements = new Dictionary<string, List<long>>
         {
             ["semantic_kernel.function.invocation.token_usage.prompt"] = [],
             ["semantic_kernel.function.invocation.token_usage.completion"] = [],
         };
 
-        listener.SetMeasurementEventCallback<int>((instrument, measurement, tags, state) =>
+        listener.SetMeasurementEventCallback<long>((instrument, measurement, tags, state) =>
         {
             if (instrument.Name == "semantic_kernel.function.invocation.token_usage.prompt" ||
                 instrument.Name == "semantic_kernel.function.invocation.token_usage.completion")

dotnet/src/Experimental/Process.IntegrationTests.Shared/ProcessCloudEventsTests.cs

@@ -1,9 +1,6 @@
 // Copyright (c) Microsoft. All rights reserved.
 
 #pragma warning disable IDE0005 // Using directive is unnecessary.
-using System;
-using System.Linq;
-using System.Runtime.Serialization;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Configuration;
 using Microsoft.SemanticKernel;

dotnet/src/Experimental/Process.IntegrationTests.Shared/ProcessTests.cs

@@ -1,9 +1,7 @@
 // Copyright (c) Microsoft. All rights reserved.
 
 #pragma warning disable IDE0005 // Using directive is unnecessary.
-using System;
 using System.Linq;
-using System.Runtime.Serialization;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Configuration;
 using Microsoft.SemanticKernel;

dotnet/src/IntegrationTests/Connectors/OpenAI/OpenAIChatCompletionTests.cs

@@ -8,12 +8,14 @@
 using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
+using Microsoft.Extensions.AI;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Http.Resilience;
 using Microsoft.Extensions.Logging;
 using Microsoft.SemanticKernel;
 using Microsoft.SemanticKernel.Connectors.OpenAI;
+using OpenAI;
 using OpenAI.Chat;
 using SemanticKernel.IntegrationTests.TestSettings;
 using Xunit;
@@ -43,6 +45,40 @@ public async Task ItCanUseOpenAiChatForTextGenerationAsync()
         Assert.Contains("Uranus", result.GetValue<string>(), StringComparison.InvariantCultureIgnoreCase);
     }
 
+    [Fact]
+    public async Task ItCanUseOpenAiChatClientAndContentsAsync()
+    {
+        var OpenAIConfiguration = this._configuration.GetSection("OpenAI").Get<OpenAIConfiguration>();
+        Assert.NotNull(OpenAIConfiguration);
+        Assert.NotNull(OpenAIConfiguration.ChatModelId);
+        Assert.NotNull(OpenAIConfiguration.ApiKey);
+        Assert.NotNull(OpenAIConfiguration.ServiceId);
+
+        // Arrange
+        var openAIClient = new OpenAIClient(OpenAIConfiguration.ApiKey);
+        var builder = Kernel.CreateBuilder();
+        builder.Services.AddChatClient(openAIClient.AsChatClient(OpenAIConfiguration.ChatModelId));
+        var kernel = builder.Build();
+
+        var func = kernel.CreateFunctionFromPrompt(
+            "List the two planets after '{{$input}}', excluding moons, using bullet points.",
+            new OpenAIPromptExecutionSettings());
+
+        // Act
+        var result = await func.InvokeAsync(kernel, new() { [InputParameterName] = "Jupiter" });
+
+        // Assert
+        Assert.NotNull(result);
+        Assert.Contains("Saturn", result.GetValue<string>(), StringComparison.InvariantCultureIgnoreCase);
+        Assert.Contains("Uranus", result.GetValue<string>(), StringComparison.InvariantCultureIgnoreCase);
+        var chatResponse = Assert.IsType<ChatResponse>(result.GetValue<ChatResponse>());
+        Assert.Contains("Saturn", chatResponse.Message.Text, StringComparison.InvariantCultureIgnoreCase);
+        var chatMessage = Assert.IsType<Microsoft.Extensions.AI.ChatMessage>(result.GetValue<Microsoft.Extensions.AI.ChatMessage>());
+        Assert.Contains("Uranus", chatMessage.Text, StringComparison.InvariantCultureIgnoreCase);
+        var chatMessageContent = Assert.IsType<Microsoft.SemanticKernel.ChatMessageContent>(result.GetValue<Microsoft.SemanticKernel.ChatMessageContent>());
+        Assert.Contains("Uranus", chatMessageContent.Content, StringComparison.InvariantCultureIgnoreCase);
+    }
+
     [Fact]
     public async Task OpenAIStreamingTestAsync()
     {
@@ -65,6 +101,43 @@ public async Task OpenAIStreamingTestAsync()
         Assert.Contains("Pike Place", fullResult.ToString(), StringComparison.OrdinalIgnoreCase);
     }
 
+    [Fact]
+    public async Task ItCanUseOpenAiStreamingChatClientAndContentsAsync()
+    {
+        var OpenAIConfiguration = this._configuration.GetSection("OpenAI").Get<OpenAIConfiguration>();
+        Assert.NotNull(OpenAIConfiguration);
+        Assert.NotNull(OpenAIConfiguration.ChatModelId);
+        Assert.NotNull(OpenAIConfiguration.ApiKey);
+        Assert.NotNull(OpenAIConfiguration.ServiceId);
+
+        // Arrange
+        var openAIClient = new OpenAIClient(OpenAIConfiguration.ApiKey);
+        var builder = Kernel.CreateBuilder();
+        builder.Services.AddChatClient(openAIClient.AsChatClient(OpenAIConfiguration.ChatModelId));
+        var kernel = builder.Build();
+
+        var plugins = TestHelpers.ImportSamplePlugins(kernel, "ChatPlugin");
+
+        StringBuilder fullResultSK = new();
+        StringBuilder fullResultMEAI = new();
+
+        var prompt = "Where is the most famous fish market in Seattle, Washington, USA?";
+
+        // Act
+        await foreach (var content in kernel.InvokeStreamingAsync<StreamingKernelContent>(plugins["ChatPlugin"]["Chat"], new() { [InputParameterName] = prompt }))
+        {
+            fullResultSK.Append(content);
+        }
+        await foreach (var content in kernel.InvokeStreamingAsync<ChatResponseUpdate>(plugins["ChatPlugin"]["Chat"], new() { [InputParameterName] = prompt }))
+        {
+            fullResultMEAI.Append(content);
+        }
+
+        // Assert
+        Assert.Contains("Pike Place", fullResultSK.ToString(), StringComparison.OrdinalIgnoreCase);
+        Assert.Contains("Pike Place", fullResultMEAI.ToString(), StringComparison.OrdinalIgnoreCase);
+    }
+
     [Fact]
     public async Task OpenAIHttpRetryPolicyTestAsync()
     {

dotnet/src/IntegrationTests/IntegrationTests.csproj

@@ -41,6 +41,7 @@
     <None Remove="skills\FunSkill\Joke\skprompt.txt" />
   </ItemGroup>
   <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.AI.OpenAI" />
     <PackageReference Include="Microsoft.Extensions.Configuration" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Binder" />
     <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" />