Betalgo.OpenAI 8.7.2

Suggested Alternatives

Betalgo.Ranul.OpenAI

Additional Details

`Betalgo.OpenAI` has changed its package ID and namespace and will now be called `Betalgo.Ranul.OpenAI`. This change improves compatibility with Microsoft libraries and aligns with a new project called Ranul Tinga.

For the migration guide: https://github.com/betalgo/openai/wiki/Migration-Guides-for-breaking-changes

For more details: https://blog.kayhantolga.com/ai-updates-series-1

dotnet add package Betalgo.OpenAI --version 8.7.2                
NuGet\Install-Package Betalgo.OpenAI -Version 8.7.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="Betalgo.OpenAI" Version="8.7.2" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Betalgo.OpenAI --version 8.7.2                
#r "nuget: Betalgo.OpenAI, 8.7.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 Betalgo.OpenAI as a Cake Addin
#addin nuget:?package=Betalgo.OpenAI&version=8.7.2

// Install Betalgo.OpenAI as a Cake Tool
#tool nuget:?package=Betalgo.OpenAI&version=8.7.2                

Betalgo Ranul OpenAI Github Readme banner

Overview

A .NET Library for accessing OpenAI's API, provided as a community library. This Library allows you to integrate OpenAI's capabilities into your .NET applications with ease.

⭐ We appreciate your star, it helps! GitHub Repo stars

We have a very new Discord and Static Badge channel. Please come and help us build the .NET AI community.

Install Packages

Core Library

Betalgo.OpenAI

Install-Package Betalgo.OpenAI
Experimental Utilities Library

Betalgo.OpenAI.Utilities

Install-Package Betalgo.OpenAI.Utilities

API Documentation

  • Betalgo.OpenAI: Static Badge
  • Betalgo.OpenAI.Utilities: Static Badge

Acknowledgements

Maintenance of this project is made possible by all the bug reporters, contributors, and sponsors.

💖 Sponsors:
@betalgo, Laser Cat Eyes
@tylerje, @oferavnery, @MayDay-wpf, @AnukarOP, @Removable, @Scar11


Sample Usage

The repository contains a sample project named OpenAI.Playground to help you understand how the library works. However, please exercise caution while experimenting, as some test methods may result in unintended consequences such as file deletion or fine-tuning.

!! It is highly recommended that you use a separate account instead of your primary account while using the playground. Some test methods may add or delete your files and models, potentially causing unwanted issues. !!

Your API Key can be obtained from here: https://platform.openai.com/account/api-keys
Your Organization ID can be found here: https://platform.openai.com/account/org-settings

Without Using Dependency Injection

var openAiService = new OpenAIService(new OpenAiOptions()
{
    ApiKey = Environment.GetEnvironmentVariable("MY_OPEN_AI_API_KEY")
});

Using Dependency Injection

secrets.json
"OpenAIServiceOptions": {
    "ApiKey": "Your api key goes here",
    "Organization": "Your Organization Id goes here (optional)",
    "UseBeta": "true/false (optional)"
}

(To use user secrets: Right-click your project name in "Solution Explorer", then click "Manage User Secrets". This is a good way to keep your API keys secure.)

Program.cs
serviceCollection.AddOpenAIService();

OR

serviceCollection.AddOpenAIService(settings => { settings.ApiKey = Environment.GetEnvironmentVariable("MY_OPEN_AI_API_KEY"); });

After injecting your service, you can retrieve it from the service provider:

var openAiService = serviceProvider.GetRequiredService<IOpenAIService>();

You can set a default model (optional):

openAiService.SetDefaultModelId(Models.Gpt_4o);

Chat GPT Sample

var completionResult = await openAiService.ChatCompletion.CreateCompletion(new ChatCompletionCreateRequest
{
    Messages = new List<ChatMessage>
    {
        ChatMessage.FromSystem("You are a helpful assistant."),
        ChatMessage.FromUser("Who won the world series in 2020?"),
        ChatMessage.FromAssistant("The Los Angeles Dodgers won the World Series in 2020."),
        ChatMessage.FromUser("Where was it played?")
    },
    Model = Models.Gpt_4o,
});
if (completionResult.Successful)
{
    Console.WriteLine(completionResult.Choices.First().Message.Content);
}

Notes

Due to time constraints, not all methods have been thoroughly tested or fully documented. If you encounter any issues, please report them or submit a pull request. Your contributions are always appreciated.

