Add enums handling to GetStructuredResponse, add new tests

Author: rodion-m

OpenAI.ChatGpt.Modules.StructuredResponse/OpenAiClientExtensions.GetAsObjectAsync.cs

@@ -1,4 +1,5 @@
 using System.Text.Json;
+using System.Text.Json.Serialization;
 using Json.Schema;
 using Json.Schema.Generation;
 using OpenAI.ChatGpt.Models.ChatCompletion;
@@ -97,7 +98,11 @@ internal static async Task<TObject> GetStructuredResponse<TObject>(
                 rawResponseGetter,
                 cancellationToken);
 
-            jsonDeserializerOptions ??= new JsonSerializerOptions { PropertyNameCaseInsensitive = true };
+            jsonDeserializerOptions ??= new JsonSerializerOptions
+            {
+                PropertyNameCaseInsensitive = true,
+                Converters = { new JsonStringEnumConverter() }
+            };
             var deserialized = JsonSerializer.Deserialize<TObject>(response, jsonDeserializerOptions);
             if (deserialized is null)
             {

tests/OpenAI.ChatGpt.IntegrationTests/OpenAiClientTests/OpenAiClient_GetAsObjectTests.cs

@@ -25,7 +25,7 @@ public async void Get_simple_structured_response_from_ChatGPT()
     }
 
     [Fact]
-    public async void Get_structured_response_with_array_from_ChatGPT()
+    public async void Get_structured_response_with_ARRAY_from_ChatGPT()
     {
         var message = 
             Dialog.StartAsSystem("What did user input?")
@@ -43,16 +43,36 @@ public async void Get_structured_response_with_array_from_ChatGPT()
         response.Items[1].Quantity.Should().Be(3);
     }
 
+    [Fact]
+    public async void Get_structured_response_with_ENUM_from_ChatGPT()
+    {
+        var message = 
+            Dialog.StartAsSystem("What did user input?")
+                .ThenUser("Мой любимый цвет - красный");
+        var response = await _client.GetStructuredResponse<Thing>(message);
+        response.Should().NotBeNull();
+        response.Color.Should().Be(Thing.Colors.Red);
+    }
+    
+    [Fact]
+    public async void Get_structured_response_with_extra_data_from_ChatGPT()
+    {
+        var message = 
+            Dialog.StartAsSystem("Just answer the questions.")
+                .ThenUser("In what year was the city of Almaty originally founded?");
+        var response = await _client.GetStructuredResponse<City>(message);
+        response.Should().NotBeNull();
+        response.Name.Should().Be("Almaty");
+        response.YearOfFoundation.Should().Be(1854);
+        response.Country.Should().Be("Kazakhstan");
+    }
+    
     private class Order
     {
         public UserInfo UserInfo { get; set; }
         public List<Item> Items { get; set; }
 
-        public class Item
-        {
-            public string Name { get; set; } = "";
-            public int Quantity { get; set; }
-        }
+        public record Item(string Name, int Quantity);
     }
 
     private class UserInfo
@@ -61,4 +81,18 @@ private class UserInfo
         public int Age { get; init; }
         public string Email { get; init; }
     }
+
+    private record Thing(Thing.Colors Color)
+    {
+        public enum Colors
+        {
+            None,
+            Red,
+            Green,
+            Blue
+        }
+    }
+
+    private record City(string Name, int YearOfFoundation, string Country);
 }
+