.Net: Add prompt execution settings to AutoFunctionInvocationContext

dotnet/src/Connectors/Connectors.OpenAI.UnitTests/Core/AutoFunctionInvocationFilterTests.cs

@@ -661,6 +661,65 @@ public async Task FilterContextHasValidStreamingFlagAsync(bool isStreaming)
         Assert.Equal(isStreaming, actualStreamingFlag);
     }
 
+    [Fact]
+    public async Task PromptExecutionSettingsArePropagatedFromInvokePromptToFilterContextAsync()
+    {
+        // Arrange
+        this._messageHandlerStub.ResponsesToReturn = GetFunctionCallingResponses();
+
+        var plugin = KernelPluginFactory.CreateFromFunctions("MyPlugin", [KernelFunctionFactory.CreateFromMethod(() => { }, "Function1")]);
+
+        AutoFunctionInvocationContext? actualContext = null;
+
+        var kernel = this.GetKernelWithFilter(plugin, (context, next) =>
+        {
+            actualContext = context;
+            return Task.CompletedTask;
+        });
+
+        var expectedExecutionSettings = new OpenAIPromptExecutionSettings
+        {
+            ToolCallBehavior = ToolCallBehavior.AutoInvokeKernelFunctions
+        };
+
+        // Act
+        var result = await kernel.InvokePromptAsync("Test prompt", new(expectedExecutionSettings));
+
+        // Assert
+        Assert.NotNull(actualContext);
+        Assert.Same(expectedExecutionSettings, actualContext!.ExecutionSettings);
+    }
+
+    [Fact]
+    public async Task PromptExecutionSettingsArePropagatedFromInvokePromptStreamingToFilterContextAsync()
+    {
+        // Arrange
+        this._messageHandlerStub.ResponsesToReturn = GetFunctionCallingStreamingResponses();
+
+        var plugin = KernelPluginFactory.CreateFromFunctions("MyPlugin", [KernelFunctionFactory.CreateFromMethod(() => { }, "Function1")]);
+
+        AutoFunctionInvocationContext? actualContext = null;
+
+        var kernel = this.GetKernelWithFilter(plugin, (context, next) =>
+        {
+            actualContext = context;
+            return Task.CompletedTask;
+        });
+
+        var expectedExecutionSettings = new OpenAIPromptExecutionSettings
+        {
+            ToolCallBehavior = ToolCallBehavior.AutoInvokeKernelFunctions
+        };
+
+        // Act
+        await foreach (var item in kernel.InvokePromptStreamingAsync("Test prompt", new(expectedExecutionSettings)))
+        { }
+
+        // Assert
+        Assert.NotNull(actualContext);
+        Assert.Same(expectedExecutionSettings, actualContext!.ExecutionSettings);
+    }
+
     public void Dispose()
     {
         this._httpClient.Dispose();

dotnet/src/Connectors/Connectors.OpenAI/Core/ClientCore.ChatCompletion.cs

@@ -200,6 +200,7 @@ internal async Task<IReadOnlyList<ChatMessageContent>> GetChatMessageContentsAsy
             // In such cases, we'll return the last message in the chat history.
             var lastMessage = await this.FunctionCallsProcessor.ProcessFunctionCallsAsync(
                 chatMessageContent,
+                chatExecutionSettings,
                 chatHistory,
                 requestIndex,
                 (FunctionCallContent content) => IsRequestableTool(chatOptions.Tools, content),
@@ -384,6 +385,7 @@ internal async IAsyncEnumerable<OpenAIStreamingChatMessageContent> GetStreamingC
             // In such cases, we'll return the last message in the chat history.
             var lastMessage = await this.FunctionCallsProcessor.ProcessFunctionCallsAsync(
                 chatMessageContent,
+                chatExecutionSettings,
                 chatHistory,
                 requestIndex,
                 (FunctionCallContent content) => IsRequestableTool(chatOptions.Tools, content),

dotnet/src/InternalUtilities/connectors/AI/FunctionCalling/FunctionCallsProcessor.cs

@@ -119,6 +119,7 @@ public FunctionCallsProcessor(ILogger? logger = null)
     /// Processes AI function calls by iterating over the function calls, invoking them and adding the results to the chat history.
     /// </summary>
     /// <param name="chatMessageContent">The chat message content representing AI model response and containing function calls.</param>
+    /// <param name="executionSettings">The prompt execution settings.</param>
     /// <param name="chatHistory">The chat history to add function invocation results to.</param>
     /// <param name="requestIndex">AI model function(s) call request sequence index.</param>
     /// <param name="checkIfFunctionAdvertised">Callback to check if a function was advertised to AI model or not.</param>
@@ -129,6 +130,7 @@ public FunctionCallsProcessor(ILogger? logger = null)
     /// <returns>Last chat history message if function invocation filter requested processing termination, otherwise null.</returns>
     public async Task<ChatMessageContent?> ProcessFunctionCallsAsync(
         ChatMessageContent chatMessageContent,
+        PromptExecutionSettings? executionSettings,
         ChatHistory chatHistory,
         int requestIndex,
         Func<FunctionCallContent, bool> checkIfFunctionAdvertised,
@@ -177,7 +179,8 @@ public FunctionCallsProcessor(ILogger? logger = null)
                     FunctionCount = functionCalls.Length,
                     CancellationToken = cancellationToken,
                     IsStreaming = isStreaming,
-                    ToolCallId = functionCall.Id
+                    ToolCallId = functionCall.Id,
+                    ExecutionSettings = executionSettings
                 };
 
             s_inflightAutoInvokes.Value++;

dotnet/src/SemanticKernel.Abstractions/Filters/AutoFunctionInvocation/AutoFunctionInvocationContext.cs

@@ -1,5 +1,6 @@
 // Copyright (c) Microsoft. All rights reserved.
 
+using System.Diagnostics.CodeAnalysis;
 using System.Threading;
 using Microsoft.SemanticKernel.ChatCompletion;
 
@@ -79,6 +80,12 @@ public AutoFunctionInvocationContext(
     /// </summary>
     public ChatMessageContent ChatMessageContent { get; }
 
+    /// <summary>
+    /// The execution settings associated with the operation.
+    /// </summary>
+    [Experimental("SKEXP0001")]
+    public PromptExecutionSettings? ExecutionSettings { get; init; }
+
     /// <summary>
     /// Gets the <see cref="Microsoft.SemanticKernel.ChatCompletion.ChatHistory"/> associated with automatic function invocation.
     /// </summary>

dotnet/src/SemanticKernel.UnitTests/Utilities/AIConnectors/FunctionCallsProcessorTests.cs

@@ -11,6 +11,8 @@
 using Microsoft.SemanticKernel.ChatCompletion;
 #pragma warning disable IDE0005 // Using directive is unnecessary
 using Microsoft.SemanticKernel.Connectors.FunctionCalling;
+using Microsoft.SemanticKernel.Connectors.OpenAI;
+
 #pragma warning restore IDE0005 // Using directive is unnecessary
 using Moq;
 using Xunit;
@@ -21,6 +23,7 @@ public class FunctionCallsProcessorTests
 {
     private readonly FunctionCallsProcessor _sut = new();
     private readonly FunctionChoiceBehaviorOptions _functionChoiceBehaviorOptions = new();
+    private readonly OpenAIPromptExecutionSettings _openAIPromptExecutionSettings = new();
 
     [Fact]
     public void ItShouldReturnNoConfigurationIfNoBehaviorProvided()
@@ -94,6 +97,7 @@ async Task ProcessFunctionCallsRecursivelyToReachInflightLimitAsync()
 
             await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: [],
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => true,
@@ -123,6 +127,7 @@ public async Task ItShouldAddFunctionCallAssistantMessageToChatHistoryAsync()
         // Act
         await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: chatHistory,
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => true,
@@ -151,6 +156,7 @@ public async Task ItShouldAddFunctionCallExceptionToChatHistoryAsync()
         // Act
         await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: chatHistory,
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => true,
@@ -184,6 +190,7 @@ public async Task ItShouldAddFunctionInvocationExceptionToChatHistoryAsync()
         // Act
         await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: chatHistory,
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => true,
@@ -212,6 +219,7 @@ public async Task ItShouldAddErrorToChatHistoryIfFunctionCallNotAdvertisedAsync(
         // Act
         await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: chatHistory,
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => false, // Return false to simulate that the function is not advertised
@@ -240,6 +248,7 @@ public async Task ItShouldAddErrorToChatHistoryIfFunctionIsNotRegisteredOnKernel
         // Act
         await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: chatHistory,
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => true,
@@ -281,6 +290,7 @@ public async Task ItShouldInvokeFunctionsAsync(bool invokeConcurrently)
         // Act
         await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: chatHistory,
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => true,
@@ -347,6 +357,7 @@ public async Task ItShouldInvokeFiltersAsync(bool invokeConcurrently)
         // Act
         await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: chatHistory,
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => true,
@@ -436,6 +447,7 @@ public async Task ItShouldInvokeMultipleFiltersInOrderAsync(bool invokeConcurren
         // Act
         await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: chatHistory,
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => true,
@@ -484,6 +496,7 @@ public async Task FilterCanOverrideArgumentsAsync(bool invokeConcurrently)
         // Act
         await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: chatHistory,
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => true,
@@ -536,6 +549,7 @@ public async Task FilterCanHandleExceptionAsync(bool invokeConcurrently)
         // Act
         await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: chatHistory,
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => true,
@@ -588,6 +602,7 @@ public async Task FiltersCanSkipFunctionExecutionAsync(bool invokeConcurrently)
         // Act
         await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: chatHistory,
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => true,
@@ -634,6 +649,7 @@ public async Task PreFilterCanTerminateOperationAsync(bool invokeConcurrently)
         // Act
         await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: chatHistory,
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => true,
@@ -678,6 +694,7 @@ public async Task PostFilterCanTerminateOperationAsync(bool invokeConcurrently)
         // Act
         await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: chatHistory,
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => true,
@@ -732,6 +749,7 @@ public async Task ItShouldHandleChatMessageContentAsFunctionResultAsync()
         // Act
         await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: chatHistory,
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => true,
@@ -767,6 +785,7 @@ public async Task ItShouldSerializeFunctionResultOfUnknowTypeAsync()
         // Act
         await this._sut.ProcessFunctionCallsAsync(
                 chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
                 chatHistory: chatHistory,
                 requestIndex: 0,
                 checkIfFunctionAdvertised: (_) => true,
@@ -837,6 +856,40 @@ public void ItShouldSerializeFunctionResultsWithStringProperties()
         Assert.Equal("{\"Text\":\"ﾃｽﾄ\"}", result);
     }
 
+    [Fact]
+    public async Task ItShouldPassPromptExecutionSettingsToAutoFunctionInvocationFilterAsync()
+    {
+        // Arrange
+        var plugin = KernelPluginFactory.CreateFromFunctions("MyPlugin", [KernelFunctionFactory.CreateFromMethod(() => { }, "Function1")]);
+
+        AutoFunctionInvocationContext? actualContext = null;
+
+        Kernel kernel = CreateKernel(plugin, (context, next) =>
+        {
+            actualContext = context;
+            return Task.CompletedTask;
+        });
+
+        var chatMessageContent = new ChatMessageContent();
+        chatMessageContent.Items.Add(new FunctionCallContent("Function1", "MyPlugin", arguments: new KernelArguments() { ["parameter"] = "function1-result" }));
+
+        // Act
+        await this._sut.ProcessFunctionCallsAsync(
+                chatMessageContent: chatMessageContent,
+                executionSettings: this._openAIPromptExecutionSettings,
+                chatHistory: new ChatHistory(),
+                requestIndex: 0,
+                checkIfFunctionAdvertised: (_) => true,
+                options: this._functionChoiceBehaviorOptions,
+                kernel: kernel!,
+                isStreaming: false,
+                cancellationToken: CancellationToken.None);
+
+        // Assert
+        Assert.NotNull(actualContext);
+        Assert.Same(this._openAIPromptExecutionSettings, actualContext!.ExecutionSettings);
+    }
+
     private sealed class AutoFunctionInvocationFilter(
         Func<AutoFunctionInvocationContext, Func<AutoFunctionInvocationContext, Task>, Task>? onAutoFunctionInvocation) : IAutoFunctionInvocationFilter
     {