Migrate to Firebase AI Logic

Migrate chatbot implementation to Firebase AI Logic

Author: lethargicpanda

README.md

@@ -46,14 +46,9 @@ Here are the screens that make up SociaLite:
 2. Open the whole project in Android Studio.
 3. Sync & Run `app` configuration
 
-> Note: The Google AI client SDK for Android used in this code sample is
-recommended for prototyping only. For non-prototyping use cases, we strongly
-recommend that you use [Vertex AI for Firebase](https://firebase.google.com/docs/vertex-ai/migrate-to-vertex-ai?platform=android).
-
-### (optional) Add Gemini API:
-4. Create a Gemini API key in [Google AI studio](https://aistudio.google.com/app/apikey),
-5. Add your Gemini API key as `API_KEY` to your [`local.properties`] file,
-6. Sync & Run `app` configuration,
+### (optional) Add Gemini API via Firebase AI Logic:
+4. Set up a Firebase Project, connect your app to the _Gemini Developer API_ by following [these steps](https://firebase.google.com/docs/ai-logic/get-started?platform=android&api=dev),
+5. Replace google-services.json with your own & Run `app` configuration,
 7. In the app, go to Settings and tap the "AI Chatbot" button.
 
 ## Reporting Issues

app/build.gradle.kts

@@ -25,6 +25,7 @@ plugins {
     alias(libs.plugins.ksp)
     alias(libs.plugins.secrets)
     alias(libs.plugins.download)
+    alias(libs.plugins.google.gms.google.services)
 }
 
 kotlin {
@@ -176,6 +177,7 @@ dependencies {
     implementation(libs.coil)
     implementation(libs.coil.compose)
 
-    implementation(libs.generativeai)
+    implementation(platform(libs.firebase.bom))
+    implementation(libs.firebase.ai)
     implementation(libs.datastore)
 }

app/google-services.json

@@ -0,0 +1,30 @@
+{
+  "comment": "NOTE: Replace this file with your own google-services.json. Learn more at: https://firebase.google.com/docs/ai-logic/get-started?api=dev#no-existing-firebase",
+  "project_info": {
+    "project_number": "123456",
+    "project_id": "mock_project",
+    "storage_bucket": "mock_project.firebasestorage.app"
+  },
+  "client": [
+    {
+      "client_info": {
+        "mobilesdk_app_id": "1:123456:android:123456",
+        "android_client_info": {
+          "package_name": "com.google.android.samples.socialite"
+        }
+      },
+      "oauth_client": [],
+      "api_key": [
+        {
+          "current_key": "123456-abcde"
+        }
+      ],
+      "services": {
+        "appinvite_service": {
+          "other_platform_oauth_client": []
+        }
+      }
+    }
+  ],
+  "configuration_version": "1"
+}

app/src/main/java/com/google/android/samples/socialite/repository/ChatRepository.kt

@@ -19,16 +19,13 @@ package com.google.android.samples.socialite.repository
 import android.content.Context
 import android.graphics.BitmapFactory
 import android.net.Uri
+import android.util.Log
 import android.widget.Toast
 import androidx.datastore.core.DataStore
 import androidx.datastore.preferences.core.Preferences
 import androidx.datastore.preferences.core.booleanPreferencesKey
 import androidx.datastore.preferences.core.edit
 import androidx.datastore.preferences.preferencesDataStore
-import com.google.ai.client.generativeai.GenerativeModel
-import com.google.ai.client.generativeai.type.Content
-import com.google.ai.client.generativeai.type.content
-import com.google.android.samples.socialite.BuildConfig
 import com.google.android.samples.socialite.R
 import com.google.android.samples.socialite.data.ChatDao
 import com.google.android.samples.socialite.data.ContactDao
@@ -38,6 +35,12 @@ import com.google.android.samples.socialite.di.AppCoroutineScope
 import com.google.android.samples.socialite.model.ChatDetail
 import com.google.android.samples.socialite.model.Message
 import com.google.android.samples.socialite.widget.model.WidgetModelRepository
+import com.google.firebase.Firebase
+import com.google.firebase.FirebaseApp
+import com.google.firebase.ai.ai
+import com.google.firebase.ai.type.Content
+import com.google.firebase.ai.type.GenerativeBackend
+import com.google.firebase.ai.type.content
 import dagger.hilt.android.qualifiers.ApplicationContext
 import javax.inject.Inject
 import javax.inject.Singleton
@@ -97,11 +100,8 @@ class ChatRepository @Inject internal constructor(
         saveMessageAndNotify(chatId, text, 0L, mediaUri, mediaMimeType, detail, PushReason.OutgoingMessage)
 
         // Create a generative AI Model to interact with the Gemini API.
-        val generativeModel = GenerativeModel(
-            modelName = "gemini-1.5-pro-latest",
-            // Set your Gemini API in as an `API_KEY` variable in your local.properties file
-            apiKey = BuildConfig.API_KEY,
-            // Set a system instruction to set the behavior of the model.
+        val generativeModel = Firebase.ai(backend = GenerativeBackend.googleAI()).generativeModel(
+            modelName = "gemini-2.0-flash-lite-001",
             systemInstruction = content {
                 text("Please respond to this chat conversation like a friendly ${detail.firstContact.replyModel}.")
             },
@@ -297,7 +297,10 @@ class ChatRepository @Inject internal constructor(
     }
 
     fun toggleChatbotSetting() {
-        if (BuildConfig.API_KEY == "DUMMY_API_KEY") {
+        val firebaseApp = FirebaseApp.getInstance()
+
+        Log.d("ChatRepository", "Firebase App ID: ${firebaseApp.options.projectId}")
+        if (firebaseApp.options.projectId == "mock_project") {
             Toast.makeText(
                 appContext,
                 appContext.getString(R.string.set_api_key_toast),

app/src/main/res/values/strings.xml

@@ -72,7 +72,7 @@
     <string name="ai_chatbot_setting">AI Chatbot</string>
     <string name="ai_chatbot_setting_enabled">enabled</string>
     <string name="ai_chatbot_setting_disabled">disabled</string>
-    <string name="set_api_key_toast">Please set your API key in local.properties</string>
+    <string name="set_api_key_toast">Please connect your app to Firebase to enable AI Chatbot</string>
     <string name="gemini_error">Gemini error (%1$s)</string>
     <string name="image_error">Can\'t open image</string>
     <string name="unknown_error">Unknown error</string>

gradle/libs.versions.toml

@@ -29,6 +29,8 @@ core = "1.15.0"
 core-performance = "1.0.0"
 core-splashscreen = "1.0.1"
 espresso = "3.6.1"
+firebaseBoM = "33.14.0"
+googleGmsGoogleServices = "4.4.2"
 download = "5.6.0"
 graphics = "1.0.1"
 hilt = "2.49"
@@ -53,7 +55,6 @@ window = "1.3.0"
 material3-adaptive-navigation-suite = "1.3.1"
 glance = "1.1.1"
 secrets = "2.0.1"
-generativeai = "0.9.0"
 datastore = "1.1.1"
 visionCommon = "17.3.0"
 segmentationSelfie = "16.0.0-beta6"
@@ -123,7 +124,8 @@ turbine = { group = "app.cash.turbine", name = "turbine", version.ref = "turbine
 uiautomator = { group = "androidx.test.uiautomator", name = "uiautomator", version.ref = "uiautomator" }
 window = { group = "androidx.window", name = "window", version.ref = "window" }
 ktlint = "com.pinterest.ktlint:ktlint-cli:1.1.1" # Used in build.gradle.kts
-generativeai = { group = "com.google.ai.client.generativeai", name = "generativeai", version.ref = "generativeai"}
+firebase-bom = { group = "com.google.firebase", name = "firebase-bom", version.ref = "firebaseBoM" }
+firebase-ai = { group = "com.google.firebase", name = "firebase-ai" }
 datastore = { group = "androidx.datastore", name = "datastore-preferences", version.ref = "datastore"}
 vision-common = { group = "com.google.mlkit", name = "vision-common", version.ref = "visionCommon" }
 segmentation-selfie = { group = "com.google.mlkit", name = "segmentation-selfie", version.ref = "segmentationSelfie" }
@@ -143,3 +145,4 @@ ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
 spotless = { id = "com.diffplug.spotless", version.ref = "spotless" }
 secrets = { id = "com.google.android.libraries.mapsplatform.secrets-gradle-plugin", version.ref = "secrets" }
 download = { id = "de.undercouch.download", version.ref = "download" }
+google-gms-google-services = { id = "com.google.gms.google-services", version.ref = "googleGmsGoogleServices" }