.Net: Function calling abstraction

dotnet/src/Connectors/Connectors.OpenAI/OpenAIPromptExecutionSettings.cs

@@ -294,6 +294,7 @@ public override PromptExecutionSettings Clone()
  ResponseFormat = this.ResponseFormat,
  TokenSelectionBiases = this.TokenSelectionBiases is not null ? new Dictionary<int, int>(this.TokenSelectionBiases) : null,
  ToolCallBehavior = this.ToolCallBehavior,
+ FunctionChoiceBehavior = this.FunctionChoiceBehavior,
  User = this.User,
  ChatSystemPrompt = this.ChatSystemPrompt
  };
@@ -330,6 +331,8 @@ public static OpenAIPromptExecutionSettings FromExecutionSettings(PromptExecutio
  var openAIExecutionSettings = JsonSerializer.Deserialize<OpenAIPromptExecutionSettings>(json, JsonOptionsCache.ReadPermissive);
  if (openAIExecutionSettings is not null)
  {
+ // Restores the original function choice behavior that lost internal state(list of functions) during serialization/deserialization process.
+ openAIExecutionSettings.FunctionChoiceBehavior = executionSettings.FunctionChoiceBehavior;
  return openAIExecutionSettings;
  }
 

dotnet/src/Connectors/Connectors.UnitTests/OpenAI/ChatCompletion/AzureOpenAIChatCompletionServiceTests.cs

@@ -913,6 +913,102 @@ public async Task FunctionResultsCanBeProvidedToLLMAsManyResultsInOneChatMessage
  Assert.Equal("2", assistantMessage2.GetProperty("tool_call_id").GetString());
  }
 
