Server Prompt Templates (#2732)

davidmotson · David Motsonashvili · thatfiredev · web-flow · commit 4018b7107723 · 2025-11-19T19:26:24.000-08:00
* Server Prompt Templates * fixes for comments * clean up samples * Update FirebaseAISamples.kt * Update firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/FirebaseAISamples.kt Co-authored-by: Rosário P. Fernandes <rosariopf@google.com> * Update firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/FirebaseAISamples.kt Co-authored-by: Rosário P. Fernandes <rosariopf@google.com> * Update firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/FirebaseAISamples.kt Co-authored-by: Rosário P. Fernandes <rosariopf@google.com> * Update firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/FirebaseAISamples.kt Co-authored-by: Rosário P. Fernandes <rosariopf@google.com> * Update firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/FirebaseAISamples.kt Co-authored-by: Rosário P. Fernandes <rosariopf@google.com> * Update firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/FirebaseAISamples.kt Co-authored-by: Rosário P. Fernandes <rosariopf@google.com> * Update firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/FirebaseAISamples.kt Co-authored-by: Rosário P. Fernandes <rosariopf@google.com> * update BoM version * format * Auto-update dependencies. (#2728) * refactor(ai-logic): upgrade to Imagen 4 (#2730) * Auto-update dependencies. (#2731) --------- Co-authored-by: David Motsonashvili <davidmotson@google.com> Co-authored-by: Rosário P. Fernandes <rosariopf@google.com> Co-authored-by: DPEBot <dpebot@google.com>
diff --git a/firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/FirebaseAISamples.kt b/firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/FirebaseAISamples.kt
@@ -328,7 +328,8 @@ val FIREBASE_AI_SAMPLES = listOf(
     ),
     Sample(
         title = "Grounding with Google Search",
-        description = "Use Grounding with Google Search to get responses based on up-to-date information from the web.",
+        description = "Use Grounding with Google Search to get responses based on up-to-date information from the" +
+                " web.",
         navRoute = "chat",
         categories = listOf(Category.TEXT, Category.DOCUMENT),
         modelName = "gemini-2.5-flash",
@@ -339,4 +340,30 @@ val FIREBASE_AI_SAMPLES = listOf(
             )
         },
     ),
+    Sample(
+        title = "Server Prompt Template - Imagen",
+        description = "Generate an image using a server prompt template. Note that you need to setup the template in" +
+                "the Firebase console before running this demo.",
+        navRoute = "imagen",
+        categories = listOf(Category.IMAGE),
+        initialPrompt = content { text("List of things that should be in the image") },
+        allowEmptyPrompt = false,
+        editingMode = EditingMode.TEMPLATE,
+        // To make this work, create an "Imagen (Basic)" server prompt template in your Firebase project with this name
+        templateId = "imagen-basic",
+        templateKey = "prompt"
+    ),
+    Sample(
+        title = "Server Prompt Templates - Gemini",
+        description = "Generate an invoice using server prompt templates.  Note that you need to setup the template" +
+                " in the Firebase console before running this demo.",
+        navRoute = "text",
+        categories = listOf(Category.TEXT),
+        initialPrompt = content { text("Jane Doe") },
+        allowEmptyPrompt = false,
+        // To make this work, create an `Input + System Instructions` template in your Firebase project with this name
+        templateId = "input-system-instructions",
+        templateKey = "customerName"
+    ),
+
 )
diff --git a/firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/MainActivity.kt b/firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/MainActivity.kt
@@ -35,6 +35,8 @@ import com.google.firebase.quickstart.ai.feature.media.imagen.ImagenRoute
 import com.google.firebase.quickstart.ai.feature.media.imagen.ImagenScreen
 import com.google.firebase.quickstart.ai.feature.text.ChatRoute
 import com.google.firebase.quickstart.ai.feature.text.ChatScreen
