OpenAiNg 3.0.0-beta2

This is a prerelease version of OpenAiNg.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package OpenAiNg --version 3.0.0-beta2
NuGet\Install-Package OpenAiNg -Version 3.0.0-beta2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="OpenAiNg" Version="3.0.0-beta2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add OpenAiNg --version 3.0.0-beta2
#r "nuget: OpenAiNg, 3.0.0-beta2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install OpenAiNg as a Cake Addin
#addin nuget:?package=OpenAiNg&version=3.0.0-beta2&prerelease

// Install OpenAiNg as a Cake Tool
#tool nuget:?package=OpenAiNg&version=3.0.0-beta2&prerelease

OpenAI

.NET SDK for accessing the OpenAI Compatible APIs such as GPT-4 (Vision), Assistants and DALL-E 3

OpenAiNextGeneration is a simple .NET library to use with various OpenAI compatible providers, such as OpenAI, Azure OpenAI, and KoboldCpp ( v1.45.2+). Supports features such as function calling in conjunction with streaming, caches its own HttpClients.

Supported features compared to OpenAI-API-dotnet:

  • Assistants, threads, and messages support.
  • Includes new models.
  • Parallel function calling.
  • Improved memory usage, and function calling in conjunction with streaming.
  • Manages its pool of HttpClients.
  • Improved credentials passing.
  • Supports OpenAI-compatible API providers, such as KoboldCpp.
  • Improved Azure OpenAI integration.
  • Nullability annotations.
  • Calls are guaranteed not to throw, full response is included in the call result. (Fully supported in 3.0+)
  • Actively maintained, backed by a company I work for.

Features scheduled for open-sourcing:

  • High-level plugin API.
  • Approximate token counting for streaming & function calling.

⚡Getting Started

Install the library via NuGet:

Install-Package OpenAiNg

🔮 Quick Inference

var api = new OpenAiNg.OpenAiApi("YOUR_API_KEY");
var result = await api.Completions.GetCompletion("One Two Three One Two");
Console.WriteLine(result);
// should print something starting with "Three"

📖 Readme

Requirements

Unlike the original library, OpenAiNg supports only .NET Core >= 6.0, if you need .NET Standard 2.0 /.NET Framework support, please use OpenAI-API-DotNet.

Getting started

Install from NuGet

Install package OpenAiNg from Nuget. Here's how via the command line:

Install-Package OpenAiNg

Authentication

Pass keys directly to ApiAuthentication(string key) constructor.

You use the APIAuthentication when you initialize the API as shown:

// for example
var api = new OpenAiApi("YOUR_API_KEY"); // shorthand
// or
var api = new OpenAiApi(new APIAuthentication("YOUR_API_KEY")); // create object manually

You may optionally include an OpenAi Organization if multiple Organizations are under one account.

// for example
var api = new OpenAiApi(new ApiAuthentication("YOUR_API_KEY", "org-yourOrgHere"));

Documentation

Every single class, method, and property has extensive XML documentation, so it should show up automatically in IntelliSense. That combined with the official OpenAI documentation should be enough to get started. Feel free to open an issue here if you have any questions.

License

This library is licensed under MIT license.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.0-beta4 81 3/12/2024
3.0.0-beta3 76 3/10/2024
3.0.0-beta2 99 2/6/2024
3.0.0-beta1 80 1/29/2024
2.3.3 425 12/14/2023
2.3.2 154 12/3/2023
2.3.1 116 12/2/2023
2.3.0 114 12/1/2023
2.2.9 950 11/9/2023
2.2.8 98 11/8/2023
2.2.7 125 11/7/2023
2.2.6 93 11/7/2023
2.2.5 95 11/7/2023
2.2.4 153 10/8/2023
2.2.3 133 10/8/2023
2.2.2 127 10/8/2023
2.2.1 126 10/8/2023
2.2.0 134 10/8/2023

TTS endpoint