Merge pull request #12 from sipsorcery-org/non-preview-model

sipsorcery · web-flow · commit 64d6f130a4fd · 2026-02-26T12:34:27.000Z
Add new gpt-realtime (non preview) model.
diff --git a/examples/AliceAndBob/Program.cs b/examples/AliceAndBob/Program.cs
@@ -82,10 +82,9 @@ static async Task Main(string[] args)
         var aliceConnectedSemaphore = new SemaphoreSlim(0, 1);
         var bobConnectedSemaphore = new SemaphoreSlim(0, 1);
 
-        var logger = loggerFactory.CreateLogger<Program>();
-        var aliceWebrtcEndPoint = new WebRTCEndPoint(openAiKey, logger);
+        var aliceWebrtcEndPoint = new WebRTCEndPoint(openAiKey, loggerFactory);
         aliceWebrtcEndPoint.OnPeerConnectionConnected += () => aliceConnectedSemaphore.Release();
-        var bobWebrtcEndPoint = new WebRTCEndPoint(openAiKey, logger);
+        var bobWebrtcEndPoint = new WebRTCEndPoint(openAiKey, loggerFactory);
         bobWebrtcEndPoint.OnPeerConnectionConnected += () => bobConnectedSemaphore.Release();
 
         // We'll listen in on the audio.
diff --git a/examples/AspNetGetStarted/AspNetGetStarted.csproj b/examples/AspNetGetStarted/AspNetGetStarted.csproj
@@ -12,11 +12,10 @@
  <ItemGroup>
     <PackageReference Include="LanguageExt.Core" Version="4.4.9" />
 	<PackageReference Include="Serilog.AspNetCore" Version="9.0.0" />
-    <PackageReference Include="SIPSorcery.OpenAI.WebRTC" Version="8.0.4" />
   </ItemGroup>
 
- <!--<ItemGroup>
+ <ItemGroup>
    <ProjectReference Include="..\..\src\SIPSorcery.OpenAI.WebRTC.csproj" />
- </ItemGroup>-->
+ </ItemGroup>
 
 </Project>
diff --git a/examples/AspNetLocalFunction/AspNetLocalFunction.csproj b/examples/AspNetLocalFunction/AspNetLocalFunction.csproj
@@ -12,11 +12,10 @@
  <ItemGroup>
     <PackageReference Include="LanguageExt.Core" Version="4.4.9" />
     <PackageReference Include="Serilog.AspNetCore" Version="9.0.0" />
-    <PackageReference Include="SIPSorcery.OpenAI.WebRTC" Version="8.0.4" />
   </ItemGroup>
 
- <!--<ItemGroup>
+ <ItemGroup>
    <ProjectReference Include="..\..\src\SIPSorcery.OpenAI.WebRTC.csproj" />
- </ItemGroup>-->
+ </ItemGroup>
 
 </Project>
diff --git a/examples/GetPaid/Program.cs b/examples/GetPaid/Program.cs
@@ -63,7 +63,7 @@ static async Task Main()
             return;
         }
 
-        var webrtcEndPoint = new WebRTCEndPoint(openAiKey, logger);
+        var webrtcEndPoint = new WebRTCEndPoint(openAiKey, loggerFactory);
 
         // We'll send/receive audio directly from our Windows audio devices.
         var windowsAudioEP = InitialiseWindowsAudioEndPoint();
