Merge pull request #31 from betalgo/dev

Version 6.5 Dall-E Support

OpenAI.Playground/OpenAI.Playground.csproj

@@ -30,6 +30,12 @@
     <None Update="SampleData\FineTuningSample1.jsonl">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Update="SampleData\image_edit_mask.png">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="SampleData\image_edit_original.png">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Update="SampleData\SentimentAnalysisSample.jsonl">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

OpenAI.Playground/Program.cs

@@ -24,7 +24,10 @@
 var serviceProvider = serviceCollection.BuildServiceProvider();
 var sdk = serviceProvider.GetRequiredService<IOpenAIService>();
 
-await ModelTestHelper.FetchModelsTest(sdk);
+//await ModelTestHelper.FetchModelsTest(sdk);
+//await ImageTestHelper.RunSimpleCreateImageTest(sdk);
+//await ImageTestHelper.RunSimpleCreateImageEditTest(sdk);
+await ImageTestHelper.RunSimpleCreateImageVariationTest(sdk);
 //await ModerationTestHelper.CreateModerationTest(sdk);
 //await CompletionTestHelper.RunSimpleCompletionTest(sdk);
 //await EmbeddingTestHelper.RunSimpleEmbeddingTest(sdk);

OpenAI.Playground/TestHelpers/ImageTestHelper.cs

@@ -0,0 +1,138 @@
+using OpenAI.GPT3.Interfaces;
+using OpenAI.GPT3.ObjectModels;
+using OpenAI.GPT3.ObjectModels.RequestModels;
+
+namespace OpenAI.Playground.TestHelpers
+{
+    internal static class ImageTestHelper
+    {
+        public static async Task RunSimpleCreateImageTest(IOpenAIService sdk)
+        {
+            ConsoleExtensions.WriteLine("Image Create Testing is starting:", ConsoleColor.Cyan);
+
+            try
+            {
+                ConsoleExtensions.WriteLine("Image Create Test:", ConsoleColor.DarkCyan);
+                var imageResult = await sdk.Image.CreateImage(new ImageCreateRequest
+                {
+                    Prompt = "Laser cat eyes",
+                    N = 2,
+                    Size = StaticValues.ImageStatics.Size.Size256,
+                    ResponseFormat = StaticValues.ImageStatics.ResponseFormat.Url,
+                    User = "TestUser"
+                });
+
+
+                if (imageResult.Successful)
+                {
+                    Console.WriteLine(string.Join("\n", imageResult.Results.Select(r => r.Url)));
+                }
+                else
+                {
+                    if (imageResult.Error == null)
+                    {
+                        throw new Exception("Unknown Error");
+                    }
+
+                    Console.WriteLine($"{imageResult.Error.Code}: {imageResult.Error.Message}");
+                }
+            }
+            catch (Exception e)
+            {
+                Console.WriteLine(e);
+                throw;
+            }
+        } 
+
+        public static async Task RunSimpleCreateImageEditTest(IOpenAIService sdk)
+        {
+            ConsoleExtensions.WriteLine("Image Edit Create Testing is starting:", ConsoleColor.Cyan);
+            const string maskFileName = "image_edit_mask.png";
+            const string originalFileName = "image_edit_original.png";
+
+            // Images should be in png format with ARGB. I got help from this website to generate sample mask
+            // https://www.online-image-editor.com/
+            var maskFile = await File.ReadAllBytesAsync($"SampleData/{maskFileName}");
+            var originalFile = await File.ReadAllBytesAsync($"SampleData/{originalFileName}");
+
+            try
+            {
+                ConsoleExtensions.WriteLine("Image  Edit Create Test:", ConsoleColor.DarkCyan);
+                var imageResult = await sdk.Image.CreateImageEdit(new ImageEditCreateRequest()
+                {
+                    Image = originalFile,
+                    ImageName = originalFileName,
+                    Mask = maskFile,
+                    MaskName = maskFileName,
+                    Prompt = "A sunlit indoor lounge area with a pool containing a cat",
+                    N = 4,
+                    Size = StaticValues.ImageStatics.Size.Size1024,
+                    ResponseFormat = StaticValues.ImageStatics.ResponseFormat.Url,
+                    User = "TestUser"
+                });
+
+
+                if (imageResult.Successful)
+                {
+                    Console.WriteLine(string.Join("\n", imageResult.Results.Select(r => r.Url)));
+                }
+                else
+                {
+                    if (imageResult.Error == null)
+                    {
+                        throw new Exception("Unknown Error");
+                    }
+
+                    Console.WriteLine($"{imageResult.Error.Code}: {imageResult.Error.Message}");
+                }
+            }
+            catch (Exception e)
+            {
+                Console.WriteLine(e);
+                throw;
+            }
+        }
+
+         public static async Task RunSimpleCreateImageVariationTest(IOpenAIService sdk)
+        {
+            ConsoleExtensions.WriteLine("Image Variation Create Testing is starting:", ConsoleColor.Cyan);
+            const string originalFileName = "image_edit_original.png";
+
+            var originalFile = await File.ReadAllBytesAsync($"SampleData/{originalFileName}");
+
+            try
+            {
+                ConsoleExtensions.WriteLine("Image Variation Create Test:", ConsoleColor.DarkCyan);
+                var imageResult = await sdk.Image.CreateImageVariation(new ImageVariationCreateRequest()
+                {
+                    Image = originalFile,
+                    ImageName = originalFileName,
+                    N = 2,
+                    Size = StaticValues.ImageStatics.Size.Size1024,
+                    ResponseFormat = StaticValues.ImageStatics.ResponseFormat.Url,
+                    User = "TestUser"
+                });
+
+
+                if (imageResult.Successful)
+                {
+                    Console.WriteLine(string.Join("\n", imageResult.Results.Select(r => r.Url)));
+                }
+                else
+                {
+                    if (imageResult.Error == null)
+                    {
+                        throw new Exception("Unknown Error");
+                    }
+
+                    Console.WriteLine($"{imageResult.Error.Code}: {imageResult.Error.Message}");
+                }
+            }
+            catch (Exception e)
+            {
+                Console.WriteLine(e);
+                throw;
+            }
+        }
+    }
+}

