refactor

RageAgainstThePixel · Nov 8, 2024 · 670d84c · 670d84c
1 parent 6ca133b
commit 670d84c
Show file tree

Hide file tree

Showing 41 changed files with 606 additions and 295 deletions.
diff --git a/OpenAI/Packages/com.openai.unity/Runtime/OpenAIClient.cs b/OpenAI/Packages/com.openai.unity/Runtime/OpenAIClient.cs
@@ -130,7 +130,8 @@ protected override void ValidateAuthentication()
             Converters = new List<JsonConverter>
             {
                 new StringEnumConverter(new SnakeCaseNamingStrategy()),
-                new RealtimeServerEventConverter()
+                new RealtimeClientEventConverter(),
+                new RealtimeServerEventConverter(),
             }
         };
 

diff --git a/OpenAI/Packages/com.openai.unity/Runtime/Realtime/BaseRealtimeEvent.cs b/OpenAI/Packages/com.openai.unity/Runtime/Realtime/BaseRealtimeEvent.cs
@@ -1,11 +1,22 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 using Newtonsoft.Json;
+using UnityEngine.Scripting;
 
 namespace OpenAI.Realtime
 {
-    public abstract class BaseRealtimeEvent
+    [Preserve]
+    public abstract class BaseRealtimeEvent : IRealtimeEvent
     {
-        public string ToJsonString() => JsonConvert.SerializeObject(this, OpenAIClient.JsonSerializationOptions);
+        /// <inheritdoc />
+        public abstract string EventId { get; internal set; }
+
+        /// <inheritdoc />
+        public abstract string Type { get; }
+
+        /// <inheritdoc />
+        [Preserve]
+        public virtual string ToJsonString()
+            => JsonConvert.SerializeObject(this, OpenAIClient.JsonSerializationOptions);
     }
 }
diff --git a/OpenAI/Packages/com.openai.unity/Runtime/Realtime/ConversationItem.cs b/OpenAI/Packages/com.openai.unity/Runtime/Realtime/ConversationItem.cs
@@ -57,7 +57,7 @@ public ConversationItem(RealtimeContent content)
         /// The object type, must be "realtime.item".
         /// </summary>
         [Preserve]
-        [JsonProperty("object", DefaultValueHandling = DefaultValueHandling.Ignore)]
+        [JsonProperty("object")]
         public string Object { get; private set; }
 
         /// <summary>
@@ -71,14 +71,14 @@ public ConversationItem(RealtimeContent content)
         /// The status of the item ("completed", "in_progress", "incomplete").
         /// </summary>
         [Preserve]
-        [JsonProperty("status", DefaultValueHandling = DefaultValueHandling.Ignore)]
+        [JsonProperty("status")]
         public RealtimeResponseStatus Status { get; private set; }
 
         /// <summary>
         /// The role associated with the item ("user", "assistant", "system").
         /// </summary>
         [Preserve]
-        [JsonProperty("role", DefaultValueHandling = DefaultValueHandling.Ignore)]
+        [JsonProperty("role")]
         public Role Role { get; private set; }
 
         /// <summary>

diff --git a/OpenAI/Packages/com.openai.unity/Runtime/Realtime/ConversationItemCreateRequest.cs b/OpenAI/Packages/com.openai.unity/Runtime/Realtime/ConversationItemCreateRequest.cs
@@ -21,13 +21,15 @@ public ConversationItemCreateRequest(ConversationItem item, string previousItemI
             Item = item;
         }
 
+        /// <inheritdoc />
         [Preserve]
         [JsonProperty("event_id")]
-        public string EventId { get; }
+        public override string EventId { get; internal set; }
 
+        /// <inheritdoc />
         [Preserve]
         [JsonProperty("type")]
-        public string Type { get; } = "conversation.item.create";
+        public override string Type { get; } = "conversation.item.create";
 
         /// <summary>
         /// The ID of the preceding item after which the new item will be inserted.

