Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PawanOsman/ChatGPT.Net
C# library for ChatGPT using official OpenAI API
https://github.com/PawanOsman/ChatGPT.Net
ai api chatgpt csharp dotnet free openai openai-api reverse-proxy
Last synced: 5 days ago
JSON representation
C# library for ChatGPT using official OpenAI API
- Host: GitHub
- URL: https://github.com/PawanOsman/ChatGPT.Net
- Owner: PawanOsman
- License: mit
- Created: 2022-12-18T16:42:50.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-29T06:34:34.000Z (5 months ago)
- Last Synced: 2024-11-01T16:09:36.406Z (12 days ago)
- Topics: ai, api, chatgpt, csharp, dotnet, free, openai, openai-api, reverse-proxy
- Language: C#
- Homepage: https://www.nuget.org/packages/ChatGPT.Net
- Size: 212 KB
- Stars: 379
- Watchers: 7
- Forks: 71
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- Awesome-ChatGPT - ChatGPT.Net
- awesome-chatgpt - ChatGPT.Net
- awesome-llm-and-aigc - PawanOsman/ChatGPT.Net
- awesome-llm-and-aigc - PawanOsman/ChatGPT.Net
README
# ChatGPT.Net - .Net Library for ChatGPT [[Discord](https://discord.pawan.krd)]
### Other versions [[NodeJS Version](https://github.com/PawanOsman/ChatGPT-Official)]
[](https://www.nuget.org/packages/ChatGPT.Net)
[](https://www.nuget.org/packages/ChatGPT.Net)
[](https://github.com/PawanOsman/ChatGPT.Net/issues)
[](https://github.com/PawanOsman/ChatGPT.Net/network)
[](https://github.com/PawanOsman/ChatGPT.Net/stargazers)
[](https://github.com/PawanOsman/ChatGPT.Net)
[](https://discord.pawan.krd)
## [Check the new Google Bard Chatbot!](https://github.com/PawanOsman/GoogleBard)
The ChatGPT.Net is a C# library for ChatGPT using official OpenAI API that allows developers to access ChatGPT, a chat-based large language model. With this API, developers can send queries to ChatGPT and receive responses in real-time, making it easy to integrate ChatGPT into their own applications.
```csharp
using ChatGPT.Net;
// ChatGPT Official API
var bot = new ChatGpt("");
var response = await bot.Ask("What is the weather like today?");
Console.WriteLine(response);
```
## Table of Contents
- [Features](#features)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [ChatGPT Official API](#chatgpt-official-api)
- [ChatGPT Unofficial API](#chatgpt-unofficial-api)
- [Configuration options](#configuration-options)
- [ChatGPT Official API](#chatgpt-official-api)
- [ChatGPT Unofficial API](#chatgpt-unofficial-api)
- [Examples](#examples)
- [ChatGPT Console App](#chatgpt-console-app)
- [Use a different model](#use-a-different-model)
- [Using ChatGPT Official API For Free](#using-chatgpt-official-api-for-free)
- [License](#license)
## Features
- Easy to use.
- Using official OpenAI API.
- Supports both free and pro accounts.
- Supports multiple accounts, and multiple conversations.
- Support response streaming, so you can get response while the model is still generating it.
## Getting Started
To install ChatGPT.Net, run the following command in the Package Manager Console:
```bash
Install-Package ChatGPT.Net
```
Alternatively, you can install it using the .NET Core command-line interface:
```bash
dotnet add package ChatGPT.Net
```
### Usage
### ChatGPT Official API
Here is a sample code showing how to use ChatGPT.Net:
```csharp
using ChatGPT.Net;
// ChatGPT Official API
var bot = new ChatGpt("");
// get response
var response = await bot.Ask("What is the weather like today?");
Console.WriteLine(response);
// stream response
await bot.AskStream(response => {
Console.WriteLine(response);
}, "What is the weather like today?");
// get response for a specific conversation
var response = await bot.Ask("What is the weather like today?", "conversation name");
Console.WriteLine(response);
// stream response for a specific conversation
await bot.AskStream(response => {
Console.WriteLine(response);
}, "What is the weather like today?", "conversation name");
// Set a system message
bot.SetConversationSystemMessage("conversation name", "You are a helpful assistant that provides clear and concise answers to questions.");
```
Some models can understand both text and images. To use this feature, you need to pass a list of content items that includes both text and images.
```csharp
// To stream responses with both image and text input, create a list of content items
var contentItems = new List();
// Each content item can be either "Text" type or "Image" type. Let's add text to inquire about the image
contentItems.Add(new ChatGptMessageContentItem()
{
Type = ChatGptMessageContentType.TEXT,
Text = "what is this image about?"
});
// Now, create another content item of "Image" type
var contentItemWithImage = new ChatGptMessageContentItem()
{
Type = ChatGptMessageContentType.IMAGE
};
// Set image by path
contentItemWithImage.SetImageFromFile("");
// Or set image by Url
contentItemWithImage.SetImageFromUrl("https://path-to-image.com/image.png");
// Or set base64 image url
contentItemWithImage.SetImageFromUrl("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA.....");
contentItems.Add(contentItemWithImage);
// Only specific models understand image input. Therefore, if you are using 'gpt-3.5-turbo' or similar model, switch or override the model before calling 'AskStream'. More details about `ChatGptOptions` (config) are covered in the next section.
config.Model = ChatGptModels.GPT_4_Vision_Preview;
var response = await bot.AskStream(response => {
Console.WriteLine(response);
}, contentItems, "conversation name");
```
### ChatGPT Unofficial API
Here is a sample code showing how to integrate (chat.openai.com) with your applications using ChatGPT.Net:
```csharp
using ChatGPT.Net;
// ChatGPT Official API
var bot = new ChatGptUnofficial("");
// get response
var response = await bot.Ask("What is the weather like today?");
Console.WriteLine(response);
// stream response
await bot.AskStream(response => {
Console.WriteLine(response);
}, "What is the weather like today?");
// get response for a specific conversation
var response = await bot.Ask("What is the weather like today?", "conversation name");
Console.WriteLine(response);
// stream response for a specific conversation
await bot.AskStream(response => {
Console.WriteLine(response);
}, "What is the weather like today?", "conversation name");
```
## Configuration options
### ChatGPT Official API
```csharp
ChatGptOptions
{
string BaseUrl; // Default: https://api.openai.com
string Model; // Default: gpt-3.5-turbo
double Temperature; // Default: 0.9;
double TopP; // Default: 1.0;
long MaxTokens; // Default: 64;
string[]? Stop; // Default: null;
double PresencePenalty; // Default: 0.0;
double FrequencyPenaltyl; // Default: 0.0;
}
```
### ChatGPT Unofficial API
```csharp
ChatGptUnofficialOptions
{
string BaseUrl; // Default: https://api.pawan.krd
string Model; // Default: text-davinci-002-render-sha
}
```
## Examples
### ChatGPT Console App
This is a simple console app that uses ChatGPT.Net to interact with ChatGPT.
```csharp
using ChatGPT.Net;
// ChatGPT Official API
var bot = new ChatGpt("");
var prompt = string.Empty;
while (true)
{
Console.Write("You: ");
prompt = Console.ReadLine();
if (prompt is null) break;
if (string.IsNullOrWhiteSpace(prompt)) break;
if (prompt == "exit") break;
Console.Write("ChatGPT: ");
await bot.AskStream(Console.Write, prompt, "default");
Console.WriteLine();
}
```
### Use a different model
You can use a different model by passing the model name to the constructor.
```csharp
var bot = new ChatGpt("", new ChatGptOptions
{
Model = "text-davinci-002-render-paid"
});
```
### Using ChatGPT Official API For Free
you can use ChatGPT Official API by setting the base url to a free reverse proxy server like [ChatGPT Free Reverse Proxy](https://github.com/PawanOsman/ChatGPT)
```csharp
var bot = new ChatGpt("", new ChatGptOptions
{
BaseUrl = "https://api.pawan.krd"
});
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details