.Net: New result types - FunctionResult and KernelResult

dotnet/samples/ApplicationInsightsExample/Program.cs

@@ -70,7 +70,7 @@ public static async Task Main()
             var result = await kernel.RunAsync(plan);
 
             Console.WriteLine("Result:");
-            Console.WriteLine(result.Result);
+            Console.WriteLine(result.GetValue<string>());
         }
         finally
         {

dotnet/samples/KernelSyntaxExamples/Example02_Pipeline.cs

@@ -22,11 +22,11 @@ public static async Task RunAsync()
         // Load native skill
         var text = kernel.ImportSkill(new TextPlugin());
 
-        SKContext result = await kernel.RunAsync("    i n f i n i t e     s p a c e     ",
+        KernelResult result = await kernel.RunAsync("    i n f i n i t e     s p a c e     ",
             text["TrimStart"],
             text["TrimEnd"],
             text["Uppercase"]);
 
-        Console.WriteLine(result);
+        Console.WriteLine(result.GetValue<string>());
     }
 }

dotnet/samples/KernelSyntaxExamples/Example03_Variables.cs

@@ -24,10 +24,10 @@ public static async Task RunAsync()
         var variables = new ContextVariables("Today is: ");
         variables.Set("day", DateTimeOffset.Now.ToString("dddd", CultureInfo.CurrentCulture));
 
-        SKContext result = await kernel.RunAsync(variables,
+        KernelResult result = await kernel.RunAsync(variables,
             text["AppendDay"],
             text["Uppercase"]);
 
-        Console.WriteLine(result);
+        Console.WriteLine(result.GetValue<string>());
     }
 }

dotnet/samples/KernelSyntaxExamples/Example07_BingAndGoogleSkills.cs

@@ -143,13 +143,15 @@ private static async Task Example2Async(IKernel kernel)
             ["externalInformation"] = string.Empty
         });
 
+        var result = answer.GetValue<string>()!;
+
         // If the answer contains commands, execute them using the prompt renderer.
-        if (answer.Result.Contains("bing.search", StringComparison.OrdinalIgnoreCase))
+        if (result.Contains("bing.search", StringComparison.OrdinalIgnoreCase))
         {
             var promptRenderer = new PromptTemplateEngine();
 
             Console.WriteLine("---- Fetching information from Bing...");
-            var information = await promptRenderer.RenderAsync(answer.Result, kernel.CreateNewContext());
+            var information = await promptRenderer.RenderAsync(result, kernel.CreateNewContext());
 
             Console.WriteLine("Information found:");
             Console.WriteLine(information);
@@ -167,7 +169,7 @@ private static async Task Example2Async(IKernel kernel)
         }
 
         Console.WriteLine("---- ANSWER:");