diff --git a/OpenAI/Packages/com.openai.unity/Runtime/Realtime/ConversationItemCreatedResponse.cs b/OpenAI/Packages/com.openai.unity/Runtime/Realtime/ConversationItemCreatedResponse.cs
@@ -8,30 +8,42 @@ namespace OpenAI.Realtime
     [Preserve]
     public sealed class ConversationItemCreatedResponse : BaseRealtimeEvent, IServerEvent
     {
+        [Preserve]
+        [JsonConstructor]
+        internal ConversationItemCreatedResponse(
+            [JsonProperty("event_id")] string eventId,
+            [JsonProperty("type")] string type,
+            [JsonProperty("previous_item_id")] string previousItemId,
+            [JsonProperty("item")] ConversationItem item)
+        {
+            EventId = eventId;
+            Type = type;
+            PreviousItemId = previousItemId;
+            Item = item;
+        }
+
         /// <inheritdoc />
         [Preserve]
         [JsonProperty("event_id")]
-        public string EventId { get; private set; }
+        public override string EventId { get; internal set; }
 
-        /// <summary>
-        /// The event type, must be "conversation.item.created".
-        /// </summary>
+        /// <inheritdoc />
         [Preserve]
         [JsonProperty("type")]
-        public string Type { get; private set; }
+        public override string Type { get; }
 
         /// <summary>
         /// The ID of the preceding item.
         /// </summary>
         [Preserve]
         [JsonProperty("previous_item_id")]
-        public string PreviousItemId { get; private set; }
+        public string PreviousItemId { get; }
 
         /// <summary>
         /// The item that was created.
         /// </summary>
         [Preserve]
         [JsonProperty("item")]
-        public ConversationItem Item { get; private set; }
+        public ConversationItem Item { get; }
     }
 }
diff --git a/OpenAI/Packages/com.openai.unity/Runtime/Realtime/ConversationItemDeleteRequest.cs b/OpenAI/Packages/com.openai.unity/Runtime/Realtime/ConversationItemDeleteRequest.cs
@@ -20,13 +20,15 @@ public ConversationItemDeleteRequest(string itemId)
             ItemId = itemId;
         }
 
+        /// <inheritdoc />
         [Preserve]
         [JsonProperty("event_id")]
-        public string EventId { get; }
+        public override string EventId { get; internal set; }
 
+        /// <inheritdoc />
         [Preserve]
         [JsonProperty("type")]
-        public string Type { get; } = "conversation.item.delete";
+        public override string Type { get; } = "conversation.item.delete";
 
         /// <summary>
         /// The ID of the item to delete.

diff --git a/OpenAI/Packages/com.openai.unity/Runtime/Realtime/ConversationItemDeletedResponse.cs b/OpenAI/Packages/com.openai.unity/Runtime/Realtime/ConversationItemDeletedResponse.cs
@@ -8,23 +8,33 @@ namespace OpenAI.Realtime
     [Preserve]
     public sealed class ConversationItemDeletedResponse : BaseRealtimeEvent, IServerEvent
     {
+        [Preserve]
+        [JsonConstructor]
+        internal ConversationItemDeletedResponse(
+            [JsonProperty("event_id")] string eventId,
+            [JsonProperty("type")] string type,
+            [JsonProperty("item_id")] string itemId)
+        {
+            EventId = eventId;
+            Type = type;
+            ItemId = itemId;
+        }
+
         /// <inheritdoc />
         [Preserve]
         [JsonProperty("event_id")]
-        public string EventId { get; private set; }
+        public override string EventId { get; internal set; }
 
-        /// <summary>
-        /// The event type, must be "conversation.item.deleted".
-        /// </summary>
+        /// <inheritdoc />
         [Preserve]
         [JsonProperty("type")]
-        public string Type { get; private set; }
+        public override string Type { get; }
 
         /// <summary>
         /// The ID of the item that was deleted.
         /// </summary>
         [Preserve]
         [JsonProperty("item_id")]
-        public string ItemId { get; private set; }
+        public string ItemId { get; }
     }
 }