+import com.google.firebase.quickstart.ai.feature.text.TextGenRoute
+import com.google.firebase.quickstart.ai.feature.text.TextGenScreen
 import com.google.firebase.quickstart.ai.ui.navigation.MainMenuScreen
 import com.google.firebase.quickstart.ai.ui.theme.FirebaseAILogicTheme
 
@@ -90,6 +92,9 @@ class MainActivity : ComponentActivity() {
                                         "stream" -> {
                                             navController.navigate(StreamRealtimeRoute(it.id))
                                         }
+                                        "text" -> {
+                                            navController.navigate(TextGenRoute(it.id))
+                                        }
                                     }
                                 }
                             )
@@ -106,6 +111,9 @@ class MainActivity : ComponentActivity() {
                         composable<StreamRealtimeRoute> {
                             StreamRealtimeScreen()
                         }
+                        composable<TextGenRoute> {
+                            TextGenScreen()
+                        }
                     }
                 }
             }
diff --git a/firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/feature/media/imagen/EditingMode.kt b/firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/feature/media/imagen/EditingMode.kt
@@ -6,4 +6,5 @@ enum class EditingMode {
     OUTPAINTING,
     SUBJECT_REFERENCE,
     STYLE_TRANSFER,
+    TEMPLATE,
 }
diff --git a/firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/feature/media/imagen/ImagenViewModel.kt b/firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/feature/media/imagen/ImagenViewModel.kt
@@ -22,6 +22,7 @@ import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.launch
 import androidx.core.graphics.scale
+import com.google.firebase.ai.TemplateImagenModel
 import com.google.firebase.ai.type.Dimensions
 import com.google.firebase.ai.type.ImagenBackgroundMask
 import com.google.firebase.ai.type.ImagenEditMode