OpenAI.SDK/Interfaces/IImageService.cs

@@ -0,0 +1,42 @@
+using OpenAI.GPT3.ObjectModels.RequestModels;
+using OpenAI.GPT3.ObjectModels.ResponseModels.ImageResponseModel;
+
+namespace OpenAI.GPT3.Interfaces;
+
+/// <summary>
+///     Given a prompt and/or an input image, the model will generate a new image.
+///     Related guide: <a href="https://beta.openai.com/docs/guides/images">Image generation</a>
+/// </summary>
+public interface IImageService
+{
+    /// <summary>
+    ///     Creates an image given a prompt.
+    /// </summary>
+    /// <param name="imageCreate"></param>
+    /// <returns></returns>
+    Task<ImageCreateResponse> CreateImage(ImageCreateRequest imageCreate);
+
+    /// <summary>
+    ///     Creates an image given a prompt.
+    /// </summary>
+    /// <param name="prompt"></param>
+    /// <returns></returns>
+    Task<ImageCreateResponse> CreateImage(string prompt)
+    {
+        return CreateImage(new ImageCreateRequest(prompt));
+    }
+
+    /// <summary>
+    ///     Creates an edited or extended image given an original image and a prompt.
+    /// </summary>
+    /// <param name="imageEditCreateRequest"></param>
+    /// <returns></returns>
+    Task<ImageCreateResponse> CreateImageEdit(ImageEditCreateRequest imageEditCreateRequest);
+
+    /// <summary>
+    ///     Creates a variation of a given image.
+    /// </summary>
+    /// <param name="imageEditCreateRequest"></param>
+    /// <returns></returns>
+    Task<ImageCreateResponse> CreateImageVariation(ImageVariationCreateRequest imageEditCreateRequest);
+}

OpenAI.SDK/Interfaces/IOpenAIService.cs

@@ -29,6 +29,12 @@ public interface IOpenAIService
 
     public IModerationService Moderation { get; }
 
