OpenAI-DotNet 4.2.0 (#16)

- Fixed missing completions namespace
- Fixed missing image edit response disposal
- misc formatting

OpenAI-DotNet-Tests/TestFixture_01_Models.cs

@@ -1,24 +1,25 @@
 using NUnit.Framework;
 using System;
+using System.Threading.Tasks;
 
 namespace OpenAI.Tests
 {
     internal class TestFixture_01_Models
     {
         [Test]
-        public void Test_1_GetModels()
+        public async Task Test_1_GetModels()
         {
             var api = new OpenAIClient(OpenAIAuthentication.LoadFromEnv());
-            var results = api.ModelsEndpoint.GetModelsAsync().Result;
+            var results = await api.ModelsEndpoint.GetModelsAsync();
             Assert.IsNotNull(results);
             Assert.NotZero(results.Count);
         }
 
         [Test]
-        public void Test_2_RetrieveModelDetails()
+        public async Task Test_2_RetrieveModelDetails()
         {
             var api = new OpenAIClient(OpenAIAuthentication.LoadFromEnv());
-            var models = api.ModelsEndpoint.GetModelsAsync().Result;
+            var models = await api.ModelsEndpoint.GetModelsAsync();
 
             Console.WriteLine($"Found {models.Count} models!");
 
@@ -28,7 +29,7 @@ public void Test_2_RetrieveModelDetails()
 
                 try
                 {
-                    var result = api.ModelsEndpoint.GetModelDetailsAsync(model.Id).Result;
+                    var result = await api.ModelsEndpoint.GetModelDetailsAsync(model.Id);
                     Assert.IsNotNull(result);
                 }
                 catch (Exception e)

OpenAI-DotNet-Tests/TestFixture_02_Completions.cs

@@ -1,4 +1,5 @@
 using NUnit.Framework;
+using OpenAI.Completions;
 using OpenAI.Models;
 using System;
 using System.Collections.Generic;

OpenAI-DotNet-Tests/TestFixture_03_Edits.cs

@@ -1,18 +1,19 @@
 using NUnit.Framework;
 using OpenAI.Edits;
 using System;
+using System.Threading.Tasks;
 
 namespace OpenAI.Tests
 {
     internal class TestFixture_03_Edits
     {
         [Test]
-        public void Test_1_GetBasicEdit()
+        public async Task Test_1_GetBasicEdit()
         {
             var api = new OpenAIClient(OpenAIAuthentication.LoadFromEnv());
             Assert.IsNotNull(api.EditsEndpoint);
             var request = new EditRequest("What day of the wek is it?", "Fix the spelling mistakes");
-            var result = api.EditsEndpoint.CreateEditAsync(request).Result;
+            var result = await api.EditsEndpoint.CreateEditAsync(request);
             Assert.IsNotNull(result);
             Assert.NotNull(result.Choices);
             Assert.NotZero(result.Choices.Count);

OpenAI-DotNet-Tests/TestFixture_04_Images.cs

@@ -2,18 +2,19 @@
 using OpenAI.Images;
 using System;
 using System.IO;
+using System.Threading.Tasks;
 
 namespace OpenAI.Tests
 {
     internal class TestFixture_04_Images
     {
         [Test]
-        public void Test_1_GenerateImages()
+        public async Task Test_1_GenerateImages()
         {
             var api = new OpenAIClient(OpenAIAuthentication.LoadFromEnv());
             Assert.IsNotNull(api.ImagesEndPoint);
 
-            var results = api.ImagesEndPoint.GenerateImageAsync("A house riding a velociraptor", 1, ImageSize.Small).Result;
+            var results = await api.ImagesEndPoint.GenerateImageAsync("A house riding a velociraptor", 1, ImageSize.Small);
 
             Assert.IsNotNull(results);
             Assert.NotZero(results.Count);
@@ -25,15 +26,15 @@ public void Test_1_GenerateImages()
         }
 
         [Test]
-        public void Test_2_GenerateImageEdits()
+        public async Task Test_2_GenerateImageEdits()
         {
             var api = new OpenAIClient(OpenAIAuthentication.LoadFromEnv());
             Assert.IsNotNull(api.ImagesEndPoint);
 
             var imageAssetPath = Path.GetFullPath("..\\..\\..\\Assets\\image_edit_original.png");
             var maskAssetPath = Path.GetFullPath("..\\..\\..\\Assets\\image_edit_mask.png");
 
-            var results = api.ImagesEndPoint.CreateImageEditAsync(Path.GetFullPath(imageAssetPath), Path.GetFullPath(maskAssetPath), "A sunlit indoor lounge area with a pool containing a flamingo", 1, ImageSize.Small).Result;
+            var results = await api.ImagesEndPoint.CreateImageEditAsync(Path.GetFullPath(imageAssetPath), Path.GetFullPath(maskAssetPath), "A sunlit indoor lounge area with a pool containing a flamingo", 1, ImageSize.Small);
 
             Assert.IsNotNull(results);
             Assert.NotZero(results.Count);
@@ -45,14 +46,14 @@ public void Test_2_GenerateImageEdits()
         }
 
         [Test]
-        public void Test_3_GenerateImageVariations()
+        public async Task Test_3_GenerateImageVariations()
         {
             var api = new OpenAIClient(OpenAIAuthentication.LoadFromEnv());
             Assert.IsNotNull(api.ImagesEndPoint);
 
             var imageAssetPath = Path.GetFullPath("..\\..\\..\\Assets\\image_edit_original.png");
 
-            var results = api.ImagesEndPoint.CreateImageVariationAsync(imageAssetPath, 1, ImageSize.Small).Result;
+            var results = await api.ImagesEndPoint.CreateImageVariationAsync(imageAssetPath, 1, ImageSize.Small);
 
             Assert.IsNotNull(results);
             Assert.NotZero(results.Count);

OpenAI-DotNet-Tests/TestFixture_05_Embeddings.cs

@@ -1,15 +1,16 @@
-using NUnit.Framework;
+using System.Threading.Tasks;
+using NUnit.Framework;
 
 namespace OpenAI.Tests
 {
     internal class TestFixture_05_Embeddings
     {
         [Test]
-        public void Test_1_CreateEmbedding()
+        public async Task Test_1_CreateEmbedding()
         {
             var api = new OpenAIClient(OpenAIAuthentication.LoadFromEnv());
             Assert.IsNotNull(api.EmbeddingsEndpoint);
-            var result = api.EmbeddingsEndpoint.CreateEmbeddingAsync("The food was delicious and the waiter...").Result;
+            var result = await api.EmbeddingsEndpoint.CreateEmbeddingAsync("The food was delicious and the waiter...");
             Assert.IsNotNull(result);
             Assert.IsNotEmpty(result.Data);
         }

OpenAI-DotNet/AuthInfo.cs

@@ -1,12 +1,11 @@
-using System;
-using System.Security.Authentication;
+using System.Security.Authentication;
 using System.Text.Json.Serialization;
 
 namespace OpenAI
 {
-    [Serializable]
     internal class AuthInfo
     {
+        [JsonConstructor]
         public AuthInfo(string apiKey, string organization = null)
         {
             if (!apiKey.Contains("sk-"))
@@ -28,9 +27,9 @@ public AuthInfo(string apiKey, string organization = null)
         }
 
         [JsonPropertyName("apiKey")]
-        public string ApiKey { get; set; }
+        public string ApiKey { get; }
 
         [JsonPropertyName("organization")]
-        public string Organization { get; set; }
+        public string Organization { get; }
     }
-}
+}

OpenAI-DotNet/BaseEndPoint.cs

@@ -16,4 +16,4 @@ public abstract class BaseEndPoint
         /// <returns>The completed basic url for the endpoint.</returns>
         protected abstract string GetEndpoint();
     }
-}
+}

OpenAI-DotNet/BaseResponse.cs

@@ -23,4 +23,4 @@ public abstract class BaseResponse
         [JsonIgnore]
         public string RequestId { get; internal set; }
     }
-}
+}

OpenAI-DotNet/Completions/Choice.cs

@@ -1,6 +1,6 @@
 using System.Text.Json.Serialization;
 
-namespace OpenAI
+namespace OpenAI.Completions
 {
     /// <summary>
     /// Represents a completion choice returned by the <see cref="CompletionsEndpoint"/>.
@@ -34,8 +34,8 @@ public sealed class Choice
         /// <summary>
         /// Gets the main text of this completion
         /// </summary>
-        public override string ToString() => $"{Index}|{FinishReason}|{Text}";
+        public override string ToString() => Text;
 
         public static implicit operator string(Choice choice) => choice.Text;
     }
-}
+}

OpenAI-DotNet/Completions/CompletionRequest.cs

@@ -4,7 +4,7 @@
 using System.Linq;
 using System.Text.Json.Serialization;
 
-namespace OpenAI
+namespace OpenAI.Completions
 {
     /// <summary>
     /// Represents a request to the <see cref="CompletionsEndpoint"/>.  Mostly matches the parameters in
@@ -20,7 +20,7 @@ public sealed class CompletionRequest
         /// If you are requesting more than one prompt, specify them as an array of strings.
         /// </summary>
         [JsonPropertyName("prompt")]
-        public string[] Prompts { get; set; } = new string[0];
+        public string[] Prompts { get; set; } = Array.Empty<string>();
 
         /// <summary>
         /// For convenience, if you are only requesting a single prompt, set it here

OpenAI-DotNet/Completions/CompletionResult.cs

@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using System.Text.Json.Serialization;
 
-namespace OpenAI
+namespace OpenAI.Completions
 {
     /// <summary>
     /// Represents a result from calling the <see cref="CompletionsEndpoint"/>.

OpenAI-DotNet/Completions/CompletionsEndpoint.cs

@@ -6,7 +6,7 @@
 using System.Text.Json;
 using System.Threading.Tasks;
 
-namespace OpenAI
+namespace OpenAI.Completions
 {
     /// <summary>
     /// Text generation is the core function of the API. You give the API a prompt, and it generates a completion.
@@ -16,7 +16,7 @@ namespace OpenAI
     /// (see the prompt library for inspiration).
     /// <see href="https://beta.openai.com/docs/api-reference/completions"/>
     /// </summary>
-    public class CompletionsEndpoint : BaseEndPoint
+    public sealed class CompletionsEndpoint : BaseEndPoint
     {
         /// <inheritdoc />
         internal CompletionsEndpoint(OpenAIClient api) : base(api) { }
@@ -71,8 +71,7 @@ public async Task<CompletionResult> CreateCompletionAsync(
             int? logProbabilities = null,
             bool? echo = null,
             string[] stopSequences = null,
-            Model model = null
-        )
+            Model model = null)
         {
             var request = new CompletionRequest(
                 model ?? Api.DefaultModel,
@@ -354,7 +353,7 @@ public async IAsyncEnumerable<CompletionResult> StreamCompletionEnumerableAsync(
 
         private CompletionResult DeserializeResult(HttpResponseMessage response, string result)
         {
-            var completionResult = JsonSerializer.Deserialize<CompletionResult>(result);
+            var completionResult = JsonSerializer.Deserialize<CompletionResult>(result, Api.JsonSerializationOptions);
 
             if (completionResult?.Completions == null || completionResult.Completions.Count == 0)
             {

OpenAI-DotNet/Completions/Logprobs.cs

@@ -1,7 +1,7 @@
 using System.Collections.Generic;
 using System.Text.Json.Serialization;
 
-namespace OpenAI
+namespace OpenAI.Completions
 {
     /// <summary>
     /// Object belonging to a <see cref="Choice"/>
@@ -20,4 +20,4 @@ public sealed class Logprobs
         [JsonPropertyName("text_offset")]
         public List<int> TextOffsets { get; set; }
     }
-}
+}

OpenAI-DotNet/Edits/Choice.cs

@@ -17,4 +17,4 @@ public sealed class Choice
 
         public static implicit operator string(Choice choice) => choice.Text;
     }
-}
+}

OpenAI-DotNet/Edits/EditRequest.cs

@@ -80,4 +80,4 @@ public EditRequest(
         [JsonPropertyName("top_p")]
         public double? TopP { get; set; }
     }
-}
+}

OpenAI-DotNet/Edits/EditResponse.cs

@@ -35,4 +35,4 @@ public override string ToString()
                 : "Edit result has no valid output";
         }
     }
-}
+}

