fix: clean up OpenAISharp public API

Author: HavenDV

src/libs/tryAGI.OpenAI/OpenAISharp/.editorconfig

@@ -15,7 +15,7 @@ public record OpenAIConfig
     /// <summary>
     /// Base WebSocket URL for OpenAI Realtime API.
     /// </summary>
-    public string BaseUrl { get; init; } = "wss://api.openai.com/v1/realtime";
+    public Uri BaseUrl { get; init; } = new("wss://api.openai.com/v1/realtime");
 
     /// <summary>
     /// Optional OpenAI organization ID.

src/libs/tryAGI.OpenAI/OpenAISharp/Configuration/OpenAIConfig.cs

@@ -0,0 +1,116 @@
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using System.Text.Json.Serialization.Metadata;
+
+namespace tryAGI.OpenAI.OpenAISharp;
+
+/// <inheritdoc />
+[JsonConverter(typeof(OpenAIOptionalJsonConverterFactory))]
+public readonly struct OpenAIOptional<T> : IEquatable<OpenAIOptional<T>>
+{
+    /// <inheritdoc />
+    public bool HasValue { get; }
+    /// <inheritdoc />
+    public T? Value { get; }
+
+    /// <inheritdoc />
+    public OpenAIOptional(T? value)
+    {
+        HasValue = true;
+        Value = value;
+    }
+
+    /// <inheritdoc />
+    public bool Equals(OpenAIOptional<T> other)
+        => HasValue == other.HasValue && EqualityComparer<T?>.Default.Equals(Value, other.Value);
+
+    /// <inheritdoc />
+    public override bool Equals(object? obj)
+        => obj is OpenAIOptional<T> other && Equals(other);
+
+    /// <inheritdoc />
+    public override int GetHashCode()
+        => HashCode.Combine(HasValue, Value);
+
+    /// <inheritdoc />
+    public static bool operator ==(OpenAIOptional<T> left, OpenAIOptional<T> right)
+        => left.Equals(right);
+
+    /// <inheritdoc />
+    public static bool operator !=(OpenAIOptional<T> left, OpenAIOptional<T> right)
+        => !left.Equals(right);
+}
+
+/// <inheritdoc />
+public static class OpenAIOptional
+{
+    /// <inheritdoc />
+    public static OpenAIOptional<T> From<T>(T? value) => new(value);
+}
+
+internal sealed class OpenAIOptionalJsonConverterFactory : JsonConverterFactory
+{
+    private static readonly Dictionary<Type, JsonConverter> Converters = new()
+    {
+        { typeof(OpenAIOptional<string?>), new OpenAIOptionalJsonConverter<string?>() },
+        { typeof(OpenAIOptional<string[]?>), new OpenAIOptionalJsonConverter<string[]?>() },
+        { typeof(OpenAIOptional<double?>), new OpenAIOptionalJsonConverter<double?>() },
+        { typeof(OpenAIOptional<int?>), new OpenAIOptionalJsonConverter<int?>() },
+        { typeof(OpenAIOptional<OpenAIRealtimeInputAudioTranscription?>), new OpenAIOptionalJsonConverter<OpenAIRealtimeInputAudioTranscription?>() },
+        { typeof(OpenAIOptional<OpenAIRealtimeTurnDetection?>), new OpenAIOptionalJsonConverter<OpenAIRealtimeTurnDetection?>() },
+        { typeof(OpenAIOptional<OpenAIRealtimeNoiseReduction?>), new OpenAIOptionalJsonConverter<OpenAIRealtimeNoiseReduction?>() },
+        { typeof(OpenAIOptional<OpenAIRealtimeTool[]?>), new OpenAIOptionalJsonConverter<OpenAIRealtimeTool[]?>() },
+    };
+
+    /// <inheritdoc />
+    public override bool CanConvert(Type typeToConvert) => Converters.ContainsKey(typeToConvert);
+
+    /// <inheritdoc />
+    public override JsonConverter CreateConverter(Type typeToConvert, JsonSerializerOptions options)
+        => Converters[typeToConvert];
+
+    private sealed class OpenAIOptionalJsonConverter<TValue> : JsonConverter<OpenAIOptional<TValue>>
+    {
+        /// <inheritdoc />
+        public override OpenAIOptional<TValue> Read(
+            ref Utf8JsonReader reader,
+            Type typeToConvert,
+            JsonSerializerOptions options)
+        {
+            if (reader.TokenType == JsonTokenType.Null)
+            {
+                return new OpenAIOptional<TValue>(default);
+            }
+
+            var typeInfo = options.GetTypeInfo(typeof(TValue)) as JsonTypeInfo<TValue>;
+            if (typeInfo is null)
+            {
+                throw new NotSupportedException($"Missing JsonTypeInfo for {typeof(TValue).Name}.");
+            }
+
+            var value = JsonSerializer.Deserialize(ref reader, typeInfo);
+            return new OpenAIOptional<TValue>(value);
+        }
+
+        /// <inheritdoc />
+        public override void Write(
+            Utf8JsonWriter writer,
+            OpenAIOptional<TValue> value,
+            JsonSerializerOptions options)
+        {
+            if (!value.HasValue || value.Value is null)
+            {
+                writer.WriteNullValue();
+                return;
+            }
+
+            var typeInfo = options.GetTypeInfo(typeof(TValue)) as JsonTypeInfo<TValue>;
+            if (typeInfo is null)
+            {
+                throw new NotSupportedException($"Missing JsonTypeInfo for {typeof(TValue).Name}.");
+            }
+
+            JsonSerializer.Serialize(writer, value.Value, typeInfo);
+        }
+    }
+}