-        Console.WriteLine(answer);
+        Console.WriteLine(answer.GetValue<string>());
 
         /* OUTPUT:
 

dotnet/samples/KernelSyntaxExamples/Example12_SequentialPlanner.cs

@@ -98,7 +98,7 @@ private static async Task PoetrySamplesAsync()
         var result = await kernel.RunAsync(plan);
 
         Console.WriteLine("Result:");
-        Console.WriteLine(result.Result);
+        Console.WriteLine(result.GetValue<string>());
     }
 
     private static async Task EmailSamplesWithRecallAsync()
@@ -186,7 +186,7 @@ await foreach (MemoryQueryResult memory in memories)
             var result = await kernel.RunAsync(newInput, restoredPlan);
 
             Console.WriteLine("Result:");
-            Console.WriteLine(result.Result);
+            Console.WriteLine(result.GetValue<string>());
         }
     }
 

dotnet/samples/KernelSyntaxExamples/Example13_ConversationSummarySkill.cs

@@ -136,12 +136,12 @@ private static async Task ConversationSummaryPluginAsync()
         IDictionary<string, ISKFunction> conversationSummarySkill =
             kernel.ImportSkill(new ConversationSummaryPlugin(kernel));
 
-        SKContext summary = await kernel.RunAsync(
+        KernelResult summary = await kernel.RunAsync(
             ChatTranscript,
             conversationSummarySkill["SummarizeConversation"]);
 
         Console.WriteLine("Generated Summary:");
-        Console.WriteLine(summary.Result);
+        Console.WriteLine(summary.GetValue<string>());
     }
 
     private static async Task GetConversationActionItemsAsync()
@@ -152,12 +152,12 @@ private static async Task GetConversationActionItemsAsync()
         IDictionary<string, ISKFunction> conversationSummarySkill =
             kernel.ImportSkill(new ConversationSummaryPlugin(kernel));
 
-        SKContext summary = await kernel.RunAsync(
+        KernelResult summary = await kernel.RunAsync(
             ChatTranscript,
             conversationSummarySkill["GetConversationActionItems"]);
 
         Console.WriteLine("Generated Action Items:");
-        Console.WriteLine(summary.Result);
+        Console.WriteLine(summary.GetValue<string>());
     }
 
     private static async Task GetConversationTopicsAsync()
@@ -168,12 +168,12 @@ private static async Task GetConversationTopicsAsync()
         IDictionary<string, ISKFunction> conversationSummarySkill =
             kernel.ImportSkill(new ConversationSummaryPlugin(kernel));
 
-        SKContext summary = await kernel.RunAsync(
+        KernelResult summary = await kernel.RunAsync(
             ChatTranscript,
             conversationSummarySkill["GetConversationTopics"]);
 
         Console.WriteLine("Generated Topics:");
-        Console.WriteLine(summary.Result);
+        Console.WriteLine(summary.GetValue<string>());
     }
 
     private static IKernel InitializeKernel()

dotnet/samples/KernelSyntaxExamples/Example23_OpenApiSkill_Github.cs

@@ -47,7 +47,7 @@ public static async Task<string> ListPullRequestsFromGitHubAsync(BearerAuthentic
         var result = await kernel.RunAsync(contextVariables, skill["PullsList"]);
 
         Console.WriteLine("Successful GitHub List Pull Requests skill response.");
-        var resultJson = JsonConvert.DeserializeObject<Dictionary<string, object>>(result.Result);
+        var resultJson = JsonConvert.DeserializeObject<Dictionary<string, object>>(result.GetValue<string>()!);
         var pullRequests = JArray.Parse((string)resultJson!["content"]);
 
         if (pullRequests != null && pullRequests.First != null)

dotnet/samples/KernelSyntaxExamples/Example24_OpenApiSkill_Jira.cs

@@ -60,7 +60,7 @@ public static async Task RunAsync()
             var result = await kernel.RunAsync(contextVariables, jiraSkills["GetIssue"]);
 
             Console.WriteLine("\n\n\n");
-            var formattedContent = JsonConvert.SerializeObject(JsonConvert.DeserializeObject(result.Result), Formatting.Indented);
+            var formattedContent = JsonConvert.SerializeObject(JsonConvert.DeserializeObject(result.GetValue<string>()!), Formatting.Indented);
             Console.WriteLine("GetIssue jiraSkills response: \n{0}", formattedContent);
         }
 
@@ -74,7 +74,7 @@ public static async Task RunAsync()
             var result = await kernel.RunAsync(contextVariables, jiraSkills["AddComment"]);
 
             Console.WriteLine("\n\n\n");
-            var formattedContent = JsonConvert.SerializeObject(JsonConvert.DeserializeObject(result.Result), Formatting.Indented);
+            var formattedContent = JsonConvert.SerializeObject(JsonConvert.DeserializeObject(result.GetValue<string>()!), Formatting.Indented);
             Console.WriteLine("AddComment jiraSkills response: \n{0}", formattedContent);
         }
     }

dotnet/samples/KernelSyntaxExamples/Example28_ActionPlanner.cs

@@ -3,7 +3,6 @@
 using System;
 using System.Threading.Tasks;
 using Microsoft.SemanticKernel;
-using Microsoft.SemanticKernel.Orchestration;
 using Microsoft.SemanticKernel.Planning;
 using Microsoft.SemanticKernel.Planning.Action;
 using RepoUtils;
@@ -43,10 +42,10 @@ public static async Task RunAsync()
         var plan = await planner.CreatePlanAsync(goal);
 
         // Execute the full plan (which is a single function)
-        SKContext result = await plan.InvokeAsync();
+        var result = await plan.InvokeAsync();
 
         // Show the result, which should match the given goal
-        Console.WriteLine(result);
+        Console.WriteLine(result.GetValue<string>());
 
         /* Output:
          *

dotnet/samples/KernelSyntaxExamples/Example31_CustomPlanner.cs

@@ -48,7 +48,7 @@ public static async Task RunAsync()
         var result = await plan.InvokeAsync(context);
 
         Console.WriteLine("Result:");
-        Console.WriteLine(result.Result);
+        Console.WriteLine(result.GetValue<string>());
         Console.WriteLine();
     }
     /* Example Output
@@ -154,7 +154,7 @@ public async Task<string> RunMarkupAsync(string docString, SKContext context)
         Console.WriteLine();
 
         var result = await plan.InvokeAsync();
-        return result.Result;
+        return result.GetValue<string>()!;
     }
 }
 

dotnet/samples/KernelSyntaxExamples/Example43_GetModelResult.cs

@@ -31,16 +31,17 @@ public static async Task RunAsync()
         var myFunction = kernel.CreateSemanticFunction(FunctionDefinition);
 
         // Using InvokeAsync with 3 results (Currently invoke only supports 1 result, but you can get the other results from the ModelResults)
-        var textResult = await myFunction.InvokeAsync("Sci-fi",
+        var functionResult = await myFunction.InvokeAsync("Sci-fi",
             settings: new CompleteRequestSettings { ResultsPerPrompt = 3, MaxTokens = 500, Temperature = 1, TopP = 0.5 });
-        Console.WriteLine(textResult);
-        Console.WriteLine(textResult.ModelResults.Select(result => result.GetOpenAIChatResult()).AsJson());
+
+        Console.WriteLine(functionResult.GetValue<string>());
+        Console.WriteLine(functionResult.ModelResults.Select(result => result.GetOpenAIChatResult()).AsJson());
         Console.WriteLine();
 
         // Using the Kernel RunAsync
-        textResult = await kernel.RunAsync("sorry I forgot your birthday", myFunction);
-        Console.WriteLine(textResult);
-        Console.WriteLine(textResult.ModelResults.LastOrDefault()?.GetOpenAIChatResult()?.Usage.AsJson());
+        var kernelResult = await kernel.RunAsync("sorry I forgot your birthday", myFunction);
+        Console.WriteLine(kernelResult.GetValue<string>());
+        Console.WriteLine(kernelResult.ModelResults.LastOrDefault()?.GetOpenAIChatResult()?.Usage.AsJson());
         Console.WriteLine();
 
         // Using Chat Completion directly

dotnet/samples/KernelSyntaxExamples/Example48_GroundednessChecks.cs

@@ -88,15 +88,15 @@ public static async Task GroundednessCheckingSkill()
         context.Variables.Set("topic", "people and places");
         context.Variables.Set("example_entities", "John, Jane, mother, brother, Paris, Rome");
 
-        var extractionResult = (await entityExtraction.InvokeAsync(context)).Result;
+        var extractionResult = (await entityExtraction.InvokeAsync(context)).GetValue<string>();
 
         Console.WriteLine("======== Extract Entities ========");
         Console.WriteLine(extractionResult);
 
         context.Variables.Update(extractionResult);
         context.Variables.Set("reference_context", s_groundingText);
 
-        var groundingResult = (await reference_check.InvokeAsync(context)).Result;
+        var groundingResult = (await reference_check.InvokeAsync(context)).GetValue<string>();
 
         Console.WriteLine("======== Reference Check ========");
         Console.WriteLine(groundingResult);
@@ -106,7 +106,7 @@ public static async Task GroundednessCheckingSkill()
         var excisionResult = await entity_excision.InvokeAsync(context);
 
         Console.WriteLine("======== Excise Entities ========");
-        Console.WriteLine(excisionResult.Result);
+        Console.WriteLine(excisionResult.GetValue<string>());
     }
 
     public static async Task PlanningWithGroundedness()
@@ -142,7 +142,7 @@ public static async Task PlanningWithGroundedness()
         Console.WriteLine(plan.ToPlanWithGoalString());
 
         var results = await plan.InvokeAsync(s_groundingText);
-        Console.WriteLine(results.Result);
+        Console.WriteLine(results.GetValue<string>());
     }
 }
 

dotnet/samples/KernelSyntaxExamples/Example51_StepwisePlanner.cs

@@ -6,7 +6,6 @@
 using System.Linq;
 using System.Threading.Tasks;
 using Microsoft.SemanticKernel;
-using Microsoft.SemanticKernel.Orchestration;
 using Microsoft.SemanticKernel.Planning;
 using Microsoft.SemanticKernel.Plugins.Core;
 using Microsoft.SemanticKernel.Plugins.Web;
@@ -68,7 +67,7 @@ private static void PrintResults()
             Console.WriteLine("Mode\tModel\tAnswer\tStepsTaken\tIterations\tTimeTaken");
             foreach (var er in ExecutionResults.OrderByDescending(s => s.model).Where(s => s.question == question))
             {
-                Console.WriteLine($"{er.mode}\t{er.model}\t{er.stepsTaken}\t{er.iterations}\t{er.timeTaken}\t{er.answer}");
+                Console.WriteLine($"{er.mode}\t{er.model}\t{er.timeTaken}\t{er.answer}");
             }
         }
     }
@@ -79,8 +78,6 @@ private struct ExecutionResult
         public string? model;
         public string? question;
         public string? answer;
-        public string? stepsTaken;
-        public string? iterations;
         public string? timeTaken;
     }
 
@@ -147,42 +144,25 @@ private static async Task RunWithQuestion(IKernel kernel, ExecutionResult curren
             plannerConfig.MaxTokens = MaxTokens.Value;
         }
 
-        SKContext result;
         sw.Start();
 
         try
         {
             StepwisePlanner planner = new(kernel: kernel, config: plannerConfig);
             var plan = planner.CreatePlan(question);
 
-            result = await plan.InvokeAsync(kernel.CreateNewContext());
+            var planResult = await plan.InvokeAsync(kernel.CreateNewContext());
+            var result = planResult.GetValue<string>()!;
 
-            if (result.Result.Contains("Result not found, review _stepsTaken to see what", StringComparison.OrdinalIgnoreCase))
+            if (result.Contains("Result not found, review _stepsTaken to see what", StringComparison.OrdinalIgnoreCase))
             {
                 Console.WriteLine("Could not answer question in " + plannerConfig.MaxIterations + " iterations");
                 currentExecutionResult.answer = "Could not answer question in " + plannerConfig.MaxIterations + " iterations";
             }
             else
             {
-                Console.WriteLine("Result: " + result.Result);
-                currentExecutionResult.answer = result.Result;
-            }
-
-            if (result.Variables.TryGetValue("stepCount", out string? stepCount))
-            {
-                Console.WriteLine("Steps Taken: " + stepCount);
-                currentExecutionResult.stepsTaken = stepCount;
-            }
-
-            if (result.Variables.TryGetValue("skillCount", out string? skillCount))
-            {
-                Console.WriteLine("Skills Used: " + skillCount);
-            }
-
-            if (result.Variables.TryGetValue("iterations", out string? iterations))
-            {
-                Console.WriteLine("Iterations: " + iterations);
-                currentExecutionResult.iterations = iterations;
+                Console.WriteLine("Result: " + result);
+                currentExecutionResult.answer = result;
             }
         }
 #pragma warning disable CA1031

dotnet/samples/KernelSyntaxExamples/Example57_FunctionEventHandlers.cs

@@ -75,7 +75,7 @@ void MyRemovedPreExecutionHandler(object? sender, FunctionInvokingEventArgs e)
 
         void MyPostExecutionHandler(object? sender, FunctionInvokedEventArgs e)
         {
-            Console.WriteLine($"{e.FunctionView.SkillName}.{e.FunctionView.Name} : Post Execution Handler - Total Tokens: {e.SKContext.ModelResults.First().GetOpenAIChatResult().Usage.TotalTokens}");
+            Console.WriteLine($"{e.FunctionView.SkillName}.{e.FunctionView.Name} : Post Execution Handler - Total Tokens: {e.ModelResults.First().GetOpenAIChatResult().Usage.TotalTokens}");
         }
 
         kernel.FunctionInvoking += MyPreHandler;
@@ -238,11 +238,11 @@ private static async Task SkippingFunctionsAsync()
             Console.WriteLine($"Only not skipped functions will trigger invoked event - Function name: {e.FunctionView.Name}");
         };
 
-        var context = await kernel.RunAsync(
+        var result = await kernel.RunAsync(
             skipMeFunction,
             dontSkipMeFunction);
 
-        Console.WriteLine($"Final result: {context.Result}");
+        Console.WriteLine($"Final result: {result.GetValue<string>()}");
     }
 
     private static async Task RepeatFunctionsAsync()

dotnet/samples/NCalcPlugins/LanguageCalculatorPlugin.cs

@@ -89,11 +89,12 @@ public LanguageCalculatorPlugin(IKernel kernel)
         string input,
         SKContext context)
     {
-        SKContext answer;
+        string answer;
 
         try
         {
-            answer = await this._mathTranslator.InvokeAsync(input).ConfigureAwait(false);
+            var result = await this._mathTranslator.InvokeAsync(input).ConfigureAwait(false);
+            answer = result.GetValue<string>() ?? throw new InvalidOperationException("No result from Math Translator function.");
         }
         catch (Exception ex)
         {
@@ -102,14 +103,14 @@ public LanguageCalculatorPlugin(IKernel kernel)
 
         string pattern = @"```\s*(.*?)\s*```";
 
-        Match match = Regex.Match(answer.Result, pattern, RegexOptions.Singleline);
+        Match match = Regex.Match(answer, pattern, RegexOptions.Singleline);
         if (match.Success)
         {
             var result = EvaluateMathExpression(match);
             return result;
         }
 
-        throw new InvalidOperationException($"Input value [{input}] could not be understood, received following {answer.Result}");
+        throw new InvalidOperationException($"Input value [{input}] could not be understood, received following {answer}");
     }
 
     private static string EvaluateMathExpression(Match match)

dotnet/src/Extensions/Extensions.UnitTests/Planning/ActionPlanner/ActionPlannerTests.cs

@@ -167,7 +167,7 @@ private Mock<IKernel> CreateMockKernelAndFunctionFlowWithTestString(string testP
             default
         )).Callback<SKContext, CompleteRequestSettings, CancellationToken>(
             (c, s, ct) => c.Variables.Update("Hello world!")
-        ).Returns(() => Task.FromResult(returnContext));
+        ).Returns(() => Task.FromResult(new FunctionResult(returnContext, testPlanString)));
 
         // Mock Skills
         kernel.Setup(x => x.Skills).Returns(skills.Object);
@@ -214,7 +214,7 @@ private Mock<ISkillCollection> CreateMockSkillCollection()
                 .Returns<SKContext, CompleteRequestSettings, CancellationToken>((context, settings, CancellationToken) =>
                 {
                     context.Variables.Update("MOCK FUNCTION CALLED");
-                    return Task.FromResult(context);
+                    return Task.FromResult(new FunctionResult(context));
                 });
             skills.Setup(x => x.GetFunction(skillName, name))
                 .Returns(mockFunction.Object);