Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/betalgo/openai
OpenAI .NET sdk - Azure OpenAI, ChatGPT, Whisper, 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: 4 days ago
JSON representation
OpenAI .NET sdk - Azure OpenAI, ChatGPT, Whisper, and DALL-E
- Host: GitHub
- URL: https://github.com/betalgo/openai
- Owner: betalgo
- License: mit
- Created: 2021-11-28T14:11:38.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-15T12:21:12.000Z (3 months ago)
- Last Synced: 2024-10-29T15:24:54.510Z (2 months ago)
- Topics: azure-openai, chatgpt, csharp, dall-e, dotnet, gpt-3, gpt-4, openai, openai-api, sdk, whisper, whisper-ai
- Language: C#
- Homepage: https://betalgo.github.io/openai/
- Size: 3.86 MB
- Stars: 2,899
- Watchers: 70
- Forks: 527
- Open Issues: 20
-
Metadata Files:
- Readme: Readme.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- Awesome-ChatGPT - openai-dotnet - 3, GPT-4, Azure OpenAI和DALL-E的dotnet SDK | | (精选开源项目合集 / GTP编程语言客户端)
- awesome-ChatGPT-repositories - openai - OpenAI .NET sdk - ChatGPT, Whisper, GPT-3, GPT-4, Azure OpenAI and DALL-E (Openai)
- StarryDivineSky - betalgo/openai
- awesome-chatgpt - betalgo/openai - OpenAI .NET sdk - ChatGPT, Whisper, GPT-3, GPT-4, Azure OpenAI and DALL-E (SDK, Libraries, Frameworks / C#)
- awesome-open-gpt - openai-dotnet - 3, GPT-4, Azure OpenAI和DALL-E的dotnet SDK | | (精选开源项目合集 / GTP编程语言客户端)
- awesome-llm-and-aigc - betalgo/openai - 3 , GPT-4, Azure OpenAI and DALL-E dotnet SDK. [betalgo.github.io/openai/](https://betalgo.github.io/openai/) (Open API / 提示语（魔法）)
README
## 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! 
#### Community Links
- [](https://discord.gg/gfgHsWnGxy) Please come and help us build the .NET AI community
- [](https://www.reddit.com/r/BetalgoDevelopers)
- [](https://github.com/betalgo/openai/discussions)
### Install Packages
#### Core Library
⚠️ We now have new PackageId and new Namespace. ⚠️
⚠️ `Betalgo.OpenAI` is now `Betalgo.Ranul.OpenAI` ⚠️
[](https://www.nuget.org/packages/Betalgo.Ranul.OpenAI/)
```shell
Install-Package Betalgo.Ranul.OpenAI
```
#### Experimental Utilities Library
[](https://www.nuget.org/packages/Betalgo.OpenAI.Utilities/)
```shell
Install-Package Betalgo.OpenAI.Utilities
```
## Documentation and Links
- [Realtime API](https://github.com/betalgo/openai/wiki/realtime) ✨NEW
- [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)
- [Migration Guide for Breaking Changes](https://github.com/betalgo/openai/wiki/Migration-Guides-for-breaking-changes)
---
## 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
### 9.0.1
- Message list now accept RunId
- Upgraded to Microsoft.Extensions.AI version 9.0.1, which resolves the "Method not found: '!!0" error when used alongside other SDKs with different versions.
### 9.0.0
- .NET 9 support added.
- ⚠️ Support for .NET 6 and .NET 7 has ended.
- Fixed utility library issues and synced with latest version.
### 8.10.1
- Fixed an issue with the `Store` parameter being included in requests by default, causing errors with Azure OpenAI models. The parameter is now optional and excluded from serialization unless explicitly set.
### 8.10.0
- Added support for `Microsoft.Extensions.AI` `IChatClient` and `IEmbeddingGenerator` (more information will be coming soon to the Wiki).
- Added missing `Temperature` and `TopP` parameters to `AssistantResponse`.
- Added missing `Store` parameter to `ChatCompletionCreateRequest`.
- Breaking Changes:
- ⚠️ `CreatedAt` parameter renamed to `CreatedAtUnix` and converted to `long` instead of `int`. Added `CreatedAt` parameter as `DateTimeOffset` type, which will automatically convert Unix time to `DateTime`.
### 8.9.0
- Realtime API implementation is completed. As usual this is the first version and it may contain bugs. Please report any issues you encounter.
- [Realtime Sample](https://github.com/betalgo/openai/wiki/realtime)
### 8.8.0
- **Compatibility Enhancement**: You can now use this library alongside the official OpenAI library and/or Semantic Kernel within the same project. The name changes in this update support this feature.
- **Namespace and Package ID Update**: The namespace and PackageId have been changed from `Betalgo.OpenAI` to `Betalgo.Ranul.OpenAI`.
- **OpenAI Naming Consistency**: We've standardized the use of "OpenAI" throughout the library, replacing any instances of "OpenAi" or other variations.
- **Migration Instructions**: Intellisense should assist you in updating your code. If it doesn't, please make the following changes manually:
- Switch to the new NuGet package: `Betalgo.Ranul.OpenAI` instead of `Betalgo.OpenAI`.
- Update all namespaces from `OpenAI` to `Betalgo.Ranul.OpenAI`.
- Replace all occurrences of "OpenAi", "Openai", or any other variations with "OpenAI".
- **Need Help?**: If you encounter any issues, feel free to reach out via our Discord channel, Reddit channel, or GitHub discussions. We're happy to assist.
- **Feedback Welcomed**: If you notice any mistakes or missing name changes, please create an issue to let us know.
- **Utilities Library Status**: Please note that the Utilities library might remain broken for a while. I will focus on fixing it after completing the real-time API implementation.
### [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/)