+    /// <summary>
+    ///     Given a prompt and/or an input image, the model will generate a new image.
+    /// </summary>
+    public IImageService Image  { get; }
+
+
     /// <summary>
     ///     Set default engine
     /// </summary>

OpenAI.SDK/Managers/OpenAIImage.cs

@@ -0,0 +1,57 @@
+using OpenAI.GPT3.Extensions;
+using OpenAI.GPT3.Interfaces;
+using OpenAI.GPT3.ObjectModels.RequestModels;
+using OpenAI.GPT3.ObjectModels.ResponseModels.ImageResponseModel;
+
+namespace OpenAI.GPT3.Managers;
+
+public partial class OpenAIService : IImageService
+{
+    /// <summary>
+    ///     Creates an image given a prompt.
+    /// </summary>
+    /// <param name="imageCreateModel"></param>
+    /// <returns></returns>
+    public async Task<ImageCreateResponse> CreateImage(ImageCreateRequest imageCreateModel)
+    {
+        return await _httpClient.PostAndReadAsAsync<ImageCreateResponse>(_endpointProvider.ImageCreate(), imageCreateModel);
+    }
+
+    /// <summary>
+    ///   Creates an edited or extended image given an original image and a prompt.
+    /// </summary>
+    /// <param name="imageEditCreateRequest"></param>
+    /// <returns></returns>
+    public async Task<ImageCreateResponse> CreateImageEdit(ImageEditCreateRequest imageEditCreateRequest)
+    {
+        var multipartContent = new MultipartFormDataContent();
+        if (imageEditCreateRequest.User != null) multipartContent.Add(new StringContent(imageEditCreateRequest.User), "user");
+        if (imageEditCreateRequest.ResponseFormat != null) multipartContent.Add(new StringContent(imageEditCreateRequest.ResponseFormat), "response_format");
+        if (imageEditCreateRequest.Size!= null) multipartContent.Add(new StringContent(imageEditCreateRequest.Size), "size");
+        if (imageEditCreateRequest.N!= null) multipartContent.Add(new StringContent(imageEditCreateRequest.N.ToString()!), "n");
+
+        multipartContent.Add(new StringContent(imageEditCreateRequest.Prompt), "prompt");
+        multipartContent.Add(new ByteArrayContent(imageEditCreateRequest.Image), "image", imageEditCreateRequest.ImageName);
+        multipartContent.Add(new ByteArrayContent(imageEditCreateRequest.Mask), "mask", imageEditCreateRequest.MaskName);
+
+        return await _httpClient.PostFileAndReadAsAsync<ImageCreateResponse>(_endpointProvider.ImageEditCreate(), multipartContent);
+    }
+
+    /// <summary>
+    ///   Creates a variation of a given image.
+    /// </summary>
+    /// <param name="imageEditCreateRequest"></param>
+    /// <returns></returns>
+    public async Task<ImageCreateResponse> CreateImageVariation(ImageVariationCreateRequest imageEditCreateRequest)
+    {
+        var multipartContent = new MultipartFormDataContent();
+        if (imageEditCreateRequest.User != null) multipartContent.Add(new StringContent(imageEditCreateRequest.User), "user");
+        if (imageEditCreateRequest.ResponseFormat != null) multipartContent.Add(new StringContent(imageEditCreateRequest.ResponseFormat), "response_format");
+        if (imageEditCreateRequest.Size!= null) multipartContent.Add(new StringContent(imageEditCreateRequest.Size), "size");
+        if (imageEditCreateRequest.N!= null) multipartContent.Add(new StringContent(imageEditCreateRequest.N.ToString()!), "n");
+
+        multipartContent.Add(new ByteArrayContent(imageEditCreateRequest.Image), "image", imageEditCreateRequest.ImageName);
+
+        return await _httpClient.PostFileAndReadAsAsync<ImageCreateResponse>(_endpointProvider.ImageVariationCreate(), multipartContent);
+    }
+}

OpenAI.SDK/Managers/OpenAIService.cs

