👁 Image
OpenAI-DotNet-Proxy 8.8.6

OpenAI-DotNet-Proxy

👁 NuGet version (OpenAI-DotNet-Proxy)

A simple Proxy API gateway for OpenAI-DotNet to make authenticated requests from a front end application without exposing your API keys.

Getting started

Install from NuGet

Install package OpenAI-DotNet-Proxy from Nuget. Here's how via command line:

Install-Package OpenAI-DotNet-Proxy

Documentation

Using either the OpenAI-DotNet or com.openai.unity packages directly in your front-end app may expose your API keys and other sensitive information. To mitigate this risk, it is recommended to set up an intermediate API that makes requests to OpenAI on behalf of your front-end app. This library can be utilized for both front-end and intermediary host configurations, ensuring secure communication with the OpenAI API.

Front End Example

In the front end example, you will need to securely authenticate your users using your preferred OAuth provider. Once the user is authenticated, exchange your custom auth token with your API key on the backend.

Follow these steps:

1. Setup a new project using either the OpenAI-DotNet or com.openai.unity packages.
2. Authenticate users with your OAuth provider.
3. After successful authentication, create a new OpenAIAuthentication object and pass in the custom token with the prefix sess-.
4. Create a new OpenAISettings object and specify the domain where your intermediate API is located.
5. Pass your new auth and settings objects to the OpenAIClient constructor when you create the client instance.

Here's an example of how to set up the front end:

var authToken = await LoginAsync();
var auth = new OpenAIAuthentication($"sess-{authToken}");
var settings = new OpenAISettings(domain: "api.your-custom-domain.com");
var api = new OpenAIClient(auth, settings);

This setup allows your front end application to securely communicate with your backend that will be using the OpenAI-DotNet-Proxy, which then forwards requests to the OpenAI API. This ensures that your OpenAI API keys and other sensitive information remain secure throughout the process.

Back End Example

In this example, we demonstrate how to set up and use OpenAIProxy in a new ASP.NET Core web app. The proxy server will handle authentication and forward requests to the OpenAI API, ensuring that your API keys and other sensitive information remain secure.

1. Create a new ASP.NET Core minimal web API project.
2. Add the OpenAI-DotNet nuget package to your project.
   • Powershell install: Install-Package OpenAI-DotNet-Proxy
   • Dotnet install: dotnet add package OpenAI-DotNet-Proxy
   • Manually editing .csproj: <PackageReference Include="OpenAI-DotNet-Proxy" />
3. Create a new class that inherits from AbstractAuthenticationFilter and override the ValidateAuthentication method. This will implement the IAuthenticationFilter that you will use to check user session token against your internal server.
4. In Program.cs, create a new proxy web application by calling OpenAIProxy.CreateWebApplication method, passing your custom AuthenticationFilter as a type argument.
5. Create OpenAIAuthentication and OpenAISettings as you would normally with your API keys, org id, or Azure settings.

public partial class Program
{
 private class AuthenticationFilter : AbstractAuthenticationFilter
 {
 public override async Task ValidateAuthenticationAsync(IHeaderDictionary request)
 {
 await Task.CompletedTask; // remote resource call to verify token

 // You will need to implement your own class to properly test
 // custom issued tokens you've setup for your end users.
 if (!request.Authorization.ToString().Contains(TestUserToken))
 {
 throw new AuthenticationException("User is not authorized");
 }
 }
 }

 public static void Main(string[] args)
 {
 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();
 }
}

Once you have set up your proxy server, your end users can now make authenticated requests to your proxy api instead of directly to the OpenAI API. The proxy server will handle authentication and forward requests to the OpenAI API, ensuring that your API keys and other sensitive information remain secure.