Add support for JSON Schema $defs, definitions, $ref, oneOf, anyOf and others in PropertyDefinition

OpenAI.SDK/ObjectModels/Converters.cs

@@ -89,4 +89,51 @@ public override void Write(Utf8JsonWriter writer, AssistantsApiToolChoiceOneOfTy
             writer.WriteNullValue();
         }
     }
-}
+}
+
+public class SingleOrArrayToListConverter : JsonConverter<IList<string?>>
+{
+    public override IList<string?>? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) {
+        switch (reader.TokenType) {
+            case JsonTokenType.String:
+                return [reader.GetString()];
+            case JsonTokenType.StartArray:
+            {
+                var list = new List<string?>();
+                while (reader.Read() && reader.TokenType != JsonTokenType.EndArray) {
+                    switch (reader.TokenType) {
+                        case JsonTokenType.String:
+                            list.Add(reader.GetString());
+                            break;
+                        case JsonTokenType.Null:
+                            list.Add(null);
+                            break;
+                        default:
+                            throw new JsonException($"Unexpected token in type array: {reader.TokenType}");
+                    }
+                }
+                return list;
+            }
+            default:
+                throw new JsonException($"Unexpected token parsing type: {reader.TokenType}");
+        }
+    }
+
+    public override void Write(Utf8JsonWriter writer, IList<string?>? value, JsonSerializerOptions options) {
+        if (value == null || value.Count == 0) {
+            writer.WriteNullValue();
+        } else if (value.Count == 1) {
+            writer.WriteStringValue(value[0]);
+        } else {
+            writer.WriteStartArray();
+            foreach (var item in value) {
+                if (item == null) {
+                    writer.WriteNullValue();
+                } else {
+                    writer.WriteStringValue(item);
+                }
+            }
+            writer.WriteEndArray();
+        }
+    }
+}

OpenAI.SDK/ObjectModels/SharedModels/FunctionParameters.cs

@@ -1,4 +1,4 @@
-using System.Text.Json.Serialization;
+using System.Text.Json.Serialization;
 
 namespace Betalgo.Ranul.OpenAI.ObjectModels.SharedModels;
 
@@ -20,10 +20,33 @@ public enum FunctionObjectTypes
     }
 
     /// <summary>
-    ///     Required. Function parameter object type. Default value is "object".
+    ///     Property's type as a string. Only one: <see cref="TypeList"/> or <see cref="Type"/> should be set.
+    /// </summary>
+    [JsonIgnore]
+    public string? Type {
+        get => TypeList?.Count != 1 ? null : TypeList[0];
+        set {
+            if (value == null) {
+                TypeList = null;
+                return;
+            }
+            TypeList = [value];
+        }
+    }
+
+    /// <summary>
+    ///     Property's type as a list of strings. Only one: <see cref="TypeList"/> or <see cref="Type"/> should be set.
     /// </summary>
     [JsonPropertyName("type")]
-    public string Type { get; set; } = "object";
+    [JsonConverter(typeof(SingleOrArrayToListConverter))]
+    public IList<string?>? TypeList { get; set; }
+
+    /// <summary>
+    ///     An instance validates successfully against this keyword if its value is equal to the value of the keyword
+    ///     https://json-schema.org/draft/2020-12/json-schema-validation#name-const
+    /// </summary>
+    [JsonPropertyName("const")]
+    public string? Constant { get; set; }
 
     /// <summary>
     ///     Optional. List of "function arguments", as a dictionary that maps from argument name
@@ -45,7 +68,15 @@ public enum FunctionObjectTypes
     public bool? AdditionalProperties { get; set; }
 
     /// <summary>
-    ///     Optional. Argument description.
+    ///     Optional. Title of the schema.
+    ///     https://json-schema.org/draft/2020-12/json-schema-validation#name-title-and-description
+    /// </summary>
+    [JsonPropertyName("title")]
+    public string? Title { get; set; }
+
+    /// <summary>
+    ///     Optional. Description of the schema.
+    ///     https://json-schema.org/draft/2020-12/json-schema-validation#name-title-and-description
     /// </summary>
     [JsonPropertyName("description")]
     public string? Description { get; set; }
@@ -69,6 +100,74 @@ public enum FunctionObjectTypes
     /// </summary>
     [JsonPropertyName("maxProperties")]
     public int? MaxProperties { get; set; }
