Update Engine to Model, deprecate the Search endpoint, get readme up to date, other minor fixes

Author: OkGoDoIt

OpenAI_API/Completions/CompletionEndpoint.cs

@@ -67,10 +67,10 @@ public class CompletionResult
 		public DateTime Created => DateTimeOffset.FromUnixTimeSeconds(CreatedUnixTime).DateTime;
 
 		/// <summary>
-		/// Which model was used to generate this result.  Be sure to check <see cref="Engine.ModelRevision"/> for the specific revision.
+		/// Which model was used to generate this result.
 		/// </summary>
 		[JsonProperty("model")]
-		public Engine Model { get; set; }
+		public Model Model { get; set; }
 
 		/// <summary>
 		/// The completions returned by the API.  Depending on your request, there may be 1 or many choices.

OpenAI_API/Completions/CompletionRequest.cs

@@ -0,0 +1,114 @@
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Net.Http;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace OpenAI_API
+{
+	/// <summary>
+	/// Represents a language model
+	/// </summary>
+	public class Model
+	{
+		/// <summary>
+		/// The id/name of the model
+		/// </summary>
+		[JsonProperty("id")]
+		public string ModelID { get; set; }
+
+        /// <summary>
+        /// The owner of this model.  Generally "openai" is a generic OpenAI model, or the organization if a custom or finetuned model.
+        /// </summary>
+        [JsonProperty("owned_by")]
+        public string OwnedBy { get; set; }
+
+        /// <summary>
+        /// Allows an model to be implicitly cast to the string of its <see cref="ModelID"/>
+        /// </summary>
+        /// <param name="model">The <see cref="Model"/> to cast to a string.</param>
+        public static implicit operator string(Model model)
+		{
+			return model?.ModelID;
+		}
+
+		/// <summary>
+		/// Allows a string to be implicitly cast as an <see cref="Model"/> with that <see cref="ModelID"/>
+		/// </summary>
+		/// <param name="name">The id/<see cref="ModelID"/> to use</param>
+		public static implicit operator Model(string name)
+		{
+			return new Model(name);
+		}
+
+		/// <summary>
+		/// Represents an Model with the given id/<see cref="ModelID"/>
+		/// </summary>
+		/// <param name="name">The id/<see cref="ModelID"/> to use.
+		///						If the <paramref name="name"/> contains a colon (as is the case in the API's <see cref="CompletionResult.Model"/> response),
+		///						the part before the colon is treated as the id/<see cref="ModelID"/> and the following portion is considered the <see cref="ModelRevision"/>
+		///	</param>
+		public Model(string name)
+		{
+			this.ModelID = name;
+		}
+
+		/// <summary>
+		/// Represents a generic Model/model
+		/// </summary>
+		public Model()
+		{
+
+		}
+
+
+
+        /// <summary>
+        /// Capable of very simple tasks, usually the fastest model in the GPT-3 series, and lowest cost
+        /// </summary>
+        public static Model AdaText => new Model("text-ada-001") { OwnedBy = "openai" };
+
+        /// <summary>
+        /// Capable of straightforward tasks, very fast, and lower cost.
+        /// </summary>
+        public static Model BabbageText => new Model("text-babbage-001") { OwnedBy = "openai" };
+
+        /// <summary>
+        /// Very capable, but faster and lower cost than Davinci.
+        /// </summary>
+        public static Model CurieText => new Model("text-curie-001") { OwnedBy = "openai" };
+
+        /// <summary>
+        /// Most capable GPT-3 model. Can do any task the other models can do, often with higher quality, longer output and better instruction-following. Also supports inserting completions within text.
+        /// </summary>
+        public static Model DavinciText => new Model("text-davinci-003") { OwnedBy = "openai" };
+
+        /// <summary>
+        /// Almost as capable as Davinci Codex, but slightly faster. This speed advantage may make it preferable for real-time applications.
+        /// </summary>
+        public static Model CushmanCode => new Model("code-cushman-001") { OwnedBy = "openai" };
+
+        /// <summary>
+        /// Most capable Codex model. Particularly good at translating natural language to code. In addition to completing code, also supports inserting completions within code.
+        /// </summary>
+        public static Model DavinciCode => new Model("code-davinci-002") { OwnedBy = "openai" };
+
+        /// <summary>
+        /// OpenAI offers one second-generation embedding model for use with the embeddings API endpoint.
+        /// </summary>
+        public static Model AdaTextEmbedding => new Model("text-embedding-ada-002") { OwnedBy = "openai" };
+
+
+
+        /// <summary>
+        /// Gets more details about this Model from the API, specifically properties such as <see cref="OwnedBy"/> and permissions.
+        /// </summary>
+        /// <param name="auth">API authentication in order to call the API endpoint.  If not specified, attempts to use a default.</param>
+        /// <returns>Asynchronously returns an Model with all relevant properties filled in</returns>
+        public async Task<Model> RetrieveModelDetailsAsync(APIAuthentication auth = null)
+		{
+			return await ModelsEndpoint.RetrieveModelDetailsAsync(this.ModelID, auth);
+		}		
+	}
+}

