feat(openai): restore realtime subprotocol auth templates

Author: HavenDV

src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.Realtime.OpenAiRealtimeClient.g.cs

@@ -105,7 +105,10 @@ private void ApplyStoredAuthorization(
                 if (_subprotocolAuthorizationValues.ContainsKey("apiKey"))
                 {
                     var __apiKey = _subprotocolAuthorizationValues["apiKey"];
-                    var __subProtocol = "openai-insecure-api-key.{apiKey}";
+                    var __subProtocol = "realtime";
+                    __subProtocol = __subProtocol.Replace("{apiKey}", __apiKey);
+                    _clientWebSocket.Options.AddSubProtocol(__subProtocol);
+                    __subProtocol = "openai-insecure-api-key.{apiKey}";
                     __subProtocol = __subProtocol.Replace("{apiKey}", __apiKey);
                     _clientWebSocket.Options.AddSubProtocol(__subProtocol);
                     return;

src/libs/tryAGI.OpenAI/OpenAiRealtimeClient.cs

@@ -0,0 +1,11 @@
+using System.Net.WebSockets;
+
+namespace tryAGI.OpenAI.Realtime;
+
+public sealed partial class OpenAiRealtimeClient
+{
+    partial void Initialized(ClientWebSocket client)
+    {
+        client.Options.SetRequestHeader("OpenAI-Beta", "realtime=v1");
+    }
+}

src/libs/tryAGI.OpenAI/asyncapi.json

@@ -370,8 +370,9 @@
       },
       "subprotocol": {
         "type": "apiKey",
-        "description": "Browser-compatible auth via WebSocket subprotocols. When ConnectAsync is called with useSubprotocolAuth: true, the client advertises `openai-insecure-api-key.<apiKey>`, avoiding the need to set an Authorization header (which browsers disallow on the JS WebSocket constructor).\n\nOpenAI also expects the `realtime` subprotocol on the connection; include it via the `additionalSubProtocols` parameter on ConnectAsync.\n\nNOTE: single template until tryAGI/AutoSDK codegen bug (duplicate __subProtocol locals with >1 template) is fixed.",
+        "description": "Browser-compatible auth via WebSocket subprotocols. When ConnectAsync is called with useSubprotocolAuth: true, the client advertises the `realtime` subprotocol plus `openai-insecure-api-key.<apiKey>`, avoiding the need to set an Authorization header (which browsers disallow on the JS WebSocket constructor).",
         "x-subprotocol-auth": [
+          "realtime",
           "openai-insecure-api-key.{apiKey}"
         ]
       }

src/libs/tryAGI.OpenAI/build-asyncapi.py

@@ -187,17 +187,13 @@ def main() -> int:
                     "description": (
                         "Browser-compatible auth via WebSocket subprotocols. "
                         "When ConnectAsync is called with useSubprotocolAuth: true, "
-                        "the client advertises `openai-insecure-api-key.<apiKey>`, "
-                        "avoiding the need to set an Authorization header (which "
-                        "browsers disallow on the JS WebSocket constructor).\n\n"
-                        "OpenAI also expects the `realtime` subprotocol on the "
-                        "connection; include it via the `additionalSubProtocols` "
-                        "parameter on ConnectAsync.\n\n"
-                        "NOTE: single template until tryAGI/AutoSDK codegen bug "
-                        "(duplicate __subProtocol locals with >1 template) is "
-                        "fixed."
+                        "the client advertises the `realtime` subprotocol plus "
+                        "`openai-insecure-api-key.<apiKey>`, avoiding the need "
+                        "to set an Authorization header (which browsers disallow "
+                        "on the JS WebSocket constructor)."
                     ),
                     "x-subprotocol-auth": [
+                        "realtime",
                         "openai-insecure-api-key.{apiKey}",
                     ],
                 },

src/tests/OpenAI.IntegrationTests/Examples/Realtime.cs

@@ -0,0 +1,52 @@
+/*
+order: 75
+title: Realtime
+slug: realtime
+
+Connect to the Realtime API with the generated WebSocket client and wait for the initial session event.
+*/
+
+using tryAGI.OpenAI.Realtime;
+
+namespace tryAGI.OpenAI.IntegrationTests;
+
+public partial class Tests
+{
+    [TestMethod]
+    public async Task Example_Realtime()
+    {
+        var apiKey =
+            Environment.GetEnvironmentVariable("OPENAI_API_KEY") is { Length: > 0 } apiKeyValue
+                ? apiKeyValue
+                : throw new AssertInconclusiveException("OPENAI_API_KEY environment variable is not found.");
+        var model =
+            Environment.GetEnvironmentVariable("OPENAI_REALTIME_MODEL") is { Length: > 0 } modelValue
+                ? modelValue
+                : "gpt-4o-realtime-preview";
+
+        using var client = new OpenAiRealtimeClient(apiKey);
+        using var cancellationTokenSource = new CancellationTokenSource(TimeSpan.FromSeconds(30));
+        var cancellationToken = cancellationTokenSource.Token;
+
+        await client.ConnectAsync(model: model, cancellationToken: cancellationToken);
+        client.IsConnected.Should().BeTrue();
+
+        await foreach (var serverEvent in client.ReceiveUpdatesAsync(cancellationToken))
+        {
+            if (serverEvent.IsSessionCreated)
+            {
+                serverEvent.SessionCreated.Should().NotBeNull();
+                Console.WriteLine(serverEvent.SessionCreated!.EventId);
+                return;
+            }
+
+            if (serverEvent.IsError)
+            {
+                throw new AssertFailedException(
+                    $"Realtime connection returned an error: {serverEvent.Error!.Error.Message}");
+            }
+        }
+
+        throw new AssertFailedException("Realtime connection did not produce a session.created event before timing out.");
+    }
+}