VB.OpenAI.SDK 1.2.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package VB.OpenAI.SDK --version 1.2.0                
NuGet\Install-Package VB.OpenAI.SDK -Version 1.2.0                
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="VB.OpenAI.SDK" Version="1.2.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add VB.OpenAI.SDK --version 1.2.0                
#r "nuget: VB.OpenAI.SDK, 1.2.0"                
#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 VB.OpenAI.SDK as a Cake Addin
#addin nuget:?package=VB.OpenAI.SDK&version=1.2.0

// Install VB.OpenAI.SDK as a Cake Tool
#tool nuget:?package=VB.OpenAI.SDK&version=1.2.0                

OpenAI.SDK

Introduction

This library provides openai api wrapper written in C#. Most of the samples are available in OpenAI.SDK.SampleConsoleApp app Program.cs file.

OpenAI.SDK.SampleConsoleApp configuration

  1. Obtain API key from OpenAI website.
  2. Initialize user secrets storage dotnet user-secrets init
  3. Add API key to the user secrets storage dotnet user-secrets set "OpenAI:Api:ApiKey" "YOU KEY HERE"

Supported APIs

Every api integration is provided as separate interface class. Following APIs are supported:

  1. Text Completion.. Implemented as ICompletionsApi
  2. Chat. Implemented as IChatApi.
  3. Edits. Implemented as IEditsApi.
  4. Images. Implemented as IImagesAPi.
  5. Embeddings. Implemented as IEmbeddingsApi.
  6. Files. Implemented as IFilesApi.
  7. Fine-tunes. Implemented as IFineTunesApi.
  8. Moderations. Implemented as IModerationsApi.
  9. Engines. Implemented as IEnginesApi.

How to use

This section describes a basic usage scenario for ASP.NET Core Web Api projects. The library can be applied to other project types too, but some details may be specific on per project type basis. It is out of scope of this document. Feel free to ask questions in issues section of the project.

  1. Create a new ASP.NET Core Web Api project or open the existing one.

  2. Add following lines to the appsettings.json: "OpenAiOptions": { "ApiKey": "SET KEY HERE", "BaseUrl": "https://api.openai.com/v1/" },

  3. Configure OpenAiOptions. ` var builder = WebApplication.CreateBuilder(args);

         builder.Services.Configure<OpenAiOptions>(builder.Configuration.GetSection(nameof(OpenAiOptions)));
    

`

  1. Add OpenAiApi to the application Service Collection. builder.Services.AddOpenAiApi();

  2. Inject required services through constructors or obtain it using IServiceProvider when necessary.

  3. Use it.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos 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
1.3.0 1,586 3/25/2023
1.2.0 235 3/19/2023
1.1.0 293 3/16/2023
1.0.0 262 3/16/2023

Chat api added