diff --git a/examples/GetStarted/Program.cs b/examples/GetStarted/Program.cs
@@ -45,8 +45,8 @@ class Program
     static async Task Main()
     {
         Log.Logger = new LoggerConfiguration()
-            .MinimumLevel.Debug() 
-            //.MinimumLevel.Verbose()
+            //.MinimumLevel.Debug() 
+            .MinimumLevel.Verbose()
             .Enrich.FromLogContext()
             .WriteTo.Console()
             .CreateLogger();
@@ -66,7 +66,7 @@ static async Task Main()
 
         var logger = loggerFactory.CreateLogger<Program>();
 
-        var webrtcEndPoint = new WebRTCEndPoint(openAiKey, logger);
+        var webrtcEndPoint = new WebRTCEndPoint(openAiKey, loggerFactory);
 
         // Send/receive audio directly from Windows audio devices.
         var windowsAudioEp = InitialiseWindowsAudioEndPoint();
@@ -84,7 +84,7 @@ static async Task Main()
         {
             Log.Logger.Information("WebRTC peer connection established.");
 
-            var voice = RealtimeVoicesEnum.shimmer;
+            var voice = RealtimeVoicesEnum.marin;
 
             // Optionally send a session update message to adjust the session parameters.
             var sessionUpdateResult = webrtcEndPoint.DataChannelMessenger.SendSessionUpdate(
diff --git a/examples/GetStartedSIP/Program.cs b/examples/GetStartedSIP/Program.cs
@@ -206,7 +206,7 @@ private static RTPSession CreateRtpSession(SIPUserAgent ua)
     private static async Task CreateOpenAIWebRTCSession(ILoggerFactory loggerFactory, string openAiKey, string sipCallID, RTPSession rtpSession)
     {
         var logger = loggerFactory.CreateLogger<WebRTCEndPoint>();
-        var webrtcEndPoint = new WebRTCEndPoint(openAiKey, logger);
+        var webrtcEndPoint = new WebRTCEndPoint(openAiKey, loggerFactory);
 
         if (_calls.TryGetValue(sipCallID, out var existing))
         {
diff --git a/examples/LocalFunctions/Program.cs b/examples/LocalFunctions/Program.cs
@@ -64,7 +64,7 @@ static async Task Main()
             return;
         }
 
-        var webrtcEndPoint = new WebRTCEndPoint(openAiKey, logger);
+        var webrtcEndPoint = new WebRTCEndPoint(openAiKey, loggerFactory);
 
         // We'll send/receive audio directly from our Windows audio devices.
         var windowsAudioEP = InitialiseWindowsAudioEndPoint();
diff --git a/src/Extensions/WebRTCExtensions.cs b/src/Extensions/WebRTCExtensions.cs
@@ -44,14 +44,17 @@ public static IServiceCollection AddOpenAIRealtimeWebRTC(this IServiceCollection
             throw new ArgumentException("OpenAI API key must be provided", nameof(openAiKey));
         }
 
+        services.AddTransient<HttpLoggingHandler>();
+
         // Register the HTTP client for the REST client
         services
             .AddHttpClient(WebRTCRestClient.OPENAI_HTTP_CLIENT_NAME, client =>
             {
                 client.Timeout = TimeSpan.FromSeconds(OPENAI_HTTP_CLIENT_TIMEOUT_SECONDS);
                 client.DefaultRequestHeaders.Authorization =
                     new AuthenticationHeaderValue("Bearer", openAiKey);
-            });
+            })
+            .AddHttpMessageHandler<HttpLoggingHandler>();
 
         // Register the REST and WebRTC clients
         services.AddTransient<IWebRTCRestClient, WebRTCRestClient>();
diff --git a/src/Models/Realtime/Enums/RealtimeConversationContentTypeEnum.cs b/src/Models/Realtime/Enums/RealtimeConversationContentTypeEnum.cs
@@ -10,5 +10,7 @@ public enum RealtimeConversationContentTypeEnum
 
     text,
 
-    audio
+    audio,
+
+    output_audio
 }
diff --git a/src/Models/Realtime/Enums/RealtimeModelsEnum.cs b/src/Models/Realtime/Enums/RealtimeModelsEnum.cs
@@ -20,5 +20,9 @@ public enum RealtimeModelsEnum
     Gpt4oMiniRealtimePreview_2024_12_17,
 
     [EnumMember(Value = "gpt-4o-realtime-preview-2025-06-03")] 
-    Gpt4oRealtimePreview_2025_06_03
+    Gpt4oRealtimePreview_2025_06_03,
+
+    // Added 23 Feb 2026 and replaces the previous preview models.
+    [EnumMember(Value = "gpt-realtime")]
+    GptRealtime
 }
diff --git a/src/Models/Realtime/Enums/RealtimeVoicesEnum.cs b/src/Models/Realtime/Enums/RealtimeVoicesEnum.cs
@@ -5,11 +5,13 @@ public enum RealtimeVoicesEnum
     alloy,
     ash,
     ballad,
