Merge branch 'main' of https://github.com/firebase/firebase-android-sdk into rpf/fix-content-part-serialization

Author: thatfiredev

firebase-ai/CHANGELOG.md

@@ -1,24 +1,27 @@
 # Unreleased
-* [fixed] **Breaking Change**: Fixed missing builder methods and return types in builders.
-* [changed] **Breaking Change**: `LiveModelFutures.connect` now returns `ListenableFuture<LiveSessionFutures>` instead of `ListenableFuture<LiveSession>`.
-    * **Action Required:** Remove any transformations from LiveSession object to LiveSessionFutures object.
-    * **Action Required:** Change type of variable handling `LiveModelFutures.connect` to `ListenableFuture<LiveSessionsFutures>`
-* [changed] **Breaking Change**: Removed `UNSPECIFIED` value for enum class `ResponseModality`
-    * **Action Required:** Remove all references to `ResponseModality.UNSPECIFIED`
-* [changed] **Breaking Change**: Renamed `LiveGenerationConfig.setResponseModalities` to `LiveGenerationConfig.setResponseModality`
-    * **Action Required:** Replace all references of `LiveGenerationConfig.setResponseModalities` with `LiveGenerationConfig.setResponseModality`
-* [feature] Added support for `HarmBlockThreshold.OFF`. See the
-  [model documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/configure-safety-filters#how_to_configure_content_filters){: .external}
-  for more information.
-* [fixed] Improved thread usage when using a `LiveGenerativeModel`. (#6870)
-* [fixed] Fixed an issue with `LiveContentResponse` audio data not being present when the model was
-  interrupted or the turn completed. (#6870)
-* [fixed] Fixed an issue with `LiveSession` not converting exceptions to `FirebaseVertexAIException`. (#6870)
-* * [changed] **Breaking Change**: Removed the `LiveContentResponse.Status` class, and instead have nested the status
-  fields as properties of `LiveContentResponse`. (#6906)
-* [changed] **Breaking Change**: Removed the `LiveContentResponse` class, and instead have provided subclasses
-  of `LiveServerMessage` that match the responses from the model. (#6910)
-* [feature] Added support for the `id` field on `FunctionResponsePart` and `FunctionCallPart`. (#6910)
-* [feature] Add support for specifying response modalities in `GenerationConfig`. (#6921)
-* [feature] Added a helper field for getting all the `InlineDataPart` from a `GenerateContentResponse`. (#6922)
+
+* [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.
+
+ 
+# 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
+ features and services.
+  * The new Firebase AI SDK provides **Preview** support for the Gemini Developer API, including its
+  free tier offering.
+  * Using the Firebase AI SDK with the Vertex AI Gemini API is still generally available (GA).
+
+ If you're using the old `firebase-vertexai`, we recommend
+ [migrating to `firebase-ai`](/docs/ai-logic/migrate-to-latest-sdk)
+ because all new development and features will be in this new SDK.
+* [feature] **Preview:** Added support for specifying response modalities in `GenerationConfig`
+ (only available in the new `firebase-ai` package). This includes support for image generation using
+ [specific Gemini models](/docs/vertex-ai/models).
+
+ Note: This feature is in Public Preview, which means that it is not subject to any SLA or
+ deprecation policy and could change in backwards-incompatible ways.
 

firebase-ai/api.txt

@@ -863,9 +863,9 @@ package com.google.firebase.ai.type {
   }
 
   @com.google.firebase.ai.type.PublicPreviewAPI public final class SpeechConfig {
-    ctor public SpeechConfig(com.google.firebase.ai.type.Voices voice);
-    method public com.google.firebase.ai.type.Voices getVoice();
-    property public final com.google.firebase.ai.type.Voices voice;
+    ctor public SpeechConfig(com.google.firebase.ai.type.Voice voice);
+    method public com.google.firebase.ai.type.Voice getVoice();
+    property public final com.google.firebase.ai.type.Voice voice;
   }
 
   public abstract class StringFormat {
@@ -914,19 +914,25 @@ package com.google.firebase.ai.type {
     property public final int totalTokenCount;
   }
 
-  @com.google.firebase.ai.type.PublicPreviewAPI public final class Voices {
-    method public int getOrdinal();
-    property public final int ordinal;
-    field public static final com.google.firebase.ai.type.Voices AOEDE;
-    field public static final com.google.firebase.ai.type.Voices CHARON;
-    field public static final com.google.firebase.ai.type.Voices.Companion Companion;
-    field public static final com.google.firebase.ai.type.Voices FENRIR;
-    field public static final com.google.firebase.ai.type.Voices KORE;
-    field public static final com.google.firebase.ai.type.Voices PUCK;
-    field public static final com.google.firebase.ai.type.Voices UNSPECIFIED;
+  @com.google.firebase.ai.type.PublicPreviewAPI public final class Voice {
+    ctor public Voice(String voiceName);
+    method public String getVoiceName();
+    property public final String voiceName;
+  }
+
+  @Deprecated @com.google.firebase.ai.type.PublicPreviewAPI public final class Voices {
+    method @Deprecated public int getOrdinal();
+    property @Deprecated public final int ordinal;
+    field @Deprecated public static final com.google.firebase.ai.type.Voices AOEDE;
+    field @Deprecated public static final com.google.firebase.ai.type.Voices CHARON;
+    field @Deprecated public static final com.google.firebase.ai.type.Voices.Companion Companion;
+    field @Deprecated public static final com.google.firebase.ai.type.Voices FENRIR;
+    field @Deprecated public static final com.google.firebase.ai.type.Voices KORE;
+    field @Deprecated public static final com.google.firebase.ai.type.Voices PUCK;
+    field @Deprecated public static final com.google.firebase.ai.type.Voices UNSPECIFIED;
   }
 
-  public static final class Voices.Companion {
+  @Deprecated public static final class Voices.Companion {
   }
 
 }

firebase-ai/gradle.properties

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

firebase-ai/src/main/kotlin/com/google/firebase/ai/FirebaseAI.kt

@@ -220,7 +220,9 @@ internal constructor(
     }
 
     /** The [FirebaseAI] instance for the provided [FirebaseApp] using the Google AI Backend. */
-    @JvmStatic public fun getInstance(app: FirebaseApp): FirebaseAI = getInstance(app)
+    @JvmStatic
+    public fun getInstance(app: FirebaseApp): FirebaseAI =
+      getInstance(app, GenerativeBackend.googleAI())
 
     private const val GEMINI_MODEL_NAME_PREFIX = "gemini-"
 

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

@@ -61,7 +61,7 @@ public class FunctionDeclaration(
   internal val schema: Schema =
     Schema.obj(properties = parameters, optionalProperties = optionalParameters, nullable = false)
 
-  internal fun toInternal() = Internal(name, "", schema.toInternal())
+  internal fun toInternal() = Internal(name, description, schema.toInternal())
 
   @Serializable
   internal data class Internal(

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

@@ -20,12 +20,30 @@ package com.google.firebase.ai.type
 @PublicPreviewAPI
 public class ImagenPersonFilterLevel private constructor(internal val internalVal: String) {
   public companion object {
-    /** No filters applied. */
+    /**
+     * Allow generation of images containing people of all ages.
+     *
+     * > 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)
+     * for more details.
+     */
     @JvmField public val ALLOW_ALL: ImagenPersonFilterLevel = ImagenPersonFilterLevel("allow_all")
-    /** Filters out any images containing depictions of children. */
+    /**
+     * Allow generation of images containing adults only; images of children are filtered out.
+     *
+     * > 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)
+     * for more details.
+     */
     @JvmField
     public val ALLOW_ADULT: ImagenPersonFilterLevel = ImagenPersonFilterLevel("allow_adult")
-    /** Filters out any images containing depictions of people. */
+    /**
+     * Disallow generation of images containing people or faces; images of people are filtered out.
+     */
     @JvmField public val BLOCK_ALL: ImagenPersonFilterLevel = ImagenPersonFilterLevel("dont_allow")
   }
 }

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

@@ -23,14 +23,14 @@ import kotlinx.serialization.Serializable
 @PublicPreviewAPI
 public class SpeechConfig(
   /** The voice to be used for the server's speech response. */
-  public val voice: Voices
+  public val voice: Voice
 ) {
 
   @Serializable
   internal data class Internal(@SerialName("voice_config") val voiceConfig: VoiceConfigInternal) {
     @Serializable
     internal data class VoiceConfigInternal(
-      @SerialName("prebuilt_voice_config") val prebuiltVoiceConfig: Voices.Internal,
+      @SerialName("prebuilt_voice_config") val prebuiltVoiceConfig: Voice.Internal,
     )
   }
 

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

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.firebase.ai.type
+
+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)
+ */
+@PublicPreviewAPI
+public class Voice public constructor(public val voiceName: String) {
+
+  @Serializable internal data class Internal(@SerialName("voice_name") val voiceName: String)
+
+  internal fun toInternal(): Internal {
+    return Internal(this.voiceName)
+  }
+}

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

@@ -20,6 +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"))
 @PublicPreviewAPI
 public class Voices private constructor(public val ordinal: Int) {
 

firebase-ai/src/test/java/com/google/firebase/ai/type/FunctionDeclarationTest.kt

@@ -0,0 +1,100 @@
+/*
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.firebase.ai.type
+
+import io.kotest.assertions.json.shouldEqualJson
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
+import org.junit.Test
+
+internal class FunctionDeclarationTest {
+
+  @Test
+  fun `Basic FunctionDeclaration with name, description and parameters`() {
+    val functionDeclaration =
+      FunctionDeclaration(
+        name = "isUserAGoat",
+        description = "Determine if the user is subject to teleportations.",
+        parameters = mapOf("userID" to Schema.string("ID of the User making the call"))
+      )
+
+    val expectedJson =
+      """
+      {
+          "name": "isUserAGoat",
+          "description": "Determine if the user is subject to teleportations.",
+          "parameters": {
+            "type": "OBJECT",
+            "properties": {
+              "userID": {
+                "type": "STRING",
+                "description": "ID of the User making the call"
+              }
+            },
+            "required": [
+              "userID"
+            ]
+          }
+        }
+    """
+        .trimIndent()
+
+    Json.encodeToString(functionDeclaration.toInternal()).shouldEqualJson(expectedJson)
+  }
+
+  @Test
+  fun `FunctionDeclaration with optional parameters`() {
+    val functionDeclaration =
+      FunctionDeclaration(
+        name = "isUserAGoat",
+        description = "Determine if the user is subject to teleportations.",
+        parameters =
+          mapOf(
+            "userID" to Schema.string("ID of the user making the call"),
+            "userName" to Schema.string("Name of the user making the call")
+          ),
+        optionalParameters = listOf("userName")
+      )
+
+    val expectedJson =
+      """
+      {
+          "name": "isUserAGoat",
+          "description": "Determine if the user is subject to teleportations.",
+          "parameters": {
+            "type": "OBJECT",
+            "properties": {
+              "userID": {
+                "type": "STRING",
+                "description": "ID of the user making the call"
+              },
+              "userName": {
+                "type": "STRING",
+                "description": "Name of the user making the call"
+              }
+            },
+            "required": [
+              "userID"
+            ]
+          }
+        }
+    """
+        .trimIndent()
+
+    Json.encodeToString(functionDeclaration.toInternal()).shouldEqualJson(expectedJson)
+  }
+}