Update long-running operation APIs to use LRO subclient pattern

OpenAI.sln

@@ -6,7 +6,9 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenAI", "src\OpenAI.csproj
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenAI.Examples", "examples\OpenAI.Examples.csproj", "{1F1CD1D4-9932-4B73-99D8-C252A67D4B46}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OpenAI.Tests", "tests\OpenAI.Tests.csproj", "{6F156401-2544-41D7-B204-3148C51C1D09}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenAI.Tests", "tests\OpenAI.Tests.csproj", "{6F156401-2544-41D7-B204-3148C51C1D09}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "System.ClientModel", "..\azure-sdk-for-net\sdk\core\System.ClientModel\src\System.ClientModel.csproj", "{8316F2D5-21A7-468B-97DB-B14C44B4F50C}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -26,11 +28,15 @@ Global
 		{6F156401-2544-41D7-B204-3148C51C1D09}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{6F156401-2544-41D7-B204-3148C51C1D09}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{6F156401-2544-41D7-B204-3148C51C1D09}.Release|Any CPU.Build.0 = Release|Any CPU
+		{8316F2D5-21A7-468B-97DB-B14C44B4F50C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{8316F2D5-21A7-468B-97DB-B14C44B4F50C}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{8316F2D5-21A7-468B-97DB-B14C44B4F50C}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{8316F2D5-21A7-468B-97DB-B14C44B4F50C}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {A97F4B90-2591-4689-B1F8-5F21FE6D6CAE}
 	EndGlobalSection
-EndGlobal
+EndGlobal

examples/Assistants/Example01_RetrievalAugmentedGeneration.cs

@@ -5,7 +5,6 @@
 using System.ClientModel;
 using System.Collections.Generic;
 using System.IO;
-using System.Threading;
 
 namespace OpenAI.Examples;
 
@@ -88,18 +87,12 @@ public void Example01_RetrievalAugmentedGeneration()
             InitialMessages = { "How well did product 113045 sell in February? Graph its trend over time." }
         };
 
-        ThreadRun threadRun = assistantClient.CreateThreadAndRun(assistant.Id, threadOptions);
-
-        // Check back to see when the run is done
-        do
-        {
-            Thread.Sleep(TimeSpan.FromSeconds(1));
-            threadRun = assistantClient.GetRun(threadRun.ThreadId, threadRun.Id);
-        } while (!threadRun.Status.IsTerminal);
+        // Passing ReturnWhen.Completed means CreateThreadAndRun will return control after the run is complete.
+        RunOperation runOperation = assistantClient.CreateThreadAndRun(ReturnWhen.Completed, assistant.Id, threadOptions);
 
         // Finally, we'll print out the full history for the thread that includes the augmented generation
         PageCollection<ThreadMessage> messagePages
-            = assistantClient.GetMessages(threadRun.ThreadId,  new MessageCollectionOptions() { Order = ListOrder.OldestFirst });
+            = assistantClient.GetMessages(runOperation.ThreadId,  new MessageCollectionOptions() { Order = ListOrder.OldestFirst });
         IEnumerable<ThreadMessage> messages = messagePages.GetAllValues();
 
         foreach (ThreadMessage message in messages)
@@ -143,7 +136,7 @@ PageCollection<ThreadMessage> messagePages
         }
 
         // Optionally, delete any persistent resources you no longer need.
-        _ = assistantClient.DeleteThread(threadRun.ThreadId);
+        _ = assistantClient.DeleteThread(runOperation.ThreadId);
         _ = assistantClient.DeleteAssistant(assistant);
         _ = fileClient.DeleteFile(salesFile);
     }

examples/Assistants/Example01_RetrievalAugmentedGenerationAsync.cs

@@ -5,7 +5,6 @@
 using System.ClientModel;
 using System.Collections.Generic;
 using System.IO;
-using System.Threading;
 using System.Threading.Tasks;
 
 namespace OpenAI.Examples;
@@ -89,18 +88,11 @@ public async Task Example01_RetrievalAugmentedGenerationAsync()
             InitialMessages = { "How well did product 113045 sell in February? Graph its trend over time." }
         };
 
-        ThreadRun threadRun = await assistantClient.CreateThreadAndRunAsync(assistant.Id, threadOptions);
-
-        // Check back to see when the run is done
-        do
-        {
-            Thread.Sleep(TimeSpan.FromSeconds(1));
-            threadRun = assistantClient.GetRun(threadRun.ThreadId, threadRun.Id);
-        } while (!threadRun.Status.IsTerminal);
+        RunOperation runOperation = await assistantClient.CreateThreadAndRunAsync(ReturnWhen.Completed, assistant.Id, threadOptions);
 
         // Finally, we'll print out the full history for the thread that includes the augmented generation
         AsyncPageCollection<ThreadMessage> messagePages