diff --git a/...ages/com.openai.unity/Runtime/Realtime/ConversationItemInputAudioTranscriptionResponse.cs b/...ages/com.openai.unity/Runtime/Realtime/ConversationItemInputAudioTranscriptionResponse.cs
@@ -8,43 +8,59 @@ namespace OpenAI.Realtime
     [Preserve]
     public sealed class ConversationItemInputAudioTranscriptionResponse : BaseRealtimeEvent, IServerEvent
     {
+        [Preserve]
+        [JsonConstructor]
+        internal ConversationItemInputAudioTranscriptionResponse(
+            [JsonProperty("event_id")] string eventId,
+            [JsonProperty("type")] string type,
+            [JsonProperty("item_id")] string itemId,
+            [JsonProperty("content_index")] int contentIndex,
+            [JsonProperty("transcription")] string transcription,
+            [JsonProperty("error")] Error error)
+        {
+            EventId = eventId;
+            Type = type;
+            ItemId = itemId;
+            ContentIndex = contentIndex;
+            Transcription = transcription;
+            Error = error;
+        }
+
         /// <inheritdoc />
         [Preserve]
         [JsonProperty("event_id")]
-        public string EventId { get; private set; }
+        public override string EventId { get; internal set; }
 
-        /// <summary>
-        /// "conversation.item.input_audio_transcription.completed" or "conversation.item.input_audio_transcription.failed"
-        /// </summary>
+        /// <inheritdoc />
         [Preserve]
         [JsonProperty("type")]
-        public string Type { get; private set; }
+        public override string Type { get; }
 
         /// <summary>
         /// The ID of the user message item.
         /// </summary>
         [Preserve]
         [JsonProperty("item_id")]
-        public string ItemId { get; private set; }
+        public string ItemId { get; }
 
         /// <summary>
         /// The index of the content part containing the audio.
         /// </summary>
         [Preserve]
         [JsonProperty("content_index")]
-        public int ContentIndex { get; private set; }
+        public int ContentIndex { get; }
 
         /// <summary>
         /// The transcribed text.
         /// </summary>
         [Preserve]
         [JsonProperty("transcription")]
-        public string Transcription { get; private set; }
+        public string Transcription { get; }
 
         /// <summary>
         /// Details of the transcription error.
         /// </summary>
         [Preserve]
-        public Error Error { get; private set; }
+        public Error Error { get; }
     }
 }
diff --git a/OpenAI/Packages/com.openai.unity/Runtime/Realtime/ConversationItemTruncateRequest.cs b/OpenAI/Packages/com.openai.unity/Runtime/Realtime/ConversationItemTruncateRequest.cs
@@ -26,13 +26,15 @@ public ConversationItemTruncateRequest(string itemId, int contentIndex, int audi
             AudioEndMs = audioEndMs;
         }
 
+        /// <inheritdoc />
         [Preserve]
         [JsonProperty("event_id")]
-        public string EventId { get; }
+        public override string EventId { get; internal set; }
 
+        /// <inheritdoc />
         [Preserve]
         [JsonProperty("type")]
-        public string Type { get; } = "conversation.item.truncate";
+        public override string Type { get; } = "conversation.item.truncate";
 
         /// <summary>
         /// The ID of the assistant message item to truncate. Only assistant message items can be truncated.

