Renaming FunctionResponse

microsoft · Oct 24, 2023 · 7d48210 · 7d48210
1 parent 7cc2058
commit 7d48210
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 4 deletions.
diff --git a/dotnet/samples/KernelSyntaxExamples/Example59_OpenAIFunctionCalling.cs b/dotnet/samples/KernelSyntaxExamples/Example59_OpenAIFunctionCalling.cs
@@ -80,7 +80,7 @@ private static async Task CompleteChatWithFunctionsAsync(string ask, ChatHistory
         }
 
         // Check for function response
-        OpenAIFunctionResponse? functionResponse = chatResult.GetFunctionResponse();
+        OpenAIFunctionResponse? functionResponse = chatResult.GetOpenAIFunctionResponse();
         if (functionResponse is not null)
         {
             // Print function response details
@@ -144,7 +144,7 @@ private static async Task StreamingCompleteChatWithFunctionsAsync(string ask, Ch
             }
             chatHistory.AddAssistantMessage(chatContent.ToString());
 
-            var functionResponse = await chatResult.GetStreamingFunctionResponseAsync();
+            var functionResponse = await chatResult.GetOpenAIStreamingFunctionResponseAsync();
 
             if (functionResponse is not null)
             {

diff --git a/dotnet/src/Connectors/Connectors.AI.OpenAI/AzureSdk/ChatResultExtensions.cs b/dotnet/src/Connectors/Connectors.AI.OpenAI/AzureSdk/ChatResultExtensions.cs
@@ -1,5 +1,6 @@
 // Copyright (c) Microsoft. All rights reserved.
 
+using System;
 using Microsoft.SemanticKernel.AI.ChatCompletion;
 
 namespace Microsoft.SemanticKernel.Connectors.AI.OpenAI.AzureSdk;
@@ -14,7 +15,18 @@ public static class ChatResultExtensions
     /// </summary>
     /// <param name="chatResult"></param>
     /// <returns>The <see cref="OpenAIFunctionResponse"/>, or null if no function was returned by the model.</returns>
+    [Obsolete("Obsoleted, please use GetOpenAIFunctionResponse instead")]
     public static OpenAIFunctionResponse? GetFunctionResponse(this IChatResult chatResult)
+    {
+        return GetOpenAIFunctionResponse(chatResult);
+    }
+
+    /// <summary>
+    /// Retrieve the resulting function from the chat result.
+    /// </summary>
+    /// <param name="chatResult"></param>
+    /// <returns>The <see cref="OpenAIFunctionResponse"/>, or null if no function was returned by the model.</returns>
+    public static OpenAIFunctionResponse? GetOpenAIFunctionResponse(this IChatResult chatResult)
     {
         OpenAIFunctionResponse? functionResponse = null;
         var functionCall = chatResult.ModelResult.GetResult<ChatModelResult>().Choice.Message.FunctionCall;

diff --git a/dotnet/src/Connectors/Connectors.AI.OpenAI/AzureSdk/ChatStreamingResultExtensions.cs b/dotnet/src/Connectors/Connectors.AI.OpenAI/AzureSdk/ChatStreamingResultExtensions.cs
@@ -18,11 +18,11 @@ public static class ChatStreamingResultExtensions
     /// </summary>
     /// <param name="chatStreamingResult">Chat streaming result</param>
     /// <returns>The <see cref="OpenAIFunctionResponse"/>, or null if no function was returned by the model.</returns>
-    public static async Task<OpenAIFunctionResponse?> GetStreamingFunctionResponseAsync(this IChatStreamingResult chatStreamingResult)
+    public static async Task<OpenAIFunctionResponse?> GetOpenAIStreamingFunctionResponseAsync(this IChatStreamingResult chatStreamingResult)
     {
         if (chatStreamingResult is not ChatStreamingResult)
         {
-            throw new NotSupportedException($"Chat streaming result is not the {nameof(ChatStreamingResult)} supported type");
+            throw new NotSupportedException($"Chat streaming result is not OpenAI {nameof(ChatStreamingResult)} supported type");
         }
 
         StringBuilder arguments = new();