-            = assistantClient.GetMessagesAsync(threadRun.ThreadId, new MessageCollectionOptions() { Order = ListOrder.OldestFirst });
+            = assistantClient.GetMessagesAsync(runOperation.ThreadId, new MessageCollectionOptions() { Order = ListOrder.OldestFirst });
         IAsyncEnumerable<ThreadMessage> messages = messagePages.GetAllValuesAsync();
 
         await foreach (ThreadMessage message in messages)
@@ -144,7 +136,7 @@ AsyncPageCollection<ThreadMessage> messagePages
         }
 
         // Optionally, delete any persistent resources you no longer need.
-        _ = await assistantClient.DeleteThreadAsync(threadRun.ThreadId);
+        _ = await assistantClient.DeleteThreadAsync(runOperation.ThreadId);
         _ = await assistantClient.DeleteAssistantAsync(assistant);
         _ = await fileClient.DeleteFileAsync(salesFile);
     }

examples/Assistants/Example02_FunctionCalling.cs

@@ -13,7 +13,7 @@ public partial class AssistantExamples
     [Test]
     public void Example02_FunctionCalling()
     {
-        #region
+        #region Define Functions
         string GetCurrentLocation()
         {
             // Call a location API here.
@@ -64,7 +64,7 @@ string GetCurrentWeather(string location, string unit = "celsius")
 #pragma warning disable OPENAI001
         AssistantClient client = new(Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
 
-        #region
+        #region Create Assistant
         // Create an assistant that can call the function tools.
         AssistantCreationOptions assistantOptions = new()
         {
@@ -78,29 +78,27 @@ string GetCurrentWeather(string location, string unit = "celsius")
         Assistant assistant = client.CreateAssistant("gpt-4-turbo", assistantOptions);
         #endregion
 
-        #region
+        #region Create Thread and Run
         // Create a thread with an initial user message and run it.
         ThreadCreationOptions threadOptions = new()
         {
             InitialMessages = { "What's the weather like today?" }
         };
 
-        ThreadRun run = client.CreateThreadAndRun(assistant.Id, threadOptions);
+        RunOperation runOperation = client.CreateThreadAndRun(ReturnWhen.Started, assistant.Id, threadOptions);
         #endregion
 
-        #region
-        // Poll the run until it is no longer queued or in progress.
-        while (!run.Status.IsTerminal)
-        {
-            Thread.Sleep(TimeSpan.FromSeconds(1));
-            run = client.GetRun(run.ThreadId, run.Id);
+        #region Submit tool outputs to run
+
+        IEnumerable<ThreadRun> updates = runOperation.GetUpdates();
 
-            // If the run requires action, resolve them.
-            if (run.Status == RunStatus.RequiresAction)
+        foreach (ThreadRun update in updates)
+        {
+            if (update.Status == RunStatus.RequiresAction)
             {
                 List<ToolOutput> toolOutputs = [];
 
-                foreach (RequiredAction action in run.RequiredActions)
+                foreach (RequiredAction action in runOperation.Value.RequiredActions)
                 {
                     switch (action.FunctionName)
                     {
@@ -142,17 +140,19 @@ string GetCurrentWeather(string location, string unit = "celsius")
                 }
 
                 // Submit the tool outputs to the assistant, which returns the run to the queued state.
-                run = client.SubmitToolOutputsToRun(run.ThreadId, run.Id, toolOutputs);
+                runOperation.SubmitToolOutputsToRun(toolOutputs);
             }
         }
+
         #endregion
 
-        #region
-        // With the run complete, list the messages and display their content
-        if (run.Status == RunStatus.Completed)
+        #region Get and display messages
+
+        // If the run completed successfully, list the messages and display their content
+        if (runOperation.Status == RunStatus.Completed)
         {
             PageCollection<ThreadMessage> messagePages
-                = client.GetMessages(run.ThreadId, new MessageCollectionOptions() { Order = ListOrder.OldestFirst });
+                = client.GetMessages(runOperation.ThreadId, new MessageCollectionOptions() { Order = ListOrder.OldestFirst });
             IEnumerable<ThreadMessage> messages = messagePages.GetAllValues();
 
             foreach (ThreadMessage message in messages)
@@ -186,7 +186,7 @@ PageCollection<ThreadMessage> messagePages
         }
         else
         {
-            throw new NotImplementedException(run.Status.ToString());
+            throw new NotImplementedException(runOperation.Status.ToString());
         }
         #endregion
     }

examples/Assistants/Example02_FunctionCallingAsync.cs

@@ -85,22 +85,22 @@ string GetCurrentWeather(string location, string unit = "celsius")
             InitialMessages = { "What's the weather like today?" }
         };
 
-        ThreadRun run = await client.CreateThreadAndRunAsync(assistant.Id, threadOptions);
+        RunOperation runOperation = await client.CreateThreadAndRunAsync(ReturnWhen.Started, assistant.Id, threadOptions);
         #endregion
 
         #region
-        // Poll the run until it is no longer queued or in progress.
-        while (!run.Status.IsTerminal)
-        {
-            await Task.Delay(TimeSpan.FromSeconds(1));
-            run = await client.GetRunAsync(run.ThreadId, run.Id);
 
+
+        IEnumerable<ThreadRun> updates = runOperation.GetUpdates();
+
+        foreach (ThreadRun update in updates)
+        {
             // If the run requires action, resolve them.
-            if (run.Status == RunStatus.RequiresAction)
+            if (runOperation.Status == RunStatus.RequiresAction)
             {
                 List<ToolOutput> toolOutputs = [];
 
-                foreach (RequiredAction action in run.RequiredActions)
+                foreach (RequiredAction action in runOperation.Value.RequiredActions)
                 {
                     switch (action.FunctionName)
                     {
@@ -142,17 +142,17 @@ string GetCurrentWeather(string location, string unit = "celsius")
                 }
 
                 // Submit the tool outputs to the assistant, which returns the run to the queued state.
-                run = await client.SubmitToolOutputsToRunAsync(run.ThreadId, run.Id, toolOutputs);
+                await runOperation.SubmitToolOutputsToRunAsync(toolOutputs);
             }
         }
         #endregion
 
         #region
         // With the run complete, list the messages and display their content
-        if (run.Status == RunStatus.Completed)
+        if (runOperation.Status == RunStatus.Completed)
         {
             AsyncPageCollection<ThreadMessage> messagePages
-                = client.GetMessagesAsync(run.ThreadId, new MessageCollectionOptions() { Order = ListOrder.OldestFirst });
+                = client.GetMessagesAsync(runOperation.ThreadId, new MessageCollectionOptions() { Order = ListOrder.OldestFirst });
             IAsyncEnumerable<ThreadMessage> messages = messagePages.GetAllValuesAsync();
 
             await foreach (ThreadMessage message in messages)
@@ -186,7 +186,7 @@ AsyncPageCollection<ThreadMessage> messagePages
         }
         else
         {
-            throw new NotImplementedException(run.Status.ToString());
+            throw new NotImplementedException(runOperation.Status.ToString());
         }
         #endregion
     }

examples/Assistants/Example02b_FunctionCallingStreaming.cs

@@ -1,7 +1,6 @@
 using NUnit.Framework;
 using OpenAI.Assistants;
 using System;
-using System.ClientModel;
 using System.ClientModel.Primitives;
 using System.Collections.Generic;
 using System.Threading.Tasks;
@@ -91,43 +90,34 @@ public async Task Example02b_FunctionCallingStreaming()
         #endregion
 
         #region Step 3 - Initiate a streaming run
-        AsyncCollectionResult<StreamingUpdate> asyncUpdates
-            = client.CreateRunStreamingAsync(thread, assistant);
+        StreamingRunOperation runOperation = client.CreateRunStreaming(thread, assistant);
+        IAsyncEnumerable<StreamingUpdate> updates = runOperation.GetUpdatesStreamingAsync();
 
-        ThreadRun currentRun = null;
-        do
+        await foreach (StreamingUpdate update in updates)
         {
-            currentRun = null;
-            List<ToolOutput> outputsToSubmit = [];
-            await foreach (StreamingUpdate update in asyncUpdates)
+            if (update is RequiredActionUpdate requiredActionUpdate)
             {
-                if (update is RunUpdate runUpdate)
-                {
-                    currentRun = runUpdate;
-                }
-                else if (update is RequiredActionUpdate requiredActionUpdate)
+                List<ToolOutput> outputsToSubmit = [];
+
+                foreach (RequiredAction action in requiredActionUpdate.RequiredActions)
                 {
-                    if (requiredActionUpdate.FunctionName == getTemperatureTool.FunctionName)
+                    if (action.FunctionName == getTemperatureTool.FunctionName)
                     {
-                        outputsToSubmit.Add(new ToolOutput(requiredActionUpdate.ToolCallId, "57"));
+                        outputsToSubmit.Add(new ToolOutput(action.ToolCallId, "57"));
                     }
-                    else if (requiredActionUpdate.FunctionName == getRainProbabilityTool.FunctionName)
+                    else if (action.FunctionName == getRainProbabilityTool.FunctionName)
                     {
-                        outputsToSubmit.Add(new ToolOutput(requiredActionUpdate.ToolCallId, "25%"));
+                        outputsToSubmit.Add(new ToolOutput(action.ToolCallId, "25%"));
                     }
                 }
-                else if (update is MessageContentUpdate contentUpdate)
-                {
-                    Console.Write(contentUpdate.Text);
-                }
+
+                await runOperation.SubmitToolOutputsToRunStreamingAsync(outputsToSubmit);
             }
-            if (outputsToSubmit.Count > 0)
+            else if (update is MessageContentUpdate contentUpdate)
             {
-                asyncUpdates = client.SubmitToolOutputsToRunStreamingAsync(currentRun, outputsToSubmit);
+                Console.Write(contentUpdate.Text);
             }
         }
-        while (currentRun?.Status.IsTerminal == false);
-
         #endregion
 
         // Optionally, delete the resources for tidiness if no longer needed.