Merge branch 'main' into rl.thinking

Author: rlazo

firebase-ai/CHANGELOG.md

@@ -1,6 +1,8 @@
 # Unreleased
 * [feature] Added support for returning thought summaries, which are synthesized
   versions of a model's internal reasoning process.
+* [fixed] Fixed an issue causing the accessor methods in `GenerateContentResponse` to throw an exception
+  when the response contained no candidates.
 * [changed] Added better description for requests which fail due to the Gemini API not being
   configured.
 * [changed] Added a `dilation` parameter to `ImagenMaskReference.generateMaskAndPadForOutpainting`

firebase-ai/api.txt

@@ -157,6 +157,9 @@ package com.google.firebase.ai.java {
 
 package com.google.firebase.ai.type {
 
+  public final class APINotConfiguredException extends com.google.firebase.ai.type.FirebaseAIException {
+  }
+
   public final class AudioRecordInitializationFailedException extends com.google.firebase.ai.type.FirebaseAIException {
     ctor public AudioRecordInitializationFailedException(String message);
   }

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

@@ -158,7 +158,7 @@ public class UnsupportedUserLocationException internal constructor(cause: Throwa
  * [steps](https://firebase.google.com/docs/ai-logic/faq-and-troubleshooting?api=dev#error-genai-config-not-found)
  * to enable the Gemini Developer API.
  */
-internal class APINotConfiguredException internal constructor(cause: Throwable? = null) :
+public class APINotConfiguredException internal constructor(cause: Throwable? = null) :
   FirebaseAIException("Gemini Developer API not enabled in Firebase console.", cause)
 
 /**

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

@@ -32,8 +32,9 @@ public class GenerateContentResponse(
   public val usageMetadata: UsageMetadata?,
 ) {
   /**
-   * Convenience field representing all text parts in the response as a single string, if they
-   * exists.
+   * Convenience field representing all the text parts in the response as a single string.
+   *
+   * The value is null if the response contains no valid text [candidates].
    *
    * Any part that's marked as a thought will be ignored. Learn more about
    * [thinking](https://firebase.google.com/docs/ai-logic/thinking?api=dev).
@@ -47,11 +48,13 @@ public class GenerateContentResponse(
   /**
    * Convenience field to list all the [FunctionCallPart]s in the response.
    *
+   * The value is an empty list if the response contains no [candidates].
+   *
    * Any part that's marked as a thought will be ignored. Learn more about
    * [thinking](https://firebase.google.com/docs/ai-logic/thinking?api=dev).
    */
   public val functionCalls: List<FunctionCallPart> by lazy {
-    candidates.firstOrNull()?.nonThoughtParts()?.filterIsInstance<FunctionCallPart>().orEmpty()
+    candidates.firstOrNull()?.content?.parts?.filterIsInstance<FunctionCallPart>().orEmpty()
   }
 
   /**
@@ -69,6 +72,8 @@ public class GenerateContentResponse(
    *
    * This also includes any [ImagePart], but they will be represented as [InlineDataPart] instead.
    *
+   * The value is an empty list if the response contains no [candidates].
+   *
    * Any part that's marked as a thought will be ignored. Learn more about
    * [thinking](https://firebase.google.com/docs/ai-logic/thinking?api=dev).
    */

firebase-ai/src/test/java/com/google/firebase/ai/DevAPIUnarySnapshotTests.kt

@@ -22,12 +22,12 @@ import com.google.firebase.ai.type.ResponseStoppedException
 import com.google.firebase.ai.type.ServerException
 import com.google.firebase.ai.util.goldenDevAPIUnaryFile
 import io.kotest.assertions.throwables.shouldThrow
+import io.kotest.matchers.collections.shouldBeEmpty
 import io.kotest.matchers.collections.shouldNotBeEmpty
 import io.kotest.matchers.nulls.shouldBeNull
 import io.kotest.matchers.nulls.shouldNotBeNull
 import io.kotest.matchers.should
 import io.kotest.matchers.shouldBe
-import io.kotest.matchers.shouldNotBe
 import io.ktor.http.HttpStatusCode
 import kotlin.time.Duration.Companion.seconds
 import kotlinx.coroutines.withTimeout
@@ -42,9 +42,24 @@ internal class DevAPIUnarySnapshotTests {
       withTimeout(testTimeout) {
         val response = model.generateContent("prompt")
 
-        response.candidates.isEmpty() shouldBe false
+        response.candidates.shouldNotBeEmpty()
         response.candidates.first().finishReason shouldBe FinishReason.STOP
-        response.candidates.first().content.parts.isEmpty() shouldBe false
+        response.candidates.first().content.parts.shouldNotBeEmpty()
+      }
+    }
+
+  @Test
+  fun `only prompt feedback reply`() =
+    goldenDevAPIUnaryFile("unary-failure-only-prompt-feedback.json") {
+      withTimeout(testTimeout) {
+        val response = model.generateContent("prompt")
+
+        response.candidates.shouldBeEmpty()
+
+        // Check response from accessors
+        response.text.shouldBeNull()
+        response.functionCalls.shouldBeEmpty()
+        response.inlineDataParts.shouldBeEmpty()
       }
     }
 
@@ -54,9 +69,9 @@ internal class DevAPIUnarySnapshotTests {
       withTimeout(testTimeout) {
         val response = model.generateContent("prompt")
 
-        response.candidates.isEmpty() shouldBe false
+        response.candidates.shouldNotBeEmpty()
         response.candidates.first().finishReason shouldBe FinishReason.STOP
-        response.candidates.first().content.parts.isEmpty() shouldBe false
+        response.candidates.first().content.parts.shouldNotBeEmpty()
       }
     }
 
@@ -66,11 +81,11 @@ internal class DevAPIUnarySnapshotTests {
       withTimeout(testTimeout) {
         val response = model.generateContent("prompt")
 
-        response.candidates.isEmpty() shouldBe false
+        response.candidates.shouldNotBeEmpty()
         response.candidates.first().citationMetadata?.citations?.size shouldBe 4
         response.candidates.first().citationMetadata?.citations?.forEach {
-          it.startIndex shouldNotBe null
-          it.endIndex shouldNotBe null
+          it.startIndex.shouldNotBeNull()
+          it.endIndex.shouldNotBeNull()
         }
       }
     }