OpenAI-DotNet/Edits/EditsEndpoint.cs

@@ -2,6 +2,7 @@
 using System.Net.Http;
 using System.Text.Json;
 using System.Threading.Tasks;
+using OpenAI.Models;
 
 namespace OpenAI.Edits
 {

OpenAI-DotNet/Embeddings/Datum.cs

@@ -14,4 +14,4 @@ public sealed class Datum
         [JsonPropertyName("index")]
         public int Index { get; set; }
     }
-}
+}

OpenAI-DotNet/Embeddings/EmbeddingsRequest.cs

@@ -1,6 +1,6 @@
-using System;
+using OpenAI.Models;
+using System;
 using System.Text.Json.Serialization;
-using OpenAI.Models;
 
 namespace OpenAI.Embeddings
 {
@@ -43,4 +43,4 @@ public EmbeddingsRequest(string input, Model model = null, string user = null)
         [JsonPropertyName("user")]
         public string User { get; }
     }
-}
+}

OpenAI-DotNet/Embeddings/EmbeddingsResponse.cs

@@ -17,4 +17,4 @@ public sealed class EmbeddingsResponse : BaseResponse
         [JsonPropertyName("usage")]
         public Usage Usage { get; set; }
     }
-}
+}

OpenAI-DotNet/Event.cs