diff --git a/OpenAI/Packages/com.openai.unity/Runtime/Realtime/ConversationItemTruncatedResponse.cs b/OpenAI/Packages/com.openai.unity/Runtime/Realtime/ConversationItemTruncatedResponse.cs
@@ -8,37 +8,51 @@ namespace OpenAI.Realtime
     [Preserve]
     public sealed class ConversationItemTruncatedResponse : BaseRealtimeEvent, IServerEvent
     {
+        [Preserve]
+        [JsonConstructor]
+        internal ConversationItemTruncatedResponse(
+            [JsonProperty("event_id")] string eventId,
+            [JsonProperty("type")] string type,
+            [JsonProperty("item_id")] string itemId,
+            [JsonProperty("content_index")] int contentIndex,
+            [JsonProperty("audio_end_ms")] int audioEndMs)
+        {
+            EventId = eventId;
+            Type = type;
+            ItemId = itemId;
+            ContentIndex = contentIndex;
+            AudioEndMs = audioEndMs;
+        }
+
         /// <inheritdoc />
         [Preserve]
         [JsonProperty("event_id")]
-        public string EventId { get; private set; }
+        public override string EventId { get; internal set; }
 
-        /// <summary>
-        /// The event type, must be "conversation.item.truncated".
-        /// </summary>
+        /// <inheritdoc />
         [Preserve]
         [JsonProperty("type")]
-        public string Type { get; private set; }
+        public override string Type { get; }
 
         /// <summary>
         /// The ID of the assistant message item that was truncated.
         /// </summary>
         [Preserve]
         [JsonProperty("item_id")]
-        public string ItemId { get; private set; }
+        public string ItemId { get; }
 
         /// <summary>
         /// The index of the content part that was truncated.
         /// </summary>
         [Preserve]
         [JsonProperty("content_index")]
-        public int ContentIndex { get; private set; }
+        public int ContentIndex { get; }
 
         /// <summary>
         /// The duration up to which the audio was truncated, in milliseconds.
         /// </summary>
         [Preserve]
         [JsonProperty("audio_end_ms")]
-        public int AudioEndMs { get; private set; }
+        public int AudioEndMs { get; }
     }
 }
diff --git a/OpenAI/Packages/com.openai.unity/Runtime/Realtime/IRealtimeEvent.cs b/OpenAI/Packages/com.openai.unity/Runtime/Realtime/IRealtimeEvent.cs
@@ -19,6 +19,7 @@ public interface IRealtimeEvent
         [JsonProperty("type")]
         public string Type { get; }
 
+        [Preserve]
         public string ToJsonString();
     }
 

diff --git a/OpenAI/Packages/com.openai.unity/Runtime/Realtime/InputAudioBufferAppendRequest.cs b/OpenAI/Packages/com.openai.unity/Runtime/Realtime/InputAudioBufferAppendRequest.cs
@@ -31,13 +31,15 @@ public InputAudioBufferAppendRequest(byte[] audioBytes)
             Audio = System.Convert.ToBase64String(audioBytes);
         }
 
+        /// <inheritdoc />
         [Preserve]
         [JsonProperty("event_id")]
-        public string EventId { get; }
+        public override string EventId { get; internal set; }
 
+        /// <inheritdoc />
         [Preserve]
         [JsonProperty("type")]
-        public string Type { get; } = "input_audio_buffer.append";
+        public override string Type { get; } = "input_audio_buffer.append";
 
         /// <summary>
         /// Base64-encoded audio bytes.

diff --git a/OpenAI/Packages/com.openai.unity/Runtime/Realtime/InputAudioBufferClearRequest.cs b/OpenAI/Packages/com.openai.unity/Runtime/Realtime/InputAudioBufferClearRequest.cs
@@ -12,12 +12,14 @@ namespace OpenAI.Realtime
     [Preserve]
     public sealed class InputAudioBufferClearRequest : BaseRealtimeEvent, IClientEvent
     {
+        /// <inheritdoc />
         [Preserve]
         [JsonProperty("event_id")]
-        public string EventId { get; }
+        public override string EventId { get; internal set; }
 
+        /// <inheritdoc />
         [Preserve]
         [JsonProperty("type")]
-        public string Type { get; } = "input_audio_buffer.clear";
+        public override string Type { get; } = "input_audio_buffer.clear";
     }
 }