OpenAI_API/Completions/CompletionResult.cs

@@ -11,73 +11,77 @@
 namespace OpenAI_API
 {
 	/// <summary>
-	/// The API endpoint for querying available Engines/models
+	/// The API endpoint for querying available models
 	/// </summary>
-	public class EnginesEndpoint
+	public class ModelsEndpoint
 	{
 		OpenAIAPI Api;
 
 		/// <summary>
-		/// Constructor of the api endpoint.  Rather than instantiating this yourself, access it through an instance of <see cref="OpenAIAPI"/> as <see cref="OpenAIAPI.Engines"/>.
+		/// Constructor of the api endpoint.  Rather than instantiating this yourself, access it through an instance of <see cref="OpenAIAPI"/> as <see cref="OpenAIAPI.Models"/>.
 		/// </summary>
 		/// <param name="api"></param>
-		internal EnginesEndpoint(OpenAIAPI api)
+		internal ModelsEndpoint(OpenAIAPI api)
 		{
 			this.Api = api;
 		}
 
 		/// <summary>
-		/// List all engines via the API
+		/// List all models via the API
 		/// </summary>
-		/// <returns>Asynchronously returns the list of all <see cref="Engine"/>s</returns>
-		public Task<List<Engine>> GetEnginesAsync()
+		/// <returns>Asynchronously returns the list of all <see cref="Model"/>s</returns>
+		public Task<List<Model>> GetModelsAsync()
 		{
-			return GetEnginesAsync(Api?.Auth);
+			return GetModelsAsync(Api?.Auth);
 		}
 
 		/// <summary>
-		/// Get details about a particular Engine from the API, specifically properties such as <see cref="Engine.Owner"/> and <see cref="Engine.Ready"/>
+		/// Get details about a particular Model from the API, specifically properties such as <see cref="Model.Owner"/> and <see cref="Model.Ready"/>
 		/// </summary>
-		/// <param name="id">The id/name of the engine to get more details about</param>
-		/// <returns>Asynchronously returns the <see cref="Engine"/> with all available properties</returns>
-		public Task<Engine> RetrieveEngineDetailsAsync(string id)
+		/// <param name="id">The id/name of the model to get more details about</param>
+		/// <returns>Asynchronously returns the <see cref="Model"/> with all available properties</returns>
+		public Task<Model> RetrieveModelDetailsAsync(string id)
 		{
-			return RetrieveEngineDetailsAsync(id, Api?.Auth);
+			return RetrieveModelDetailsAsync(id, Api?.Auth);
 		}
 
 		/// <summary>
-		/// List all engines via the API
+		/// List all models via the API
 		/// </summary>
 		/// <param name="auth">API authentication in order to call the API endpoint.  If not specified, attempts to use a default.</param>
-		/// <returns>Asynchronously returns the list of all <see cref="Engine"/>s</returns>
-		public static async Task<List<Engine>> GetEnginesAsync(APIAuthentication auth = null)
+		/// <returns>Asynchronously returns the list of all <see cref="Model"/>s</returns>
+		public static async Task<List<Model>> GetModelsAsync(APIAuthentication auth = null)
 		{
-			HttpClient client = new HttpClient();
+            if (auth.ThisOrDefault()?.ApiKey is null)
+            {
+                throw new AuthenticationException("You must provide API authentication.  Please refer to https://github.com/OkGoDoIt/OpenAI-API-dotnet#authentication for details.");
+            }
+            HttpClient client = new HttpClient();
 			client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", auth.ThisOrDefault().ApiKey);
 			client.DefaultRequestHeaders.Add("User-Agent", "okgodoit/dotnet_openai_api");
             if (!string.IsNullOrEmpty(auth.ThisOrDefault().OpenAIOrganization)) client.DefaultRequestHeaders.Add("OpenAI-Organization", auth.ThisOrDefault().OpenAIOrganization);
 
-			var response = await client.GetAsync(@"https://api.openai.com/v1/engines");
+			var response = await client.GetAsync(@"https://api.openai.com/v1/models");
 			string resultAsString = await response.Content.ReadAsStringAsync();
 
 			if (response.IsSuccessStatusCode)
 			{
-				var engines = JsonConvert.DeserializeObject<JsonHelperRoot>(resultAsString).data;
-				return engines;
+				var models = JsonConvert.DeserializeObject<JsonHelperRoot>(resultAsString).data;
+				return models;
 			}
 			else
 			{
-				throw new HttpRequestException("Error calling OpenAi API to get list of engines.  HTTP status code: " + response.StatusCode.ToString() + ". Content: " + resultAsString);
+				throw new HttpRequestException("Error calling OpenAi API to get list of models.  HTTP status code: " + response.StatusCode.ToString() + ". Content: " + resultAsString);
 			}
 		}
 
 		/// <summary>
-		/// Get details about a particular Engine from the API, specifically properties such as <see cref="Engine.Owner"/> and <see cref="Engine.Ready"/>
+		/// Get details about a particular Model from the API, specifically properties such as <see cref="Model.Owner"/> and <see cref="Model.Ready"/>
 		/// </summary>
-		/// <param name="id">The id/name of the engine to get more details about</param>
+		/// <param name="id">The id/name of the model to get more details about</param>
 		/// <param name="auth">API authentication in order to call the API endpoint.  If not specified, attempts to use a default.</param>
-		/// <returns>Asynchronously returns the <see cref="Engine"/> with all available properties</returns>
-		public static async Task<Engine> RetrieveEngineDetailsAsync(string id, APIAuthentication auth = null)
+		/// <returns>Asynchronously returns the <see cref="Model"/> with all available properties</returns>
+		public static async Task<Model> RetrieveModelDetailsAsync(string id, APIAuthentication auth = null)
 		{
 			if (auth.ThisOrDefault()?.ApiKey is null)
 			{
@@ -87,17 +91,18 @@ public static async Task<Engine> RetrieveEngineDetailsAsync(string id, APIAuthen
 			HttpClient client = new HttpClient();
 			client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", auth.ThisOrDefault().ApiKey);
 			client.DefaultRequestHeaders.Add("User-Agent", "okgodoit/dotnet_openai_api");
+            if (!string.IsNullOrEmpty(auth.ThisOrDefault().OpenAIOrganization)) client.DefaultRequestHeaders.Add("OpenAI-Organization", auth.ThisOrDefault().OpenAIOrganization);
 
-			var response = await client.GetAsync(@"https://api.openai.com/v1/engines/" + id);
+            var response = await client.GetAsync(@"https://api.openai.com/v1/models/" + id);
 			if (response.IsSuccessStatusCode)
 			{
 				string resultAsString = await response.Content.ReadAsStringAsync();
-				var engine = JsonConvert.DeserializeObject<Engine>(resultAsString);
-				return engine;
+				var model = JsonConvert.DeserializeObject<Model>(resultAsString);
+				return model;
 			}
 			else
 			{
-				throw new HttpRequestException("Error calling OpenAi API to get engine details.  HTTP status code: " + response.StatusCode.ToString());
+				throw new HttpRequestException("Error calling OpenAi API to get model details.  HTTP status code: " + response.StatusCode.ToString());
 			}
 		}
 
@@ -107,7 +112,7 @@ public static async Task<Engine> RetrieveEngineDetailsAsync(string id, APIAuthen
 		private class JsonHelperRoot
 		{
 			[JsonProperty("data")]
-			public List<Engine> data { get; set; }
+			public List<Model> data { get; set; }
 			[JsonProperty("object")]
 			public string obj { get; set; }