C#/.NET SDK for accessing the OpenAI APIs, including GPT-3.5/4, GPT-3.5/4-Turbo, and DALL-E 2/3

Quick Example

varapi=newOpenAI_API.OpenAIAPI("YOUR_API_KEY");varresult=awaitapi.Chat.CreateChatCompletionAsync("Hello!");Console.WriteLine(result);// should print something like "Hi! How can I help you?"

Readme

Status

Requirements

Getting started

Install from NuGet

Install-Package OpenAI-Version1.11.0

Authentication

OPENAI_API_KEY=sk-aaaabbbbbccccddddd

// for exampleOpenAIAPIapi=newOpenAIAPI("YOUR_API_KEY");// shorthand// orOpenAIAPIapi=newOpenAIAPI(newAPIAuthentication("YOUR_API_KEY"));// create object manually// orOpenAIAPIapi=newOpenAIAPI(APIAuthenticationLoadFromEnv());// use env vars// orOpenAIAPIapi=newOpenAIAPI(APIAuthenticationLoadFromPath());// use config file (can optionally specify where to look)// orOpenAIAPIapi=newOpenAIAPI();// uses default, env, or config file

// for exampleOpenAIAPIapi=newOpenAIAPI(newAPIAuthentication("YOUR_API_KEY","org-yourOrgHere"));

Chat API

Chat Conversations

varchat=api.Chat.CreateConversation();chat.Model=Model.GPT4_Turbo;chat.RequestParameters.Temperature=0;/// give instruction as Systemchat.AppendSystemMessage("You are a teacher who helps children understand if things are animals or not.  If the user tells you an animal, you say\"yes\".  If the user tells you something that is not an animal, you say\"no\".  You only ever respond with\"yes\" or\"no\".  You do not say anything else.");// give a few examples as user and assistantchat.AppendUserInput("Is this an animal? Cat");chat.AppendExampleChatbotOutput("Yes");chat.AppendUserInput("Is this an animal? House");chat.AppendExampleChatbotOutput("No");// now let's ask it a questionchat.AppendUserInput("Is this an animal? Dog");// and get the responsestringresponse=awaitchat.GetResponseFromChatbotAsync();Console.WriteLine(response);// "Yes"// and continue the conversation by asking anotherchat.AppendUserInput("Is this an animal? Chair");// and get another responseresponse=awaitchat.GetResponseFromChatbotAsync();Console.WriteLine(response);// "No"// the entire chat history is available in chat.Messagesforeach(ChatMessagemsginchat.Messages){Console.WriteLine($"{msg.Role}:{msg.Content}");}

Chat Streaming

varchat=api.Chat.CreateConversation();chat.AppendUserInput("How to make a hamburger?");awaitforeach(varresinchat.StreamResponseEnumerableFromChatbotAsync()){Console.Write(res);}

varchat=api.Chat.CreateConversation();chat.AppendUserInput("How to make a hamburger?");awaitchat.StreamResponseFromChatbotAsync(res=>{Console.Write(res);});

GPT Vision

// the simplest formvarresult=awaitapi.Chat.CreateChatCompletionAsync("What is the primary non-white color in this logo?",ImageInput.FromFile("path/to/logo.png"));// or in a conversationvarchat=api.Chat.CreateConversation();chat.Model=Model.GPT4_Vision;chat.AppendSystemMessage("You are a graphic design assistant who helps identify colors.");chat.AppendUserInput("What are the primary non-white colors in this logo?",ImageInput.FromFile("path/to/logo.png"));stringresponse=awaitchat.GetResponseFromChatbotAsync();Console.WriteLine(response);// "Blue and purple"chat.AppendUserInput("What are the primary non-white colors in this logo?",ImageInput.FromImageUrl("https://rogerpincombe.com/templates/rp/center-aligned-no-shadow-small.png"));response=awaitchat.GetResponseFromChatbotAsync();Console.WriteLine(response);// "Blue, red, and yellow"// or when manually creating the ChatMessagemessageWithImage=newChatMessage(ChatMessageRole.User,"What colors do these logos have in common?");messageWithImage.images.Add(ImageInput.FromFile("path/to/logo.png"));messageWithImage.images.Add(ImageInput.FromImageUrl("https://rogerpincombe.com/templates/rp/center-aligned-no-shadow-small.png"));// you can specify multiple images at oncechat.AppendUserInput("What colors do these logos have in common?",ImageInput.FromFile("path/to/logo.png"),ImageInput.FromImageUrl("https://rogerpincombe.com/templates/rp/center-aligned-no-shadow-small.png"));

