Davidmotson.extra schema

firebase-ai/CHANGELOG.md

@@ -6,6 +6,8 @@
 * [changed] **Breaking Change**: Updated `SpeechConfig` to take in `Voice` class instead of `Voices` class.
     * **Action Required:** Update all references of `SpeechConfig` initialization to use `Voice` class.
 * [fixed] Fix incorrect model name in count token requests to the developer API backend
+* [feature] Added support for extra schema properties like `title`, `minItems`, `maxItems`, `minimum`
+ and `maximum`. As well as support for the `anyOf` schema. 
 
 
 # 16.0.0

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Schema.kt

@@ -34,14 +34,20 @@ public abstract class StringFormat private constructor(internal val value: Strin
  */
 public class Schema
 internal constructor(
-  public val type: String,
+  public val type: String? = null,
   public val description: String? = null,
   public val format: String? = null,
   public val nullable: Boolean? = null,
   public val enum: List<String>? = null,
   public val properties: Map<String, Schema>? = null,
   public val required: List<String>? = null,
   public val items: Schema? = null,
+  public val title: String? = null,
+  public val minItems: Int? = null,
+  public val maxItems: Int? = null,
+  public val minimum: Double? = null,
+  public val maximum: Double? = null,
+  public val anyOf: List<Schema>? = null
 ) {
 
   public companion object {
@@ -53,12 +59,12 @@ internal constructor(
      */
     @JvmStatic
     @JvmOverloads
-    public fun boolean(description: String? = null, nullable: Boolean = false): Schema =
-      Schema(
-        description = description,
-        nullable = nullable,
-        type = "BOOLEAN",
-      )
+    public fun boolean(
+      description: String? = null,
+      nullable: Boolean = false,
+      title: String? = null
+    ): Schema =
+      Schema(description = description, nullable = nullable, type = "BOOLEAN", title = title)
 
     /**
      * Returns a [Schema] for a 32-bit signed integer number.
@@ -73,12 +79,21 @@ internal constructor(
     @JvmStatic
     @JvmName("numInt")
     @JvmOverloads
-    public fun integer(description: String? = null, nullable: Boolean = false): Schema =
+    public fun integer(
+      description: String? = null,
+      nullable: Boolean = false,
+      title: String? = null,
+      minimum: Double? = null,
+      maximum: Double? = null
+    ): Schema =
       Schema(
         description = description,
         format = "int32",
         nullable = nullable,
         type = "INTEGER",
+        title = title,
+        minimum = minimum,
+        maximum = maximum,
       )
 
     /**
@@ -90,11 +105,20 @@ internal constructor(
     @JvmStatic
     @JvmName("numLong")
     @JvmOverloads
-    public fun long(description: String? = null, nullable: Boolean = false): Schema =
+    public fun long(
+      description: String? = null,
+      nullable: Boolean = false,
+      title: String? = null,
+      minimum: Double? = null,
+      maximum: Double? = null
+    ): Schema =
       Schema(
         description = description,
         nullable = nullable,
         type = "INTEGER",
+        title = title,
+        minimum = minimum,
+        maximum = maximum,
       )
 
     /**
@@ -106,8 +130,21 @@ internal constructor(
     @JvmStatic
     @JvmName("numDouble")
     @JvmOverloads
-    public fun double(description: String? = null, nullable: Boolean = false): Schema =
-      Schema(description = description, nullable = nullable, type = "NUMBER")
+    public fun double(
+      description: String? = null,
+      nullable: Boolean = false,
+      title: String? = null,
+      minimum: Double? = null,
+      maximum: Double? = null
+    ): Schema =
+      Schema(
+        description = description,
+        nullable = nullable,
+        type = "NUMBER",
+        title = title,
+        minimum = minimum,
+        maximum = maximum,
+      )
 
     /**
      * Returns a [Schema] for a single-precision floating-point number.
@@ -123,8 +160,22 @@ internal constructor(
     @JvmStatic
     @JvmName("numFloat")
     @JvmOverloads
-    public fun float(description: String? = null, nullable: Boolean = false): Schema =
-      Schema(description = description, nullable = nullable, type = "NUMBER", format = "float")
+    public fun float(
+      description: String? = null,
+      nullable: Boolean = false,
+      title: String? = null,
+      minimum: Double? = null,
+      maximum: Double? = null
+    ): Schema =
+      Schema(
+        description = description,
+        nullable = nullable,
+        type = "NUMBER",
+        format = "float",
+        title = title,
+        minimum = minimum,
+        maximum = maximum,
+      )
 
     /**
      * Returns a [Schema] for a string.
@@ -139,13 +190,15 @@ internal constructor(
     public fun string(
       description: String? = null,
       nullable: Boolean = false,
-      format: StringFormat? = null
+      format: StringFormat? = null,
+      title: String? = null,
     ): Schema =
       Schema(
         description = description,
         format = format?.value,
         nullable = nullable,
-        type = "STRING"
+        type = "STRING",
+        title = title
       )
 
     /**
@@ -176,6 +229,7 @@ internal constructor(
       optionalProperties: List<String> = emptyList(),
       description: String? = null,
       nullable: Boolean = false,
+      title: String? = null
     ): Schema {
       if (!properties.keys.containsAll(optionalProperties)) {
         throw IllegalArgumentException(
@@ -188,6 +242,7 @@ internal constructor(
         properties = properties,
         required = properties.keys.minus(optionalProperties.toSet()).toList(),
         type = "OBJECT",
+        title = title
       )
     }
 
@@ -203,13 +258,19 @@ internal constructor(
     public fun array(
       items: Schema,
       description: String? = null,
-      nullable: Boolean = false
+      nullable: Boolean = false,
+      title: String? = null,
+      minItems: Int? = null,
+      maxItems: Int? = null
     ): Schema =
       Schema(
         description = description,
         nullable = nullable,
         items = items,
         type = "ARRAY",
+        title = title,
+        minItems = minItems,
+        maxItems = maxItems
       )
 
     /**
@@ -230,15 +291,37 @@ internal constructor(
     public fun enumeration(
       values: List<String>,
       description: String? = null,
-      nullable: Boolean = false
+      nullable: Boolean = false,
+      title: String? = null,
     ): Schema =
       Schema(
         description = description,
         format = "enum",
         nullable = nullable,
         enum = values,
         type = "STRING",
+        title = title
       )
+
+    /**
+     * Returns a [Schema] representing a value that must conform to *any* (one of) the provided
+     * sub-schema.
+     *
+     * Example: A field that can hold either a simple userID or a more detailed user object.
+     *
+     * Schema.anyOf( listOf( Schema.integer(description = "User ID"), Schema.obj(mapOf(
+     * ```
+     *     "userID" to Schema.integer(description = "User ID"),
+     *     "username" to Schema.string(description = "Username")
+     * ```
+     * )) )
+     *
+     * @param schemas The list of valid schemas which could be here
+     */
+    @JvmStatic
+    public fun anyOf(
+      schemas: List<Schema>,
+    ): Schema = Schema(anyOf = schemas)
   }
 
   internal fun toInternal(): Internal =
@@ -251,16 +334,28 @@ internal constructor(
       properties?.mapValues { it.value.toInternal() },
       required,
       items?.toInternal(),
+      title,
+      minItems,
+      maxItems,
+      minimum,
+      maximum,
+      anyOf?.map { it.toInternal() },
     )
   @Serializable
   internal data class Internal(
-    val type: String,
+    val type: String? = null,
     val description: String? = null,
     val format: String? = null,
     val nullable: Boolean? = false,
     val enum: List<String>? = null,
     val properties: Map<String, Internal>? = null,
     val required: List<String>? = null,
     val items: Internal? = null,
+    val title: String? = null,
+    val minItems: Int? = null,
+    val maxItems: Int? = null,
+    val minimum: Double? = null,
+    val maximum: Double? = null,
+    val anyOf: List<Internal>? = null
   )
 }

firebase-ai/src/test/java/com/google/firebase/ai/SerializationTests.kt

@@ -175,18 +175,15 @@ internal class SerializationTests {
         "type": {
           "type": "string"
         },
-        "format": {
+        "description": {
           "type": "string"
         },
-        "description": {
+        "format": {
           "type": "string"
         },
         "nullable": {
           "type": "boolean"
         },
-        "items": {
-          "${'$'}ref": "Schema"
-        },
         "enum": {
           "type": "array",
           "items": {
@@ -204,7 +201,31 @@ internal class SerializationTests {
           "items": {
             "type": "string"
           }
-        } 
+        },
+        "items": {
+          "${'$'}ref": "Schema"
+        },
+        "title": {
+          "type": "string"
+        },
+        "minItems": {
+          "type": "integer"
+        },
+        "maxItems": {
+          "type": "integer"
+        },
+        "minimum": {
+          "type": "number"
+        },
+        "maximum": {
+          "type": "number"
+        },
+        "anyOf": {
+          "type": "array",
+          "items": {
+            "${'$'}ref": "Schema"
+          }
+        }
       }
     }
       """