Merge remote-tracking branch 'origin/main' into DemoDokka

Author: dconeybe

firebase-ai/CHANGELOG.md

@@ -1,13 +1,16 @@
 # Unreleased
 
+
+# 16.1.0
 * [fixed] Fixed `FirebaseAI.getInstance` StackOverflowException (#6971)
 * [fixed] Fixed an issue that was causing the SDK to send empty `FunctionDeclaration` descriptions to the API.
 * [changed] Introduced the `Voice` class, which accepts a voice name, and deprecated the `Voices` class.
 * [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
 * [feature] Initial release of the Firebase AI SDK (`firebase-ai`). This SDK *replaces* the previous
  Vertex AI in Firebase SDK (`firebase-vertexai`) to accommodate the evolving set of supported

firebase-ai/api.txt

@@ -12,5 +12,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-version=16.1.0
-latestReleasedVersion=16.0.0
+version=16.2.0
+latestReleasedVersion=16.1.0

firebase-ai/gradle.properties

@@ -25,8 +25,7 @@ public class ImagenPersonFilterLevel private constructor(internal val internalVa
      *
      * > Important: Generation of images containing people or faces may require your use case to be
      * reviewed and approved by Cloud support; see the
-     * [Responsible AI and usage
-     * guidelines](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#person-face-gen)
+     * [Responsible AI and usage guidelines](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#person-face-gen)
      * for more details.
      */
     @JvmField public val ALLOW_ALL: ImagenPersonFilterLevel = ImagenPersonFilterLevel("allow_all")
@@ -35,8 +34,7 @@ public class ImagenPersonFilterLevel private constructor(internal val internalVa
      *
      * > Important: Generation of images containing people or faces may require your use case to be
      * reviewed and approved by Cloud support; see the
-     * [Responsible AI and usage
-     * guidelines](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#person-face-gen)
+     * [Responsible AI and usage guidelines](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#person-face-gen)
      * for more details.
      */
     @JvmField

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

@@ -42,6 +42,12 @@ internal constructor(
   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,
       )
 
     /**
@@ -155,6 +208,7 @@ internal constructor(
      * `String` and values of type [Schema].
      *
      * **Example:** A `city` could be represented with the following object `Schema`.
+     *
      * ```
      * Schema.obj(mapOf(
      *   "name"  to Schema.string(),
@@ -176,6 +230,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 +243,7 @@ internal constructor(
         properties = properties,
         required = properties.keys.minus(optionalProperties.toSet()).toList(),
         type = "OBJECT",
+        title = title,
       )
     }
 
@@ -203,20 +259,25 @@ 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,
       )
 
     /**
      * Returns a [Schema] for an enumeration.
      *
      * For example, the cardinal directions can be represented as:
-     *
      * ```
      * Schema.enumeration(listOf("north", "east", "south", "west"), "Cardinal directions")
      * ```
@@ -230,37 +291,79 @@ 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(type = "ANYOF", anyOf = schemas)
   }
 
-  internal fun toInternal(): Internal =
-    Internal(
-      type,
+  internal fun toInternal(): Internal {
+    val cleanedType =
+      if (type == "ANYOF") {
+        null
+      } else {
+        type
+      }
+    return Internal(
+      cleanedType,
       description,
       format,
       nullable,
       enum,
       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/main/kotlin/com/google/firebase/ai/type/Schema.kt

@@ -20,8 +20,8 @@ import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
 /**
- * Various voices supported by the server. The list of all voices can be found
- * [here](https://cloud.google.com/text-to-speech/docs/chirp3-hd)
+ * Various voices supported by the server. In the documentation, find the list of
+ * [all supported voices](https://cloud.google.com/text-to-speech/docs/chirp3-hd).
  */
 @PublicPreviewAPI
 public class Voice public constructor(public val voiceName: String) {

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

@@ -20,7 +20,7 @@ import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
 /** Various voices supported by the server */
-@Deprecated("Please use the Voice class instead.", ReplaceWith("Voice"))
+@Deprecated("Use the Voice class instead.", ReplaceWith("Voice"))
 @PublicPreviewAPI
 public class Voices private constructor(public val ordinal: Int) {