Update models including gpt-4-turbo and dalle-3

Author: OkGoDoIt

OpenAI_API/Chat/ChatEndpoint.cs

@@ -16,7 +16,7 @@ public class ChatEndpoint : EndpointBase, IChatEndpoint
 		/// <summary>
 		/// This allows you to set default parameters for every request, for example to set a default temperature or max tokens.  For every request, if you do not have a parameter set on the request but do have it set here as a default, the request will automatically pick up the default value.
 		/// </summary>
-		public ChatRequest DefaultChatRequestArgs { get; set; } = new ChatRequest() { Model = Model.ChatGPTTurbo };
+		public ChatRequest DefaultChatRequestArgs { get; set; } = new ChatRequest() { Model = Model.DefaultChatModel };
 
 		/// <summary>
 		/// The name of the endpoint, which is the final path segment in the API URL.  For example, "completions".
@@ -33,7 +33,7 @@ internal ChatEndpoint(OpenAIAPI api) : base(api) { }
 		/// Creates an ongoing chat which can easily encapsulate the conversation.  This is the simplest way to use the Chat endpoint.
 		/// </summary>
 		/// <param name="defaultChatRequestArgs">Allows setting the parameters to use when calling the ChatGPT API.  Can be useful for setting temperature, presence_penalty, and more.  See <see href="https://platform.openai.com/docs/api-reference/chat/create">OpenAI documentation for a list of possible parameters to tweak.</see></param>
