.Net: Add more options to getmessages for each agentthread and improve xml docs.

dotnet/src/Agents/Abstractions/AgentThread.cs

@@ -31,6 +31,7 @@ public abstract class AgentThread
     /// </summary>
     /// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param>
     /// <returns>A task that completes when the thread has been created.</returns>
+    /// <exception cref="InvalidOperationException">The thread has been deleted.</exception>
     protected virtual async Task CreateAsync(CancellationToken cancellationToken = default)
     {
         if (this.IsDeleted)
@@ -51,6 +52,7 @@ protected virtual async Task CreateAsync(CancellationToken cancellationToken = d
     /// </summary>
     /// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param>
     /// <returns>A task that completes when the thread has been deleted.</returns>
+    /// <exception cref="InvalidOperationException">The thread was never created.</exception>
     public virtual async Task DeleteAsync(CancellationToken cancellationToken = default)
     {
         if (this.IsDeleted)
@@ -77,6 +79,7 @@ public virtual async Task DeleteAsync(CancellationToken cancellationToken = defa
     /// <param name="newMessage">The new message.</param>
     /// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param>
     /// <returns>A task that completes when the context has been updated.</returns>
+    /// <exception cref="InvalidOperationException">The thread has been deleted.</exception>
     public virtual async Task OnNewMessageAsync(ChatMessageContent newMessage, CancellationToken cancellationToken = default)
     {
         if (this.IsDeleted)

dotnet/src/Agents/AzureAI/AzureAIAgentThread.cs

@@ -141,9 +141,15 @@ protected override async Task OnNewMessageInternalAsync(ChatMessageContent newMe
         }
     }
 
-    /// <inheritdoc />
+    /// <summary>
+    /// Asynchronously retrieves all messages in the thread.
+    /// </summary>
+    /// <param name="sortOrder">The order to return messages in.</param>
+    /// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param>
+    /// <returns>The messages in the thread.</returns>
+    /// <exception cref="InvalidOperationException">The thread has been deleted.</exception>
     [Experimental("SKEXP0110")]
-    public async IAsyncEnumerable<ChatMessageContent> GetMessagesAsync([EnumeratorCancellation] CancellationToken cancellationToken = default)
+    public async IAsyncEnumerable<ChatMessageContent> GetMessagesAsync(ListSortOrder? sortOrder = default, [EnumeratorCancellation] CancellationToken cancellationToken = default)
     {
         if (this.IsDeleted)
         {
@@ -155,7 +161,7 @@ public async IAsyncEnumerable<ChatMessageContent> GetMessagesAsync([EnumeratorCa
             await this.CreateAsync(cancellationToken).ConfigureAwait(false);
         }
 
-        await foreach (var message in AgentThreadActions.GetMessagesAsync(this._client, this.Id!, ListSortOrder.Ascending, cancellationToken).ConfigureAwait(false))
+        await foreach (var message in AgentThreadActions.GetMessagesAsync(this._client, this.Id!, sortOrder, cancellationToken).ConfigureAwait(false))
         {
             yield return message;
         }

dotnet/src/Agents/Core/ChatHistoryAgentThread.cs

@@ -66,7 +66,15 @@ protected override Task OnNewMessageInternalAsync(ChatMessageContent newMessage,
         return Task.CompletedTask;
     }
 
-    /// <inheritdoc />
+    /// <summary>
+    /// Asynchronously retrieves all messages in the thread.
+    /// </summary>
+    /// <remarks>
+    /// Messages will be returned in ascending chronological order.
+    /// </remarks>
+    /// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param>
+    /// <returns>The messages in the thread.</returns>
+    /// <exception cref="InvalidOperationException">The thread has been deleted.</exception>
     [Experimental("SKEXP0110")]
     public async IAsyncEnumerable<ChatMessageContent> GetMessagesAsync([EnumeratorCancellation] CancellationToken cancellationToken = default)
     {

dotnet/src/Agents/OpenAI/OpenAIAssistantAgentThread.cs

@@ -123,9 +123,15 @@ protected override async Task OnNewMessageInternalAsync(ChatMessageContent newMe
         }
     }
 
-    /// <inheritdoc />
+    /// <summary>
+    /// Asynchronously retrieves all messages in the thread.
+    /// </summary>
+    /// <param name="sortOrder">The order to return messages in.</param>
+    /// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param>
+    /// <returns>The messages in the thread.</returns>
+    /// <exception cref="InvalidOperationException">The thread has been deleted.</exception>
     [Experimental("SKEXP0110")]
-    public async IAsyncEnumerable<ChatMessageContent> GetMessagesAsync([EnumeratorCancellation] CancellationToken cancellationToken = default)
+    public async IAsyncEnumerable<ChatMessageContent> GetMessagesAsync(MessageCollectionOrder? sortOrder = default, [EnumeratorCancellation] CancellationToken cancellationToken = default)
     {
         if (this.IsDeleted)
         {
@@ -137,7 +143,7 @@ public async IAsyncEnumerable<ChatMessageContent> GetMessagesAsync([EnumeratorCa
             await this.CreateAsync(cancellationToken).ConfigureAwait(false);
         }
 
-        await foreach (var message in AssistantThreadActions.GetMessagesAsync(this._client, this.Id!, MessageCollectionOrder.Ascending, cancellationToken).ConfigureAwait(false))
+        await foreach (var message in AssistantThreadActions.GetMessagesAsync(this._client, this.Id!, sortOrder, cancellationToken).ConfigureAwait(false))
         {
             yield return message;
         }

dotnet/src/IntegrationTests/Agents/CommonInterfaceConformance/AzureAIAgentFixture.cs

@@ -43,7 +43,7 @@ public class AzureAIAgentFixture : AgentFixture
     public override async Task<ChatHistory> GetChatHistory()
     {
         var chatHistory = new ChatHistory();
-        await foreach (var existingMessage in this._thread!.GetMessagesAsync().ConfigureAwait(false))
+        await foreach (var existingMessage in this._thread!.GetMessagesAsync(AAIP.ListSortOrder.Ascending).ConfigureAwait(false))
         {
             chatHistory.Add(existingMessage);
         }

dotnet/src/IntegrationTests/Agents/CommonInterfaceConformance/OpenAIAssistantAgentFixture.cs

@@ -47,7 +47,7 @@ public class OpenAIAssistantAgentFixture : AgentFixture
     public override async Task<ChatHistory> GetChatHistory()
     {
         var chatHistory = new ChatHistory();
-        await foreach (var existingMessage in this._thread!.GetMessagesAsync().ConfigureAwait(false))
+        await foreach (var existingMessage in this._thread!.GetMessagesAsync(MessageCollectionOrder.Ascending).ConfigureAwait(false))
         {
             chatHistory.Add(existingMessage);
         }