forked from RageAgainstThePixel/OpenAI-DotNet
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
OpenAI-DotNet 6.4.0 (RageAgainstThePixel#63)
- Moved OpenAI-DotNet-Proxy back into its own project and package - Make a few classes sealed that are not meant to be extended
- Loading branch information
1 parent
d32fcea
commit 0a9dbc0
Showing
11 changed files
with
254 additions
and
118 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| <Project> | ||
| <PropertyGroup> | ||
| <OpenAIDotNetVersion>6.4.0</OpenAIDotNetVersion> | ||
| </PropertyGroup> | ||
| </Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,43 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <TargetFramework>net6.0</TargetFramework> | ||
| <RootNamespace>OpenAI_DotNet_Proxy</RootNamespace> | ||
| <ImplicitUsings>disable</ImplicitUsings> | ||
| <Nullable>disable</Nullable> | ||
| <LangVersion>latest</LangVersion> | ||
| <OutputPath>..\OpenAI-DotNet\bin\$(Configuration)\</OutputPath> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <FrameworkReference Include="Microsoft.AspNetCore.App" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <ProjectReference Include="..\OpenAI-DotNet\OpenAI-DotNet.csproj" /> | ||
| </ItemGroup> | ||
| <PropertyGroup> | ||
| <TargetFramework>net6.0</TargetFramework> | ||
| <ImplicitUsings>false</ImplicitUsings> | ||
| <Nullable>disable</Nullable> | ||
| <SignAssembly>false</SignAssembly> | ||
| <Authors>Stephen Hodgson</Authors> | ||
| <Product>OpenAI-DotNet-Proxy</Product> | ||
| <Description>A simple Proxy API gateway for OpenAI-DotNet to make authenticated requests from a front end application without exposing your API keys.</Description> | ||
| <Copyright>2023</Copyright> | ||
| <PackageLicenseExpression>CC0-1.0</PackageLicenseExpression> | ||
| <PackageProjectUrl>https://github.com/RageAgainstThePixel/OpenAI-DotNet</PackageProjectUrl> | ||
| <RepositoryUrl>https://github.com/RageAgainstThePixel/OpenAI-DotNet</RepositoryUrl> | ||
| <PackageTags>OpenAI, AI, ML, API, gpt, gpt-4, gpt-3.5-turbo, gpt-3, chatGPT, api-proxy, proxy, gateway</PackageTags> | ||
| <Title>OpenAI API Proxy</Title> | ||
| <PackageId>OpenAI-DotNet-Proxy</PackageId> | ||
| <Version>$(OpenAIDotNetVersion)</Version> | ||
| <Company>RageAgainstThePixel</Company> | ||
| <RootNamespace>OpenAI.Proxy</RootNamespace> | ||
| <PackageIcon>OpenAI-DotNet-Icon.png</PackageIcon> | ||
| <PackageReleaseNotes>Initial Release!</PackageReleaseNotes> | ||
| <TreatWarningsAsErrors>True</TreatWarningsAsErrors> | ||
| <GeneratePackageOnBuild>false</GeneratePackageOnBuild> | ||
| <PackageReadmeFile>Readme.md</PackageReadmeFile> | ||
| <IncludeSymbols>True</IncludeSymbols> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <ProjectReference Include="..\OpenAI-DotNet\OpenAI-DotNet.csproj" /> | ||
| <FrameworkReference Include="Microsoft.AspNetCore.App" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <None Include="..\OpenAI-DotNet\Assets\OpenAI-DotNet-Icon.png"> | ||
| <Pack>True</Pack> | ||
| <PackagePath>\</PackagePath> | ||
| </None> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <None Update="Readme.md"> | ||
| <Pack>True</Pack> | ||
| <PackagePath>\</PackagePath> | ||
| </None> | ||
| </ItemGroup> | ||
| </Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
|
|
||
| # OpenAI-DotNet-Proxy | ||
|
|
||
| [](https://www.nuget.org/packages/OpenAI-DotNet-Proxy/) | ||
|
|
||
| A simple Proxy API gateway for [OpenAI-DotNet](https://github.com/RageAgainstThePixel/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](https://www.nuget.org/packages/OpenAI-DotNet-Proxy/). Here's how via command line: | ||
|
|
||
| ```powershell | ||
| Install-Package OpenAI-DotNet-Proxy | ||
| ``` | ||
|
|
||
| ## Documentation | ||
|
|
||
| Using either the [OpenAI-DotNet](https://github.com/RageAgainstThePixel/OpenAI-DotNet) or [com.openai.unity](https://github.com/RageAgainstThePixel/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](https://github.com/RageAgainstThePixel/OpenAI-DotNet) or [com.openai.unity](https://github.com/RageAgainstThePixel/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 `OpenAIClientSettings` 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: | ||
|
|
||
| ```csharp | ||
| var authToken = await LoginAsync(); | ||
| var auth = new OpenAIAuthentication($"sess-{authToken}"); | ||
| var settings = new OpenAIClientSettings(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 `OpenAIProxyStartup` 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](https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-6.0) project. | ||
| 2. Add the OpenAI-DotNet nuget package to your project. | ||
| - Powershell install: `Install-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 `OpenAIProxyStartup.CreateDefaultHost` method, passing your custom `AuthenticationFilter` as a type argument. | ||
| 5. Create `OpenAIAuthentication` and `OpenAIClientSettings` as you would normally with your API keys, org id, or Azure settings. | ||
|
|
||
| ```csharp | ||
| public partial class Program | ||
| { | ||
| private class AuthenticationFilter : AbstractAuthenticationFilter | ||
| { | ||
| public override void ValidateAuthentication(IHeaderDictionary request) | ||
| { | ||
| // 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(userToken)) | ||
| { | ||
| throw new AuthenticationException("User is not authorized"); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public static void Main(string[] args) | ||
| { | ||
| var auth = OpenAIAuthentication.LoadFromEnv(); | ||
| var settings = new OpenAIClientSettings(/* your custom settings if using Azure OpenAI */); | ||
| var openAIClient = new OpenAIClient(auth, settings); | ||
| var proxy = OpenAIProxyStartup.CreateDefaultHost<AuthenticationFilter>(args, openAIClient); | ||
| proxy.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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.