OpenAI-DotNet 8.7.4 (#470)

- Updated proxy support for the OpenAI-DotNet-Proxy package
- Renamed OpenAIAuthentication.LoadFromEnv -> OpenAIAuthentication.LoadFromEnvironment

## OpenAI-DotNet-Proxy 8.7.4
- Updated proxy support for the OpenAI-DotNet package
- Ensure we're returning the full response message body and content length to the clients

Author: StephenHodgson

OpenAI-DotNet-Proxy/OpenAI-DotNet-Proxy.csproj

@@ -22,8 +22,11 @@
     <IncludeSymbols>true</IncludeSymbols>
     <SignAssembly>false</SignAssembly>
     <ImplicitUsings>false</ImplicitUsings>
-    <Version>8.7.0</Version>
+    <Version>8.7.4</Version>
     <PackageReleaseNotes>
+Version 8.7.4
+- Updated proxy support for the OpenAI-DotNet package
+- Ensure we're returning the full response message body and content length to the clients
 Version 8.7.0
 - Fix Azure OpenAI api-version query parameter not being forwarded correctly
 Version 8.4.0

OpenAI-DotNet-Proxy/Proxy/EndpointRouteBuilder.cs

@@ -52,12 +52,12 @@ public static class EndpointRouteBuilder
         /// Maps the <see cref="OpenAIClient"/> endpoints.
         /// </summary>
         /// <param name="endpoints"><see cref="IEndpointRouteBuilder"/>.</param>
-        /// <param name="openAIClient"><see cref="OpenAIClient"/>.</param>
+        /// <param name="client"><see cref="OpenAIClient"/>.</param>
         /// <param name="authenticationFilter"><see cref="IAuthenticationFilter"/>.</param>
         /// <param name="routePrefix">Optional, custom route prefix. i.e. '/openai'.</param>
-        public static void MapOpenAIEndpoints(this IEndpointRouteBuilder endpoints, OpenAIClient openAIClient, IAuthenticationFilter authenticationFilter, string routePrefix = "")
+        public static void MapOpenAIEndpoints(this IEndpointRouteBuilder endpoints, OpenAIClient client, IAuthenticationFilter authenticationFilter, string routePrefix = "")
         {
-            endpoints.Map($"{routePrefix}{openAIClient.Settings.BaseRequest}{{**endpoint}}", HandleRequest);
+            endpoints.Map($"{routePrefix}{client.Settings.BaseRequest}{{**endpoint}}", HandleRequest);
             return;
 
             async Task HandleRequest(HttpContext httpContext, string endpoint)
@@ -80,13 +80,13 @@ async Task HandleRequest(HttpContext httpContext, string endpoint)
                         modifiedQuery[pair.Key] = pair.Value.FirstOrDefault();
                     }
 
-                    if (openAIClient.Settings.IsAzureOpenAI)
+                    if (client.Settings.IsAzureOpenAI)
                     {
-                        modifiedQuery["api-version"] = openAIClient.Settings.ApiVersion;
+                        modifiedQuery["api-version"] = client.Settings.ApiVersion;
                     }
 
                     var uri = new Uri(string.Format(
-                        openAIClient.Settings.BaseRequestUrlFormat,
+                        client.Settings.BaseRequestUrlFormat,
                         QueryHelpers.AddQueryString(endpoint, modifiedQuery)
                     ));
 
@@ -98,8 +98,10 @@ async Task HandleRequest(HttpContext httpContext, string endpoint)
                         request.Content.Headers.ContentType = System.Net.Http.Headers.MediaTypeHeaderValue.Parse(httpContext.Request.ContentType);
                     }
 
-                    var proxyResponse = await openAIClient.Client.SendAsync(request, HttpCompletionOption.ResponseHeadersRead, httpContext.RequestAborted).ConfigureAwait(false);
+                    var proxyResponse = await client.Client.SendAsync(request, HttpCompletionOption.ResponseHeadersRead, httpContext.RequestAborted).ConfigureAwait(false);
                     httpContext.Response.StatusCode = (int)proxyResponse.StatusCode;
