DougWare.OobaboogaAPIHelper 1.0.2

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package DougWare.OobaboogaAPIHelper --version 1.0.2                

                    
                

            
NuGet\Install-Package DougWare.OobaboogaAPIHelper -Version 1.0.2
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="DougWare.OobaboogaAPIHelper" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add DougWare.OobaboogaAPIHelper --version 1.0.2                

                    
                

            
#r "nuget: DougWare.OobaboogaAPIHelper, 1.0.2"
#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 DougWare.OobaboogaAPIHelper as a Cake Addin
#addin nuget:?package=DougWare.OobaboogaAPIHelper&version=1.0.2

// Install DougWare.OobaboogaAPIHelper as a Cake Tool
#tool nuget:?package=DougWare.OobaboogaAPIHelper&version=1.0.2

OobaboogaAPIHelper

OobaboogaAPIHelper is a .NET library available on nuget.org. This class library makes it easy to consume the Oobabooga Text Generation Web UI’s API extension. Key features include: prompt templates for Vicuna 1,0, 1.1, Dolly v2, and basic LLama with a base class that is easy to extend, converstaion helpers to easily convert saved converstaions created with one model and/or prompt template for use with other models, model parameters and presets, and token counting to make it easy to fit your model's context size limits.

Why?

Converting the python in Oobabooga Text Generation Web UI to C# was a good way for me to learn what happens in the Web UI Gradio app under the covers. The library contains:

  • Each of the Web UI presets (at the time of this writing)
  • Models for generating requests with documentation of each property
  • Methods for /api/v1/generate and /api/v1/token-count
  • Prompt templates for Vicuna, Dolly, and Llama models and a base class that is easy to use and extend for your own prompt templates
  • Conversation helpers that make it easy to save and reuse conversations including token counts with different prompt templates

Source, sample console app and unit tests are in github
Classes and methods are documented here

Console Sample

First start Text Generation Web UI and enable the api extension.

alternate text is missing from this package README image

Make sure you can chat in the browser and that the api extension is loaded. The console sample will work with minimal effort.

alternate text is missing from this package README image

<br/>
But, you do need to make sure you set the promptTemplate to match the model you have loaded in Web UI!

alternate text is missing from this package README image

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.0.2 242 6/19/2023
1.0.1 178 6/6/2023
1.0.0 166 6/4/2023

Bug fix to apply correct system prompt when loading a saved conversation created using a different prompt template