Add model version to GenerateContent Output (#8227)

VinayGuthal · web-flow · commit 21831fd9cf06 · 2026-06-09T13:57:33.000-04:00
This PR adds to the Firebase Android SDK's `GenerateContentResponse`
object the output-only `modelVersion` string field, which enables
developers to identify the exact version of the model that performed the
inference. This pr also updated the script to take in a branch name
argument to get the test data in.
diff --git a/ai-logic/firebase-ai-ondevice-interop/api.txt b/ai-logic/firebase-ai-ondevice-interop/api.txt
@@ -98,8 +98,11 @@ package com.google.firebase.ai.ondevice.interop {
 
   public final class GenerateContentResponse {
     ctor public GenerateContentResponse(java.util.List<com.google.firebase.ai.ondevice.interop.Candidate> candidates);
+    ctor public GenerateContentResponse(java.util.List<com.google.firebase.ai.ondevice.interop.Candidate> candidates, String? modelVersion = null);
     method public java.util.List<com.google.firebase.ai.ondevice.interop.Candidate> getCandidates();
+    method public String? getModelVersion();
     property public final java.util.List<com.google.firebase.ai.ondevice.interop.Candidate> candidates;
+    property public final String? modelVersion;
   }
 
   public final class GenerationConfig {
diff --git a/ai-logic/firebase-ai-ondevice-interop/src/main/kotlin/com/google/firebase/ai/ondevice/interop/GenerateContentResponse.kt b/ai-logic/firebase-ai-ondevice-interop/src/main/kotlin/com/google/firebase/ai/ondevice/interop/GenerateContentResponse.kt
@@ -20,5 +20,8 @@ package com.google.firebase.ai.ondevice.interop
  * Represents a content generation response from the model.
  *
  * @property candidates The individual responses from the model.
+ * @property modelVersion The version of the model that generated the response.
  */
-public class GenerateContentResponse(public val candidates: List<Candidate>) {}
+public class GenerateContentResponse
+@JvmOverloads
+constructor(public val candidates: List<Candidate>, public val modelVersion: String? = null) {}
diff --git a/ai-logic/firebase-ai-ondevice/CHANGELOG.md b/ai-logic/firebase-ai-ondevice/CHANGELOG.md
@@ -1,5 +1,7 @@
 # Unreleased
 
+- [feature] Added `modelVersion` property to `GenerateContentResponse` (#8227)
+
 # 16.0.0-beta02
 
 - [feature] Added support for model selection, required for nano-v4. (#8043)
diff --git a/ai-logic/firebase-ai-ondevice/firebase-ai-ondevice.gradle.kts b/ai-logic/firebase-ai-ondevice/firebase-ai-ondevice.gradle.kts
@@ -68,7 +68,7 @@ kotlin {
 
 dependencies {
   implementation(libs.genai.prompt)
-  implementation("com.google.firebase:firebase-ai-ondevice-interop:16.0.0-beta02")
+  implementation(project(":ai-logic:firebase-ai-ondevice-interop"))
 
   implementation(libs.firebase.common)
   implementation(libs.firebase.components)
diff --git a/ai-logic/firebase-ai-ondevice/src/main/kotlin/com/google/firebase/ai/ondevice/Converters.kt b/ai-logic/firebase-ai-ondevice/src/main/kotlin/com/google/firebase/ai/ondevice/Converters.kt
@@ -80,8 +80,9 @@ internal fun com.google.firebase.ai.ondevice.interop.GenerateContentRequest.toMl
   }
 }
 
-internal fun com.google.mlkit.genai.prompt.GenerateContentResponse.toInterop():
-  GenerateContentResponse = GenerateContentResponse(candidates.map { it.toInterop() })
+internal fun com.google.mlkit.genai.prompt.GenerateContentResponse.toInterop(
+  modelName: String
+): GenerateContentResponse = GenerateContentResponse(candidates.map { it.toInterop() }, modelName)
 
 // ================================================
 // `GenerationConfig` converter extension functions
diff --git a/ai-logic/firebase-ai-ondevice/src/main/kotlin/com/google/firebase/ai/ondevice/GenerativeModelImpl.kt b/ai-logic/firebase-ai-ondevice/src/main/kotlin/com/google/firebase/ai/ondevice/GenerativeModelImpl.kt
@@ -48,7 +48,7 @@ internal class GenerativeModelImpl(
   override suspend fun generateContent(request: GenerateContentRequest): GenerateContentResponse =
     try {
       val response = mlkitModel.generateContent(request.toMlKit())
-      response.toInterop()
+      response.toInterop(mlkitModel.getBaseModelName())
     } catch (e: GenAiException) {
       throw getMappingException(e)
     }
@@ -67,7 +67,7 @@ internal class GenerativeModelImpl(
     return mlkitModel
       .generateContentStream(request.toMlKit())
       .catch { throw getMappingException(it) }
-      .map { it.toInterop() }
+      .map { it.toInterop(mlkitModel.getBaseModelName()) }
   }
 
   override suspend fun getBaseModelName(): String = mlkitModel.getBaseModelName()
diff --git a/ai-logic/firebase-ai-ondevice/src/test/kotlin/com/google/firebase/ai/ondevice/ConvertersTest.kt b/ai-logic/firebase-ai-ondevice/src/test/kotlin/com/google/firebase/ai/ondevice/ConvertersTest.kt
@@ -103,4 +103,22 @@ internal class ConvertersTest {
     assertThat(mlKitRequest.candidateCount).isEqualTo(1)
     assertThat(mlKitRequest.maxOutputTokens).isEqualTo(256)
   }
+
+  @Test
+  fun `GenerateContentResponse toInterop should convert correctly and populate modelVersion`() {
+    val mlKitCandidate =
+      mock(Candidate::class.java).apply {
+        `when`(text).thenReturn("hello")
+        `when`(finishReason).thenReturn(Candidate.FinishReason.STOP)
+      }
+    val mlKitResponse =
+      mock(com.google.mlkit.genai.prompt.GenerateContentResponse::class.java).apply {
+        `when`(candidates).thenReturn(listOf(mlKitCandidate))
+      }
+    val interopResponse = mlKitResponse.toInterop("gemini-3.1-flash-lite")
+
+    assertThat(interopResponse.candidates.size).isEqualTo(1)
+    assertThat(interopResponse.candidates[0].text).isEqualTo("hello")
+    assertThat(interopResponse.modelVersion).isEqualTo("gemini-3.1-flash-lite")
+  }
 }
diff --git a/ai-logic/firebase-ai-ondevice/src/test/kotlin/com/google/firebase/ai/ondevice/GenerativeModelImplTest.kt b/ai-logic/firebase-ai-ondevice/src/test/kotlin/com/google/firebase/ai/ondevice/GenerativeModelImplTest.kt
@@ -68,6 +68,7 @@ class GenerativeModelImplTest {
   fun `generateContent should return converted response`() = runTest {
     val mlkitModel =
       mockk<MlKitGenerativeModel> {
+        coEvery { getBaseModelName() } returns "gemini-3.1-flash-lite"
         coEvery { generateContent(any<MlKitGenerateContentRequest>()) } returns
           mockk {
             every { candidates } returns
@@ -111,6 +112,7 @@ class GenerativeModelImplTest {
   fun `generateContentStream should emit converted responses`() = runTest {
     val mlkitModel =
       mockk<MlKitGenerativeModel> {
+        coEvery { getBaseModelName() } returns "gemini-3.1-flash-lite"
         coEvery { generateContentStream(any<MlKitGenerateContentRequest>()) } returns
           flowOf(
             mockk {
diff --git a/ai-logic/firebase-ai/CHANGELOG.md b/ai-logic/firebase-ai/CHANGELOG.md
@@ -1,5 +1,6 @@
 # Unreleased
 
+- [feature] Added `modelVersion` property to `GenerateContentResponse` (#8227)
 - [feature] Added [firebase_app_check] as a dependency of the SDK (#8225)
 
 # 17.12.1
diff --git a/ai-logic/firebase-ai/api.txt b/ai-logic/firebase-ai/api.txt
@@ -679,6 +679,7 @@ package com.google.firebase.ai.type {
     method public java.util.List<com.google.firebase.ai.type.FunctionCallPart> getFunctionCalls();
     method public com.google.firebase.ai.InferenceSource getInferenceSource();
     method public java.util.List<com.google.firebase.ai.type.InlineDataPart> getInlineDataParts();
+    method public String? getModelVersion();
     method public com.google.firebase.ai.type.PromptFeedback? getPromptFeedback();
     method public String? getText();
     method public String? getThoughtSummary();
@@ -687,6 +688,7 @@ package com.google.firebase.ai.type {
     property public final java.util.List<com.google.firebase.ai.type.FunctionCallPart> functionCalls;
     property public final com.google.firebase.ai.InferenceSource inferenceSource;
     property public final java.util.List<com.google.firebase.ai.type.InlineDataPart> inlineDataParts;
+    property public final String? modelVersion;
     property public final com.google.firebase.ai.type.PromptFeedback? promptFeedback;
     property public final String? text;
     property public final String? thoughtSummary;
diff --git a/ai-logic/firebase-ai/firebase-ai.gradle.kts b/ai-logic/firebase-ai/firebase-ai.gradle.kts
@@ -98,7 +98,7 @@ dependencies {
   implementation("androidx.concurrent:concurrent-futures:1.2.0")
   implementation("androidx.concurrent:concurrent-futures-ktx:1.2.0")
   implementation("com.google.firebase:firebase-auth-interop:18.0.0")
-  implementation("com.google.firebase:firebase-ai-ondevice-interop:16.0.0-beta02")
+  implementation(project(":ai-logic:firebase-ai-ondevice-interop"))
 
   // Use different logging libraries depending on the variant
   releaseImplementation(libs.slf4j.nop)
diff --git a/ai-logic/firebase-ai/gradle.properties b/ai-logic/firebase-ai/gradle.properties
@@ -12,5 +12,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-version=17.12.2
+version=17.13.0
 latestReleasedVersion=17.12.1
diff --git a/ai-logic/firebase-ai/src/main/kotlin/com/google/firebase/ai/generativemodel/OnDeviceGenerativeModelProvider.kt b/ai-logic/firebase-ai/src/main/kotlin/com/google/firebase/ai/generativemodel/OnDeviceGenerativeModelProvider.kt
@@ -73,7 +73,8 @@ internal class OnDeviceGenerativeModelProvider(
         response.candidates.map { Candidate.fromInterop(it) },
         InferenceSource.ON_DEVICE,
         null,
-        null
+        null,
+        response.modelVersion
       )
     }
 
@@ -122,7 +123,8 @@ internal class OnDeviceGenerativeModelProvider(
             it.candidates.map { candidate -> Candidate.fromInterop(candidate) },
             InferenceSource.ON_DEVICE,
             null,
-            null
+            null,
+            it.modelVersion
           )
         }
     )
diff --git a/ai-logic/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/GenerateContentResponse.kt b/ai-logic/firebase-ai/src/main/kotlin/com/google/firebase/ai/type/GenerateContentResponse.kt
@@ -35,6 +35,7 @@ internal constructor(
   public val inferenceSource: InferenceSource,
   public val promptFeedback: PromptFeedback?,
   public val usageMetadata: UsageMetadata?,
+  public val modelVersion: String?
 ) {
 
   // To maintain backwards compatibility with possible outside usage, we maintain a public
@@ -47,7 +48,7 @@ internal constructor(
     candidates: List<Candidate>,
     promptFeedback: PromptFeedback?,
     usageMetadata: UsageMetadata?,
-  ) : this(candidates, InferenceSource.IN_CLOUD, promptFeedback, usageMetadata)
+  ) : this(candidates, InferenceSource.IN_CLOUD, promptFeedback, usageMetadata, null)
 
   /**
    * Convenience field representing all the text parts in the response as a single string.
@@ -118,13 +119,15 @@ internal constructor(
     val candidates: List<Candidate.Internal>? = null,
     val promptFeedback: PromptFeedback.Internal? = null,
     val usageMetadata: UsageMetadata.Internal? = null,
+    val modelVersion: String? = null,
   ) : Response {
     internal fun toPublic(): GenerateContentResponse {
       return GenerateContentResponse(
         candidates?.map { it.toPublic() }.orEmpty(),
         InferenceSource.IN_CLOUD,
         promptFeedback?.toPublic(),
-        usageMetadata?.toPublic()
+        usageMetadata?.toPublic(),
+        modelVersion
       )
     }
   }
diff --git a/ai-logic/firebase-ai/src/test/java/com/google/firebase/ai/DevAPIStreamingSnapshotTests.kt b/ai-logic/firebase-ai/src/test/java/com/google/firebase/ai/DevAPIStreamingSnapshotTests.kt
@@ -78,6 +78,7 @@ internal class DevAPIStreamingSnapshotTests {
           finishReason shouldBe FinishReason.STOP
           finishMessage shouldBe "Finished successfully"
         }
+        responseList.last().modelVersion shouldBe "gemini-3.1-flash-lite"
       }
     }
 
@@ -93,6 +94,7 @@ internal class DevAPIStreamingSnapshotTests {
           finishReason shouldBe FinishReason.STOP
           content.parts.isEmpty() shouldBe false
         }
+        responseList.last().modelVersion shouldBe "gemini-3.1-flash-lite"
       }
     }
 
@@ -110,6 +112,7 @@ internal class DevAPIStreamingSnapshotTests {
           finishReason shouldBe FinishReason.STOP
           content.parts.isEmpty() shouldBe false
         }
+        responseList.last().modelVersion shouldBe "gemini-2.5-flash-image-preview"
       }
     }
 
@@ -129,6 +132,7 @@ internal class DevAPIStreamingSnapshotTests {
           it.thoughtSignature.shouldNotBeNull()
           it.thoughtSignature.shouldStartWith("CiIBVKhc7vB")
         }
+        responseList.last().modelVersion shouldBe "gemini-2.5-flash"
       }
     }
 
diff --git a/ai-logic/firebase-ai/src/test/java/com/google/firebase/ai/DevAPIUnarySnapshotTests.kt b/ai-logic/firebase-ai/src/test/java/com/google/firebase/ai/DevAPIUnarySnapshotTests.kt
@@ -52,6 +52,7 @@ internal class DevAPIUnarySnapshotTests {
         response.candidates.shouldNotBeEmpty()
         response.candidates.first().finishReason shouldBe FinishReason.STOP
         response.candidates.first().content.parts.shouldNotBeEmpty()
+        response.modelVersion shouldBe "gemini-3.1-flash-lite"
       }
     }
 
@@ -79,6 +80,7 @@ internal class DevAPIUnarySnapshotTests {
         response.candidates.shouldNotBeEmpty()
         response.candidates.first().finishReason shouldBe FinishReason.STOP
         response.candidates.first().content.parts.shouldNotBeEmpty()
+        response.modelVersion shouldBe "gemini-3.1-flash-lite"
       }
     }
 
@@ -94,6 +96,7 @@ internal class DevAPIUnarySnapshotTests {
           it.startIndex.shouldNotBeNull()
           it.endIndex.shouldNotBeNull()
         }
+        response.modelVersion shouldBe "gemini-3.1-flash-lite"
       }
     }
 
@@ -136,6 +139,7 @@ internal class DevAPIUnarySnapshotTests {
 
         groundingMetadata.groundingChunks.shouldNotBeEmpty()
         groundingMetadata.groundingChunks.forEach { it.web.shouldBeNull() }
+        response.modelVersion shouldBe "gemini-3.1-flash-lite"
       }
     }
 
diff --git a/ai-logic/firebase-ai/src/test/java/com/google/firebase/ai/SerializationTests.kt b/ai-logic/firebase-ai/src/test/java/com/google/firebase/ai/SerializationTests.kt
@@ -122,6 +122,9 @@ internal class SerializationTests {
             },
             "usageMetadata": {
                 "${'$'}ref": "UsageMetadata"
+            },
+            "modelVersion": {
+                "type": "string"
             }
         }
      }
diff --git a/ai-logic/firebase-ai/update_responses.sh b/ai-logic/firebase-ai/update_responses.sh
@@ -17,15 +17,16 @@
 # This script replaces mock response files for Vertex AI unit tests with a fresh
 # clone of the shared repository of Vertex AI test data.
 
-RESPONSES_VERSION='v16.*' # The major version of mock responses to use
+RESPONSES_VERSION='v17.*' # The major version of mock responses to use
+BRANCH_NAME=${1:-main}
 REPO_NAME="vertexai-sdk-test-data"
 REPO_LINK="https://github.com/FirebaseExtended/$REPO_NAME.git"
 
 set -x
 
 cd "$(dirname "$0")/src/test/resources" || exit
 rm -rf "$REPO_NAME"
-git clone "$REPO_LINK" --quiet || exit
+git clone "$REPO_LINK" --branch "$BRANCH_NAME" --quiet || exit
 cd "$REPO_NAME" || exit
 
 # Find and checkout latest tag matching major version
@@ -34,4 +35,4 @@ if [ -z "$TAG" ]; then
   echo "Error: No tag matching '$RESPONSES_VERSION' found in $REPO_NAME"
   exit
 fi
-git checkout "$TAG" --quiet
+git checkout "$TAG" --quiet

Original file line number	Diff line number	Diff line change
`@@ -80,8 +80,9 @@ internal fun com.google.firebase.ai.ondevice.interop.GenerateContentRequest.toMl`
`80`	`80`	`}`
`81`	`81`	`}`
`82`	`82`
`83`		`-internal fun com.google.mlkit.genai.prompt.GenerateContentResponse.toInterop():`
`84`		`- GenerateContentResponse = GenerateContentResponse(candidates.map { it.toInterop() })`
	`83`	`+internal fun com.google.mlkit.genai.prompt.GenerateContentResponse.toInterop(`
	`84`	`+ modelName: String`
	`85`	`+): GenerateContentResponse = GenerateContentResponse(candidates.map { it.toInterop() }, modelName)`
`85`	`86`
`86`	`87`	`// ================================================`
`87`	`88`	// `GenerationConfig` converter extension functions