+ [Fact]
+ public async Task ItCreatesCorrectFunctionToolCallsWhenUsingAutoFunctionChoiceBehaviorAsync()
+ {
+ // Arrange
+ var kernel = new Kernel();
+ kernel.Plugins.AddFromFunctions("TimePlugin", [
+ KernelFunctionFactory.CreateFromMethod(() => { }, "Date"),
+ KernelFunctionFactory.CreateFromMethod(() => { }, "Now")
+ ]);
+
+ var chatCompletion = new AzureOpenAIChatCompletionService("deployment", "https://endpoint", "api-key", "model-id", this._httpClient);
+
+ this._messageHandlerStub.ResponsesToReturn.Add(new HttpResponseMessage(HttpStatusCode.OK)
+ {
+ Content = new StringContent(OpenAITestHelper.GetTestResponse("chat_completion_test_response.json"))
+ });
+
+ var executionSettings = new OpenAIPromptExecutionSettings() { FunctionChoiceBehavior = FunctionChoiceBehavior.AutoFunctionChoice() };
+
+ // Act
+ await chatCompletion.GetChatMessageContentsAsync([], executionSettings, kernel);
+
+ // Assert
+ var actualRequestContent = Encoding.UTF8.GetString(this._messageHandlerStub.RequestContents[0]!);
+ Assert.NotNull(actualRequestContent);
+
+ var optionsJson = JsonSerializer.Deserialize<JsonElement>(actualRequestContent);
+ Assert.Equal(2, optionsJson.GetProperty("tools").GetArrayLength());
+ Assert.Equal("TimePlugin-Date", optionsJson.GetProperty("tools")[0].GetProperty("function").GetProperty("name").GetString());
+ Assert.Equal("TimePlugin-Now", optionsJson.GetProperty("tools")[1].GetProperty("function").GetProperty("name").GetString());
+
+ Assert.Equal("auto", optionsJson.GetProperty("tool_choice").ToString());
+ }
+
+ [Fact]
+ public async Task ItCreatesCorrectFunctionToolCallsWhenUsingRequiredFunctionChoiceBehaviorAsync()
+ {
+ // Arrange
+ var kernel = new Kernel();
+ kernel.Plugins.AddFromFunctions("TimePlugin", [
+ KernelFunctionFactory.CreateFromMethod(() => { }, "Date"),
+ ]);
+
+ var chatCompletion = new AzureOpenAIChatCompletionService("deployment", "https://endpoint", "api-key", "model-id", this._httpClient);
+
+ this._messageHandlerStub.ResponsesToReturn.Add(new HttpResponseMessage(HttpStatusCode.OK)
+ {
+ Content = new StringContent(OpenAITestHelper.GetTestResponse("chat_completion_test_response.json"))
+ });
+
+ var executionSettings = new OpenAIPromptExecutionSettings() { FunctionChoiceBehavior = FunctionChoiceBehavior.RequiredFunctionChoice() };
+
+ // Act
+ await chatCompletion.GetChatMessageContentsAsync([], executionSettings, kernel);
+
+ // Assert
+ var actualRequestContent = Encoding.UTF8.GetString(this._messageHandlerStub.RequestContents[0]!);
+ Assert.NotNull(actualRequestContent);
+
+ var optionsJson = JsonSerializer.Deserialize<JsonElement>(actualRequestContent);
+ Assert.Equal(1, optionsJson.GetProperty("tools").GetArrayLength());
+ Assert.Equal("TimePlugin-Date", optionsJson.GetProperty("tools")[0].GetProperty("function").GetProperty("name").GetString());
+ Assert.Equal("TimePlugin-Date", optionsJson.GetProperty("tool_choice").GetProperty("function").GetProperty("name").ToString());
+ }
+
+ [Fact]
+ public async Task ItCreatesCorrectFunctionToolCallsWhenUsingNoneFunctionChoiceBehaviorAsync()
+ {
+ // Arrange
+ var kernel = new Kernel();
+ kernel.Plugins.AddFromFunctions("TimePlugin", [
+ KernelFunctionFactory.CreateFromMethod(() => { }, "Date"),
+ ]);
+
+ var chatCompletion = new AzureOpenAIChatCompletionService("deployment", "https://endpoint", "api-key", "model-id", this._httpClient);
+
+ this._messageHandlerStub.ResponsesToReturn.Add(new HttpResponseMessage(HttpStatusCode.OK)
+ {
+ Content = new StringContent(OpenAITestHelper.GetTestResponse("chat_completion_test_response.json"))
+ });
+
+ var executionSettings = new OpenAIPromptExecutionSettings() { FunctionChoiceBehavior = FunctionChoiceBehavior.None };
+
+ // Act
+ await chatCompletion.GetChatMessageContentsAsync([], executionSettings, kernel);
+
+ // Assert
+ var actualRequestContent = Encoding.UTF8.GetString(this._messageHandlerStub.RequestContents[0]!);
+ Assert.NotNull(actualRequestContent);
+
+ var optionsJson = JsonSerializer.Deserialize<JsonElement>(actualRequestContent);
+ Assert.Equal(1, optionsJson.GetProperty("tools").GetArrayLength());
+ Assert.Equal("NonInvocableTool", optionsJson.GetProperty("tools")[0].GetProperty("function").GetProperty("name").GetString());
+ Assert.Equal("none", optionsJson.GetProperty("tool_choice").ToString());
+ }
+
  public void Dispose()
  {
  this._httpClient.Dispose();

dotnet/src/Connectors/Connectors.UnitTests/OpenAI/ChatCompletion/OpenAIChatCompletionServiceTests.cs

@@ -4,6 +4,7 @@
 using System.Collections.Generic;
 using System.Globalization;
 using System.IO;
+using System.Linq;
 using System.Net;
 using System.Net.Http;
 using System.Text;
@@ -27,7 +28,8 @@ public sealed class OpenAIChatCompletionServiceTests : IDisposable
 {
  private readonly HttpMessageHandlerStub _messageHandlerStub;
  private readonly HttpClient _httpClient;
- private readonly OpenAIFunction _timepluginDate, _timepluginNow;
+ private readonly KernelPlugin _plugin;
+ private readonly KernelFunction _timepluginDate, _timepluginNow;
  private readonly OpenAIPromptExecutionSettings _executionSettings;
  private readonly Mock<ILoggerFactory> _mockLoggerFactory;
 
@@ -37,18 +39,21 @@ public OpenAIChatCompletionServiceTests()
  this._httpClient = new HttpClient(this._messageHandlerStub, false);
  this._mockLoggerFactory = new Mock<ILoggerFactory>();
 
- IList<KernelFunctionMetadata> functions = KernelPluginFactory.CreateFromFunctions("TimePlugin", new[]
+ this._plugin = KernelPluginFactory.CreateFromFunctions("TimePlugin", new[]
  {
  KernelFunctionFactory.CreateFromMethod((string? format = null) => DateTime.Now.Date.ToString(format, CultureInfo.InvariantCulture), "Date", "TimePlugin.Date"),
  KernelFunctionFactory.CreateFromMethod((string? format = null) => DateTime.Now.ToString(format, CultureInfo.InvariantCulture), "Now", "TimePlugin.Now"),
- }).GetFunctionsMetadata();
+ });
 
- this._timepluginDate = functions[0].ToOpenAIFunction();
- this._timepluginNow = functions[1].ToOpenAIFunction();
+ this._timepluginDate = this._plugin.ElementAt(0);
+ this._timepluginNow = this._plugin.ElementAt(1);
 
  this._executionSettings = new()
  {
- ToolCallBehavior = ToolCallBehavior.EnableFunctions([this._timepluginDate, this._timepluginNow])
+ ToolCallBehavior = ToolCallBehavior.EnableFunctions([
+ this._timepluginDate.Metadata.ToOpenAIFunction(),
+ this._timepluginNow.Metadata.ToOpenAIFunction()
+ ])
  };
  }
 