+
+    /// <summary>
+    ///     The value of "multipleOf" MUST be a number, strictly greater than 0.
+    ///     A numeric instance is valid only if division by this keyword's value results in an integer.
+    ///     https://json-schema.org/draft/2020-12/draft-bhutton-json-schema-validation-00#rfc.section.6.2.1
+    /// </summary>
+    [JsonPropertyName("multipleOf")]
+    public float? MultipleOf { get; set; }
+
+    /// <summary>
+    ///     The value of "minimum" MUST be a number, representing an inclusive lower limit for a numeric instance.
+    ///     https://json-schema.org/draft/2020-12/json-schema-validation#name-minimum
+    /// </summary>
+    [JsonPropertyName("minimum")]
+    public float? Minimum { get; set; }
+
+    /// <summary>
+    ///     The value of "exclusiveMinimum" MUST be a number, representing an exclusive lower limit for a numeric
+    ///     instance. If the instance is a number, then the instance is valid only if it has a value strictly greater
+    ///     than (not equal to) "exclusiveMinimum".
+    ///     https://json-schema.org/draft/2020-12/draft-bhutton-json-schema-validation-00#rfc.section.6.2.5
+    /// </summary>
+    [JsonPropertyName("exclusiveMinimum")]
+    public float? ExclusiveMinimum { get; set; }
+
+    /// <summary>
+    ///     The value of "maximum" MUST be a number, representing an inclusive upper limit for a numeric instance.
+    ///     https://json-schema.org/draft/2020-12/json-schema-validation#name-maximum
+    /// </summary>
+    [JsonPropertyName("maximum")]
+    public float? Maximum { get; set; }
+
+    /// <summary>
+    ///     The value of "exclusiveMaximum" MUST be a number, representing an exclusive upper limit for a numeric
+    ///     instance. If the instance is a number, then the instance is valid only if it has a value strictly less than
+    ///     (not equal to) "exclusiveMaximum". 
+    ///     https://json-schema.org/draft/2020-12/draft-bhutton-json-schema-validation-00#rfc.section.6.2.3
+    /// </summary>
+    [JsonPropertyName("exclusiveMaximum")]
+    public float? ExclusiveMaximum { get; set; }
+
+    /// <summary>
+    ///     Predefined formats for strings. Currently supported:
+    ///     date-time, time, date, duration, email, hostname, ipv4, ipv6, uuid
+    /// </summary>
+    [JsonPropertyName("format")]
+    public string? Format { get; set; }
+
+    /// <summary>
+    ///     A regular expression that the string must match.
+    ///     https://json-schema.org/draft/2020-12/draft-bhutton-json-schema-validation-00#pattern
+    /// </summary>
+    [JsonPropertyName("pattern")]
+    public string? Pattern { get; set; }
+
+    /// <summary>
+    ///     The array must have at least this many items.
+    ///     https://json-schema.org/draft/2020-12/draft-bhutton-json-schema-validation-00#rfc.section.6.4.2
+    /// </summary>
+    [JsonPropertyName("minItems")]
+    public int? MinItems { get; set; }
+
+    /// <summary>
+    ///     The array must have at most this many items.
+    ///     https://json-schema.org/draft/2020-12/draft-bhutton-json-schema-validation-00#rfc.section.6.4.4
+    /// </summary>
+    [JsonPropertyName("maxItems")]
+    public int? MaxItems { get; set; }
 
     /// <summary>
     ///     If type is "array", this specifies the element type for all items in the array.
@@ -77,6 +176,40 @@ public enum FunctionObjectTypes
     /// </summary>
     [JsonPropertyName("items")]
     public PropertyDefinition? Items { get; set; }
+
+    /// <summary>
+    ///     Definitions of schemas (2020-12 and newer specifications).
+    ///     For more details, see https://json-schema.org/understanding-json-schema/structuring#defs
+    /// </summary>
+    [JsonPropertyName("$defs")]
+    public IDictionary<string, PropertyDefinition>? Defs { get; set; }
+
+    /// <summary>
+    ///     Definitions of schemas (draft-07 specification).
+    /// </summary>
+    [JsonPropertyName("definitions")]
+    public IDictionary<string, PropertyDefinition>? Definitions { get; set; }
+
+    /// <summary>
+    ///     Reference to another schema definition.
+    ///     For more details, see https://json-schema.org/understanding-json-schema/structuring#dollarref
+    /// </summary>
+    [JsonPropertyName("$ref")]
+    public string? Ref { get; set; }
+
+    /// <summary>
+    ///     To validate against anyOf, the given data must be valid against any (one or more) of the given subschemas.
+    ///     For more details, see https://json-schema.org/understanding-json-schema/reference/combining#anyOf
+    /// </summary>
+    [JsonPropertyName("anyOf")]
+    public IList<PropertyDefinition>? AnyOf { get; set; }
+
+    /// <summary>
+    ///     To validate against oneOf, the given data must be valid against exactly one of the given subschemas.
+    ///     For more details, see https://json-schema.org/understanding-json-schema/reference/combining#oneOf
+    /// </summary>
+    [JsonPropertyName("oneOf")]
+    public IList<PropertyDefinition>? OneOf { get; set; }
 
     public static PropertyDefinition DefineArray(PropertyDefinition? arrayItems = null)
     {
@@ -174,4 +307,4 @@ public static string ConvertTypeToString(FunctionObjectTypes type)
             _ => throw new ArgumentOutOfRangeException(nameof(type), $"Unknown type: {type}")
         };
     }
-}
+}