OpenAI-DotNet 6.3.2

- Attempt to fix dependency requirement for dotnet/runtime docker base images - Made internal OpenAIClient constructor with HttpClient public
RageAgainstThePixel · StephenHodgson · Mar 22, 2023 · Mar 21, 2023 · Mar 21, 2023 · Mar 21, 2023
commit 6d697126067d9bf999b3df272a0c706a022d7f1b
@@ -45,7 +45,8 @@ jobs:
  - name: Build Pack and Publish NuGet Package
  run: |
  $projectPath = "${{ github.workspace }}\OpenAI-DotNet"
- dotnet build $projectPath --configuration Release
+ dotnet build --configuration Release
+ dotnet pack $projectPath --configuration Release --include-symbols
  $out = "$projectPath\bin\Release"
  $packagePath = Get-ChildItem -Path $out -File -Include '*.nupkg' -Recurse -ErrorAction SilentlyContinue
 

@@ -0,0 +1,16 @@
+<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>
+</Project>
@@ -11,6 +11,7 @@
  </PropertyGroup>
 
  <ItemGroup>
+ <ProjectReference Include="..\OpenAI-DotNet-Proxy\OpenAI-DotNet-Proxy.csproj" />
  <ProjectReference Include="..\OpenAI-DotNet\OpenAI-DotNet.csproj" />
  </ItemGroup>
 

@@ -1,5 +1,6 @@
 using NUnit.Framework;
 using System;
+using System.Linq;
 using System.Threading.Tasks;
 
 namespace OpenAI.Tests
@@ -20,7 +21,7 @@ public async Task Test_2_RetrieveModelDetails()
  var models = await OpenAIClient.ModelsEndpoint.GetModelsAsync();
  Console.WriteLine($"Found {models.Count} models!");
 
