feat: add array anyof support

Author: r-Larch

OpenAi.JsonSchema.Tests/FluentSchemaBuilderTests.cs

@@ -173,6 +173,44 @@ public void Test_Actions()
         Assert.NotNull(json);
         Helper.Assert(json);
     }
+
+
+    [Fact]
+    public void Test_array_anyof()
+    {
+        var generator = new DefaultSchemaGenerator();
+        var options = new JsonSchemaOptions(SchemaDefaults.OpenAi, Helper.JsonOptionsSnakeCase);
+
+        var schema = generator.Build(options, _ => _
+            .Object(_ => _
+                .Property("answer", _ => _
+                    .Array(_ => _
+                        .AnyOf(
+                            _ => _.Object("Write markdown text.", _ => _
+                                .Property("$type", _ => _.Const("text"))
+                                .Property("content", _ => _.Value<string>())
+                            ),
+                            _ => _.Object("Show a visually appearing widget.", _ => _
+                                .Property("$type", _ => _.Const("widget"))
+                                .Property("id", "Value form widgetId in context.", _ => _.Value<string>())
+                                .Property("comment", "A user-facing `comment`", _ => _.Value<string>())
+                            ),
+                            _ => _.Object("Add a reference to your statement.", _ => _
+                                .Property("$type", _ => _.Const("citation"))
+                                .Property("title", _ => _.Value<string>())
+                                .Property("url", "URL from context.", _ => _.Value<string>())
+                            )
+                        )
+                    )
+                )
+            )
+        );
+
+        var json = schema.ToJson();
+        output.WriteLine(json);
+        Assert.NotNull(json);
+        Helper.Assert(json);
+    }
 }
 
 public record FluentDocument(

OpenAi.JsonSchema.Tests/Output/FluentSchemaBuilderTests.Test_array_anyof.json

@@ -0,0 +1,81 @@
+{
+  "type": "object",
+  "properties": {
+    "answer": {
+      "type": "array",
+      "items": {
+        "anyOf": [
+          {
+            "type": "object",
+            "description": "Write markdown text.",
+            "properties": {
+              "$type": {
+                "type": "string",
+                "const": "text"
+              },
+              "content": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "$type",
+              "content"
+            ],
+            "additionalProperties": false
+          },
+          {
+            "type": "object",
+            "description": "Show a visually appearing widget.",
+            "properties": {
+              "$type": {
+                "type": "string",
+                "const": "widget"
+              },
+              "id": {
+                "type": "string",
+                "description": "Value form widgetId in context."
+              },
+              "comment": {
+                "type": "string",
+                "description": "A user-facing \u0060comment\u0060"
+              }
+            },
+            "required": [
+              "$type",
+              "id",
+              "comment"
+            ],
+            "additionalProperties": false
+          },
+          {
+            "type": "object",
+            "description": "Add a reference to your statement.",
+            "properties": {
+              "$type": {
+                "type": "string",
+                "const": "citation"
+              },
+              "title": {
+                "type": "string"
+              },
+              "url": {
+                "type": "string",
+                "description": "URL from context."
+              }
+            },
+            "required": [
+              "$type",
+              "title",
+              "url"
+            ],
+            "additionalProperties": false
+          }
+        ]
+      }
+    }
+  },
+  "required": [
+    "answer"
+  ],
+  "additionalProperties": false
+}

OpenAi.JsonSchema/Fluent/FluentSchemaBuilder.cs

@@ -86,6 +86,20 @@ public SchemaNode Object<T>(Action<IFluentObjectSchemaBuilder<T>> properties) wh
         return node;
     }
 
+    public SchemaNode Array(string description, Func<IFluentSchemaBuilder, SchemaNode> items)
+    {
+        var itemsType = items(this);
+        return new SchemaArrayNode(itemsType) {
+            Description = description
+        };
+    }
+
+    public SchemaNode Array(Func<IFluentSchemaBuilder, SchemaNode> items)
+    {
+        var itemsType = items(this);
+        return new SchemaArrayNode(itemsType);
+    }
+
     public SchemaNode Array<T>()
     {
         return Schema(Resolve(typeof(T)));

OpenAi.JsonSchema/Fluent/IFluentSchemaBuilder.cs

@@ -16,6 +16,9 @@ public interface IFluentSchemaBuilder {
     SchemaNode Object<T>(string description, Action<IFluentObjectSchemaBuilder<T>> properties) where T : class;
     SchemaNode Object<T>(Action<IFluentObjectSchemaBuilder<T>> properties) where T : class;
 
+    SchemaNode Array(string description, Func<IFluentSchemaBuilder, SchemaNode> properties);
+    SchemaNode Array(Func<IFluentSchemaBuilder, SchemaNode> properties);
+
     SchemaNode Array<T>();
     SchemaNode Array<T>(string description);
     SchemaNode Array<T>(string description, Action<IFluentObjectSchemaBuilder<T>> properties) where T : class;