Update paging APIs to use updated SCM types

README.md

@@ -115,11 +115,11 @@ When you request a chat completion, the default behavior is for the server to ge
 The client library offers a convenient approach to working with streaming chat completions. If you wanted to re-write the example from the previous section using streaming, rather than calling the `ChatClient`'s `CompleteChat` method, you would call its `CompleteChatStreaming` method instead:
 
 ```csharp
-ResultCollection<StreamingChatCompletionUpdate> updates
+CollectionResult<StreamingChatCompletionUpdate> updates
     = client.CompleteChatStreaming("Say 'this is a test.'");
 ```
 
-Notice that the returned value is a `ResultCollection<StreamingChatCompletionUpdate>` instance, which can be enumerated to process the streaming response chunks as they arrive:
+Notice that the returned value is a `CollectionResult<StreamingChatCompletionUpdate>` instance, which can be enumerated to process the streaming response chunks as they arrive:
 
 ```csharp
 Console.WriteLine($"[ASSISTANT]:");
@@ -132,10 +132,10 @@ foreach (StreamingChatCompletionUpdate update in updates)
 }
 ```
 
-Alternatively, you can do this asynchronously by calling the `CompleteChatStreamingAsync` method to get an `AsyncResultCollection<StreamingChatCompletionUpdate>` and enumerate it using `await foreach`:
+Alternatively, you can do this asynchronously by calling the `CompleteChatStreamingAsync` method to get an `AsyncCollectionResult<StreamingChatCompletionUpdate>` and enumerate it using `await foreach`:
 
 ```csharp
-AsyncResultCollection<StreamingChatCompletionUpdate> updates
+AsyncCollectionResult<StreamingChatCompletionUpdate> updates
     = client.CompleteChatStreamingAsync("Say 'this is a test.'");
 
 Console.WriteLine($"[ASSISTANT]:");
@@ -528,7 +528,7 @@ Finally, you can use the `AssistantClient`'s `GetMessages` method to retrieve th
 For illustrative purposes, you could print the messages to the console and also save any images produced by the assistant to local storage:
 
 ```csharp
