/// <summary>
/// Ask the API to complete the prompt(s) using the specified request, and stream the results to the <paramref name="resultHandler"/> as they come in.
/// If you are not using C# 8 supporting async enumerables or if you are using the .NET Framework, you may need to use <see cref="StreamCompletionAsync(CompletionRequest, Action{CompletionResult})"/> instead.
/// </summary>
/// <param name="request">The request to send to the API. This does not fall back to default values specified in <see cref="DefaultCompletionRequestArgs"/>.</param>
/// <returns>An async enumerable with each of the results as they come in. See <seealso cref="https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-8#asynchronous-streams"/> for more deatils on how to consume an async enumerable.</returns>
/*
* public async IAsyncEnumerable<CompletionResult> StreamCompletionEnumerableAsync(CompletionRequest request)
* {
* if (Api.Auth?.GetKey() is null)
* {
* throw new AuthenticationException("You must provide API authentication. Please refer to https://github.com/OkGoDoIt/OpenAI-API-dotnet#authentication for details.");
* }
*
* request = new CompletionRequest(request) { Stream = true };
* HttpClient client = new HttpClient();
*
* string jsonContent = JsonConvert.SerializeObject(request, new JsonSerializerSettings() { NullValueHandling = NullValueHandling.Ignore });
* var stringContent = new StringContent(jsonContent, UnicodeEncoding.UTF8, "application/json");
*
* using (HttpRequestMessage req = new HttpRequestMessage(HttpMethod.Post, $"https://api.openai.com/v1/engines/{Api.UsingEngine.EngineName}/completions"))
* {
* req.Content = stringContent;
* req.Headers.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", Api.Auth.GetKey()); ;
* req.Headers.Add("User-Agent", "okgodoit/dotnet_openai_api");
*
* var response = await client.SendAsync(req, HttpCompletionOption.ResponseHeadersRead);
*
* if (response.IsSuccessStatusCode)
* {
* using (var stream = await response.Content.ReadAsStreamAsync())
* using (StreamReader reader = new StreamReader(stream))
* {
* string line;
* while ((line = await reader.ReadLineAsync()) != null)
* {
* if (line.StartsWith("data: "))
* line = line.Substring("data: ".Length);
* if (line == "[DONE]")
* {
* yield break;
* }
* else if (!string.IsNullOrWhiteSpace(line))
* {
* var res = JsonConvert.DeserializeObject<CompletionResult>(line.Trim());
* yield return res;
* }
* }
* }
* }
* else
* {
* throw new HttpRequestException("Error calling OpenAi API to get completion. HTTP status code: " + response.StatusCode.ToString() + ". Request body: " + jsonContent);
* }
* }
* }
*/
/// <summary>
/// Ask the API to complete the prompt(s) using the specified parameters.
/// Any non-specified parameters will fall back to default values specified in <see cref="DefaultCompletionRequestArgs"/> if present.
/// If you are not using C# 8 supporting async enumerables or if you are using the .NET Framework, you may need to use <see cref="StreamCompletionAsync(CompletionRequest, Action{CompletionResult})"/> instead.
/// </summary>
/// <param name="prompt">The prompt to generate from</param>
/// <param name="max_tokens">How many tokens to complete to. Can return fewer if a stop sequence is hit.</param>
/// <param name="temperature">What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer. It is generally recommend to use this or <paramref name="top_p"/> but not both.</param>
/// <param name="top_p">An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. It is generally recommend to use this or <paramref name="temperature"/> but not both.</param>
/// <param name="numOutputs">How many different choices to request for each prompt.</param>
/// <param name="presencePenalty">The scale of the penalty applied if a token is already present at all. Should generally be between 0 and 1, although negative numbers are allowed to encourage token reuse.</param>
/// <param name="frequencyPenalty">The scale of the penalty for how often a token is used. Should generally be between 0 and 1, although negative numbers are allowed to encourage token reuse.</param>
/// <param name="logProbs">Include the log probabilities on the logprobs most likely tokens, which can be found in <see cref="CompletionResult.Choices"/> -> <see cref="Choice.Logprobs"/>. So for example, if logprobs is 10, the API will return a list of the 10 most likely tokens. If logprobs is supplied, the API will always return the logprob of the sampled token, so there may be up to logprobs+1 elements in the response.</param>
/// <param name="stopSequences">One or more sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.</param>
/// <returns>An async enumerable with each of the results as they come in. See <see href="https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-8#asynchronous-streams">the C# docs</see> for more deatils on how to consume an async enumerable.</returns>
/*
* public IAsyncEnumerable<CompletionResult> StreamCompletionEnumerableAsync(string prompt,
* int? max_tokens = null,
* double? temperature = null,
* double? top_p = null,
* int? numOutputs = null,
* double? presencePenalty = null,
* double? frequencyPenalty = null,
* int? logProbs = null,
* params string[] stopSequences)
* {
* CompletionRequest request = new CompletionRequest(DefaultCompletionRequestArgs)
* {
* Prompt = prompt,
* MaxTokens = max_tokens ?? DefaultCompletionRequestArgs.MaxTokens,
* Temperature = temperature ?? DefaultCompletionRequestArgs.Temperature,
* TopP = top_p ?? DefaultCompletionRequestArgs.TopP,
* NumChoicesPerPrompt = numOutputs ?? DefaultCompletionRequestArgs.NumChoicesPerPrompt,
* PresencePenalty = presencePenalty ?? DefaultCompletionRequestArgs.PresencePenalty,
* FrequencyPenalty = frequencyPenalty ?? DefaultCompletionRequestArgs.FrequencyPenalty,
* Logprobs = logProbs ?? DefaultCompletionRequestArgs.Logprobs,
* MultipleStopSequences = stopSequences ?? DefaultCompletionRequestArgs.MultipleStopSequences,
* Stream = true
* };
* return StreamCompletionEnumerableAsync(request);
* }
*/
#endregion
#region Helpers
/// <summary>
/// Simply returns a string of the prompt followed by the best completion
/// </summary>
/// <param name="request">The request to send to the API. This does not fall back to default values specified in <see cref="DefaultCompletionRequestArgs"/>.</param>
/// <returns>A string of the prompt followed by the best completion</returns>
public async Task <string> CreateAndFormatCompletion(CompletionRequest request)
{
string prompt = request.Prompt;
var result = await CreateCompletionAsync(request);
return(prompt + result.ToString());
}
/// <summary>
/// Ask the API to complete the prompt(s) using the specified parameters. This is non-streaming, so it will wait until the API returns the full result. Any non-specified parameters will fall back to default values specified in <see cref="DefaultCompletionRequestArgs"/> if present.
/// </summary>
/// <param name="prompt">The prompt to generate from</param>
/// <param name="max_tokens">How many tokens to complete to. Can return fewer if a stop sequence is hit.</param>
/// <param name="temperature">What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer. It is generally recommend to use this or <paramref name="top_p"/> but not both.</param>
/// <param name="top_p">An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. It is generally recommend to use this or <paramref name="temperature"/> but not both.</param>
/// <param name="numOutputs">How many different choices to request for each prompt.</param>
/// <param name="presencePenalty">The scale of the penalty applied if a token is already present at all. Should generally be between 0 and 1, although negative numbers are allowed to encourage token reuse.</param>
/// <param name="frequencyPenalty">The scale of the penalty for how often a token is used. Should generally be between 0 and 1, although negative numbers are allowed to encourage token reuse.</param>
/// <param name="logProbs">Include the log probabilities on the logprobs most likely tokens, which can be found in <see cref="CompletionResult.Choices"/> -> <see cref="Choice.Logprobs"/>. So for example, if logprobs is 10, the API will return a list of the 10 most likely tokens. If logprobs is supplied, the API will always return the logprob of the sampled token, so there may be up to logprobs+1 elements in the response.</param>
/// <param name="stopSequences">One or more sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.</param>
/// <returns>Asynchronously returns the completion result. Look in its <see cref="CompletionResult.Choices"/> property for the completions.</returns>
public Task <CompletionResult> CreateCompletionAsync(string prompt,
int?max_tokens = null,
double?temperature = null,
double?top_p = null,
int?numOutputs = null,
double?presencePenalty = null,
double?frequencyPenalty = null,
int?logProbs = null,
params string[] stopSequences)
{
CompletionRequest request = new CompletionRequest(DefaultCompletionRequestArgs)
{
Prompt = prompt,
MaxTokens = max_tokens ?? DefaultCompletionRequestArgs.MaxTokens,
Temperature = temperature ?? DefaultCompletionRequestArgs.Temperature,
TopP = top_p ?? DefaultCompletionRequestArgs.TopP,
NumChoicesPerPrompt = numOutputs ?? DefaultCompletionRequestArgs.NumChoicesPerPrompt,
PresencePenalty = presencePenalty ?? DefaultCompletionRequestArgs.PresencePenalty,
FrequencyPenalty = frequencyPenalty ?? DefaultCompletionRequestArgs.FrequencyPenalty,
Logprobs = logProbs ?? DefaultCompletionRequestArgs.Logprobs,
MultipleStopSequences = stopSequences ?? DefaultCompletionRequestArgs.MultipleStopSequences
};
return(CreateCompletionAsync(request));
}
/// <summary>
/// Ask the API to complete the prompt(s) using the specified parameters.
/// Any non-specified parameters will fall back to default values specified in <see cref="DefaultCompletionRequestArgs"/> if present.
/// If you are not using C# 8 supporting async enumerables or if you are using the .NET Framework, you may need to use <see cref="StreamCompletionAsync(CompletionRequest, Action{CompletionResult})"/> instead.
/// </summary>
/// <param name="prompt">The prompt to generate from</param>
/// <param name="max_tokens">How many tokens to complete to. Can return fewer if a stop sequence is hit.</param>
/// <param name="temperature">What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer. It is generally recommend to use this or <paramref name="top_p"/> but not both.</param>
/// <param name="top_p">An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. It is generally recommend to use this or <paramref name="temperature"/> but not both.</param>
/// <param name="numOutputs">How many different choices to request for each prompt.</param>
/// <param name="presencePenalty">The scale of the penalty applied if a token is already present at all. Should generally be between 0 and 1, although negative numbers are allowed to encourage token reuse.</param>
/// <param name="frequencyPenalty">The scale of the penalty for how often a token is used. Should generally be between 0 and 1, although negative numbers are allowed to encourage token reuse.</param>
/// <param name="logProbs">Include the log probabilities on the logprobs most likely tokens, which can be found in <see cref="CompletionResult.Choices"/> -> <see cref="Choice.Logprobs"/>. So for example, if logprobs is 10, the API will return a list of the 10 most likely tokens. If logprobs is supplied, the API will always return the logprob of the sampled token, so there may be up to logprobs+1 elements in the response.</param>
/// <param name="echo">Echo back the prompt in addition to the completion.</param>
/// <param name="stopSequences">One or more sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.</param>
/// <returns>An async enumerable with each of the results as they come in. See <see href="https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-8#asynchronous-streams">the C# docs</see> for more details on how to consume an async enumerable.</returns>
public IAsyncEnumerable <CompletionResult> StreamCompletionEnumerableAsync(string prompt,
int?max_tokens = null,
double?temperature = null,
double?top_p = null,
int?numOutputs = null,
double?presencePenalty = null,
double?frequencyPenalty = null,
int?logProbs = null,
bool?echo = null,
params string[] stopSequences)
{
CompletionRequest request = new CompletionRequest(DefaultCompletionRequestArgs)
{
Prompt = prompt,
MaxTokens = max_tokens ?? DefaultCompletionRequestArgs.MaxTokens,
Temperature = temperature ?? DefaultCompletionRequestArgs.Temperature,
TopP = top_p ?? DefaultCompletionRequestArgs.TopP,
NumChoicesPerPrompt = numOutputs ?? DefaultCompletionRequestArgs.NumChoicesPerPrompt,
PresencePenalty = presencePenalty ?? DefaultCompletionRequestArgs.PresencePenalty,
FrequencyPenalty = frequencyPenalty ?? DefaultCompletionRequestArgs.FrequencyPenalty,
Logprobs = logProbs ?? DefaultCompletionRequestArgs.Logprobs,
Echo = echo ?? DefaultCompletionRequestArgs.Echo,
MultipleStopSequences = stopSequences ?? DefaultCompletionRequestArgs.MultipleStopSequences,
Stream = true
};
return(StreamCompletionEnumerableAsync(request));
}
/// <summary>
/// Ask the API to complete the prompt(s) using the specified promptes, with other paramets being drawn from default values specified in <see cref="DefaultCompletionRequestArgs"/> if present. This is non-streaming, so it will wait until the API returns the full result.
/// </summary>
/// <param name="prompts">One or more prompts to generate from</param>
/// <returns></returns>
public Task <CompletionResult> CreateCompletionAsync(params string[] prompts)
{
CompletionRequest request = new CompletionRequest(DefaultCompletionRequestArgs)
{
MultiplePrompts = prompts
};
return(CreateCompletionAsync(request));
}
/// <summary>
/// Ask the API to complete the prompt(s) using the specified request, and stream the results to the <paramref name="resultHandler"/> as they come in.
/// If you are not using C# 8 supporting async enumerables or if you are using the .NET Framework, you may need to use <see cref="StreamCompletionAsync(CompletionRequest, Action{CompletionResult})"/> instead.
/// </summary>
/// <param name="request">The request to send to the API. This does not fall back to default values specified in <see cref="DefaultCompletionRequestArgs"/>.</param>
/// <returns>An async enumerable with each of the results as they come in. See <seealso cref="https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-8#asynchronous-streams"/> for more deatils on how to consume an async enumerable.</returns>
public async IAsyncEnumerable <CompletionResult> StreamCompletionEnumerableAsync(CompletionRequest request)
{
if (Api.Auth?.GetKey() is null)
{
throw new AuthenticationException("You must provide API authentication. Please refer to https://github.com/OkGoDoIt/OpenAI-API-dotnet#authentication for details.");
}
request = new CompletionRequest(request)
{
Stream = true
};
HttpClient client = new HttpClient();
string jsonContent = JsonConvert.SerializeObject(request, new JsonSerializerSettings()
{
NullValueHandling = NullValueHandling.Ignore
});
var stringContent = new StringContent(jsonContent, UnicodeEncoding.UTF8, "application/json");
using (HttpRequestMessage req = new HttpRequestMessage(HttpMethod.Post, $"https://api.openai.com/v1/engines/{Api.UsingEngine.EngineName}/completions"))
{
req.Content = stringContent;
req.Headers.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", Api.Auth.GetKey());;
req.Headers.Add("User-Agent", "okgodoit/dotnet_openai_api");
var response = await client.SendAsync(req, HttpCompletionOption.ResponseHeadersRead);
if (response.IsSuccessStatusCode)
{
using (var stream = await response.Content.ReadAsStreamAsync())
using (StreamReader reader = new StreamReader(stream))
{
string line;
while ((line = await reader.ReadLineAsync()) != null)
{
if (line.StartsWith("data: "))
{
line = line.Substring("data: ".Length);
}
if (line == "[DONE]")
{
yield break;
}
else if (!string.IsNullOrWhiteSpace(line))
{
var res = JsonConvert.DeserializeObject <CompletionResult>(line.Trim());
yield return(res);
}
}
}
}
else
{
throw new HttpRequestException("Error calling OpenAi API to get completion. HTTP status code: " + response.StatusCode.ToString() + ". Request body: " + jsonContent);
}
}
}
/// <summary>
/// Ask the API to complete the prompt(s) using the specified request. This is non-streaming, so it will wait until the API returns the full result.
/// </summary>
/// <param name="request">The request to send to the API. This does not fall back to default values specified in <see cref="DefaultCompletionRequestArgs"/>.</param>
/// <returns>Asynchronously returns the completion result. Look in its <see cref="CompletionResult.Choices"/> property for the completions.</returns>
public async Task <CompletionResult> CreateCompletionAsync(CompletionRequest request)
{
if (Api.Auth?.GetKey() is null)
{
throw new AuthenticationException("You must provide API authentication. Please refer to https://github.com/OkGoDoIt/OpenAI-API-dotnet#authentication for details.");
}
request.Stream = false;
HttpClient client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", Api.Auth.GetKey());
client.DefaultRequestHeaders.Add("User-Agent", "okgodoit/dotnet_openai_api");
string jsonContent = JsonConvert.SerializeObject(request, new JsonSerializerSettings()
{
NullValueHandling = NullValueHandling.Ignore
});
var stringContent = new StringContent(jsonContent, UnicodeEncoding.UTF8, "application/json");
// UnityEngine.Debug.Log(jsonContent);
var response = await client.PostAsync($"https://api.openai.com/v1/engines/{Api.UsingEngine.EngineName}/completions", stringContent);
if (response.IsSuccessStatusCode)
{
string resultAsString = await response.Content.ReadAsStringAsync();
//UnityEngine.Debug.Log(resultAsString);
var res = JsonConvert.DeserializeObject <CompletionResult>(resultAsString);
try
{
res.Organization = response.Headers.GetValues("Openai-Organization").FirstOrDefault();
res.RequestId = response.Headers.GetValues("X-Request-ID").FirstOrDefault();
res.ProcessingTime = TimeSpan.FromMilliseconds(int.Parse(response.Headers.GetValues("Openai-Processing-Ms").First()));
}
catch (Exception) { }
return(res);
}
else
{
throw new HttpRequestException("Error calling OpenAi API to get completion. HTTP status code: " + response.StatusCode.ToString() + ". Request body: " + jsonContent);
}
}
/// <summary>
/// Ask the API to complete the prompt(s) using the specified request and a requested number of outputs. This is non-streaming, so it will wait until the API returns the full result.
/// </summary>
/// <param name="request">The request to send to the API. This does not fall back to default values specified in <see cref="DefaultCompletionRequestArgs"/>.</param>
/// <param name="numOutputs">Overrides <see cref="CompletionRequest.NumChoicesPerPrompt"/> as a convenience.</param>
/// <returns>Asynchronously returns the completion result. Look in its <see cref="CompletionResult.Choices"/> property for the completions, which should have a length equal to <paramref name="numOutputs"/>.</returns>
public Task <CompletionResult> CreateCompletionsAsync(CompletionRequest request)
{
return(CreateCompletionAsync(request));
}
/// <summary>
/// Ask the API to complete the prompt(s) using the specified request, and stream the results to the <paramref name="resultHandler"/> as they come in.
/// If you are on the latest C# supporting async enumerables, you may prefer the cleaner syntax of <see cref="StreamCompletionEnumerableAsync(CompletionRequest)"/> instead.
/// </summary>
/// <param name="request">The request to send to the API. This does not fall back to default values specified in <see cref="DefaultCompletionRequestArgs"/>.</param>
/// <param name="resultHandler">An action to be called as each new result arrives.</param>
public async Task StreamCompletionAsync(CompletionRequest request, Action <CompletionResult> resultHandler)
{
await StreamCompletionAsync(request, (i, res) => resultHandler(res));
}
/// <summary>
/// Ask the API to complete the prompt(s) using the specified request, and stream the results to the <paramref name="resultHandler"/> as they come in.
/// If you are on the latest C# supporting async enumerables, you may prefer the cleaner syntax of <see cref="StreamCompletionEnumerableAsync(CompletionRequest)"/> instead.
/// </summary>
/// <param name="request">The request to send to the API. This does not fall back to default values specified in <see cref="DefaultCompletionRequestArgs"/>.</param>
/// <param name="resultHandler">An action to be called as each new result arrives, which includes the index of the result in the overall result set.</param>
public async Task StreamCompletionAsync(CompletionRequest request, Action <int, CompletionResult> resultHandler)
{
// await Task.Run(async () =>
{
if (Api.Auth?.GetKey() is null)
{
throw new AuthenticationException("You must provide API authentication. Please refer to https://github.com/OkGoDoIt/OpenAI-API-dotnet#authentication for details.");
}
request = new CompletionRequest(request)
{
Stream = true
};
HttpClient client = new HttpClient();
string jsonContent = JsonConvert.SerializeObject(request, new JsonSerializerSettings()
{
NullValueHandling = NullValueHandling.Ignore
});
var stringContent = new StringContent(jsonContent, UnicodeEncoding.UTF8, "application/json");
using (HttpRequestMessage req = new HttpRequestMessage(HttpMethod.Post, $"https://api.openai.com/v1/engines/{Api.UsingEngine.EngineName}/completions"))
{
req.Content = stringContent;
req.Headers.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", Api.Auth.GetKey());;
req.Headers.Add("User-Agent", "okgodoit/dotnet_openai_api");
var response = await client.SendAsync(req, HttpCompletionOption.ResponseHeadersRead);
if (response.IsSuccessStatusCode)
{
int index = 0;
using (var stream = await response.Content.ReadAsStreamAsync())
using (StreamReader reader = new StreamReader(stream))
{
string line;
while ((line = await reader.ReadLineAsync()) != null)
{
if (line.StartsWith("data: "))
{
line = line.Substring("data: ".Length);
}
if (line == "[DONE]")
{
return;
}
else if (!string.IsNullOrWhiteSpace(line))
{
index++;
var res = JsonConvert.DeserializeObject <CompletionResult>(line.Trim());
try
{
res.Organization = response.Headers.GetValues("Openai-Organization").FirstOrDefault();
res.RequestId = response.Headers.GetValues("X-Request-ID").FirstOrDefault();
res.ProcessingTime = TimeSpan.FromMilliseconds(int.Parse(response.Headers.GetValues("Openai-Processing-Ms").First()));
}
catch (Exception) { }
resultHandler(index, res);
}
}
}
}
else
{
throw new HttpRequestException("Error calling OpenAi API to get completion. HTTP status code: " + response.StatusCode.ToString() + ". Request body: " + jsonContent);
}
}
}//);
}
/// <summary>
/// Ask the API to complete the prompt(s) using the specified request and a requested number of outputs. This is non-streaming, so it will wait until the API returns the full result.
/// </summary>
/// <param name="request">The request to send to the API. This does not fall back to default values specified in <see cref="DefaultCompletionRequestArgs"/>.</param>
/// <param name="numOutputs">Overrides <see cref="CompletionRequest.NumChoicesPerPrompt"/> as a convenience.</param>
/// <returns>Asynchronously returns the completion result. Look in its <see cref="CompletionResult.Choices"/> property for the completions, which should have a length equal to <paramref name="numOutputs"/>.</returns>
public Task <CompletionResult> CreateCompletionsAsync(CompletionRequest request, int numOutputs = 5)
{
request.NumChoicesPerPrompt = numOutputs;
return(CreateCompletionAsync(request));
}