-		/// <returns>A <see cref="Conversation"/> which encapulates a back and forth chat betwen a user and an assistant.</returns>
+		/// <returns>A <see cref="Conversation"/> which encapsulates a back and forth chat between a user and an assistant.</returns>
 		public Conversation CreateConversation(ChatRequest defaultChatRequestArgs = null)
 		{
 			return new Conversation(this, defaultChatRequestArgs: defaultChatRequestArgs ?? DefaultChatRequestArgs);

OpenAI_API/Chat/ChatRequest.cs

@@ -43,7 +43,7 @@ public class ChatRequest
 		public int? NumChoicesPerMessage { get; set; }
 
 		/// <summary>
-		/// Specifies where the results should stream and be returned at one time.  Do not set this yourself, use the appropriate methods on <see cref="CompletionEndpoint"/> instead.
+		/// Specifies where the results should stream and be returned at one time.  Do not set this yourself, use the appropriate methods on <see cref="OpenAI_API.Completions.CompletionEndpoint"/> instead.
 		/// </summary>
 		[JsonProperty("stream")]
 		public bool Stream { get; internal set; } = false;

OpenAI_API/Chat/Conversation.cs

@@ -49,15 +49,15 @@ public OpenAI_API.Models.Model Model
 		/// Creates a new conversation with ChatGPT chat
 		/// </summary>
 		/// <param name="endpoint">A reference to the API endpoint, needed for API requests.  Generally should be <see cref="OpenAIAPI.Chat"/>.</param>
-		/// <param name="model">Optionally specify the model to use for ChatGPT requests.  If not specified, used <paramref name="defaultChatRequestArgs"/>.Model or falls back to <see cref="OpenAI_API.Models.Model.ChatGPTTurbo"/></param>
+		/// <param name="model">Optionally specify the model to use for ChatGPT requests.  If not specified, used <paramref name="defaultChatRequestArgs"/>.Model or falls back to <see cref="OpenAI_API.Models.Model.DefaultChatModel"/></param>
 		/// <param name="defaultChatRequestArgs">Allows setting the parameters to use when calling the ChatGPT API.  Can be useful for setting temperature, presence_penalty, and more.  See <see href="https://platform.openai.com/docs/api-reference/chat/create">OpenAI documentation for a list of possible parameters to tweak.</see></param>
 		public Conversation(ChatEndpoint endpoint, OpenAI_API.Models.Model model = null, ChatRequest defaultChatRequestArgs = null)
 		{
 			RequestParameters = new ChatRequest(defaultChatRequestArgs);
 			if (model != null)
 				RequestParameters.Model = model;
 			if (RequestParameters.Model == null)
-				RequestParameters.Model = Models.Model.ChatGPTTurbo;
+				RequestParameters.Model = Models.Model.DefaultChatModel;
 
 			_Messages = new List<ChatMessage>();
 			_endpoint = endpoint;
@@ -66,9 +66,9 @@ public Conversation(ChatEndpoint endpoint, OpenAI_API.Models.Model model = null,
 		}
 
 		/// <summary>
-		/// A list of messages exchanged so far.  Do not modify this list directly.  Instead, use <see cref="AppendMessage(ChatMessage)"/>, <see cref="AppendUserInput(string)"/>, <see cref="AppendSystemMessage(string)"/>, or <see cref="AppendExampleChatbotOutput(string)"/>.
+		/// A list of messages exchanged so far. To append to this list, use <see cref="AppendMessage(ChatMessage)"/>, <see cref="AppendUserInput(string)"/>, <see cref="AppendSystemMessage(string)"/>, or <see cref="AppendExampleChatbotOutput(string)"/>.
 		/// </summary>
-		public IReadOnlyList<ChatMessage> Messages { get => _Messages; }
+		public IList<ChatMessage> Messages { get => _Messages; }
 		private List<ChatMessage> _Messages;
 
 		/// <summary>

OpenAI_API/Chat/IChatEndpoint.cs

@@ -19,7 +19,7 @@ public interface IChatEndpoint
 		/// Creates an ongoing chat which can easily encapsulate the conversation.  This is the simplest way to use the Chat endpoint.
 		/// </summary>
 		/// <param name="defaultChatRequestArgs">Allows setting the parameters to use when calling the ChatGPT API.  Can be useful for setting temperature, presence_penalty, and more.  See <see href="https://platform.openai.com/docs/api-reference/chat/create">OpenAI documentation for a list of possible parameters to tweak.</see></param>
-		/// <returns>A <see cref="Conversation"/> which encapulates a back and forth chat betwen a user and an assistant.</returns>
+		/// <returns>A <see cref="Conversation"/> which encapsulates a back and forth chat between a user and an assistant.</returns>
 		Conversation CreateConversation(ChatRequest defaultChatRequestArgs = null);
 
 

OpenAI_API/Completions/CompletionRequest.cs

@@ -13,7 +13,7 @@ public class CompletionRequest
 		/// ID of the model to use. You can use <see cref="ModelsEndpoint.GetModelsAsync()"/> to see all of your available models, or use a standard model like <see cref="Model.DavinciText"/>.
 		/// </summary>
 		[JsonProperty("model")]
-		public string Model { get; set; } = OpenAI_API.Models.Model.DavinciText;
+		public string Model { get; set; } = OpenAI_API.Models.Model.DefaultModel;
 
 		/// <summary>
 		/// This is only used for serializing the request into JSON, do not use it directly.

OpenAI_API/Images/IImageGenerationEndpoint.cs

@@ -1,4 +1,5 @@
 using System.Threading.Tasks;
+using OpenAI_API.Models;
 
 namespace OpenAI_API.Images
 {
@@ -18,7 +19,8 @@ public interface IImageGenerationEndpoint
 		/// Ask the API to Creates an image given a prompt.
 		/// </summary>
 		/// <param name="input">A text description of the desired image(s)</param>
+		/// <param name="model">The model to use for generating the image.  Defaults to <see cref="OpenAI_API.Models.Model.DALLE2"/>.</param>
 		/// <returns>Asynchronously returns the image result. Look in its <see cref="Data.Url"/> </returns>
-		Task<ImageResult> CreateImageAsync(string input);
+		Task<ImageResult> CreateImageAsync(string input, Model model = null);
 	}
 }

OpenAI_API/Images/ImageGenerationEndpoint.cs

@@ -26,10 +26,11 @@ internal ImageGenerationEndpoint(OpenAIAPI api) : base(api) { }
 		/// Ask the API to Creates an image given a prompt.
 		/// </summary>
 		/// <param name="input">A text description of the desired image(s)</param>
+		/// <param name="model">The model to use for generating the image.  Defaults to <see cref="OpenAI_API.Models.Model.DALLE2"/>.</param>
 		/// <returns>Asynchronously returns the image result. Look in its <see cref="Data.Url"/> </returns>
-		public async Task<ImageResult> CreateImageAsync(string input)
+		public async Task<ImageResult> CreateImageAsync(string input, Model model = null)
 		{
-			ImageGenerationRequest req = new ImageGenerationRequest(prompt: input);
+			ImageGenerationRequest req = new ImageGenerationRequest(prompt: input, model: model);
 			return await CreateImageAsync(req);
 		}
 

OpenAI_API/Images/ImageGenerationRequest.cs

@@ -7,22 +7,40 @@
 
 namespace OpenAI_API.Images
 {
-    /// <summary>
+	/// <summary>
 	/// Represents a request to the Images API.  Mostly matches the parameters in <see href="https://platform.openai.com/docs/api-reference/images/create">the OpenAI docs</see>, although some have been renamed or expanded into single/multiple properties for ease of use.
 	/// </summary>
-    public class ImageGenerationRequest
-    {
+	public class ImageGenerationRequest
+	{
+		private int? numOfImages = 1;
+		private ImageSize size = ImageSize._1024;
+		private string quality = "standard";
+
 		/// <summary>
 		/// A text description of the desired image(s). The maximum length is 1000 characters.
 		/// </summary>
 		[JsonProperty("prompt")]
 		public string Prompt { get; set; }
 
 		/// <summary>
-		/// How many different choices to request for each prompt.  Defaults to 1.
+		/// How many different choices to request for each prompt.  Defaults to 1.  Only for DALL-E 2.  For DALL-E 3, only 1 is allowed.
 		/// </summary>
 		[JsonProperty("n")]
-		public int? NumOfImages { get; set; } = 1;
+		public int? NumOfImages
+		{
+			get
+			{
+				if (this.Model == OpenAI_API.Models.Model.DALLE3 && numOfImages != 1)
+					throw new ArgumentException("For DALL-E 3, only 1 NumOfImages is allowed.");
+				return numOfImages;
+			}
+			set => numOfImages = value;
+		}
+		/// <summary>
+		/// The model to use for this request.  Defaults to DALL-E 2.
+		/// </summary>
+		[JsonProperty("model")]
+		public string Model { get; set; } = OpenAI_API.Models.Model.DALLE2;
 
 		/// <summary>
 		/// A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Optional.
@@ -31,10 +49,51 @@ public class ImageGenerationRequest
 		public string User { get; set; }
 
 		/// <summary>
-		/// The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024. Defauls to 1024x1024
+		/// The size of the generated images. Defaults to 1024x1024.
 		/// </summary>
 		[JsonProperty("size"), JsonConverter(typeof(ImageSize.ImageSizeJsonConverter))]
-		public ImageSize Size { get; set; }
+		public ImageSize Size
+		{
+			get
+			{
+				if (this.Model == OpenAI_API.Models.Model.DALLE3 && (this.size == ImageSize._256 || this.size == ImageSize._512))
+					throw new ArgumentException("For DALL-E 3, only 1024x1024, 1024x1792, or 1792x1024 is allowed.");
+				if (this.Model == OpenAI_API.Models.Model.DALLE2 && (this.size == ImageSize._1792x1024 || this.size == ImageSize._1024x1792))
+					throw new ArgumentException("For DALL-E 2, only 256x256, 512x512, or 1024x1024 is allowed.");
+				return size;
+			}
+			set => size = value;
+		}
+
+		/// <summary>
+		/// By default, images are generated at `standard` quality, but when using DALL·E 3 you can set quality to `hd` for enhanced detail. Square, standard quality images are the fastest to generate.
+		/// </summary>
+		[JsonProperty("quality", NullValueHandling=NullValueHandling.Ignore)]
+		public string Quality
+		{
+			get
+			{
+				if (this.Model == OpenAI_API.Models.Model.DALLE2 && this.quality == "hd")
+					throw new ArgumentException("For DALL-E 2, hd quality is not available.");
+				if (this.Model == OpenAI_API.Models.Model.DALLE3 && this.quality == "standard")
+					return null;
+				return quality;
+			}
+			set
+			{
+				switch (value.ToLower().Trim())
+				{
+					case "standard":
+						quality="standard";
+						break;
+					case "hd":
+						quality = "hd";
+						break;
+					default:
+						throw new ArgumentException("Quality must be either 'standard' or 'hd'.");
+				}
+			}
+		}
 
 		/// <summary>
 		/// The format in which the generated images are returned. Must be one of url or b64_json. Defaults to Url.
@@ -50,6 +109,47 @@ public ImageGenerationRequest()
 
 		}
 
+		/// <summary>
+		/// Creates a new <see cref="ImageGenerationRequest"/> with the specified parameters
+		/// </summary>
+		/// <param name="prompt">A text description of the desired image(s). The maximum length is 1000 characters.</param>
+		/// <param name="model">The model to use for this request. Defaults to DALL-E 2.</param>
+		/// <param name="size">The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.</param>
+		/// <param name="quality">By default, images are generated at `standard` quality, but when using DALL·E 3 you can set quality to `hd` for enhanced detail.</param>
+		/// <param name="user">A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.</param>
+		/// <param name="responseFormat">The format in which the generated images are returned. Must be one of url or b64_json.</param>
+		public ImageGenerationRequest(
+			string prompt,
+			Model model,
+			ImageSize size = null,
+			string quality = "standard",
+			string user = null,
+			ImageResponseFormat responseFormat = null)
+		{
+			this.Prompt = prompt;
+			this.Model = model ?? OpenAI_API.Models.Model.DALLE2;
+			this.Quality = quality ?? "standard";
+			this.User = user;
+			this.Size = size ?? ImageSize._1024;
+			this.ResponseFormat = responseFormat ?? ImageResponseFormat.Url;
+
+			// check for incompatible parameters
+			if (this.Model == OpenAI_API.Models.Model.DALLE3)
+			{
+				if (this.Size == ImageSize._256 || this.Size == ImageSize._512)
+					throw new ArgumentException("For DALL-E 3, only sizes 1024x1024, 1024x1792, or 1792x1024 are allowed.");
+				if (this.quality != "standard" && this.quality != "hd")
+					throw new ArgumentException("Quality must be one of 'standard' or 'hd'");
+			}
+			else
+			{
+				if (this.Size == ImageSize._1792x1024 || this.Size == ImageSize._1024x1792)
+					throw new ArgumentException("For DALL-E 2, only sizes 256x256, 512x512, or 1024x1024 are allowed.");
+				if (this.quality != "standard")
+					throw new ArgumentException("For DALL-E 2, only 'standard' quality is available");
+			}
+		}
+
 		/// <summary>
 		/// Creates a new <see cref="ImageGenerationRequest"/> with the specified parameters
 		/// </summary>

OpenAI_API/Images/ImageSize.cs

@@ -1,4 +1,5 @@
 using Newtonsoft.Json;
+using OpenAI_API.Models;
 using System;
 using System.Collections.Generic;
 using System.Text;
@@ -10,23 +11,33 @@ namespace OpenAI_API.Images
 	/// </summary>
 	public class ImageSize
 	{
-		private ImageSize(string value) { Value = value; }
+		internal ImageSize(string value) { Value = value; }
 
 		private string Value { get; set; }
 
 		/// <summary>
-		/// Requests an image that is 256x256
+		/// Only for DALL-E 2. Requests an image that is 256x256
 		/// </summary>
 		public static ImageSize _256 { get { return new ImageSize("256x256"); } }
 		/// <summary>
-		/// Requests an image that is 512x512
+		/// Only for DALL-E 2. Requests an image that is 512x512
 		/// </summary>
 		public static ImageSize _512 { get { return new ImageSize("512x512"); } }
 		/// <summary>
-		/// Requests and image that is 1024x1024
+		/// Works with both DALL-E 2 and 3. Requests and image that is 1024x1024.
 		/// </summary>
 		public static ImageSize _1024 { get { return new ImageSize("1024x1024"); } }
 
+		/// <summary>
+		/// Only for DALL-E 3. Requests a tall image that is 1024x1792.
+		/// </summary>
+		public static ImageSize _1024x1792 { get { return new ImageSize("1024x1792"); } }
+
+		/// <summary>
+		/// Only for DALL-E 3. Requests a wide image that is 1792x1024.
+		/// </summary>
+		public static ImageSize _1792x1024 { get { return new ImageSize("1792x1024"); } }
+
 		/// <summary>
 		/// Gets the string value for this size to pass to the API
 		/// </summary>
@@ -36,7 +47,37 @@ public override string ToString()
 			return Value;
 		}
 
+		/// <summary>
+		/// Returns true is the string value of the sizes match
+		/// </summary>
+		/// <param name="obj">The other object to compare to</param>
+		/// <returns>True is the sizes are the same</returns>
+		public override bool Equals(object obj)
+		{
+			if (obj is null)
+				return false;
+			else if (obj is ImageSize)
+				return this.Value.Equals(((ImageSize)obj).Value);
+			else if (obj is string)
+				return this.Value.Equals((string)obj);
+			else
+				return false;
+		}
+
+		/// <inheritdoc/>
+		public override int GetHashCode()
+		{
+			return Value.GetHashCode();
+		}
 
+		public static bool operator ==(ImageSize a, ImageSize b)
+		{
+			return a.Equals(b);
+		}
+		public static bool operator !=(ImageSize a, ImageSize b)
+		{
+			return !a.Equals(b);
+		}
 
 		/// <summary>
 		/// Gets the string value for this size to pass to the API