+    cedar,
     coral,
     echo,
-    //fable,
-    //onyx,
-    //nova,
+    fable,
+    marin,
+    nova,
+    onyx,
     sage,
     shimmer,
     verse
diff --git a/src/Rest/HttpClientFactory.cs b/src/Rest/HttpClientFactory.cs
@@ -14,6 +14,8 @@
 // BDS BY-NC-SA restriction, see included LICENSE.md file.
 //-----------------------------------------------------------------------------
 
+using Microsoft.Extensions.Logging;
+using System;
 using System.Collections.Concurrent;
 using System.Net.Http;
 using System.Net.Http.Headers;
@@ -23,19 +25,33 @@ namespace SIPSorcery.OpenAIWebRTC;
 public class HttpClientFactory : IHttpClientFactory
 {
     private readonly string _openAiKey;
+    private readonly ILoggerFactory? _loggerFactory;
     private readonly ConcurrentDictionary<string, HttpClient> _clients
         = new ConcurrentDictionary<string, HttpClient>();
 
-    public HttpClientFactory(string openAiKey)
+    public HttpClientFactory(string openAiKey, ILoggerFactory? loggerFactory = null)
     {
         _openAiKey = openAiKey;
+        _loggerFactory = loggerFactory;
     }
 
     public HttpClient CreateClient(string name)
     {
         return _clients.GetOrAdd(name, _ =>
         {
-            var client = new HttpClient();
+            HttpClient? client = null;
+
+            if (_loggerFactory == null)
+            {
+                client = new HttpClient();
+            }
+            else
+            {
+                var handler = new HttpClientHandler();
+                var logger = _loggerFactory.CreateLogger<HttpLoggingHandler>();
+                var loggingHandler = new HttpLoggingHandler(logger) { InnerHandler = handler };
+                client =  new HttpClient(loggingHandler);                  
+            }
 
             client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", _openAiKey);
 
diff --git a/src/Rest/HttpLoggingHandler.cs b/src/Rest/HttpLoggingHandler.cs
@@ -0,0 +1,134 @@
+﻿//-----------------------------------------------------------------------------
+// Filename: HttpLoggingHandler.cs
+//
+// Description: Provides a logging hook for the HttpClient.
+//
+// References:
+// See https://learn.microsoft.com/en-us/aspnet/core/fundamentals/http-requests?view=aspnetcore-7.0#outgoing-request-middleware.
+//
+// Author(s):
+// Aaron Clauson (aaron@sipsorcery.com)
+// 
+// History:
+// 26 Feb 2026  Aaron Clauson   Created, Dublin, Ireland.
+//
+// License: 
+// BSD 3-Clause "New" or "Revised" License and the additional
+// BDS BY-NC-SA restriction, see included LICENSE.md file.
+//-----------------------------------------------------------------------------
+
+using System;
+using System.Linq;
+using System.Net.Http;
+using System.Net.Http.Headers;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Abstractions;
+
+namespace SIPSorcery.OpenAIWebRTC;
+
+/// <summary>
+/// This class can be used to log events that occur in the HttpClient operation.
+/// </summary>
+public class HttpLoggingHandler : DelegatingHandler
+{
+    private ILogger _logger = NullLogger.Instance;
+
+    // Sensitive headers to redact.
+    private static readonly string[] SensitiveHeaders = [ "Authorization" ];
+
+    public HttpLoggingHandler(ILogger<HttpLoggingHandler> logger)
+    {
+        _logger = logger ?? _logger;
+    }
+
+        protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
+        {
+            // Log request with better formatting
+            var requestId = Guid.NewGuid().ToString("N")[..8]; // Short ID for correlation
+        
+            _logger.LogTrace("🚀 HTTP Request [{RequestId}]", requestId);
+            _logger.LogTrace("  Method: {Method}", request.Method);
+            _logger.LogTrace("  URL: {RequestUri}", request.RequestUri);
+        
+            // Log headers in a more readable format
+            LogHeaders("  Request Headers:", request.Headers, SensitiveHeaders);
+        
+            if (request.Content != null)
+            {
+                LogHeaders("  Content Headers:", request.Content.Headers, null);
+            
+                var requestBody = await request.Content.ReadAsStringAsync(cancellationToken);
+                if (!string.IsNullOrEmpty(requestBody))
+                {
+                    _logger.LogTrace("  Request Body:\n{RequestBody}", FormatBody(requestBody));
+                }
+            }
+
+            var stopwatch = System.Diagnostics.Stopwatch.StartNew();
+            HttpResponseMessage response = await base.SendAsync(request, cancellationToken);
+            stopwatch.Stop();
+
+            // Log response with better formatting
+            var statusIcon = response.IsSuccessStatusCode ? "✅" : "❌";
+            _logger.LogInformation("{StatusIcon} HTTP Response [{RequestId}] - {StatusCode} {ReasonPhrase} ({ElapsedMs}ms)", 
+                statusIcon, requestId, (int)response.StatusCode, response.ReasonPhrase, stopwatch.ElapsedMilliseconds);
+        
+            LogHeaders("  Response Headers:", response.Headers, null);
+
+            if (response.Content != null)
+            {
+                LogHeaders("  Content Headers:", response.Content.Headers, SensitiveHeaders);
+
+                var responseBody = await response.Content.ReadAsStringAsync(cancellationToken);
+                if (!string.IsNullOrEmpty(responseBody))
+                {
+                    _logger.LogTrace("  Response Body:\n{ResponseBody}", FormatBody(responseBody));
+                }
+            }
+
+        return response;
+    }
+
+    private void LogHeaders(string title, HttpHeaders headers, string[]? excludeHeaderNames)
+    {
+        if (headers == null || !headers.Any()) return;
+
+        _logger.LogTrace(title);
+        foreach (var header in headers)
+        {
+            var isExcluded = excludeHeaderNames is not null &&
+                             excludeHeaderNames.Any(h => string.Equals(h, header.Key, StringComparison.OrdinalIgnoreCase));
+
+            var value = isExcluded ? "[REDACTED]" : string.Join(", ", header.Value ?? Array.Empty<string>());
+            _logger.LogTrace("    {HeaderName}: {HeaderValue}", header.Key, value);
+        }
+    }
+
+    private static string FormatBody(string body)
+    {
+        if (string.IsNullOrEmpty(body)) return body;
+
+        // Try to format as JSON if it looks like JSON
+        if (body.TrimStart().StartsWith('{') || body.TrimStart().StartsWith('['))
+        {
+            try
+            {
+                var jsonDoc = System.Text.Json.JsonDocument.Parse(body);
+                return System.Text.Json.JsonSerializer.Serialize(jsonDoc, new System.Text.Json.JsonSerializerOptions 
+                { 
+                    WriteIndented = true 
+                });
+            }
+            catch
+            {
+                // If JSON parsing fails, return as-is
+            }
+        }
+
+        // For non-JSON or if JSON parsing failed, add some basic formatting
+        return body.Length > 500 ? $"{body[..500]}... (truncated, {body.Length} total chars)" : body;
+    }
+}
diff --git a/src/Rest/WebRTCRestClient.cs b/src/Rest/WebRTCRestClient.cs
@@ -33,7 +33,7 @@ public class WebRTCRestClient : IWebRTCRestClient
 {
     public const string OPENAI_HTTP_CLIENT_NAME = "openai";
 
-    public const RealtimeModelsEnum DEFAULT_REALTIME_MODEL = RealtimeModelsEnum.Gpt4oRealtimePreview_2025_06_03;
+    public const RealtimeModelsEnum DEFAULT_REALTIME_MODEL = RealtimeModelsEnum.GptRealtime;
 
     private const string OPENAI_REALTIME_BASE_URL = "https://api.openai.com/v1/realtime";
 
@@ -106,7 +106,8 @@ public async Task<Either<Error, string>> GetSdpAnswerAsync(
     {
         var useModel = model ?? DEFAULT_REALTIME_MODEL;
         var client = GetClient();
-        var url = $"?model={Uri.EscapeDataString(useModel.ToEnumString())}";
+        //var url = $"?model={Uri.EscapeDataString(useModel.ToEnumString())}";
+        var url = $"/v1/realtime/calls?model={Uri.EscapeDataString(useModel.ToEnumString())}";
 
         using var req = new HttpRequestMessage(HttpMethod.Post, url);
         req.Content = new StringContent(offerSdp, Encoding.UTF8);
diff --git a/src/WebRTC/WebRTCEndPoint.cs b/src/WebRTC/WebRTCEndPoint.cs
@@ -83,18 +83,15 @@ public WebRTCEndPoint(
     /// Constructor for use when not using dependency injection.
     /// </summary>
     /// <param name="openAiKey">The OpenAI bearer token API key.</param>
-    /// <param name="logger">Optional logger to use for the end point.</param>
-    public WebRTCEndPoint(string openAiKey, ILogger? logger = null)
+    /// <param name="loggerFactory">Logger factory to use for the end point.</param>
+    public WebRTCEndPoint(string openAiKey, ILoggerFactory loggerFactory)
     {
-        var openAIHttpClientFactory = new HttpClientFactory(openAiKey);
+        var openAIHttpClientFactory = new HttpClientFactory(openAiKey, loggerFactory);
         _openAIRealtimeRestClient = new WebRTCRestClient(openAIHttpClientFactory);
 
-        if (logger != null)
-        {
-            _logger = logger;
-        }
+        _logger = loggerFactory.CreateLogger<DataChannelMessenger>();
 
-        DataChannelMessenger = new DataChannelMessenger(this, logger);
+        DataChannelMessenger = new DataChannelMessenger(this, _logger);
     }
 
     public async Task<Either<Error, Unit>> StartConnect(RTCConfiguration? pcConfig = null, RealtimeModelsEnum? model = null)
diff --git a/test/unit/SIPSorcery.OpenAI.WebRTC.UnitTests.csproj b/test/unit/SIPSorcery.OpenAI.WebRTC.UnitTests.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-	<TargetFramework>net8.0</TargetFramework>
+	<TargetFramework>net10.0</TargetFramework>
 	<LangVersion>12.0</LangVersion>
 	<Nullable>enable</Nullable>
     <IsPackable>false</IsPackable>

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ static async Task Main()`
`63`	`63`	`return;`
`64`	`64`	`}`
`65`	`65`
`66`		`- var webrtcEndPoint = new WebRTCEndPoint(openAiKey, logger);`
	`66`	`+ var webrtcEndPoint = new WebRTCEndPoint(openAiKey, loggerFactory);`
`67`	`67`
`68`	`68`	`// We'll send/receive audio directly from our Windows audio devices.`
`69`	`69`	`var windowsAudioEP = InitialiseWindowsAudioEndPoint();`
Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,7 @@ private static RTPSession CreateRtpSession(SIPUserAgent ua)`
`206`	`206`	`private static async Task CreateOpenAIWebRTCSession(ILoggerFactory loggerFactory, string openAiKey, string sipCallID, RTPSession rtpSession)`
`207`	`207`	`{`
`208`	`208`	`var logger = loggerFactory.CreateLogger<WebRTCEndPoint>();`
`209`		`- var webrtcEndPoint = new WebRTCEndPoint(openAiKey, logger);`
	`209`	`+ var webrtcEndPoint = new WebRTCEndPoint(openAiKey, loggerFactory);`
`210`	`210`
`211`	`211`	`if (_calls.TryGetValue(sipCallID, out var existing))`
`212`	`212`	`{`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ static async Task Main()`
`64`	`64`	`return;`
`65`	`65`	`}`
`66`	`66`
`67`		`- var webrtcEndPoint = new WebRTCEndPoint(openAiKey, logger);`
	`67`	`+ var webrtcEndPoint = new WebRTCEndPoint(openAiKey, loggerFactory);`
`68`	`68`
`69`	`69`	`// We'll send/receive audio directly from our Windows audio devices.`
`70`	`70`	`var windowsAudioEP = InitialiseWindowsAudioEndPoint();`
Original file line number	Diff line number	Diff line change
`@@ -10,5 +10,7 @@ public enum RealtimeConversationContentTypeEnum`
`10`	`10`
`11`	`11`	`text,`
`12`	`12`
`13`		`- audio`
	`13`	`+ audio,`
	`14`	`+`
	`15`	`+ output_audio`
`14`	`16`	`}`