Generate GetChatCompletionMessages with pagination

specification/client/chat.client.tsp

@@ -14,6 +14,7 @@ using Azure.ClientGenerator.Core;
 @@usage(CreateChatCompletionStreamResponse, Usage.output);
 
 @@visibility(ChatCompletionResponseMessage.tool_calls, Lifecycle.Read);
+@@visibility(ChatCompletionResponseMessage.annotations, Lifecycle.Read);
 @@visibility(ChatCompletionStreamResponseDelta.tool_calls, Lifecycle.Read);
 
 @@clientName(Chat.createChatCompletion, "CompleteChat");

specification/client/models/chat.models.tsp

@@ -36,7 +36,7 @@ alias ChatCompletionMessageCollectionOrderQueryParameter = {
    * Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`
    * for descending order.
    */
-  @query order?: ChatCompletionCollectionOrder;
+  @query order?: ChatCompletionMessageCollectionOrder;
 };
 
 union ChatCompletionMessageCollectionOrder {

src/Custom/Chat/ChatCompletionMessageCollectionOptions.cs

@@ -1,4 +1,3 @@
-
 namespace OpenAI.Chat;
 
 // CUSTOM: Use the correct namespace.

src/Custom/Chat/ChatCompletionMessageCollectionOrder.cs

@@ -0,0 +1,5 @@
+namespace OpenAI.Chat;
+
+// CUSTOM: Use the correct namespace.
+[CodeGenType("ChatCompletionMessageCollectionOrder")] 
+public readonly partial struct ChatCompletionMessageCollectionOrder {}

src/Custom/Chat/ChatCompletionMessageListDatum.cs

@@ -6,4 +6,8 @@ public partial class ChatCompletionMessageListDatum
     // CUSTOM: Ensure enumerated value is used.
     [CodeGenMember("Role")]
     internal ChatMessageRole Role { get; set; } = ChatMessageRole.Assistant;
+
+    // CUSTOM: Rename
+    [CodeGenMember("Audio")]
+    public ChatOutputAudio OutputAudio { get; }
 }

src/Generated/Models/Chat/ChatCompletionMessageCollectionOptions.Serialization.cs

@@ -69,7 +69,7 @@ internal static ChatCompletionMessageCollectionOptions DeserializeChatCompletion
             }
             string afterId = default;
             int? pageSizeLimit = default;
-            ChatCompletionCollectionOrder? order = default;
+            ChatCompletionMessageCollectionOrder? order = default;
             IDictionary<string, BinaryData> additionalBinaryDataProperties = new ChangeTrackingDictionary<string, BinaryData>();
             foreach (var prop in element.EnumerateObject())
             {

src/Generated/Models/Chat/ChatCompletionMessageCollectionOptions.cs

@@ -17,7 +17,7 @@ public ChatCompletionMessageCollectionOptions()
         {
         }
 
-        internal ChatCompletionMessageCollectionOptions(string afterId, int? pageSizeLimit, ChatCompletionCollectionOrder? order, IDictionary<string, BinaryData> additionalBinaryDataProperties)
+        internal ChatCompletionMessageCollectionOptions(string afterId, int? pageSizeLimit, ChatCompletionMessageCollectionOrder? order, IDictionary<string, BinaryData> additionalBinaryDataProperties)
         {
             AfterId = afterId;
             PageSizeLimit = pageSizeLimit;
@@ -29,7 +29,7 @@ internal ChatCompletionMessageCollectionOptions(string afterId, int? pageSizeLim
 
         public int? PageSizeLimit { get; set; }
 
-        public ChatCompletionCollectionOrder? Order { get; set; }
+        public ChatCompletionMessageCollectionOrder? Order { get; set; }
 
         internal IDictionary<string, BinaryData> SerializedAdditionalRawData
         {

src/Generated/Models/Chat/ChatCompletionMessageCollectionOrder.cs

@@ -0,0 +1,46 @@
+// <auto-generated/>
+
+#nullable disable
+
+using System;
+using System.ComponentModel;
+using System.Diagnostics.CodeAnalysis;
+using OpenAI;
+
+namespace OpenAI.Chat
+{
+    [Experimental("OPENAI001")]
+    public readonly partial struct ChatCompletionMessageCollectionOrder : IEquatable<ChatCompletionMessageCollectionOrder>
+    {
+        private readonly string _value;
+        private const string AscendingValue = "asc";
+        private const string DescendingValue = "desc";
+
+        public ChatCompletionMessageCollectionOrder(string value)
+        {
+            Argument.AssertNotNull(value, nameof(value));
+
+            _value = value;
+        }
+
+        public static ChatCompletionMessageCollectionOrder Ascending { get; } = new ChatCompletionMessageCollectionOrder(AscendingValue);
+
+        public static ChatCompletionMessageCollectionOrder Descending { get; } = new ChatCompletionMessageCollectionOrder(DescendingValue);
+
+        public static bool operator ==(ChatCompletionMessageCollectionOrder left, ChatCompletionMessageCollectionOrder right) => left.Equals(right);
+
+        public static bool operator !=(ChatCompletionMessageCollectionOrder left, ChatCompletionMessageCollectionOrder right) => !left.Equals(right);
+
+        public static implicit operator ChatCompletionMessageCollectionOrder(string value) => new ChatCompletionMessageCollectionOrder(value);
+
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public override bool Equals(object obj) => obj is ChatCompletionMessageCollectionOrder other && Equals(other);
+
+        public bool Equals(ChatCompletionMessageCollectionOrder other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase);
+
+        [EditorBrowsable(EditorBrowsableState.Never)]
+        public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0;
+
+        public override string ToString() => _value;
+    }
+}

src/Generated/Models/Chat/ChatCompletionMessageListDatum.Serialization.cs

@@ -12,7 +12,7 @@ namespace OpenAI.Chat
 {
     public partial class ChatCompletionMessageListDatum : IJsonModel<ChatCompletionMessageListDatum>
     {
-        internal ChatCompletionMessageListDatum() : this(null, null, null, null, null, null, null, default, null)
+        internal ChatCompletionMessageListDatum() : this(null, null, null, null, null, null, default, null, null)
         {
         }
 
@@ -65,6 +65,7 @@ protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWrit
                 }
                 writer.WriteEndArray();
             }
+            // Plugin customization: remove options.Format != "W" check
             if (Optional.IsCollectionDefined(Annotations) && _additionalBinaryDataProperties?.ContainsKey("annotations") != true)
             {
                 writer.WritePropertyName("annotations"u8);
@@ -80,11 +81,6 @@ protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWrit
                 writer.WritePropertyName("function_call"u8);
                 writer.WriteObjectValue(FunctionCall, options);
             }
-            if (Optional.IsDefined(Audio) && _additionalBinaryDataProperties?.ContainsKey("audio") != true)
-            {
-                writer.WritePropertyName("audio"u8);
-                writer.WriteObjectValue(Audio, options);
-            }
             if (_additionalBinaryDataProperties?.ContainsKey("id") != true)
             {
                 writer.WritePropertyName("id"u8);
@@ -95,6 +91,11 @@ protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWrit
                 writer.WritePropertyName("role"u8);
                 writer.WriteStringValue(Role.ToSerialString());
             }
+            if (Optional.IsDefined(OutputAudio) && _additionalBinaryDataProperties?.ContainsKey("audio") != true)
+            {
+                writer.WritePropertyName("audio"u8);
+                writer.WriteObjectValue(OutputAudio, options);
+            }
             // Plugin customization: remove options.Format != "W" check
             if (_additionalBinaryDataProperties != null)
             {
@@ -139,11 +140,11 @@ internal static ChatCompletionMessageListDatum DeserializeChatCompletionMessageL
             string content = default;
             string refusal = default;
             IReadOnlyList<ChatToolCall> toolCalls = default;
-            IList<ChatMessageAnnotation> annotations = default;
+            IReadOnlyList<ChatMessageAnnotation> annotations = default;
             InternalChatCompletionResponseMessageFunctionCall functionCall = default;
-            ChatOutputAudio audio = default;
             string id = default;
             ChatMessageRole role = default;
+            ChatOutputAudio outputAudio = default;
             IDictionary<string, BinaryData> additionalBinaryDataProperties = new ChangeTrackingDictionary<string, BinaryData>();
             foreach (var prop in element.EnumerateObject())
             {
@@ -204,16 +205,6 @@ internal static ChatCompletionMessageListDatum DeserializeChatCompletionMessageL
                     functionCall = InternalChatCompletionResponseMessageFunctionCall.DeserializeInternalChatCompletionResponseMessageFunctionCall(prop.Value, options);
                     continue;
                 }
-                if (prop.NameEquals("audio"u8))
-                {
-                    if (prop.Value.ValueKind == JsonValueKind.Null)
-                    {
-                        audio = null;
-                        continue;
-                    }
-                    audio = ChatOutputAudio.DeserializeChatOutputAudio(prop.Value, options);
-                    continue;
-                }
                 if (prop.NameEquals("id"u8))
                 {
                     id = prop.Value.GetString();
@@ -224,6 +215,16 @@ internal static ChatCompletionMessageListDatum DeserializeChatCompletionMessageL
                     role = prop.Value.GetString().ToChatMessageRole();
                     continue;
                 }
+                if (prop.NameEquals("audio"u8))
+                {
+                    if (prop.Value.ValueKind == JsonValueKind.Null)
+                    {
+                        outputAudio = null;
+                        continue;
+                    }
+                    outputAudio = ChatOutputAudio.DeserializeChatOutputAudio(prop.Value, options);
+                    continue;
+                }
                 // Plugin customization: remove options.Format != "W" check
                 additionalBinaryDataProperties.Add(prop.Name, BinaryData.FromString(prop.Value.GetRawText()));
             }
@@ -233,9 +234,9 @@ internal static ChatCompletionMessageListDatum DeserializeChatCompletionMessageL
                 toolCalls ?? new ChangeTrackingList<ChatToolCall>(),
                 annotations ?? new ChangeTrackingList<ChatMessageAnnotation>(),
                 functionCall,
-                audio,
                 id,
                 role,
+                outputAudio,
                 additionalBinaryDataProperties);
         }
 

src/Generated/Models/Chat/ChatCompletionMessageListDatum.cs

@@ -24,17 +24,17 @@ internal ChatCompletionMessageListDatum(string content, string refusal, string i
             Role = role;
         }
 
-        internal ChatCompletionMessageListDatum(string content, string refusal, IReadOnlyList<ChatToolCall> toolCalls, IList<ChatMessageAnnotation> annotations, InternalChatCompletionResponseMessageFunctionCall functionCall, ChatOutputAudio audio, string id, ChatMessageRole role, IDictionary<string, BinaryData> additionalBinaryDataProperties)
+        internal ChatCompletionMessageListDatum(string content, string refusal, IReadOnlyList<ChatToolCall> toolCalls, IReadOnlyList<ChatMessageAnnotation> annotations, InternalChatCompletionResponseMessageFunctionCall functionCall, string id, ChatMessageRole role, ChatOutputAudio outputAudio, IDictionary<string, BinaryData> additionalBinaryDataProperties)
         {
             // Plugin customization: ensure initialization of collections
             Content = content;
             Refusal = refusal;
             ToolCalls = toolCalls ?? new ChangeTrackingList<ChatToolCall>();
             Annotations = annotations ?? new ChangeTrackingList<ChatMessageAnnotation>();
             FunctionCall = functionCall;
-            Audio = audio;
             Id = id;
             Role = role;
+            OutputAudio = outputAudio;
             _additionalBinaryDataProperties = additionalBinaryDataProperties;
         }
 
@@ -44,12 +44,10 @@ internal ChatCompletionMessageListDatum(string content, string refusal, IReadOnl
 
         public IReadOnlyList<ChatToolCall> ToolCalls { get; }
 
-        public IList<ChatMessageAnnotation> Annotations { get; }
+        public IReadOnlyList<ChatMessageAnnotation> Annotations { get; }
 
         internal InternalChatCompletionResponseMessageFunctionCall FunctionCall { get; }
 
-        public ChatOutputAudio Audio { get; }
-
         public string Id { get; }
 
         internal IDictionary<string, BinaryData> SerializedAdditionalRawData

src/Generated/Models/Chat/InternalChatCompletionResponseMessage.Serialization.cs

@@ -53,6 +53,7 @@ protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWrit
                 }
                 writer.WriteEndArray();
             }
+            // Plugin customization: remove options.Format != "W" check
             if (Optional.IsCollectionDefined(Annotations) && _additionalBinaryDataProperties?.ContainsKey("annotations") != true)
             {
                 writer.WritePropertyName("annotations"u8);
@@ -133,7 +134,7 @@ internal static InternalChatCompletionResponseMessage DeserializeInternalChatCom
             }
             string refusal = default;
             IReadOnlyList<ChatToolCall> toolCalls = default;
-            IList<ChatMessageAnnotation> annotations = default;
+            IReadOnlyList<ChatMessageAnnotation> annotations = default;
             ChatOutputAudio audio = default;
             ChatMessageRole role = default;
             ChatMessageContent content = default;

src/Generated/Models/Chat/InternalChatCompletionResponseMessage.cs

@@ -22,7 +22,7 @@ internal InternalChatCompletionResponseMessage(string refusal, ChatMessageRole r
             Content = content ?? new ChatMessageContent();
         }
 
-        internal InternalChatCompletionResponseMessage(string refusal, IReadOnlyList<ChatToolCall> toolCalls, IList<ChatMessageAnnotation> annotations, ChatOutputAudio audio, ChatMessageRole role, ChatMessageContent content, ChatFunctionCall functionCall, IDictionary<string, BinaryData> additionalBinaryDataProperties)
+        internal InternalChatCompletionResponseMessage(string refusal, IReadOnlyList<ChatToolCall> toolCalls, IReadOnlyList<ChatMessageAnnotation> annotations, ChatOutputAudio audio, ChatMessageRole role, ChatMessageContent content, ChatFunctionCall functionCall, IDictionary<string, BinaryData> additionalBinaryDataProperties)
         {
             // Plugin customization: ensure initialization of collections
             Refusal = refusal;
@@ -39,7 +39,7 @@ internal InternalChatCompletionResponseMessage(string refusal, IReadOnlyList<Cha
 
         public IReadOnlyList<ChatToolCall> ToolCalls { get; }
 
-        public IList<ChatMessageAnnotation> Annotations { get; }
+        public IReadOnlyList<ChatMessageAnnotation> Annotations { get; }
 
         public ChatOutputAudio Audio { get; }
 

src/Generated/OpenAIModelFactory.cs

@@ -1083,7 +1083,7 @@ public static ChatCompletionCollectionOptions ChatCompletionCollectionOptions(st
                 additionalBinaryDataProperties: null);
         }
 
-        public static ChatCompletionMessageCollectionOptions ChatCompletionMessageCollectionOptions(string afterId = default, int? pageSizeLimit = default, ChatCompletionCollectionOrder? order = default)
+        public static ChatCompletionMessageCollectionOptions ChatCompletionMessageCollectionOptions(string afterId = default, int? pageSizeLimit = default, ChatCompletionMessageCollectionOrder? order = default)
         {
             return new ChatCompletionMessageCollectionOptions(afterId, pageSizeLimit, order, additionalBinaryDataProperties: null);
         }

tests/Chat/ChatTests.cs

@@ -1887,7 +1887,7 @@ await RetryWithExponentialBackoffAsync(async () =>
             List<ChatCompletionMessageListDatum> ascMessages = new();
             var ascOptions = new ChatCompletionMessageCollectionOptions()
             {
-                Order = ChatCompletionCollectionOrder.Ascending,
+                Order = ChatCompletionMessageCollectionOrder.Ascending,
                 PageSizeLimit = 5
             };
 
@@ -1901,7 +1901,7 @@ await RetryWithExponentialBackoffAsync(async () =>
             List<ChatCompletionMessageListDatum> descMessages = new();
             var descOptions = new ChatCompletionMessageCollectionOptions()
             {
-                Order = ChatCompletionCollectionOrder.Descending,
+                Order = ChatCompletionMessageCollectionOrder.Descending,
                 PageSizeLimit = 5
             };
 
@@ -2004,7 +2004,7 @@ await RetryWithExponentialBackoffAsync(async () =>
                 new ChatCompletionMessageCollectionOptions()
                 {
                     PageSizeLimit = 3,
-                    Order = ChatCompletionCollectionOrder.Descending
+                    Order = ChatCompletionMessageCollectionOrder.Descending
                 },
                 cancellationToken: cts.Token))
             {