NGpt 1.6.0

NGpt - OpenAI ChatGPT Client for C# AI Developers

Table of Contents

1. Introduction
2. Features
3. Installation
4. Quickstart Examples
   • Chat - Simplest Example
   • Chat - More Complex Example
   • Chat - Multiple Response Options
   • Edit - Modify Text
   • Edit - Modify Code in C#
   • Edit - Modify Code or Text with Flexibility
   • Image - Create an Image Based on a Given Prompt
5. Support
6. License

Introduction

Thanks for downloading NGpt, OpenAI ChatGPT client for C# developers! We hope this library will help you to create amazing AI applications in C#.

NGpt is a powerful transient fault-tolerant .NET 6 OpenAI client that helps C# developers to use OpenAPI ChatGPT in their applications in seconds. All you need to know is your OpenAI apiKey. Download this package and start coding AI applications in C# today!

Features

• Easy integration with ChatGPT in OpenAI in your .NET applications
• Simplified API usage - Just use the Chat class and Completion method.
• Built specifically for C# developers
• Generate more than 1 completion option in a single response
• You can send more reqests than allowed, NGpt will handle it for you and send it with a proper delay. Transient HTTP errors handling with rety logic and exponential backoff.

Installation

Install the package from NuGet: Install-Package NGpt

Quickstart Examples

How to get API key and organization?

1. Go to: https://platform.openai.com/signup/
2. Sign in with your Google account
3. Go to https://platform.openai.com/account/api-keys

This is a QUICKSTART for C# DEVELOPERS to use OPENAI ChatGPT:

1. Replace the <API_KEY> and optionally <ORGANIZATION> with your own values that you can find on OpenAI website.
2. Copy the example code and paste it into your C# program in Visual Studio.
3. Run the application
4. Congratulations! You made your first call to OpenAI ChatGPT!
5. Experiment with your own requests and responses.

CHAT - the Simplest Example

using NGpt;

// Initialize the client with your API key.
var chat = new Chat("<API_KEY>");
// Get a response from ChatGPT
var responseFromOpenAI = chat.Complete("Say hello");

Console.WriteLine(responseFromOpenAI);

CHAT - more Complex Example - use it when you need more configuration flexibility

using NGpt;

// Initialize the client.
// Optionally you can pass the organization id as a second parameter.
var chat = new Chat("<API_KEY>");

// Create a completion request
var completionRequest = new ChatRequest()
{
    Messages = new ChatMessage[]
    {
        new ChatMessage()
        {
            Role = Role.User,
            Content = "Say this is a test!",
        }
    },
    Temperature = 0.7f,
    Model = ChatModel.GPT3_5Turbo
};

// Get the response
var response = chat.Complete(completionRequest);

// Extract the content
var content = response.Choices[0].Message.Content;

Console.WriteLine(content);

CHAT - example - generate 3 response options in a single OpenAPI request

using NGpt.ChatCompletion;
using NGpt;

// Optionally you can pass the organization id as a second parameter.
var chat = new Chat("<API_KEY>");

var completionRequest = new ChatRequest()
{
    Messages = new ChatMessage[]
    {
        new ChatMessage()
        {
            Role = Role.User,
            Content = "Create C# program that checks if a given number is prime number",
        },
    },
    Temperature = 0f,
    Model = ChatModel.GPT3_5Turbo,
    N = 3
};

var response = chat.Complete(completionRequest);

foreach(var choice in response.Choices)
{
    var content = choice.Message.Content;
    Console.WriteLine(content);
}

EDIT - ask GPT to modify specified text

using NGpt.Domain.Edit;

//Organization is optional parameter - you can skip it
var edit = new Edit("<API_KEY>", "<Organization>");

var response = edit.EditText("To bee or not to be.", "fix spelling");

//Displays: "To be or not to be.\n"
Console.WriteLine(response);

EDIT - ask GPT to modify specified Code in C#

using NGpt.Domain.Edit;

var edit = new Edit("<API_KEY>", "<Organization>");

var response = edit.EditCode("Console.WriteLine(\"Test\");", "Change it to dispay text: \"aaa\"");

//Displays: "Console.WriteLine(\"aaa\");\n"
Console.WriteLine(response);

EDIT - ask GPT to modify code or text.

Useful when you need a flexibility (for example you want to increase temperature to get more random results, or you want to increase N parameter to generate more alternative results)

using NGpt.Domain.Edit;

var edit = new Edit("<API_KEY>", "<Organization>");

var request = new EditRequest(EditModel.TextDavinciEdit001, "Change it to dispay text: \"aaa\"")
{
    Input = "Console.WriteLine(\"Test\");",
    Temperature = 0,
    N = 1,
    Top_p = 1
};

var response = edit.Edit(request);

//Displays: "Console.WriteLine(\"aaa\");\n"
Console.WriteLine(response);

IMAGE - DALL-E 2 - ask GPT to create an image based on a given prompt

// Create an instance of the Image class with the API key and organization.
var image = new Image("<API_KEY>", "<Organization>");

// Create a new ImageRequest object with a prompt, "Little Labrador dog",
// and set the properties for the number of images, response format, size, and user.
var imageRequest = new ImageRequest("Little Labrador dog")
{
    NumberOfImages = 1,
    ResponseFormat = ResponseFormatType.Url,
    Size = ImageSize.Size512x512,
    User = "Dariusz Kacban"
};

// Call the Generate method of the image object to request image generation
// based on the properties set in the imageRequest object.
var response = image.Generate(imageRequest);

// Extract the first URL from the response's Data property.
var url = response.Data.First().Url;

Support

If you have any issues or need help, please contact us: kontakt@pilsoft.platform

License

This project is licensed under the MIT License. See the LICENSE file for more information.