src/libs/tryAGI.OpenAI/OpenAISharp/Models/OpenAIOptional.cs

@@ -29,80 +29,104 @@ namespace tryAGI.OpenAI.OpenAISharp;
 [JsonDerivedType(typeof(OpenAIRealtimeTranscriptionSessionUpdateEvent), typeDiscriminator: "transcription_session.update")]
 public abstract record OpenAIRealtimeClientEvent
 {
+    /// <inheritdoc />
     [JsonPropertyName("event_id")]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? EventId { get; init; }
 }
 
+/// <inheritdoc />
 public sealed record OpenAIRealtimeSessionUpdateEvent : OpenAIRealtimeClientEvent
 {
+    /// <inheritdoc />
     [JsonPropertyName("session")]
     public required OpenAIRealtimeSessionUpdate Session { get; init; }
 }
 
+/// <inheritdoc />
 public sealed record OpenAIRealtimeResponseCreateEvent : OpenAIRealtimeClientEvent
 {
+    /// <inheritdoc />
     [JsonPropertyName("response")]
     public required OpenAIRealtimeResponse Response { get; init; }
 }
 
+/// <inheritdoc />
 public sealed record OpenAIRealtimeResponseCancelEvent : OpenAIRealtimeClientEvent
 {
+    /// <inheritdoc />
     [JsonPropertyName("response_id")]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? ResponseId { get; init; }
 }
 
+/// <inheritdoc />
 public sealed record OpenAIRealtimeConversationItemCreateEvent : OpenAIRealtimeClientEvent
 {
+    /// <inheritdoc />
     [JsonPropertyName("item")]
     public required OpenAIRealtimeConversationItem Item { get; init; }
 }
 
+/// <inheritdoc />
 public sealed record OpenAIRealtimeConversationItemDeleteEvent : OpenAIRealtimeClientEvent
 {
+    /// <inheritdoc />
     [JsonPropertyName("item_id")]
     public required string ItemId { get; init; }
 }
 
+/// <inheritdoc />
 public sealed record OpenAIRealtimeConversationItemTruncateEvent : OpenAIRealtimeClientEvent
 {
+    /// <inheritdoc />
     [JsonPropertyName("item_id")]
     public required string ItemId { get; init; }
 
+    /// <inheritdoc />
     [JsonPropertyName("content_index")]
     public int? ContentIndex { get; init; }
 
+    /// <inheritdoc />
     [JsonPropertyName("audio_end_ms")]
     public int? AudioEndMs { get; init; }
 }
 
+/// <inheritdoc />
 public sealed record OpenAIRealtimeInputAudioBufferAppendEvent : OpenAIRealtimeClientEvent
 {
+    /// <inheritdoc />
     [JsonPropertyName("audio")]
     public required string Audio { get; init; }
 }
 
+/// <inheritdoc />
 public sealed record OpenAIRealtimeInputAudioBufferCommitEvent : OpenAIRealtimeClientEvent
 {
 }
 
+/// <inheritdoc />
 public sealed record OpenAIRealtimeInputAudioBufferClearEvent : OpenAIRealtimeClientEvent
 {
 }
 
+/// <inheritdoc />
 public sealed record OpenAIRealtimeOutputAudioBufferClearEvent : OpenAIRealtimeClientEvent
 {
 }
 
+/// <inheritdoc />
 public sealed record OpenAIRealtimeSessionInputAudioBufferAppendEvent : OpenAIRealtimeClientEvent
 {
+    /// <inheritdoc />
     [JsonPropertyName("audio")]
     public required string Audio { get; init; }
 }
 
+/// <inheritdoc />
 public sealed record OpenAIRealtimeTranscriptionSessionUpdateEvent : OpenAIRealtimeClientEvent
 {
+    /// <inheritdoc />
     [JsonPropertyName("session")]
     public required OpenAIRealtimeTranscriptionSessionUpdate Session { get; init; }
 }

src/libs/tryAGI.OpenAI/OpenAISharp/Models/OpenAIRealtimeClientEvents.cs

@@ -61,9 +61,13 @@ public sealed record OpenAIRealtimeConnectOptions
     public IReadOnlyList<string>? AdditionalSubProtocols { get; init; }
 }
 
+/// <inheritdoc />
 public enum OpenAIRealtimeSessionKind
 {
+    /// <inheritdoc />
     Realtime,
+    /// <inheritdoc />
     Transcription,
+    /// <inheritdoc />
     Translation,
 }