@@ -34,4 +34,4 @@ string message
         [JsonPropertyName("message")]
         public string Message { get; }
     }
-}
+}

OpenAI-DotNet/Files/FileData.cs

@@ -31,4 +31,4 @@ public sealed class FileData
 
         public static implicit operator string(FileData fileData) => fileData.Id;
     }
-}
+}

OpenAI-DotNet/Files/FileUploadRequest.cs

@@ -56,4 +56,4 @@ public void Dispose()
             GC.SuppressFinalize(this);
         }
     }
-}
+}

OpenAI-DotNet/Files/FilesEndpoint.cs

@@ -46,7 +46,7 @@ public async Task<IReadOnlyList<FileData>> ListFilesAsync()
 
             if (response.IsSuccessStatusCode)
             {
-                return JsonSerializer.Deserialize<FilesList>(resultAsString)?.Data;
+                return JsonSerializer.Deserialize<FilesList>(resultAsString, Api.JsonSerializationOptions)?.Data;
             }
 
             throw new HttpRequestException($"{nameof(ListFilesAsync)} Failed! HTTP status code: {response.StatusCode}.");

OpenAI-DotNet/FineTuning/CreateFineTuneJobRequest.cs

@@ -69,4 +69,4 @@ public CreateFineTuneJobRequest(
         [JsonPropertyName("suffix")]
         public string Suffix { get; set; }
     }
-}
+}

OpenAI-DotNet/FineTuning/FineTuneJob.cs

@@ -52,4 +52,4 @@ public sealed class FineTuneJob
         [JsonIgnore]
         public DateTime UpdatedAt => DateTimeOffset.FromUnixTimeSeconds(UpdatedAtUnixTime).DateTime;
     }
-}
+}

OpenAI-DotNet/FineTuning/FineTuneJobResponse.cs

@@ -71,4 +71,4 @@ public static implicit operator FineTuneJob(FineTuneJobResponse jobResponse)
         [JsonIgnore]
         public DateTime UpdatedAt => DateTimeOffset.FromUnixTimeSeconds(UpdatedAtUnixTime).DateTime;
     }
-}
+}