- foreach (var model in models)
+ foreach (var model in models.OrderBy(model => model.Id))
  {
  Console.WriteLine($"{model.Id} | Owner: {model.OwnedBy}");
 

@@ -5,6 +5,8 @@ VisualStudioVersion = 17.5.33424.131
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenAI-DotNet", "OpenAI-DotNet\OpenAI-DotNet.csproj", "{76B6480E-154A-4341-B530-AFE04B254360}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OpenAI-DotNet-Proxy", "OpenAI-DotNet-Proxy\OpenAI-DotNet-Proxy.csproj", "{A4D454D4-C21C-49D3-85A7-B4950358C6E7}"
+EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenAI-DotNet-Tests", "OpenAI-DotNet-Tests\OpenAI-DotNet-Tests.csproj", "{066EC5A5-47CE-4B91-B924-F236644037C1}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenAI-DotNet-Tests-Proxy", "OpenAI-DotNet-Tests-Proxy\OpenAI-DotNet-Tests-Proxy.csproj", "{F8B5D079-FD33-4A9E-92C4-CC88C911CFF3}"
@@ -19,6 +21,10 @@ Global
  {76B6480E-154A-4341-B530-AFE04B254360}.Debug|Any CPU.Build.0 = Debug|Any CPU
  {76B6480E-154A-4341-B530-AFE04B254360}.Release|Any CPU.ActiveCfg = Release|Any CPU
  {76B6480E-154A-4341-B530-AFE04B254360}.Release|Any CPU.Build.0 = Release|Any CPU
+ {A4D454D4-C21C-49D3-85A7-B4950358C6E7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+ {A4D454D4-C21C-49D3-85A7-B4950358C6E7}.Debug|Any CPU.Build.0 = Debug|Any CPU
+ {A4D454D4-C21C-49D3-85A7-B4950358C6E7}.Release|Any CPU.ActiveCfg = Release|Any CPU
+ {A4D454D4-C21C-49D3-85A7-B4950358C6E7}.Release|Any CPU.Build.0 = Release|Any CPU
  {066EC5A5-47CE-4B91-B924-F236644037C1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
  {066EC5A5-47CE-4B91-B924-F236644037C1}.Debug|Any CPU.Build.0 = Debug|Any CPU
  {066EC5A5-47CE-4B91-B924-F236644037C1}.Release|Any CPU.ActiveCfg = Release|Any CPU

@@ -1,104 +1,27 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
  <TargetFramework>net6.0</TargetFramework>
  <LangVersion>latest</LangVersion>
- <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
- <Authors>Stephen Hodgson</Authors>
- <Product>OpenAI-DotNet</Product>
- <Description>A simple C# .NET client library for OpenAI to use chat-gpt, gpt-4, gpt-3.5-turbo and Dall-E though their RESTful API (currently in beta). Independently developed, this is not an official library and I am not affiliated with OpenAI. An OpenAI API account is required.
-
-Forked from [OpenAI-API-dotnet](https://github.com/OkGoDoIt/OpenAI-API-dotnet).
-
-More context [on Roger Pincombe's blog](https://rogerpincombe.com/openai-dotnet-api).
-</Description>
- <Copyright>2023</Copyright>
+ <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
  <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-4, gpt-3.5-tubo, gpt-3, chatGPT, chat-gpt, gpt-2, gpt</PackageTags>
- <Title>OpenAI API</Title>
- <PackageReleaseNotes>Bump version to 6.3.1
-- Fixed apikey requiring sk- prefix with Azure OpenAI
-Bump version to 6.3.0
-- Removed OpenAI-DotNet-Proxy and put it directly in packge on its own
-Bump version to 6.2.0
-- Added OpenAI-DotNet-Proxy project and package.
-- Added support for custom domains
-- Updated unit tests
-- Updated docs
-Bump version to 6.1.0
-- Added support for gpt-4 models
-Bump version to 6.0.1
-- Updated package info
-- Updated docs
-Bump version to 6.0.0
-- Added support for Azure OpenAI
-Bump version to 5.1.2
-- Fixed an issue when deleting personal account fine tuned models
-Bump version to 5.1.1
-- Refactored Model validation
-- Added additional default models
-- Deprecate OpenAIClient.DefaultModel
-- Implemented chat completion streaming
-- Refactored immutable types
-Bump version to 5.1.0
-- Add support for Audio endpoint and Whisper models
- - Audio Speech to text
- - Audio translation
-Bump version to 5.0.2
-- Support multiple inputs in embedding
-- Added better model validation in all endpoints
-Bump version to 5.0.1
-- Fixed chat parameters
-Bump version to 5.0.0
-- Added Chat endpoint
-Bump version to 4.4.4
-- ImageEditRequest mask is now optional so long as texture has alpha transparency
-- ImageVariationRequest added constructor overload for memory stream image
-- Updated AuthInfo parameter validation
-- Renamed OPEN_AI_ORGANIZATION_ID -&gt; OPENAI_ORGANIZATION_ID
-Bump version to 4.4.3
-- added `OPEN_AI_ORGANIZATION_ID` environment variable
-- deprecated `Organization` use `OrganizationId` instead
-Bump version to 4.4.2
-- Removed a useless assert
-- Updated docs
-Bump version to 4.4.1
-- hotfix to CompletionsEndpoint to use IEnumerable&lt;string&gt;
-- hotfix to cleanup Images endpoints
-Bump version to 4.4.0
-- Renamed Choice.Logprobs -&gt; Choice.LogProbabilities
-- Renamed OpenAI.Completions.Logprobs -&gt; OpenAI.Completions.OpenAI.Completions
-- Renamed CompletionRequest parameter names:
- - max_tokens -&gt; maxTokens
- - top_p -&gt; topP
-- Updated CompletionRequest to accept IEnumerable&lt;string&gt; values for prompts and stopSequences
-- Refactored all endpoints to use new response validation extension
-- Added `CancellationToken` to most endpoints that had long running operations</PackageReleaseNotes>
- <SignAssembly>false</SignAssembly>
- <AssemblyOriginatorKeyFile>OpenAI-DotNet.pfx</AssemblyOriginatorKeyFile>
- <DelaySign>true</DelaySign>
- <PackageId>OpenAI-DotNet</PackageId>
- <Version>6.3.1</Version>
- <Company>RageAgainstThePixel</Company>
  <PackageReadmeFile>README.md</PackageReadmeFile>
  <PackageIcon>Assets\OpenAI-DotNet-Icon.png</PackageIcon>
- </PropertyGroup>
- <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
- <TreatWarningsAsErrors>True</TreatWarningsAsErrors>
- </PropertyGroup>
- <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
  <TreatWarningsAsErrors>True</TreatWarningsAsErrors>
+ <SignAssembly>false</SignAssembly>
+ <AssemblyOriginatorKeyFile>OpenAI-DotNet.pfx</AssemblyOriginatorKeyFile>
+ <DelaySign>true</DelaySign>
+ <NuspecFile>OpenAI-DotNet.nuspec</NuspecFile>
  </PropertyGroup>
  <ItemGroup>
  <None Include="..\README.md">
  <Pack>True</Pack>
  <PackagePath>\</PackagePath>
  </None>
+ </ItemGroup>
+ <ItemGroup>
  <None Update="Assets\OpenAI-DotNet-Icon.png">
  <Pack>True</Pack>
  <PackagePath>\</PackagePath>
  </None>
- <FrameworkReference Include="Microsoft.AspNetCore.App" />
  </ItemGroup>
 </Project>
@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package xmlns="http:https://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+ <metadata>
+ <id>OpenAI-DotNet</id>
+ <version>6.3.2</version>
+ <title>OpenAI API</title>
+ <authors>Stephen Hodgson</authors>
+ <license type="expression">CC0-1.0</license>
+ <licenseUrl>https://licenses.nuget.org/CC0-1.0</licenseUrl>
+ <icon>Assets\OpenAI-DotNet-Icon.png</icon>
+ <readme>README.md</readme>
+ <projectUrl>https://github.com/RageAgainstThePixel/OpenAI-DotNet</projectUrl>
+ <description>A simple C# .NET client library for OpenAI to use chat-gpt, gpt-4, gpt-3.5-turbo and Dall-E though their RESTful API (currently in beta). Independently developed, this is not an official library and I am not affiliated with OpenAI. An OpenAI API account is required.
+
+Forked from [OpenAI-API-dotnet](https://github.com/OkGoDoIt/OpenAI-API-dotnet).
+
+More context [on Roger Pincombe's blog](https://rogerpincombe.com/openai-dotnet-api).</description>
+ <releaseNotes>Bump version to 6.3.2
+- Attempt to fix dependency requirement for dotnet/runtime docker base images
+- Made internal OpenAIClient constructor with HttpClient public
+Bump version to 6.3.1
+- Fixed apikey requiring sk- prefix with Azure OpenAI
+Bump version to 6.3.0
+- Removed OpenAI-DotNet-Proxy and put it directly in packge on its own
+Bump version to 6.2.0
+- Added OpenAI-DotNet-Proxy project and package.
+- Added support for custom domains
+- Updated unit tests
+- Updated docs
+Bump version to 6.1.0
+- Added support for gpt-4 models
+Bump version to 6.0.1
+- Updated package info
+- Updated docs
+Bump version to 6.0.0
+- Added support for Azure OpenAI
+Bump version to 5.1.2
+- Fixed an issue when deleting personal account fine tuned models
+Bump version to 5.1.1
+- Refactored Model validation
+- Added additional default models
+- Deprecate OpenAIClient.DefaultModel
+- Implemented chat completion streaming
+- Refactored immutable types
+Bump version to 5.1.0
+- Add support for Audio endpoint and Whisper models
+ - Audio Speech to text
+ - Audio translation
+Bump version to 5.0.2
+- Support multiple inputs in embedding
+- Added better model validation in all endpoints
+Bump version to 5.0.1
+- Fixed chat parameters
+Bump version to 5.0.0
+- Added Chat endpoint
+Bump version to 4.4.4
+- ImageEditRequest mask is now optional so long as texture has alpha transparency
+- ImageVariationRequest added constructor overload for memory stream image
+- Updated AuthInfo parameter validation
+- Renamed OPEN_AI_ORGANIZATION_ID -&gt; OPENAI_ORGANIZATION_ID
+Bump version to 4.4.3
+- added `OPEN_AI_ORGANIZATION_ID` environment variable
+- deprecated `Organization` use `OrganizationId` instead
+Bump version to 4.4.2
+- Removed a useless assert
+- Updated docs
+Bump version to 4.4.1
+- hotfix to CompletionsEndpoint to use IEnumerable&lt;string&gt;
+- hotfix to cleanup Images endpoints
+Bump version to 4.4.0
+- Renamed Choice.Logprobs -&gt; Choice.LogProbabilities
+- Renamed OpenAI.Completions.Logprobs -&gt; OpenAI.Completions.OpenAI.Completions
+- Renamed CompletionRequest parameter names:
+ - max_tokens -&gt; maxTokens
+ - top_p -&gt; topP
+- Updated CompletionRequest to accept IEnumerable&lt;string&gt; values for prompts and stopSequences
+- Refactored all endpoints to use new response validation extension
+- Added `CancellationToken` to most endpoints that had long running operations</releaseNotes>
+ <copyright>2023</copyright>
+ <tags>OpenAI, AI, ML, API, gpt-4, gpt-3.5-tubo, gpt-3, chatGPT, chat-gpt, gpt-2, gpt</tags>
+ <repository url="https://github.com/RageAgainstThePixel/OpenAI-DotNet" />
+ <dependencies>
+ <group targetFramework="net6.0" />
+ </dependencies>
+ </metadata>
+ <files>
+ <file src="..\README.md" target="\README.md" />
+ <file src="Assets\OpenAI-DotNet-Icon.png" target="\Assets\OpenAI-DotNet-Icon.png" />
+ <file src="bin\Release\net6.0\OpenAI-DotNet.dll" target="\lib\net6.0\OpenAI-DotNet.dll" />
+ <!-- include OpenAI-DotNet-Proxy.dll only for web projects -->
+ <file src="bin\Release\net6.0\OpenAI-DotNet-Proxy.dll" target="\lib\net6.0\OpenAI-DotNet-Proxy.dll" condition="'$(Project Sdk)' == 'Microsoft.NET.Sdk.Web'" />
+ </files>
+</package>
@@ -22,9 +22,19 @@ namespace OpenAI
  public sealed class OpenAIClient
  {
  /// <summary>
- /// For internal testing only.
+ /// Creates a new entry point to the OpenAPI API, handling auth and allowing access to the various API endpoints
  /// </summary>
- internal OpenAIClient(OpenAIAuthentication openAIAuthentication, OpenAIClientSettings clientSettings, HttpClient client)
+ /// <param name="openAIAuthentication">
+ /// The API authentication information to use for API calls,
+ /// or <see langword="null"/> to attempt to use the <see cref="OpenAI.OpenAIAuthentication.Default"/>,
+ /// potentially loading from environment vars or from a config file.
+ /// </param>
+ /// <param name="clientSettings">
+ /// Optional, <see cref="OpenAIClientSettings"/> for specifying OpenAI deployments to Azure.
+ /// </param>
+ /// <param name="client">A <see cref="HttpClient"/>.</param>
+ /// <exception cref="AuthenticationException">Raised when authentication details are missing or invalid.</exception>
+ public OpenAIClient(OpenAIAuthentication openAIAuthentication, OpenAIClientSettings clientSettings, HttpClient client)
  : this(openAIAuthentication, clientSettings)
  {
  Client = SetupClient(client);