@@ -67,6 +68,10 @@ class ImagenViewModel(
 
     val additionalImage = sample.additionalImage
 
+    val templateId = sample.templateId
+
+    val templateKey = sample.templateKey
+
     private val _attachedImage = MutableStateFlow<Bitmap?>(null)
     val attachedImage: StateFlow<Bitmap?> = _attachedImage
 
@@ -75,6 +80,7 @@ class ImagenViewModel(
 
     // Firebase AI Logic
     private val imagenModel: ImagenModel
+    private val templateImagenModel: TemplateImagenModel
 
     init {
         val config = imagenGenerationConfig {
@@ -92,23 +98,34 @@ class ImagenViewModel(
             generationConfig = config,
             safetySettings = settings
         )
+        templateImagenModel = Firebase.ai.templateImagenModel()
     }
 
     fun generateImages(inputText: String) {
         viewModelScope.launch {
             _isLoading.value = true
+            _errorMessage.value = null // clear error message
             try {
                 val imageResponse = when(sample.editingMode) {
                     EditingMode.INPAINTING -> inpaint(imagenModel, inputText)
                     EditingMode.OUTPAINTING -> outpaint(imagenModel, inputText)
                     EditingMode.SUBJECT_REFERENCE -> drawReferenceSubject(imagenModel, inputText)
                     EditingMode.STYLE_TRANSFER -> transferStyle(imagenModel, inputText)
+                    EditingMode.TEMPLATE ->
+                        generateWithTemplate(templateImagenModel, templateId!!, mapOf(templateKey!! to inputText))
                     else -> generate(imagenModel, inputText)
                 }
                 _generatedBitmaps.value = imageResponse.images.map { it.asBitmap() }
-                _errorMessage.value = null // clear error message
             } catch (e: Exception) {
-                _errorMessage.value = e.localizedMessage
+                val errorMessage =
+                    if ((e.localizedMessage?.contains("not found") == true) &&
+                        sample.editingMode == EditingMode.TEMPLATE) {
+                        "Template was not found, please verify that your project contains a" +
+                                " template named \"$templateId\"."
+                    } else {
+                        e.localizedMessage
+                    }
+                _errorMessage.value = errorMessage
             } finally {
                 _isLoading.value = false
             }
@@ -212,4 +229,12 @@ class ImagenViewModel(
             inputText
         )
     }
+
+    suspend fun generateWithTemplate(
+        model: TemplateImagenModel,
+        templateId: String,
+        inputMap: Map<String, String>
+    ): ImagenGenerationResponse<ImagenInlineImage> {
+        return model.generateImages(templateId, inputMap)
+    }
 }
diff --git a/firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/feature/text/TextGenScreen.kt b/firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/feature/text/TextGenScreen.kt
@@ -0,0 +1,142 @@
+package com.google.firebase.quickstart.ai.feature.text
+
+import android.net.Uri
+import android.provider.OpenableColumns
+import android.text.format.Formatter
+import androidx.activity.compose.rememberLauncherForActivityResult
+import androidx.activity.result.contract.ActivityResultContracts
+import androidx.compose.foundation.Image
+import androidx.compose.foundation.clickable
+import androidx.compose.foundation.layout.Arrangement
+import androidx.compose.foundation.layout.Box
+import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.Row
+import androidx.compose.foundation.layout.fillMaxWidth
+import androidx.compose.foundation.layout.height
+import androidx.compose.foundation.layout.padding
+import androidx.compose.foundation.lazy.grid.GridCells
+import androidx.compose.foundation.lazy.grid.LazyHorizontalGrid
+import androidx.compose.foundation.lazy.grid.items
+import androidx.compose.foundation.rememberScrollState
+import androidx.compose.foundation.verticalScroll
+import androidx.compose.material3.Card
+import androidx.compose.material3.CardDefaults
+import androidx.compose.material3.CircularProgressIndicator
+import androidx.compose.material3.DropdownMenu
+import androidx.compose.material3.DropdownMenuItem
+import androidx.compose.material3.ElevatedCard
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.material3.OutlinedTextField
+import androidx.compose.material3.Text
+import androidx.compose.material3.TextButton
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableIntStateOf
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.remember
+import androidx.compose.runtime.rememberCoroutineScope
+import androidx.compose.runtime.saveable.rememberSaveable
+import androidx.compose.runtime.setValue
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.graphics.asImageBitmap
+import androidx.compose.ui.platform.LocalContext
+import androidx.compose.ui.res.painterResource
+import androidx.compose.ui.unit.dp
+import androidx.lifecycle.compose.collectAsStateWithLifecycle
+import androidx.lifecycle.viewmodel.compose.viewModel
+import com.google.firebase.quickstart.ai.R
+import kotlinx.coroutines.launch
+import kotlinx.serialization.Serializable
+
+@Serializable
+class TextGenRoute(val sampleId: String)
+
+@Composable
+fun TextGenScreen(
+    textGenViewModel: TextGenViewModel = viewModel<TextGenViewModel>()
+) {
+    var textPrompt by rememberSaveable { mutableStateOf(textGenViewModel.initialPrompt) }
+    val errorMessage by textGenViewModel.errorMessage.collectAsStateWithLifecycle()
+    val isLoading by textGenViewModel.isLoading.collectAsStateWithLifecycle()
+    val generatedText by textGenViewModel.generatedText.collectAsStateWithLifecycle()
+
+    Column(
+        modifier = Modifier.verticalScroll(rememberScrollState())
+    ) {
+        ElevatedCard(
+            modifier = Modifier
+                .padding(all = 16.dp)
+                .fillMaxWidth(),
+            shape = MaterialTheme.shapes.large
+        ) {
+            OutlinedTextField(
+                value = textPrompt,
+                label = { Text("Prompt") },
+                placeholder = { Text("Enter text to generate") },
+                onValueChange = { textPrompt = it },
+                modifier = Modifier
+                    .padding(16.dp)
+                    .fillMaxWidth()
+            )
+            Row() {
+                TextButton(
+                    onClick = {
+                        if (textGenViewModel.allowEmptyPrompt || textPrompt.isNotBlank()) {
+                            textGenViewModel.generate(textPrompt)
+                        }
+                    },
+                    modifier = Modifier.padding(end = 16.dp, bottom = 16.dp)
+                ) {
+                    Text("Generate")
+                }
+            }
+
+        }
+
+        if (isLoading) {
+            Box(
+                contentAlignment = Alignment.Center,
+                modifier = Modifier
+                    .padding(all = 8.dp)
+                    .align(Alignment.CenterHorizontally)
+            ) {
+                CircularProgressIndicator()
+            }
+        }
+        errorMessage?.let {
+            Card(
+                modifier = Modifier
+                    .padding(horizontal = 16.dp)
+                    .fillMaxWidth(),
+                shape = MaterialTheme.shapes.large,
+                colors = CardDefaults.cardColors(
+                    containerColor = MaterialTheme.colorScheme.errorContainer
+                )
+            ) {
+                Text(
+                    text = it,
+                    color = MaterialTheme.colorScheme.error,
+                    modifier = Modifier.padding(all = 16.dp)
+                )
+            }
+        }
+        generatedText?.let {
+            Card(
+                modifier = Modifier
+                    .padding(horizontal = 16.dp)
+                    .fillMaxWidth(),
+                shape = MaterialTheme.shapes.large,
+                colors = CardDefaults.cardColors(
+                    containerColor = MaterialTheme.colorScheme.primaryContainer
+                )
+            ) {
+                Text(
+                    text = it,
+                    color = MaterialTheme.colorScheme.primary,
+                    modifier = Modifier.padding(all = 16.dp)
+                )
+            }
+        }
+    }
+}
diff --git a/firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/feature/text/TextGenViewModel.kt b/firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/feature/text/TextGenViewModel.kt
@@ -0,0 +1,83 @@
+package com.google.firebase.quickstart.ai.feature.text
+
+import androidx.lifecycle.SavedStateHandle
+import androidx.lifecycle.ViewModel
+import androidx.lifecycle.viewModelScope
+import androidx.navigation.toRoute
+import com.google.firebase.Firebase
+import com.google.firebase.ai.ai
+import com.google.firebase.ai.type.PublicPreviewAPI
+import com.google.firebase.ai.type.asTextOrNull
+import com.google.firebase.quickstart.ai.FIREBASE_AI_SAMPLES
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.launch
+import com.google.firebase.ai.GenerativeModel
+import com.google.firebase.ai.TemplateGenerativeModel
+
+@OptIn(PublicPreviewAPI::class)
+class TextGenViewModel(
+    savedStateHandle: SavedStateHandle
+) : ViewModel() {
+    private val sampleId = savedStateHandle.toRoute<TextGenRoute>().sampleId
+    private val sample = FIREBASE_AI_SAMPLES.first { it.id == sampleId }
+    val initialPrompt = sample.initialPrompt?.parts?.first()?.asTextOrNull().orEmpty()
+
+    private val _errorMessage: MutableStateFlow<String?> = MutableStateFlow(null)
+    val errorMessage: StateFlow<String?> = _errorMessage
+
+    private val _isLoading = MutableStateFlow(false)
+    val isLoading: StateFlow<Boolean> = _isLoading
+
+    val allowEmptyPrompt = sample.allowEmptyPrompt
+
+    val templateId = sample.templateId
+
+    val templateKey = sample.templateKey
+
+    private val _generatedText = MutableStateFlow<String?>(null)
+    val generatedText: StateFlow<String?> = _generatedText
+
+    // Firebase AI Logic
+    private val generativeModel: GenerativeModel
+    private val templateGenerativeModel: TemplateGenerativeModel
+
+    init {
+        generativeModel = Firebase.ai(
+            backend = sample.backend // GenerativeBackend.googleAI() by default
+        ).generativeModel(
+            modelName = sample.modelName ?: "gemini-2.5-flash",
+            systemInstruction = sample.systemInstructions,
+            generationConfig = sample.generationConfig,
+            tools = sample.tools
+        )
+        templateGenerativeModel = Firebase.ai.templateGenerativeModel()
+    }
+
+    fun generate(inputText: String) {
+        viewModelScope.launch {
+            _isLoading.value = true
+            _errorMessage.value = null // clear error message
+            try {
+                val generativeResponse = if (templateId != null) {
+                    templateGenerativeModel
+                        .generateContent(templateId, mapOf(templateKey!! to inputText))
+                } else {
+                    generativeModel.generateContent(inputText)
+                }
+                _generatedText.value = generativeResponse.text
+            } catch (e: Exception) {
+                val errorMessage =
+                    if ((e.localizedMessage?.contains("not found") == true) && (templateId != null)) {
+                        "Template was not found, please verify that your project contains a" +
+                                " template named \"$templateId\"."
+                    } else {
+                        e.localizedMessage
+                    }
+                _errorMessage.value = errorMessage
+            } finally {
+                _isLoading.value = false
+            }
+        }
+    }
+}
diff --git a/firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/ui/navigation/Sample.kt b/firebase-ai/app/src/main/java/com/google/firebase/quickstart/ai/ui/navigation/Sample.kt
@@ -45,4 +45,6 @@ data class Sample(
     val imageLabels: List<String> = emptyList(),
     val selectionOptions: List<String> = emptyList(),
     val editingMode: EditingMode? = null,
+    val templateId: String? = null,
+    val templateKey: String? = null,
 )

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,8 @@ import com.google.firebase.quickstart.ai.feature.media.imagen.ImagenRoute`
`35`	`35`	`import com.google.firebase.quickstart.ai.feature.media.imagen.ImagenScreen`
`36`	`36`	`import com.google.firebase.quickstart.ai.feature.text.ChatRoute`
`37`	`37`	`import com.google.firebase.quickstart.ai.feature.text.ChatScreen`
	`38`	`+import com.google.firebase.quickstart.ai.feature.text.TextGenRoute`
	`39`	`+import com.google.firebase.quickstart.ai.feature.text.TextGenScreen`
`38`	`40`	`import com.google.firebase.quickstart.ai.ui.navigation.MainMenuScreen`
`39`	`41`	`import com.google.firebase.quickstart.ai.ui.theme.FirebaseAILogicTheme`
`40`	`42`
`@@ -90,6 +92,9 @@ class MainActivity : ComponentActivity() {`
`90`	`92`	`"stream" -> {`
`91`	`93`	`navController.navigate(StreamRealtimeRoute(it.id))`
`92`	`94`	`}`
	`95`	`+ "text" -> {`
	`96`	`+ navController.navigate(TextGenRoute(it.id))`
	`97`	`+ }`
`93`	`98`	`}`
`94`	`99`	`}`
`95`	`100`	`)`
`@@ -106,6 +111,9 @@ class MainActivity : ComponentActivity() {`
`106`	`111`	`composable<StreamRealtimeRoute> {`
`107`	`112`	`StreamRealtimeScreen()`
`108`	`113`	`}`
	`114`	`+ composable<TextGenRoute> {`
	`115`	`+ TextGenScreen()`
	`116`	`+ }`
`109`	`117`	`}`
`110`	`118`	`}`
`111`	`119`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,4 +6,5 @@ enum class EditingMode {`
`6`	`6`	`OUTPAINTING,`
`7`	`7`	`SUBJECT_REFERENCE,`
`8`	`8`	`STYLE_TRANSFER,`
	`9`	`+ TEMPLATE,`
`9`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,4 +45,6 @@ data class Sample(`
`45`	`45`	`val imageLabels: List<String> = emptyList(),`
`46`	`46`	`val selectionOptions: List<String> = emptyList(),`
`47`	`47`	`val editingMode: EditingMode? = null,`
	`48`	`+ val templateId: String? = null,`
	`49`	`+ val templateKey: String? = null,`
`48`	`50`	`)`