@@ -161,7 +166,7 @@ public async Task ItCreatesCorrectFunctionToolCallsWhenUsingNowAsync()
  var chatCompletion = new OpenAIChatCompletionService(modelId: "gpt-3.5-turbo", apiKey: "NOKEY", httpClient: this._httpClient);
  this._messageHandlerStub.ResponseToReturn = new HttpResponseMessage(System.Net.HttpStatusCode.OK)
  { Content = new StringContent(ChatCompletionResponse) };
- this._executionSettings.ToolCallBehavior = ToolCallBehavior.RequireFunction(this._timepluginNow);
+ this._executionSettings.ToolCallBehavior = ToolCallBehavior.RequireFunction(this._timepluginNow.Metadata.ToOpenAIFunction());
 
  // Act
  await chatCompletion.GetChatMessageContentsAsync([], this._executionSettings);
@@ -587,6 +592,95 @@ public async Task FunctionResultsCanBeProvidedToLLMAsManyResultsInOneChatMessage
  Assert.Equal("2", assistantMessage2.GetProperty("tool_call_id").GetString());
  }
 
+ [Fact]
+ public async Task ItCreatesCorrectFunctionToolCallsWhenUsingAutoFunctionChoiceBehaviorAsync()
+ {
+ // Arrange
+ var kernel = new Kernel();
+ kernel.Plugins.Add(this._plugin);
+
+ var chatCompletion = new OpenAIChatCompletionService(modelId: "gpt-3.5-turbo", apiKey: "NOKEY", httpClient: this._httpClient);
+
+ this._messageHandlerStub.ResponseToReturn = new HttpResponseMessage(System.Net.HttpStatusCode.OK)
+ {
+ Content = new StringContent(ChatCompletionResponse)
+ };
+
+ var executionSettings = new OpenAIPromptExecutionSettings() { FunctionChoiceBehavior = FunctionChoiceBehavior.AutoFunctionChoice() };
+
+ // Act
+ await chatCompletion.GetChatMessageContentsAsync([], executionSettings, kernel);
+
+ // Assert
+ var actualRequestContent = Encoding.UTF8.GetString(this._messageHandlerStub.RequestContent!);
+ Assert.NotNull(actualRequestContent);
+
+ var optionsJson = JsonSerializer.Deserialize<JsonElement>(actualRequestContent);
+ Assert.Equal(2, optionsJson.GetProperty("tools").GetArrayLength());
+ Assert.Equal("TimePlugin-Date", optionsJson.GetProperty("tools")[0].GetProperty("function").GetProperty("name").GetString());
+ Assert.Equal("TimePlugin-Now", optionsJson.GetProperty("tools")[1].GetProperty("function").GetProperty("name").GetString());
+
+ Assert.Equal("auto", optionsJson.GetProperty("tool_choice").ToString());
+ }
+
+ [Fact]
+ public async Task ItCreatesCorrectFunctionToolCallsWhenUsingRequiredFunctionChoiceBehaviorAsync()
+ {
+ // Arrange
+ var kernel = new Kernel();
+ kernel.Plugins.AddFromFunctions("TimePlugin", [this._timepluginDate]);
+
+ var chatCompletion = new OpenAIChatCompletionService(modelId: "gpt-3.5-turbo", apiKey: "NOKEY", httpClient: this._httpClient);
+
+ this._messageHandlerStub.ResponseToReturn = new HttpResponseMessage(System.Net.HttpStatusCode.OK)
+ {
+ Content = new StringContent(ChatCompletionResponse)
+ };
+
+ var executionSettings = new OpenAIPromptExecutionSettings() { FunctionChoiceBehavior = FunctionChoiceBehavior.RequiredFunctionChoice() };
+
+ // Act
+ await chatCompletion.GetChatMessageContentsAsync([], executionSettings, kernel);
+
+ // Assert
+ var actualRequestContent = Encoding.UTF8.GetString(this._messageHandlerStub.RequestContent!);
+ Assert.NotNull(actualRequestContent);
+
+ var optionsJson = JsonSerializer.Deserialize<JsonElement>(actualRequestContent);
+ Assert.Equal(1, optionsJson.GetProperty("tools").GetArrayLength());
+ Assert.Equal("TimePlugin-Date", optionsJson.GetProperty("tools")[0].GetProperty("function").GetProperty("name").GetString());
+ Assert.Equal("TimePlugin-Date", optionsJson.GetProperty("tool_choice").GetProperty("function").GetProperty("name").ToString());
+ }
+
+ [Fact]
+ public async Task ItCreatesCorrectFunctionToolCallsWhenUsingNoneFunctionChoiceBehaviorAsync()
+ {
+ // Arrange
+ var kernel = new Kernel();
+ kernel.Plugins.AddFromFunctions("TimePlugin", [this._timepluginDate]);
+
+ var chatCompletion = new OpenAIChatCompletionService(modelId: "gpt-3.5-turbo", apiKey: "NOKEY", httpClient: this._httpClient);
+
+ this._messageHandlerStub.ResponseToReturn = new HttpResponseMessage(System.Net.HttpStatusCode.OK)
+ {
+ Content = new StringContent(ChatCompletionResponse)
+ };
+
+ var executionSettings = new OpenAIPromptExecutionSettings() { FunctionChoiceBehavior = FunctionChoiceBehavior.None };
+
+ // Act
+ await chatCompletion.GetChatMessageContentsAsync([], executionSettings, kernel);
+
+ // Assert
+ var actualRequestContent = Encoding.UTF8.GetString(this._messageHandlerStub.RequestContent!);
+ Assert.NotNull(actualRequestContent);
+
+ var optionsJson = JsonSerializer.Deserialize<JsonElement>(actualRequestContent);
+ Assert.Equal(1, optionsJson.GetProperty("tools").GetArrayLength());
+ Assert.Equal("NonInvocableTool", optionsJson.GetProperty("tools")[0].GetProperty("function").GetProperty("name").GetString());
+ Assert.Equal("none", optionsJson.GetProperty("tool_choice").ToString());
+ }
+
  public void Dispose()
  {
  this._httpClient.Dispose();

dotnet/src/Connectors/Connectors.UnitTests/OpenAI/OpenAIPromptExecutionSettingsTests.cs

@@ -243,6 +243,22 @@ public void FromExecutionSettingsWithDataDoesNotIncludeEmptyStopSequences()
  Assert.Null(executionSettingsWithData.StopSequences);
  }
 