Conversation History Context Length Management

chat.OnTruncationNeeded+=(sender,args)=>{// args is a List<ChatMessage> with the current chat history.  Remove or edit as nessisary.// replace this with more sophisticated logic for your use-case, such as summarizing the chat historyfor(inti=0;i<args.Count;i++){if(args[i].Role!=ChatMessageRole.System){args.RemoveAt(i);return;}}};

Chat Endpoint Requests

asyncTask<ChatResult>CreateChatCompletionAsync(ChatRequestrequest);// for examplevarresult=awaitapi.Chat.CreateChatCompletionAsync(newChatRequest(){Model=Model.ChatGPTTurbo,Temperature=0.1,MaxTokens=50,Messages=newChatMessage[]{newChatMessage(ChatMessageRole.User,"Hello!")}})// orvar result= api.Chat.CreateChatCompletionAsync("Hello!");varreply=results.Choices[0].Message;Console.WriteLine($"{reply.Role}:{reply.Content.Trim()}");// orConsole.WriteLine(results);

JSON Mode

ChatRequestchatRequest=newChatRequest(){Model=model,Temperature=0.0,MaxTokens=500,ResponseFormat=ChatRequest.ResponseFormats.JsonObject,Messages=newChatMessage[]{newChatMessage(ChatMessageRole.System,"You are a helpful assistant designed to output JSON."),newChatMessage(ChatMessageRole.User,"Who won the world series in 2020?  Return JSON of a 'wins' dictionary with the year as the numeric key and the winning team as the string value.")}};varresults=awaitapi.Chat.CreateChatCompletionAsync(chatRequest);Console.WriteLine(results);/* prints:{  "wins": {2020: "Los Angeles Dodgers"  }}*/

Completions API

asyncTask<CompletionResult>CreateCompletionAsync(CompletionRequestrequest);// for examplevarresult=awaitapi.Completions.CreateCompletionAsync(newCompletionRequest("One Two Three One Two",model:Model.CurieText,temperature:0.1));// orvarresult=awaitapi.Completions.CreateCompletionAsync("One Two Three One Two",temperature:0.1);// or other convenience overloads

Streaming

IAsyncEnumerable<CompletionResult>StreamCompletionEnumerableAsync(CompletionRequestrequest);// for exampleawaitforeach(vartokeninapi.Completions.StreamCompletionEnumerableAsync(newCompletionRequest("My name is Roger and I am a principal software engineer at Salesforce.  This is my resume:",Model.DavinciText,200,0.5,presencePenalty:0.1,frequencyPenalty:0.1))){Console.Write(token);}

asyncTaskStreamCompletionAsync(CompletionRequestrequest,Action<CompletionResult>resultHandler);// for exampleawaitapi.Completions.StreamCompletionAsync(newCompletionRequest("My name is Roger and I am a principal software engineer at Salesforce.  This is my resume:",Model.DavinciText,200,0.5,presencePenalty:0.1,frequencyPenalty:0.1),res=>ResumeTextbox.Text+=res.ToString());

Audio

Text to Speech (TTS)

awaitapi.TextToSpeech.SaveSpeechToFileAsync("Hello, brave new world!  This is a test.",outputPath);// You can open it in the defaul audio player like this:Process.Start(outputPath);

varrequest=newTextToSpeechRequest(){Input="Hello, brave new world!  This is a test.",ResponseFormat=ResponseFormats.AAC,Model=Model.TTS_HD,Voice=Voices.Nova,Speed=0.9};awaitapi.TextToSpeech.SaveSpeechToFileAsync(request,"test.aac");

using(Streamresult=awaitapi.TextToSpeech.GetSpeechAsStreamAsync("Hello, brave new world!",Voices.Fable))using(StreamReaderreader=newStreamReader(result)){// do something with the audio stream here}

Transcription (Speech to Text)

stringresultText=awaitapi.Transcriptions.GetTextAsync("path/to/file.mp3");

AudioResultVerboseresult=awaitapi.Transcriptions.GetWithDetailsAsync("path/to/file.m4a");Console.WriteLine(result.ProcessingTime.TotalMilliseconds);// 496msConsole.WriteLine(result.text);// "Hello, this is a test of the transcription function."Console.WriteLine(result.language);// "english"Console.WriteLine(result.segments[0].no_speech_prob);// 0.03712// etc

stringresult=awaitapi.Transcriptions.GetAsFormatAsync("path/to/file.m4a",AudioRequest.ResponseFormats.SRT);

// inlineresult=awaitapi.Transcriptions.GetTextAsync("conversation.mp3","en","This is a transcript of a conversation between a medical doctor and her patient: ",0.3);// set defaultsapi.Transcriptions.DefaultTranscriptionRequestArgs.Language="en";

using(varaudioStream=File.OpenRead("path-here.mp3")){returnawaitapi.Transcriptions.GetTextAsync(audioStream,"file.mp3");}

Translations (Non-English Speech to English Text)

stringresult=awaitapi.Translations.GetTextAsync("chinese-example.m4a");

Embeddings

asyncTask<EmbeddingResult>CreateEmbeddingAsync(EmbeddingRequestrequest);// for examplevarresult=awaitapi.Embeddings.CreateEmbeddingAsync(newEmbeddingRequest("A test text for embedding",model:Model.AdaTextEmbedding));// orvarresult=awaitapi.Embeddings.CreateEmbeddingAsync("A test text for embedding");

Moderation

asyncTask<ModerationResult>CreateEmbeddingAsync(ModerationRequestrequest);// for examplevarresult=awaitapi.Moderation.CallModerationAsync(newModerationRequest("A test text for moderating",Model.TextModerationLatest));// orvarresult=awaitapi.Moderation.CallModerationAsync("A test text for moderating");Console.WriteLine(result.results[0].MainContentFlag);

Files (for fine-tuning)

// uploadingasyncTask<File>UploadFileAsync(stringfilePath,stringpurpose="fine-tune");// for examplevarresponse=awaitapi.Files.UploadFileAsync("fine-tuning-data.jsonl");Console.Write(response.Id);//the id of the uploaded file// listingasyncTask<List<File>>GetFilesAsync();// for examplevarresponse=awaitapi.Files.GetFilesAsync();foreach(varfileinresponse){Console.WriteLine(file.Name);}

Images

asyncTask<ImageResult>CreateImageAsync(ImageGenerationRequestrequest);// for examplevarresult=awaitapi.ImageGenerations.CreateImageAsync(newImageGenerationRequest("A drawing of a computer writing a test",1,ImageSize._512));// orvarresult=awaitapi.ImageGenerations.CreateImageAsync("A drawing of a computer writing a test");Console.WriteLine(result.Data[0].Url);

DALL-E 3

asyncTask<ImageResult>CreateImageAsync(ImageGenerationRequestrequest);// for examplevarresult=awaitapi.ImageGenerations.CreateImageAsync(newImageGenerationRequest("A drawing of a computer writing a test",OpenAI_API.Models.Model.DALLE3,ImageSize._1024x1792,"hd"));// orvarresult=awaitapi.ImageGenerations.CreateImageAsync("A drawing of a computer writing a test",OpenAI_API.Models.Model.DALLE3);Console.WriteLine(result.Data[0].Url);

Azure

OpenAIAPIapi=OpenAIAPI.ForAzure("YourResourceName","deploymentId","api-key");api.ApiVersion="2023-03-15-preview";// needed to access chat endpoint on Azure

IHttpClientFactory

OpenAIAPIapi=newOpenAIAPI();api.HttpClientFactory=myIHttpClientFactoryObject;

Documentation

License