.Net: planner tests openai (#4318)

- Changing function calling integration tests to use OpenAI gpt-4 until issues with OAI function calling are resolved. - Added description to some kernel functions using in tests to improve stability of function calling.  - [ ] The code builds clean without any errors or warnings - [ ] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [ ] All unit tests pass, and I have added new tests where possible - [ ] I didn't break anyone 😄 --------- Co-authored-by: Ben Thomas <[email protected]>
microsoft · Dec 15, 2023 · 65e20a6 · 65e20a6
1 parent 425fcdf
commit 65e20a6
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 15 deletions.
diff --git a/.github/workflows/dotnet-build-and-test.yml b/.github/workflows/dotnet-build-and-test.yml
@@ -104,6 +104,8 @@ jobs:
           Planners__AzureOpenAI__ApiKey: ${{ secrets.PLANNERS__AZUREOPENAI__APIKEY }}
           Planners__AzureOpenAI__Endpoint: ${{ secrets.PLANNERS__AZUREOPENAI__ENDPOINT }}
           Planners__AzureOpenAI__DeploymentName: ${{ vars.PLANNERS__AZUREOPENAI__DEPLOYMENTNAME }}
+          Planners__OpenAI__ApiKey: ${{ secrets.PLANNERS__OPENAI__APIKEY }}
+          Planners__OpenAI__ModelId: ${{ vars.PLANNERS__OPENAI__MODELID }}
           Bing__ApiKey: ${{ secrets.BING__APIKEY }}
           OpenAI__ApiKey: ${{ secrets.OPENAI__APIKEY }}
 

diff --git a/dotnet/samples/KernelSyntaxExamples/Example59_OpenAIFunctionCalling.cs b/dotnet/samples/KernelSyntaxExamples/Example59_OpenAIFunctionCalling.cs
@@ -27,7 +27,7 @@ public static async Task RunAsync()
         // Add a plugin with some helper functions we want to allow the model to utilize.
         kernel.Plugins.Add(KernelPluginFactory.CreateFromFunctions("HelperFunctions", new[]
         {
-            kernel.CreateFunctionFromMethod(() => DateTime.UtcNow.ToString("R"), "GetCurrentUtcTime"),
+            kernel.CreateFunctionFromMethod(() => DateTime.UtcNow.ToString("R"), "GetCurrentUtcTime", "Retrieves the current time in UTC."),
             kernel.CreateFunctionFromMethod((string cityName) =>
                 cityName switch
                 {

diff --git a/dotnet/samples/KernelSyntaxExamples/Getting_Started/Step2_Add_Plugins.cs b/dotnet/samples/KernelSyntaxExamples/Getting_Started/Step2_Add_Plugins.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft. All rights reserved.
 
 using System;
+using System.ComponentModel;
 using System.Threading.Tasks;
 using Microsoft.SemanticKernel;
 using Microsoft.SemanticKernel.Connectors.OpenAI;
@@ -38,6 +39,7 @@ public static async Task RunAsync()
     public class TimeInformation
     {
         [KernelFunction]
+        [Description("Retrieves the current time in UTC.")]
         public string GetCurrentUtcTime() => DateTime.UtcNow.ToString("R");
     }
 }
diff --git a/dotnet/samples/KernelSyntaxExamples/Getting_Started/Step4_Dependency_Injection.cs b/dotnet/samples/KernelSyntaxExamples/Getting_Started/Step4_Dependency_Injection.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft. All rights reserved.
 
 using System;
+using System.ComponentModel;
 using System.Threading.Tasks;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
@@ -56,6 +57,7 @@ public TimeInformation(ILoggerFactory loggerFactory)
         }
 
         [KernelFunction]
+        [Description("Retrieves the current time in UTC.")]
         public string GetCurrentUtcTime()
         {
             var utcNow = DateTime.UtcNow.ToString("R");

diff --git a/dotnet/samples/KernelSyntaxExamples/Getting_Started/Step7_Observability.cs b/dotnet/samples/KernelSyntaxExamples/Getting_Started/Step7_Observability.cs
@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft. All rights reserved.
 
 using System;
+using System.ComponentModel;
 using System.Threading.Tasks;
 using Microsoft.SemanticKernel;
 using Microsoft.SemanticKernel.Connectors.OpenAI;
@@ -58,6 +59,7 @@ void MyInvokedHandler(object? sender, FunctionInvokedEventArgs e)
     public class TimeInformation
     {
         [KernelFunction]
+        [Description("Retrieves the current time in UTC.")]
         public string GetCurrentUtcTime() => DateTime.UtcNow.ToString("R");
     }
 }
diff --git a/dotnet/src/IntegrationTests/Connectors/OpenAI/OpenAIToolsTests.cs b/dotnet/src/IntegrationTests/Connectors/OpenAI/OpenAIToolsTests.cs
@@ -2,6 +2,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.ComponentModel;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Configuration;
 using Microsoft.SemanticKernel;
@@ -53,14 +54,13 @@ void MyInvokingHandler(object? sender, FunctionInvokingEventArgs e)
 
     private Kernel InitializeKernel()
     {
-        AzureOpenAIConfiguration? azureOpenAIConfiguration = this._configuration.GetSection("Planners:AzureOpenAI").Get<AzureOpenAIConfiguration>();
-        Assert.NotNull(azureOpenAIConfiguration);
+        OpenAIConfiguration? openAIConfiguration = this._configuration.GetSection("Planners:OpenAI").Get<OpenAIConfiguration>();
+        Assert.NotNull(openAIConfiguration);
 
         IKernelBuilder builder = Kernel.CreateBuilder()
-            .AddAzureOpenAIChatCompletion(
-                deploymentName: azureOpenAIConfiguration.ChatDeploymentName!,
-                endpoint: azureOpenAIConfiguration.Endpoint,
-                apiKey: azureOpenAIConfiguration.ApiKey);
+            .AddOpenAIChatCompletion(
+                modelId: openAIConfiguration.ModelId,
+                apiKey: openAIConfiguration.ApiKey);
 
         var kernel = builder.Build();
 
@@ -95,6 +95,7 @@ private void Dispose(bool disposing)
     public class TimeInformation
     {
         [KernelFunction]
+        [Description("Retrieves the current time in UTC.")]
         public string GetCurrentUtcTime() => DateTime.UtcNow.ToString("R");
     }
 }
diff --git a/dotnet/src/IntegrationTests/Planners/Stepwise/FunctionCallingStepwisePlannerTests.cs b/dotnet/src/IntegrationTests/Planners/Stepwise/FunctionCallingStepwisePlannerTests.cs
@@ -74,14 +74,13 @@ public async Task CanExecuteStepwisePlanAsync(string prompt, string[] expectedFu
 
     private Kernel InitializeKernel()
     {
-        AzureOpenAIConfiguration? azureOpenAIConfiguration = this._configuration.GetSection("Planners:AzureOpenAI").Get<AzureOpenAIConfiguration>();
-        Assert.NotNull(azureOpenAIConfiguration);
+        OpenAIConfiguration? openAIConfiguration = this._configuration.GetSection("Planners:OpenAI").Get<OpenAIConfiguration>();
+        Assert.NotNull(openAIConfiguration);
 
         IKernelBuilder builder = Kernel.CreateBuilder()
-            .AddAzureOpenAIChatCompletion(
-                deploymentName: azureOpenAIConfiguration.ChatDeploymentName!,
-                endpoint: azureOpenAIConfiguration.Endpoint,
-                apiKey: azureOpenAIConfiguration.ApiKey);
+            .AddOpenAIChatCompletion(
+                modelId: openAIConfiguration.ModelId,
+                apiKey: openAIConfiguration.ApiKey);
 
         var kernel = builder.Build();
 

diff --git a/dotnet/src/IntegrationTests/testsettings.json b/dotnet/src/IntegrationTests/testsettings.json
@@ -43,8 +43,8 @@
       "ApiKey": ""
     },
     "OpenAI": {
-      "ServiceId": "text-davinci-003",
-      "ModelId": "text-davinci-003",
+      "ServiceId": "openai-gpt-4",
+      "ModelId": "gpt-4",
       "ApiKey": ""
     }
   }