Needless to say, I cannot accept responsibility for any damage caused by using the library.

Changelog

8.7.2

  • Fixed incorrect Azure Urls.
  • Token usage response extended with PromptTokensDetails, audio_tokens and cached_tokens.
  • Model list extended with Gpt_4o_2024_08_06 and Chatgpt_4o_latest.

8.7.1

  • moved strict paremeter from ToolDefinition to FunctionDefinition

8.7.0

  • Added Support for o1 reasing models (o1-mini and o1-preview).
  • Added MaxCompletionTokens for chat completions.
  • Added support for ParallelToolCalls for chat completions.
  • Added support for ServiceTier for chat completions.
  • Added support for ChunkingStrategy in Vector Store and Vector Store Files.
  • Added support for Strict in ToolDefinition.
  • Added support for MaxNumberResults and RankingOptions for FileSearchTool.
  • Added support for ReasoningTokens for token usage.
  • Added support for ResponseFormatOneOfType for AssistantResponse.cs.

More Change Logs


For any issues, contributions, or feedback, feel free to reach out or submit a pull request.

Betalgo X: Betalgo (@Betalgo) / X (twitter.com)
Betalgo Linkedin: Betalgo | LinkedIn
Tolga X: Tolga Kayhan (@kayhantolga) / X (twitter.com)
Tolga Linkedin: Tolga Kayhan | LinkedIn

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  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 is compatible.  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 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. 
.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 (17)

Showing the top 5 NuGet packages that depend on Betalgo.OpenAI:

Package Downloads
Soenneker.OpenAI.Client

An async thread-safe singleton for the OpenAI client by Betalgo

Betalgo.OpenAI.Utilities

Utility tools for Betalgo.OpenAI - Dotnet SDK for OpenAI ChatGPT, Whisper, GPT-4 and DALL·E

Squidex.CLI.Core

Command Line Interface for Squidex Headless CMS

OuroborosAI.Core

Powerful layer on top of OpenAI supporting chaining and recursion scenarios. Includes fluent SDK for chaining, templates, and text processing. Still very early an .NET 7 only; Docs and broader support to follow.

JS.Abp.AI.OpenAI

Package Description

GitHub repositories (4)

Showing the top 4 popular GitHub repositories that depend on Betalgo.OpenAI:

Repository Stars
cmu-sei/GHOSTS
GHOSTS is a realistic user simulation framework for cyber experimentation, simulation, training, and exercise
FireCubeStudios/Clippy
Bring back Clippy on Windows 10/11!
MayDay-wpf/AIBotPublic
AIBot PRO 是一个基于.NET 6 的 AI聚合客户端 to C 弱 to B 可以集成众多AI产品(ChatGPT,Gemini,Claude,文心一言,通义千问,讯飞星火),无感切换对话,支持知识库、插件开发、AI流程引擎(workflow)、以及开放平台对外输出定制化的特色AI API
FireCubeStudios/Run
WinUI 3 Run
Version Downloads Last updated
8.7.2 25,240 10/10/2024 8.7.2 is deprecated.
8.7.1 15,456 9/24/2024
8.7.0 975 9/23/2024
8.6.2 38,827 8/26/2024
8.6.1 43,719 7/18/2024
8.6.0 12,352 7/11/2024
8.5.1 36,980 6/18/2024
8.5.0 7,553 6/15/2024
8.4.0 7,766 6/11/2024
8.3.0 11,296 6/3/2024
8.2.2 36,668 5/18/2024
8.1.1 28,177 4/20/2024
8.1.0 15,156 4/16/2024
8.0.1 6,201 4/11/2024
8.0.0 6,841 4/9/2024
7.4.7 6,205 4/6/2024
7.4.6 142,175 2/7/2024
7.4.5 9,279 2/1/2024
7.4.4 3,214 1/30/2024
7.4.3 111,263 12/11/2023
7.4.2 7,349 12/6/2023
7.4.1 48,699 11/15/2023
7.4.0 16,151 11/10/2023
7.3.1 31,803 10/19/2023
7.2.0 37,998 10/6/2023
7.1.5 175,100 8/6/2023
7.1.3 9,137 7/30/2023
7.0.0 240,160 5/31/2023
6.8.6 59,609 5/11/2023
6.8.5 43,029 4/19/2023
6.8.2 1,087 3/28/2023