@@ -55,6 +55,7 @@ public OpenAIService(OpenAiOptions settings, HttpClient? httpClient = null)
         public IFileService Files => this;
         public IFineTuneService FineTunes => this;
         public IModerationService Moderation => this;
+        public IImageService Image => this;
 
         public void SetDefaultEngineId(string engineId)
         {

OpenAI.SDK/ObjectModels/RequestModels/CompletionCreateRequest.cs

@@ -10,7 +10,7 @@ namespace OpenAI.GPT3.ObjectModels.RequestModels
     /// <summary>
     ///     Create Completion Request Model
     /// </summary>
-    public record CompletionCreateRequest : IModelValidate, IOpenAiModels.ITemperature, IOpenAiModels.IModel, IOpenAiModels.ILogProbs
+    public record CompletionCreateRequest : IModelValidate, IOpenAiModels.ITemperature, IOpenAiModels.IModel, IOpenAiModels.ILogProbs, IOpenAiModels.IUser
     {
         /// <summary>
         ///     The prompt(s) to generate completions for, encoded as a string, a list of strings, or a list of token lists.

OpenAI.SDK/ObjectModels/RequestModels/ImageCreateRequest.cs

@@ -0,0 +1,26 @@
+using System.Text.Json.Serialization;
+using OpenAI.GPT3.ObjectModels.SharedModels;
+
+namespace OpenAI.GPT3.ObjectModels.RequestModels
+{
+    /// <summary>
+    ///     Image Create Request Model
+    /// </summary>
+    public class ImageCreateRequest : SharedImageRequestBaseModel, IOpenAiModels.IUser
+    {
+        public ImageCreateRequest()
+        {
+        }
+
+        public ImageCreateRequest(string prompt)
+        {
+            Prompt = prompt;
+        }
+
+        /// <summary>
+        ///     A text description of the desired image(s). The maximum length is 1000 characters.
+        /// </summary>
+        [JsonPropertyName("prompt")]
+        public string Prompt { get; set; }
+    }
+}

OpenAI.SDK/ObjectModels/RequestModels/ImageEditCreateRequest.cs

@@ -0,0 +1,25 @@
+namespace OpenAI.GPT3.ObjectModels.RequestModels
+{
+    public class ImageEditCreateRequest : ImageCreateRequest
+    {
+        /// <summary>
+        ///     The image to edit. Must be a valid PNG file, less than 4MB, and square.
+        /// </summary>
+        public byte[] Image { get; set; }
+
+        /// <summary>
+        ///     Image file name
+        /// </summary>
+        public string ImageName { get; set; }
+        /// <summary>
+        ///     An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited.
+        ///     Must be a valid PNG file, less than 4MB, and have the same dimensions as image.
+        /// </summary>
+        public byte[] Mask { get; set; }
+
+        /// <summary>
+        ///     Mask file name
+        /// </summary>
+        public string MaskName { get; set; }
+    }
+}

OpenAI.SDK/ObjectModels/RequestModels/ImageVariationCreateRequest.cs

@@ -0,0 +1,17 @@
+using OpenAI.GPT3.ObjectModels.SharedModels;
+
+namespace OpenAI.GPT3.ObjectModels.RequestModels
+{
+    public class ImageVariationCreateRequest : SharedImageRequestBaseModel
+    {
+        /// <summary>
+        ///     The image to edit. Must be a valid PNG file, less than 4MB, and square.
+        /// </summary>
+        public byte[] Image { get; set; }
+
+        /// <summary>
+        ///     Image file name
+        /// </summary>
+        public string ImageName { get; set; }
+    }
+}

OpenAI.SDK/ObjectModels/ResponseModels/BaseResponse.cs

@@ -4,7 +4,7 @@ namespace OpenAI.GPT3.ObjectModels.ResponseModels
 {
     public record BaseResponse
     {
-        [JsonPropertyName("object")] public string ObjectTypeName { get; set; }
+        [JsonPropertyName("object")] public string? ObjectTypeName { get; set; }
         public bool Successful => Error == null;
         [JsonPropertyName("error")] public Error? Error { get; set; }
     }