-PageableCollection<ThreadMessage> messages = assistantClient.GetMessages(threadRun.ThreadId, ListOrder.OldestFirst);
+PageCollection<ThreadMessage> messages = assistantClient.GetMessages(threadRun.ThreadId, ListOrder.OldestFirst);
 
 foreach (ThreadMessage message in messages)
 {
@@ -640,10 +640,10 @@ AssistantThread thread = assistantClient.CreateThread(new ThreadCreationOptions(
 });
 ```
 
-With the assistant and thread prepared, use the `CreateRunStreaming` method to get an enumerable `ResultCollection<StreamingUpdate>`. You can then iterate over this collection with `foreach`. For async calling patterns, use `CreateRunStreamingAsync` and iterate over the `AsyncResultCollection<StreamingUpdate>` with `await foreach`, instead. Note that streaming variants also exist for `CreateThreadAndRunStreaming` and `SubmitToolOutputsToRunStreaming`.
+With the assistant and thread prepared, use the `CreateRunStreaming` method to get an enumerable `CollectionResult<StreamingUpdate>`. You can then iterate over this collection with `foreach`. For async calling patterns, use `CreateRunStreamingAsync` and iterate over the `AsyncCollectionResult<StreamingUpdate>` with `await foreach`, instead. Note that streaming variants also exist for `CreateThreadAndRunStreaming` and `SubmitToolOutputsToRunStreaming`.
 
 ```csharp
-ResultCollection<StreamingUpdate> streamingUpdates = assistantClient.CreateRunStreaming(
+CollectionResult<StreamingUpdate> streamingUpdates = assistantClient.CreateRunStreaming(
     thread,
     assistant,
     new RunCreationOptions()

examples/Assistants/Example01_RetrievalAugmentedGeneration.cs

@@ -98,8 +98,9 @@ public void Example01_RetrievalAugmentedGeneration()
         } while (!threadRun.Status.IsTerminal);
 
         // Finally, we'll print out the full history for the thread that includes the augmented generation
-        PageableCollection<ThreadMessage> messages
-            = assistantClient.GetMessages(threadRun.ThreadId, ListOrder.OldestFirst);
+        PageCollection<ThreadMessage> messagePages
+            = assistantClient.GetMessages(threadRun.ThreadId,  new MessageCollectionOptions() { Order = ListOrder.OldestFirst });
+        IEnumerable<ThreadMessage> messages = messagePages.GetAllValues();
 
         foreach (ThreadMessage message in messages)
         {

examples/Assistants/Example01_RetrievalAugmentedGenerationAsync.cs

@@ -99,8 +99,9 @@ public async Task Example01_RetrievalAugmentedGenerationAsync()
         } while (!threadRun.Status.IsTerminal);
 
         // Finally, we'll print out the full history for the thread that includes the augmented generation
-        AsyncPageableCollection<ThreadMessage> messages
-            = assistantClient.GetMessagesAsync(threadRun.ThreadId, ListOrder.OldestFirst);
+        AsyncPageCollection<ThreadMessage> messagePages
+            = assistantClient.GetMessagesAsync(threadRun.ThreadId, new MessageCollectionOptions() { Order = ListOrder.OldestFirst });
+        IAsyncEnumerable<ThreadMessage> messages = messagePages.GetAllValuesAsync();
 
         await foreach (ThreadMessage message in messages)
         {

examples/Assistants/Example02_FunctionCalling.cs

@@ -151,8 +151,9 @@ string GetCurrentWeather(string location, string unit = "celsius")
         // With the run complete, list the messages and display their content
         if (run.Status == RunStatus.Completed)
         {
-            PageableCollection<ThreadMessage> messages
-                = client.GetMessages(run.ThreadId, resultOrder: ListOrder.OldestFirst);
+            PageCollection<ThreadMessage> messagePages
+                = client.GetMessages(run.ThreadId, new MessageCollectionOptions() { Order = ListOrder.OldestFirst });
+            IEnumerable<ThreadMessage> messages = messagePages.GetAllValues();
 
             foreach (ThreadMessage message in messages)
             {

examples/Assistants/Example02_FunctionCallingAsync.cs

@@ -151,8 +151,9 @@ string GetCurrentWeather(string location, string unit = "celsius")
         // With the run complete, list the messages and display their content
         if (run.Status == RunStatus.Completed)
         {
-            AsyncPageableCollection<ThreadMessage> messages
-                = client.GetMessagesAsync(run.ThreadId, resultOrder: ListOrder.OldestFirst);
+            AsyncPageCollection<ThreadMessage> messagePages
+                = client.GetMessagesAsync(run.ThreadId, new MessageCollectionOptions() { Order = ListOrder.OldestFirst });
+            IAsyncEnumerable<ThreadMessage> messages = messagePages.GetAllValuesAsync();
 
             await foreach (ThreadMessage message in messages)
             {

examples/Assistants/Example02b_FunctionCallingStreaming.cs

@@ -91,8 +91,7 @@ public async Task Example02b_FunctionCallingStreaming()
         #endregion
 
         #region Step 3 - Initiate a streaming run
-        // TODO: replace this with finalized enumerable result pattern
-        AsyncResultCollection<StreamingUpdate> asyncUpdates
+        AsyncCollectionResult<StreamingUpdate> asyncUpdates
             = client.CreateRunStreamingAsync(thread, assistant);
 
         ThreadRun currentRun = null;

examples/Assistants/Example03_ListAssistantsWithPagination.cs

@@ -2,6 +2,7 @@
 using OpenAI.Assistants;
 using System;
 using System.ClientModel;
+using System.Collections.Generic;
 
 namespace OpenAI.Examples;
 
@@ -16,7 +17,8 @@ public void Example03_ListAssistantsWithPagination()
 
         int count = 0;
 
-        PageableCollection<Assistant> assistants = client.GetAssistants();
+        PageCollection<Assistant> assistantPages = client.GetAssistants();
+        IEnumerable<Assistant> assistants = assistantPages.GetAllValues();
         foreach (Assistant assistant in assistants)
         {
             Console.WriteLine($"[{count,3}] {assistant.Id} {assistant.CreatedAt:s} {assistant.Name}");

examples/Assistants/Example03_ListAssistantsWithPaginationAsync.cs

@@ -2,6 +2,7 @@
 using OpenAI.Assistants;
 using System;
 using System.ClientModel;
+using System.Collections.Generic;
 using System.Threading.Tasks;
 
 namespace OpenAI.Examples;
@@ -17,7 +18,8 @@ public async Task Example03_ListAssistantsWithPaginationAsync()
 
         int count = 0;
 
-        AsyncPageableCollection<Assistant> assistants = client.GetAssistantsAsync();
+        AsyncPageCollection<Assistant> assistantPages = client.GetAssistantsAsync();
+        IAsyncEnumerable<Assistant> assistants = assistantPages.GetAllValuesAsync();
         await foreach (Assistant assistant in assistants)
         {
             Console.WriteLine($"[{count,3}] {assistant.Id} {assistant.CreatedAt:s} {assistant.Name}");

examples/Assistants/Example04_AllTheTools.cs

@@ -137,8 +137,9 @@ static string GetNameOfFamilyMember(string relation)
         // With the run complete, list the messages and display their content
         if (run.Status == RunStatus.Completed)
         {
-            PageableCollection<ThreadMessage> messages
-                = client.GetMessages(run.ThreadId, resultOrder: ListOrder.OldestFirst);
+            PageCollection<ThreadMessage> messagePages
+                = client.GetMessages(run.ThreadId, new MessageCollectionOptions() { Order = ListOrder.OldestFirst });
+            IEnumerable<ThreadMessage> messages = messagePages.GetAllValues();
 
             foreach (ThreadMessage message in messages)
             {
@@ -171,8 +172,12 @@ PageableCollection<ThreadMessage> messages
             #endregion
 
             #region List run steps for details about tool calls
-            PageableCollection<RunStep> runSteps = client.GetRunSteps(run, resultOrder: ListOrder.OldestFirst);
-            foreach (RunStep step in runSteps)
+            PageCollection<RunStep> runSteps = client.GetRunSteps(
+                run, new RunStepCollectionOptions()
+                {
+                    Order = ListOrder.OldestFirst
+                });
+            foreach (RunStep step in runSteps.GetAllValues())
             {
                 Console.WriteLine($"Run step: {step.Status}");
                 foreach (RunStepToolCall toolCall in step.Details.ToolCalls)

examples/Assistants/Example05_AssistantsWithVision.cs

@@ -44,7 +44,7 @@ public void Example05_AssistantsWithVision()
                 }
         });
 
-        ResultCollection<StreamingUpdate> streamingUpdates = assistantClient.CreateRunStreaming(
+        CollectionResult<StreamingUpdate> streamingUpdates = assistantClient.CreateRunStreaming(
             thread,
             assistant,
             new RunCreationOptions()

examples/Assistants/Example05_AssistantsWithVisionAsync.cs

@@ -45,7 +45,7 @@ public async Task Example05_AssistantsWithVisionAsync()
                 }
         });
 
-        AsyncResultCollection<StreamingUpdate> streamingUpdates = assistantClient.CreateRunStreamingAsync(
+        AsyncCollectionResult<StreamingUpdate> streamingUpdates = assistantClient.CreateRunStreamingAsync(
             thread,
             assistant,
             new RunCreationOptions()

examples/Chat/Example02_SimpleChatStreaming.cs

@@ -12,7 +12,7 @@ public void Example02_SimpleChatStreaming()
     {
         ChatClient client = new(model: "gpt-4o", Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
 
-        ResultCollection<StreamingChatCompletionUpdate> updates
+        CollectionResult<StreamingChatCompletionUpdate> updates
             = client.CompleteChatStreaming("Say 'this is a test.'");
 
         Console.WriteLine($"[ASSISTANT]:");

examples/Chat/Example02_SimpleChatStreamingAsync.cs

@@ -13,7 +13,7 @@ public async Task Example02_SimpleChatStreamingAsync()
     {
         ChatClient client = new(model: "gpt-4o", Environment.GetEnvironmentVariable("OPENAI_API_KEY"));
 
-        AsyncResultCollection<StreamingChatCompletionUpdate> updates
+        AsyncCollectionResult<StreamingChatCompletionUpdate> updates
             = client.CompleteChatStreamingAsync("Say 'this is a test.'");
 
         Console.WriteLine($"[ASSISTANT]:");

examples/Chat/Example04_FunctionCallingStreaming.cs

@@ -38,7 +38,7 @@ public void Example04_FunctionCallingStreaming()
             Dictionary<int, string> indexToFunctionName = [];
             Dictionary<int, StringBuilder> indexToFunctionArguments = [];
             StringBuilder contentBuilder = new();
-            ResultCollection<StreamingChatCompletionUpdate> chatUpdates
+            CollectionResult<StreamingChatCompletionUpdate> chatUpdates
                 = client.CompleteChatStreaming(messages, options);
 
             foreach (StreamingChatCompletionUpdate chatUpdate in chatUpdates)

examples/Chat/Example04_FunctionCallingStreamingAsync.cs

@@ -39,7 +39,7 @@ public async Task Example04_FunctionCallingStreamingAsync()
             Dictionary<int, string> indexToFunctionName = [];
             Dictionary<int, StringBuilder> indexToFunctionArguments = [];
             StringBuilder contentBuilder = new();
-            AsyncResultCollection<StreamingChatCompletionUpdate> chatUpdates
+            AsyncCollectionResult<StreamingChatCompletionUpdate> chatUpdates
                 = client.CompleteChatStreamingAsync(messages, options);
 
             await foreach (StreamingChatCompletionUpdate chatUpdate in chatUpdates)