+ [Fact]
+ public void ItRestoresOriginalFunctionChoiceBehavior()
+ {
+ // Arrange
+ var functionChoiceBehavior = FunctionChoiceBehavior.None;
+
+ var originalExecutionSettings = new PromptExecutionSettings();
+ originalExecutionSettings.FunctionChoiceBehavior = functionChoiceBehavior;
+
+ // Act
+ var result = OpenAIPromptExecutionSettings.FromExecutionSettings(originalExecutionSettings);
+
+ // Assert
+ Assert.Equal(functionChoiceBehavior, result.FunctionChoiceBehavior);
+ }
+
  private static void AssertExecutionSettings(OpenAIPromptExecutionSettings executionSettings)
  {
  Assert.NotNull(executionSettings);

dotnet/src/Functions/Functions.UnitTests/Markdown/Functions/KernelFunctionMarkdownTests.cs

@@ -1,5 +1,6 @@
 // Copyright (c) Microsoft. All rights reserved.
 
+using System.Linq;
 using Microsoft.SemanticKernel;
 using Xunit;
 
@@ -18,9 +19,56 @@ public void ItShouldCreatePromptFunctionConfigFromMarkdown()
  Assert.NotNull(model);
  Assert.Equal("TellMeAbout", model.Name);
  Assert.Equal("Hello AI, tell me about {{$input}}", model.Template);
- Assert.Equal(2, model.ExecutionSettings.Count);
+ Assert.Equal(3, model.ExecutionSettings.Count);
  Assert.Equal("gpt4", model.ExecutionSettings["service1"].ModelId);
  Assert.Equal("gpt3.5", model.ExecutionSettings["service2"].ModelId);
+ Assert.Equal("gpt3.5-turbo", model.ExecutionSettings["service3"].ModelId);
+ }
+
+ [Fact]
+ public void ItShouldInitializeFunctionChoiceBehaviorsFromMarkdown()
+ {
+ // Arrange
+ var kernel = new Kernel();
+
+ // Act
+ var function = KernelFunctionMarkdown.CreateFromPromptMarkdown(Markdown, "TellMeAbout");
+
+ // Assert
+ Assert.NotNull(function);
+ Assert.NotEmpty(function.ExecutionSettings);
+
+ Assert.Equal(3, function.ExecutionSettings.Count);
+
+ // AutoFunctionCallChoice for service1
+ var service1ExecutionSettings = function.ExecutionSettings["service1"];
+ Assert.NotNull(service1ExecutionSettings);
+
+ var autoFunctionChoiceBehavior = service1ExecutionSettings.FunctionChoiceBehavior as AutoFunctionChoiceBehavior;
+ Assert.NotNull(autoFunctionChoiceBehavior);
+
+ Assert.NotNull(autoFunctionChoiceBehavior.Functions);
+ Assert.Single(autoFunctionChoiceBehavior.Functions);
+ Assert.Equal("p1.f1", autoFunctionChoiceBehavior.Functions.First());
+ Assert.Equal(8, autoFunctionChoiceBehavior.MaximumAutoInvokeAttempts);
+
+ // RequiredFunctionCallChoice for service2
+ var service2ExecutionSettings = function.ExecutionSettings["service2"];
+ Assert.NotNull(service2ExecutionSettings);
+
+ var requiredFunctionChoiceBehavior = service2ExecutionSettings.FunctionChoiceBehavior as RequiredFunctionChoiceBehavior;
+ Assert.NotNull(requiredFunctionChoiceBehavior);
+ Assert.NotNull(requiredFunctionChoiceBehavior.Functions);
+ Assert.Single(requiredFunctionChoiceBehavior.Functions);
+ Assert.Equal("p1.f1", requiredFunctionChoiceBehavior.Functions.First());
+ Assert.Equal(2, requiredFunctionChoiceBehavior.MaximumUseAttempts);
+
+ // NoneFunctionCallChoice for service3
+ var service3ExecutionSettings = function.ExecutionSettings["service3"];
+ Assert.NotNull(service3ExecutionSettings);
+
+ var noneFunctionChoiceBehavior = service3ExecutionSettings.FunctionChoiceBehavior as NoneFunctionChoiceBehavior;
+ Assert.NotNull(noneFunctionChoiceBehavior);
  }
 
  [Fact]
@@ -47,7 +95,12 @@ public void ItShouldCreatePromptFunctionFromMarkdown()
  {
  "service1" : {
  "model_id": "gpt4",
- "temperature": 0.7
+ "temperature": 0.7,
+ "function_choice_behavior": {
+ "type": "auto",
+ "functions": ["p1.f1"],
+ "maximumAutoInvokeAttempts": 8
+ }
  }
  }
  ```
@@ -56,7 +109,24 @@ public void ItShouldCreatePromptFunctionFromMarkdown()
  {
  "service2" : {
  "model_id": "gpt3.5",
- "temperature": 0.8
+ "temperature": 0.8,
+ "function_choice_behavior": {
+ "type": "required",
+ "functions": ["p1.f1"],
+ "maximumUseAttempts": 2
+ }
+ }
+ }
+ ```
+ These are AI execution settings as well
+ ```sk.execution_settings
+ {
+ "service3" : {
+ "model_id": "gpt3.5-turbo",
+ "temperature": 0.8,
+ "function_choice_behavior": {
+ "type": "none"
+ }
  }
  }
  ```