Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/betalgo/openai

OpenAI .NET sdk - ChatGPT, Whisper, GPT-3, GPT-4, Azure OpenAI and DALL-E
https://github.com/betalgo/openai

azure-openai chatgpt csharp dall-e dotnet gpt-3 gpt-4 openai openai-api sdk whisper whisper-ai

Last synced: 30 days ago
JSON representation

OpenAI .NET sdk - ChatGPT, Whisper, GPT-3, GPT-4, Azure OpenAI and DALL-E

Awesome Lists containing this project

README 

        
![Betalgo Ranul OpenAI Github Readme banner](https://github.com/user-attachments/assets/ca87b21f-e2a3-4bf2-88ad-4610bda6dfd6)



## 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](https://img.shields.io/github/stars/betalgo/openai)  

 #### Community Links

 We have a very new [![Discord](https://img.shields.io/discord/1250841506785529916?label=Discord)](https://discord.gg/gfgHsWnGxy) and [![Static Badge](https://img.shields.io/badge/Reddit-BetalgoDevelopers-orange)](https://www.reddit.com/r/BetalgoDevelopers) channel. Please come and help us build the .NET AI community.

 

### Install Packages

#### Core Library

[![Betalgo.OpenAI](https://img.shields.io/nuget/v/Betalgo.OpenAI?style=for-the-badge)](https://www.nuget.org/packages/Betalgo.OpenAI/)

```shell

Install-Package Betalgo.OpenAI

```



#### Experimental Utilities Library

[![Betalgo.OpenAI.Utilities](https://img.shields.io/nuget/v/Betalgo.OpenAI.Utilities?style=for-the-badge)](https://www.nuget.org/packages/Betalgo.OpenAI.Utilities/)

```shell

Install-Package Betalgo.OpenAI.Utilities

```



## Documentation and Links

- [Wiki Page](https://github.com/betalgo/openai/wiki)

- [Feature Availability Table](https://github.com/betalgo/openai/wiki/Feature-Availability)

- [Change Logs](https://github.com/betalgo/openai/wiki/Change-Logs)



### API Documentation

- Betalgo.OpenAI: [![Static Badge](https://img.shields.io/badge/API%20Docs-DNDocs-190088?logo=readme&logoColor=white)](https://dndocs.com/d/betalgo-openai/api/OpenAI.OpenAiOptions.html)

- Betalgo.OpenAI.Utilities: [![Static Badge](https://img.shields.io/badge/API%20Docs-DNDocs-190088?logo=readme&logoColor=white)](https://dndocs.com/d/betalgo-openai/api/OpenAI.Utilities.Embedding.EmbeddingTools.html)



---



## Acknowledgements

Maintenance of this project is made possible by all the bug reporters, [contributors](https://github.com/betalgo/openai/graphs/contributors), and [sponsors](https://github.com/sponsors/kayhantolga).



💖 Sponsors:  

[@betalgo](https://github.com/betalgo), [Laser Cat Eyes](https://lasercateyes.com/)   

[@tylerje](https://github.com/tylerje), [@oferavnery](https://github.com/oferavnery), [@MayDay-wpf](https://github.com/MayDay-wpf), [@AnukarOP](https://github.com/AnukarOP), [@Removable](https://github.com/Removable), [@Scar11](https://github.com/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

```csharp

var openAiService = new OpenAIService(new OpenAiOptions()

{

    ApiKey = Environment.GetEnvironmentVariable("MY_OPEN_AI_API_KEY")

});

```



### Using Dependency Injection



#### secrets.json

```json

"OpenAIServiceOptions": {

    "ApiKey": "Your api key goes here",

    "Organization": "Your Organization Id goes here (optional)",

    "UseBeta": "true/false (optional)"

}

```

*(To use [user secrets](https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-6.0&tabs=windows): 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

```csharp

serviceCollection.AddOpenAIService();

```



**OR**



```csharp

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

```



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

```csharp

var openAiService = serviceProvider.GetRequiredService();

```



You can set a default model (optional):

```csharp

openAiService.SetDefaultModelId(Models.Gpt_4o);

```



## Chat GPT Sample

```csharp

var completionResult = await openAiService.ChatCompletion.CreateCompletion(new ChatCompletionCreateRequest

{

    Messages = new List

    {

        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.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](https://github.com/betalgo/openai/wiki/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)](https://twitter.com/Betalgo)  

Betalgo Linkedin:  [Betalgo | LinkedIn](https://www.linkedin.com/company/betalgo-up )  

Tolga X: [Tolga Kayhan (@kayhantolga) / X (twitter.com)](https://twitter.com/kayhantolga)  

Tolga Linkedin: [Tolga Kayhan | LinkedIn](https://www.linkedin.com/in/kayhantolga/)