fixes for comments

Author: David Motsonashvili

firebase-ai/CHANGELOG.md

@@ -1,3 +1,15 @@
 # Unreleased
-
-
+* [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)

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

@@ -30,24 +30,28 @@ import com.google.firebase.ai.type.LiveGenerationConfig
 import com.google.firebase.ai.type.PublicPreviewAPI
 import com.google.firebase.ai.type.RequestOptions
 import com.google.firebase.ai.type.SafetySetting
+import com.google.firebase.ai.type.ServiceDisabledException
 import com.google.firebase.ai.type.Tool
 import com.google.firebase.ai.type.ToolConfig
-import com.google.firebase.annotations.concurrent.Background
+import com.google.firebase.annotations.concurrent.Blocking
 import com.google.firebase.app
 import com.google.firebase.appcheck.interop.InteropAppCheckTokenProvider
 import com.google.firebase.auth.internal.InternalAuthProvider
 import com.google.firebase.inject.Provider
 import kotlin.coroutines.CoroutineContext
 
-/** Entry point for all _Vertex AI for Firebase_ functionality. */
+/** Entry point for all _Firebase AI_ functionality. */
 public class FirebaseAI
 internal constructor(
   private val firebaseApp: FirebaseApp,
   private val backend: GenerativeBackend,
-  @Background private val backgroundDispatcher: CoroutineContext,
+  @Blocking private val blockingDispatcher: CoroutineContext,
   private val appCheckProvider: Provider<InteropAppCheckTokenProvider>,
   private val internalAuthProvider: Provider<InternalAuthProvider>,
 ) {
+  init {
+    validateLocation()
+  }
 
   /**
    * Instantiates a new [GenerativeModel] given the provided parameters.
@@ -72,7 +76,6 @@ internal constructor(
     systemInstruction: Content? = null,
     requestOptions: RequestOptions = RequestOptions(),
   ): GenerativeModel {
-    validateLocation()
     val modelUri =
       when (backend.backend) {
         GenerativeBackendEnum.VERTEX_AI ->
@@ -134,12 +137,16 @@ internal constructor(
           .trimIndent(),
       )
     }
-    validateLocation()
     return LiveGenerativeModel(
-      "projects/${firebaseApp.options.projectId}/locations/${backend.location}/publishers/google/models/${modelName}",
+      when (backend.backend) {
+        GenerativeBackendEnum.VERTEX_AI ->
+          "projects/${firebaseApp.options.projectId}/locations/${backend.location}/publishers/google/models/${modelName}"
+        GenerativeBackendEnum.GOOGLE_AI ->
+          throw ServiceDisabledException("Live Model is not yet available on the Google AI backend")
+      },
       firebaseApp.options.apiKey,
       firebaseApp,
-      backgroundDispatcher,
+      blockingDispatcher,
       generationConfig,
       tools,
       systemInstruction,
@@ -174,7 +181,6 @@ internal constructor(
         GenerativeBackendEnum.GOOGLE_AI ->
           "projects/${firebaseApp.options.projectId}/models/${modelName}"
       }
-    validateLocation()
     if (!modelName.startsWith(IMAGEN_MODEL_NAME_PREFIX)) {
       Log.w(
         TAG,
@@ -223,7 +229,7 @@ internal constructor(
       backend: GenerativeBackend
     ): FirebaseAI {
       val multiResourceComponent = app[FirebaseAIMultiResourceComponent::class.java]
-      return multiResourceComponent.getAI(backend)
+      return multiResourceComponent.get(backend)
     }
 
     /** Returns the [FirebaseAI] instance for the provided [FirebaseApp] */

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

@@ -39,7 +39,7 @@ internal class FirebaseAIMultiResourceComponent(
 
   @GuardedBy("this") private val aiInstances: MutableMap<String, FirebaseAI> = mutableMapOf()
 
-  fun getAI(backend: GenerativeBackend): FirebaseAI =
+  fun get(backend: GenerativeBackend): FirebaseAI =
     synchronized(this) {
       aiInstances[backend.location]
         ?: FirebaseAI(

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

@@ -35,7 +35,7 @@ import kotlinx.coroutines.CoroutineDispatcher
  * @hide
  */
 @Keep
-internal class FirebaseVertexAIRegistrar : ComponentRegistrar {
+internal class FirebaseAIRegistrar : ComponentRegistrar {
   override fun getComponents() =
     listOf(
       Component.builder(FirebaseAIMultiResourceComponent::class.java)

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

@@ -234,7 +234,7 @@ internal constructor(
 
   private fun constructCountTokensRequest(vararg prompt: Content) =
     when (generativeBackend.backend) {
-      GenerativeBackendEnum.GOOGLE_AI -> CountTokensRequest.forGenAI(constructRequest(*prompt))
+      GenerativeBackendEnum.GOOGLE_AI -> CountTokensRequest.forGoogleAI(constructRequest(*prompt))
       GenerativeBackendEnum.VERTEX_AI -> CountTokensRequest.forVertexAI(constructRequest(*prompt))
     }
 

firebase-ai/src/main/kotlin/com/google/firebase/ai/common/APIController.kt

@@ -293,7 +293,7 @@ private suspend fun validateResponse(response: HttpResponse) {
   val htmlContentType = ContentType.Text.Html.withCharset(Charset.forName("utf-8"))
   if (response.status == HttpStatusCode.NotFound && response.contentType() == htmlContentType)
     throw ServerException(
-      """URL not found. Please verify the location used to create the `FirebaseVertexAI` object
+      """URL not found. Please verify the location used to create the `FirebaseAI` object
           | See https://cloud.google.com/vertex-ai/generative-ai/docs/learn/locations#available-regions
           | for the list of available locations. Raw response: ${response.bodyAsText()}"""
         .trimMargin()
@@ -323,7 +323,7 @@ private suspend fun validateResponse(response: HttpResponse) {
     val errorMessage =
       if (it.metadata?.get("service") == "firebasevertexai.googleapis.com") {
         """
-        The Vertex AI in Firebase SDK requires the Vertex AI in Firebase API
+        The Firebase AI SDK requires the Vertex AI in Firebase API
         (`firebasevertexai.googleapis.com`) to be enabled in your Firebase project. Enable this API
         by visiting the Firebase Console at
         https://console.firebase.google.com/project/${Firebase.options.projectId}/genai

firebase-ai/src/main/kotlin/com/google/firebase/ai/common/Request.kt

@@ -53,7 +53,7 @@ internal data class CountTokensRequest(
 ) : Request {
   companion object {
 
-    fun forGenAI(generateContentRequest: GenerateContentRequest) =
+    fun forGoogleAI(generateContentRequest: GenerateContentRequest) =
       CountTokensRequest(
         generateContentRequest =
           generateContentRequest.model?.let {

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

@@ -70,7 +70,7 @@ internal constructor(message: String, cause: Throwable? = null) : RuntimeExcepti
 
     /**
      * Catch any exception thrown in the [callback] block and rethrow it as a
-     * [FirebaseVertexAIException].
+     * [FirebaseAIException].
      *
      * Will return whatever the [callback] returns as well.
      *

firebase-ai/src/test/java/com/google/firebase/ai/common/util/descriptorToJson.kt

@@ -144,8 +144,8 @@ internal fun typeNameFromKind(kind: SerialKind): String {
  * Our serialization classes are nested within the public-facing classes, and that's the name we
  * want in the json output. There are two class names
  *
- * - `com.google.firebase.vertexai.type.Content.Internal` for regular scenarios
- * - `com.google.firebase.vertexai.type.Content.Internal.SomeClass` for nested classes in the
+ * - `com.google.firebase.ai.type.Content.Internal` for regular scenarios
+ * - `com.google.firebase.ai.type.Content.Internal.SomeClass` for nested classes in the
  * serializer.
  *
  * For the later time we need the second to last component, for the former we need the last