+                    httpContext.Response.ContentLength = proxyResponse.Content.Headers.ContentLength;
+                    httpContext.Response.ContentType = proxyResponse.Content.Headers.ContentType?.ToString();
 
                     foreach (var (key, value) in proxyResponse.Headers)
                     {
@@ -112,11 +114,10 @@ async Task HandleRequest(HttpContext httpContext, string endpoint)
                         if (excludedHeaders.Contains(key)) { continue; }
                         httpContext.Response.Headers[key] = value.ToArray();
                     }
-
-                    httpContext.Response.ContentType = proxyResponse.Content.Headers.ContentType?.ToString() ?? string.Empty;
                     const string streamingContent = "text/event-stream";
 
-                    if (httpContext.Response.ContentType.Equals(streamingContent))
+                    if (httpContext.Response.ContentType != null &&
+                        httpContext.Response.ContentType.Equals(streamingContent, StringComparison.OrdinalIgnoreCase))
                     {
                         var stream = await proxyResponse.Content.ReadAsStreamAsync().ConfigureAwait(false);
                         await WriteServerStreamEventsAsync(httpContext, stream).ConfigureAwait(false);
@@ -185,13 +186,13 @@ async Task ProcessWebSocketRequest(HttpContext httpContext, string endpoint)
 
                 using var hostWebsocket = new ClientWebSocket();
 
-                foreach (var header in openAIClient.WebsocketHeaders)
+                foreach (var header in client.WebsocketHeaders)
                 {
                     hostWebsocket.Options.SetRequestHeader(header.Key, header.Value);
                 }
 
                 var uri = new Uri(string.Format(
-                    openAIClient.Settings.BaseWebSocketUrlFormat,
+                    client.Settings.BaseWebSocketUrlFormat,
                     $"{endpoint}{httpContext.Request.QueryString}"
                 ));
                 await hostWebsocket.ConnectAsync(uri, httpContext.RequestAborted).ConfigureAwait(false);

OpenAI-DotNet-Proxy/Readme.md

@@ -75,7 +75,7 @@ public partial class Program
 
     public static void Main(string[] args)
     {
-        var auth = OpenAIAuthentication.LoadFromEnv();
+        var auth = OpenAIAuthentication.LoadFromEnvironment();
         var settings = new OpenAISettings(/* your custom settings if using Azure OpenAI */);
         using var openAIClient = new OpenAIClient(auth, settings);
         OpenAIProxy.CreateWebApplication<AuthenticationFilter>(args, openAIClient).Run();

OpenAI-DotNet-Tests-Proxy/Program.cs

@@ -33,7 +33,7 @@ public override async Task ValidateAuthenticationAsync(IHeaderDictionary request
 
         public static void Main(string[] args)
         {
-            var auth = OpenAIAuthentication.LoadFromEnv();
+            var auth = OpenAIAuthentication.LoadFromEnvironment();
             var settings = new OpenAISettings(/* your custom settings if using Azure OpenAI */);
             using var openAIClient = new OpenAIClient(auth, settings);
             using var app = OpenAIProxy.CreateWebApplication<AuthenticationFilter>(args, openAIClient);

OpenAI-DotNet-Tests/TestFixture_00_01_Authentication.cs

@@ -22,12 +22,12 @@ public void Setup()
         [Test]
         public void Test_01_GetAuthFromEnv()
         {
-            var auth = OpenAIAuthentication.LoadFromEnv();
+            var auth = OpenAIAuthentication.LoadFromEnvironment();
             Assert.IsNotNull(auth);
             Assert.IsNotNull(auth.ApiKey);
             Assert.IsNotEmpty(auth.ApiKey);
 
-            auth = OpenAIAuthentication.LoadFromEnv("org-testOrg");
+            auth = OpenAIAuthentication.LoadFromEnvironment("org-testOrg");
             Assert.IsNotNull(auth);
             Assert.IsNotNull(auth.ApiKey);
             Assert.IsNotEmpty(auth.ApiKey);

OpenAI-DotNet/Authentication/OpenAIAuthentication.cs

@@ -71,7 +71,7 @@ public sealed class OpenAIAuthentication
         /// <summary>
         /// The default authentication to use when no other auth is specified.
         /// This can be set manually, or automatically loaded via environment variables or a config file.
-        /// <seealso cref="LoadFromEnv"/><seealso cref="LoadFromDirectory"/>
+        /// <seealso cref="LoadFromEnvironment"/><seealso cref="LoadFromDirectory"/>
         /// </summary>
         public static OpenAIAuthentication Default
         {
@@ -84,13 +84,17 @@ public static OpenAIAuthentication Default
 
                 var auth = LoadFromDirectory() ??
                            LoadFromDirectory(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile)) ??
-                           LoadFromEnv();
+                           LoadFromEnvironment();
                 cachedDefault = auth ?? throw new UnauthorizedAccessException("Failed to load a valid API Key!");
                 return auth;
             }
             internal set => cachedDefault = value;
         }
 
+        [Obsolete("use LoadFromEnvironment")]
+        public static OpenAIAuthentication LoadFromEnv(string organizationId = null)
+            => LoadFromEnvironment(organizationId);
+
         /// <summary>
         /// Attempts to load api keys from environment variables, as "OPENAI_KEY" (or "OPENAI_SECRET_KEY", for backwards compatibility)
         /// </summary>
@@ -102,7 +106,7 @@ public static OpenAIAuthentication Default
         /// Returns the loaded <see cref="OpenAIAuthentication"/> any api keys were found,
         /// or <see langword="null"/> if there were no matching environment vars.
         /// </returns>
-        public static OpenAIAuthentication LoadFromEnv(string organizationId = null)
+        public static OpenAIAuthentication LoadFromEnvironment(string organizationId = null)
         {
             var apiKey = Environment.GetEnvironmentVariable(OPENAI_KEY);
 

OpenAI-DotNet/OpenAI-DotNet.csproj

@@ -29,8 +29,11 @@ More context [on Roger Pincombe's blog](https://rogerpincombe.com/openai-dotnet-
     <AssemblyOriginatorKeyFile>OpenAI-DotNet.pfx</AssemblyOriginatorKeyFile>
     <IncludeSymbols>true</IncludeSymbols>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <Version>8.7.3</Version>
+    <Version>8.7.4</Version>
     <PackageReleaseNotes>
+Version 8.7.4
+- Updated proxy support for the OpenAI-DotNet-Proxy package
+- Renamed OpenAIAuthentication.LoadFromEnv -&gt; OpenAIAuthentication.LoadFromEnvironment
 Version 8.7.3
 - Fixed Response.Instructions deserialization when using CreateResponseRequest.Prompt
 Version 8.7.2
@@ -481,7 +484,8 @@ Version 4.4.0
     </None>
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0">
+    <PackageReference Include="Microsoft.SourceLink.GitHub"
+      Version="8.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>

README.md

@@ -231,7 +231,7 @@ Use your system's environment variables specify an api key and organization to u
 - Use `OPENAI_PROJECT_ID` to specify a project.
 
 ```csharp
-using var api = new OpenAIClient(OpenAIAuthentication.LoadFromEnv());
+using var api = new OpenAIClient(OpenAIAuthentication.LoadFromEnvironment());
 ```
 
 ### Handling OpenAIClient and HttpClient Lifecycle
@@ -355,7 +355,7 @@ public partial class Program
 
     public static void Main(string[] args)
     {
-        var auth = OpenAIAuthentication.LoadFromEnv();
+        var auth = OpenAIAuthentication.LoadFromEnvironment();
         var settings = new OpenAISettings(/* your custom settings if using Azure OpenAI */);
         using var openAIClient = new OpenAIClient(auth, settings);
         OpenAIProxy.CreateWebApplication<AuthenticationFilter>(args, openAIClient).Run();