Merge branch 'main' into dconeybe/GradlePluginVersionIntoLibsVersionsToml

Author: dconeybe

firebase-vertexai/firebase-vertexai.gradle.kts

@@ -16,6 +16,9 @@
 
 @file:Suppress("UnstableApiUsage")
 
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+
 plugins {
   id("firebase-library")
   id("kotlin-android")
@@ -66,6 +69,21 @@ android {
   }
 }
 
+// Enable Kotlin "Explicit API Mode". This causes the Kotlin compiler to fail if any
+// classes, methods, or properties have implicit `public` visibility. This check helps
+// avoid  accidentally leaking elements into the public API, requiring that any public
+// element be explicitly declared as `public`.
+// https://github.com/Kotlin/KEEP/blob/master/proposals/explicit-api-mode.md
+// https://chao2zhang.medium.com/explicit-api-mode-for-kotlin-on-android-b8264fdd76d1
+tasks.withType<KotlinCompile>().all {
+  if (!name.contains("test", ignoreCase = true)) {
+    if (!kotlinOptions.freeCompilerArgs.contains("-Xexplicit-api=strict")) {
+      kotlinOptions.freeCompilerArgs += "-Xexplicit-api=strict"
+    }
+  }
+}
+
+
 dependencies {
   val ktorVersion = "2.3.2"
 

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/Chat.kt

@@ -42,7 +42,10 @@ import kotlinx.coroutines.flow.onEach
  * @param model The model to use for the interaction
  * @property history The previous interactions with the model
  */
-class Chat(private val model: GenerativeModel, val history: MutableList<Content> = ArrayList()) {
+public class Chat(
+  private val model: GenerativeModel,
+  public val history: MutableList<Content> = ArrayList()
+) {
   private var lock = Semaphore(1)
 
   /**
@@ -53,7 +56,7 @@ class Chat(private val model: GenerativeModel, val history: MutableList<Content>
    * @throws InvalidStateException if the prompt is not coming from the 'user' role
    * @throws InvalidStateException if the [Chat] instance has an active request.
    */
-  suspend fun sendMessage(prompt: Content): GenerateContentResponse {
+  public suspend fun sendMessage(prompt: Content): GenerateContentResponse {
     prompt.assertComesFromUser()
     attemptLock()
     try {
@@ -72,7 +75,7 @@ class Chat(private val model: GenerativeModel, val history: MutableList<Content>
    * @param prompt The text to be converted into a single piece of [Content] to send to the model.
    * @throws InvalidStateException if the [Chat] instance has an active request.
    */
-  suspend fun sendMessage(prompt: String): GenerateContentResponse {
+  public suspend fun sendMessage(prompt: String): GenerateContentResponse {
     val content = content { text(prompt) }
     return sendMessage(content)
   }
@@ -83,7 +86,7 @@ class Chat(private val model: GenerativeModel, val history: MutableList<Content>
    * @param prompt The image to be converted into a single piece of [Content] to send to the model.
    * @throws InvalidStateException if the [Chat] instance has an active request.
    */
-  suspend fun sendMessage(prompt: Bitmap): GenerateContentResponse {
+  public suspend fun sendMessage(prompt: Bitmap): GenerateContentResponse {
     val content = content { image(prompt) }
     return sendMessage(content)
   }
@@ -96,7 +99,7 @@ class Chat(private val model: GenerativeModel, val history: MutableList<Content>
    * @throws InvalidStateException if the prompt is not coming from the 'user' role
    * @throws InvalidStateException if the [Chat] instance has an active request.
    */
-  fun sendMessageStream(prompt: Content): Flow<GenerateContentResponse> {
+  public fun sendMessageStream(prompt: Content): Flow<GenerateContentResponse> {
     prompt.assertComesFromUser()
     attemptLock()
 
@@ -149,7 +152,7 @@ class Chat(private val model: GenerativeModel, val history: MutableList<Content>
    * @return A [Flow] which will emit responses as they are returned from the model.
    * @throws InvalidStateException if the [Chat] instance has an active request.
    */
-  fun sendMessageStream(prompt: String): Flow<GenerateContentResponse> {
+  public fun sendMessageStream(prompt: String): Flow<GenerateContentResponse> {
     val content = content { text(prompt) }
     return sendMessageStream(content)
   }
@@ -161,7 +164,7 @@ class Chat(private val model: GenerativeModel, val history: MutableList<Content>
    * @return A [Flow] which will emit responses as they are returned from the model.
    * @throws InvalidStateException if the [Chat] instance has an active request.
    */
-  fun sendMessageStream(prompt: Bitmap): Flow<GenerateContentResponse> {
+  public fun sendMessageStream(prompt: Bitmap): Flow<GenerateContentResponse> {
     val content = content { image(prompt) }
     return sendMessageStream(content)
   }

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/FirebaseVertexAI.kt

@@ -31,7 +31,7 @@ import com.google.firebase.vertexai.type.Tool
 import com.google.firebase.vertexai.type.ToolConfig
 
 /** Entry point for all _Vertex AI for Firebase_ functionality. */
-class FirebaseVertexAI
+public class FirebaseVertexAI
 internal constructor(
   private val firebaseApp: FirebaseApp,
   private val location: String,
@@ -51,7 +51,7 @@ internal constructor(
    * @param systemInstruction contains a [Content] that directs the model to behave a certain way
    */
   @JvmOverloads
-  fun generativeModel(
+  public fun generativeModel(
     modelName: String,
     generationConfig: GenerationConfig? = null,
     safetySettings: List<SafetySetting>? = null,
@@ -77,13 +77,13 @@ internal constructor(
     )
   }
 
-  companion object {
+  public companion object {
     /** The [FirebaseVertexAI] instance for the default [FirebaseApp] */
     @JvmStatic
-    val instance: FirebaseVertexAI
+    public val instance: FirebaseVertexAI
       get() = getInstance(location = "us-central1")
 
-    @JvmStatic fun getInstance(app: FirebaseApp): FirebaseVertexAI = getInstance(app)
+    @JvmStatic public fun getInstance(app: FirebaseApp): FirebaseVertexAI = getInstance(app)
 
     /**
      * Returns the [FirebaseVertexAI] instance for the provided [FirebaseApp] and [location]
@@ -93,19 +93,19 @@ internal constructor(
      */
     @JvmStatic
     @JvmOverloads
-    fun getInstance(app: FirebaseApp = Firebase.app, location: String): FirebaseVertexAI {
+    public fun getInstance(app: FirebaseApp = Firebase.app, location: String): FirebaseVertexAI {
       val multiResourceComponent = app[FirebaseVertexAIMultiResourceComponent::class.java]
       return multiResourceComponent.get(location)
     }
   }
 }
 
 /** Returns the [FirebaseVertexAI] instance of the default [FirebaseApp]. */
-val Firebase.vertexAI: FirebaseVertexAI
+public val Firebase.vertexAI: FirebaseVertexAI
   get() = FirebaseVertexAI.instance
 
 /** Returns the [FirebaseVertexAI] instance of a given [FirebaseApp]. */
-fun Firebase.vertexAI(
+public fun Firebase.vertexAI(
   app: FirebaseApp = Firebase.app,
   location: String = "us-central1"
 ): FirebaseVertexAI = FirebaseVertexAI.getInstance(app, location)

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

@@ -50,7 +50,7 @@ import kotlinx.coroutines.tasks.await
 /**
  * A controller for communicating with the API of a given multimodal model (for example, Gemini).
  */
-class GenerativeModel
+public class GenerativeModel
 internal constructor(
   private val modelName: String,
   private val generationConfig: GenerationConfig? = null,
@@ -128,7 +128,7 @@ internal constructor(
    * @return A [GenerateContentResponse]. Function should be called within a suspend context to
    * properly manage concurrency.
    */
-  suspend fun generateContent(vararg prompt: Content): GenerateContentResponse =
+  public suspend fun generateContent(vararg prompt: Content): GenerateContentResponse =
     try {
       controller.generateContent(constructRequest(*prompt)).toPublic().validate()
     } catch (e: Throwable) {
@@ -141,7 +141,7 @@ internal constructor(
    * @param prompt [Content] to send to the model.
    * @return A [Flow] which will emit responses as they are returned from the model.
    */
-  fun generateContentStream(vararg prompt: Content): Flow<GenerateContentResponse> =
+  public fun generateContentStream(vararg prompt: Content): Flow<GenerateContentResponse> =
     controller
       .generateContentStream(constructRequest(*prompt))
       .catch { throw FirebaseVertexAIException.from(it) }
@@ -154,7 +154,7 @@ internal constructor(
    * @return A [GenerateContentResponse] after some delay. Function should be called within a
    * suspend context to properly manage concurrency.
    */
-  suspend fun generateContent(prompt: String): GenerateContentResponse =
+  public suspend fun generateContent(prompt: String): GenerateContentResponse =
     generateContent(content { text(prompt) })
 
   /**
@@ -163,7 +163,7 @@ internal constructor(
    * @param prompt The text to be converted into a single piece of [Content] to send to the model.
    * @return A [Flow] which will emit responses as they are returned from the model.
    */
-  fun generateContentStream(prompt: String): Flow<GenerateContentResponse> =
+  public fun generateContentStream(prompt: String): Flow<GenerateContentResponse> =
     generateContentStream(content { text(prompt) })
 
   /**
@@ -173,7 +173,7 @@ internal constructor(
    * @return A [GenerateContentResponse] after some delay. Function should be called within a
    * suspend context to properly manage concurrency.
    */
-  suspend fun generateContent(prompt: Bitmap): GenerateContentResponse =
+  public suspend fun generateContent(prompt: Bitmap): GenerateContentResponse =
     generateContent(content { image(prompt) })
 
   /**
@@ -182,19 +182,20 @@ internal constructor(
    * @param prompt The image to be converted into a single piece of [Content] to send to the model.
    * @return A [Flow] which will emit responses as they are returned from the model.
    */
-  fun generateContentStream(prompt: Bitmap): Flow<GenerateContentResponse> =
+  public fun generateContentStream(prompt: Bitmap): Flow<GenerateContentResponse> =
     generateContentStream(content { image(prompt) })
 
   /** Creates a [Chat] instance which internally tracks the ongoing conversation with the model */
-  fun startChat(history: List<Content> = emptyList()): Chat = Chat(this, history.toMutableList())
+  public fun startChat(history: List<Content> = emptyList()): Chat =
+    Chat(this, history.toMutableList())
 
   /**
    * Counts the amount of tokens in a prompt.
    *
    * @param prompt A group of [Content] to count tokens of.
    * @return A [CountTokensResponse] containing the amount of tokens in the prompt.
    */
-  suspend fun countTokens(vararg prompt: Content): CountTokensResponse {
+  public suspend fun countTokens(vararg prompt: Content): CountTokensResponse {
     try {
       return controller.countTokens(constructCountTokensRequest(*prompt)).toPublic()
     } catch (e: Throwable) {
@@ -208,7 +209,7 @@ internal constructor(
    * @param prompt The text to be converted to a single piece of [Content] to count the tokens of.
    * @return A [CountTokensResponse] containing the amount of tokens in the prompt.
    */
-  suspend fun countTokens(prompt: String): CountTokensResponse {
+  public suspend fun countTokens(prompt: String): CountTokensResponse {
     return countTokens(content { text(prompt) })
   }
 
@@ -218,7 +219,7 @@ internal constructor(
    * @param prompt The image to be converted to a single piece of [Content] to count the tokens of.
    * @return A [CountTokensResponse] containing the amount of tokens in the prompt.
    */
-  suspend fun countTokens(prompt: Bitmap): CountTokensResponse {
+  public suspend fun countTokens(prompt: Bitmap): CountTokensResponse {
     return countTokens(content { image(prompt) })
   }
 
@@ -247,7 +248,7 @@ internal constructor(
       ?.let { throw ResponseStoppedException(this) }
   }
 
-  companion object {
+  private companion object {
     private val TAG = GenerativeModel::class.java.simpleName
   }
 }

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/common/shared/Types.kt

@@ -41,7 +41,7 @@ internal enum class HarmCategory {
   @SerialName("HARM_CATEGORY_DANGEROUS_CONTENT") DANGEROUS_CONTENT
 }
 
-typealias Base64 = String
+internal typealias Base64 = String
 
 @ExperimentalSerializationApi
 @Serializable

firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/internal/util/conversions.kt

@@ -21,10 +21,6 @@ import android.graphics.BitmapFactory
 import android.util.Base64
 import com.google.firebase.vertexai.common.client.Schema
 import com.google.firebase.vertexai.common.shared.FileData
-import com.google.firebase.vertexai.common.shared.FunctionCall
-import com.google.firebase.vertexai.common.shared.FunctionCallPart
-import com.google.firebase.vertexai.common.shared.FunctionResponse
-import com.google.firebase.vertexai.common.shared.FunctionResponsePart
 import com.google.firebase.vertexai.common.shared.InlineData
 import com.google.firebase.vertexai.type.BlockReason
 import com.google.firebase.vertexai.type.Candidate
@@ -34,8 +30,12 @@ import com.google.firebase.vertexai.type.Content
 import com.google.firebase.vertexai.type.CountTokensResponse
 import com.google.firebase.vertexai.type.FileDataPart
 import com.google.firebase.vertexai.type.FinishReason
+import com.google.firebase.vertexai.type.FunctionCall
+import com.google.firebase.vertexai.type.FunctionCallPart
 import com.google.firebase.vertexai.type.FunctionCallingConfig
 import com.google.firebase.vertexai.type.FunctionDeclaration
+import com.google.firebase.vertexai.type.FunctionResponse
+import com.google.firebase.vertexai.type.FunctionResponsePart
 import com.google.firebase.vertexai.type.GenerateContentResponse
 import com.google.firebase.vertexai.type.GenerationConfig
 import com.google.firebase.vertexai.type.HarmBlockMethod
@@ -59,6 +59,7 @@ import java.io.ByteArrayOutputStream
 import java.util.Calendar
 import kotlinx.serialization.json.Json
 import kotlinx.serialization.json.JsonObject
+import kotlinx.serialization.json.JsonPrimitive
 import org.json.JSONObject
 
 private const val BASE_64_FLAGS = Base64.NO_WRAP
@@ -80,10 +81,10 @@ internal fun Part.toInternal(): com.google.firebase.vertexai.common.shared.Part
       com.google.firebase.vertexai.common.shared.InlineDataPart(
         InlineData(mimeType, Base64.encodeToString(inlineData, BASE_64_FLAGS))
       )
-    is com.google.firebase.vertexai.type.FunctionCallPart ->
-      FunctionCallPart(FunctionCall(name, args.orEmpty()))
-    is com.google.firebase.vertexai.type.FunctionResponsePart ->
-      FunctionResponsePart(FunctionResponse(name, response.toInternal()))
+    is FunctionCallPart ->
+      com.google.firebase.vertexai.common.shared.FunctionCallPart(functionCall.toInternal())
+    is FunctionResponsePart ->
+      com.google.firebase.vertexai.common.shared.FunctionResponsePart(functionResponse.toInternal())
     is FileDataPart ->
       com.google.firebase.vertexai.common.shared.FileDataPart(
         FileData(mimeType = mimeType, fileUri = uri)
@@ -95,6 +96,15 @@ internal fun Part.toInternal(): com.google.firebase.vertexai.common.shared.Part
   }
 }
 
+internal fun FunctionCall.toInternal() =
+  com.google.firebase.vertexai.common.shared.FunctionCall(
+    name,
+    args.orEmpty().mapValues { it.value.toString() }
+  )
+
+internal fun FunctionResponse.toInternal() =
+  com.google.firebase.vertexai.common.shared.FunctionResponse(name, response)
+
 internal fun SafetySetting.toInternal() =
   com.google.firebase.vertexai.common.shared.SafetySetting(
     harmCategory.toInternal(),
@@ -213,16 +223,10 @@ internal fun com.google.firebase.vertexai.common.shared.Part.toPublic(): Part {
         InlineDataPart(inlineData.mimeType, data)
       }
     }
-    is FunctionCallPart ->
-      com.google.firebase.vertexai.type.FunctionCallPart(
-        functionCall.name,
-        functionCall.args.orEmpty(),
-      )
-    is FunctionResponsePart ->
-      com.google.firebase.vertexai.type.FunctionResponsePart(
-        functionResponse.name,
-        functionResponse.response.toPublic(),
-      )
+    is com.google.firebase.vertexai.common.shared.FunctionCallPart ->
+      FunctionCallPart(functionCall.toPublic())
+    is com.google.firebase.vertexai.common.shared.FunctionResponsePart ->
+      FunctionResponsePart(functionResponse.toPublic())
     is com.google.firebase.vertexai.common.shared.FileDataPart ->
       FileDataPart(fileData.mimeType, fileData.fileUri)
     else ->
@@ -232,6 +236,21 @@ internal fun com.google.firebase.vertexai.common.shared.Part.toPublic(): Part {
   }
 }
 
+internal fun com.google.firebase.vertexai.common.shared.FunctionCall.toPublic() =
+  FunctionCall(
+    name,
+    args.orEmpty().mapValues {
+      val argValue = it.value
+      if (argValue == null) JsonPrimitive(null) else Json.parseToJsonElement(argValue)
+    }
+  )
+
+internal fun com.google.firebase.vertexai.common.shared.FunctionResponse.toPublic() =
+  FunctionResponse(
+    name,
+    response,
+  )
+
 internal fun com.google.firebase.vertexai.common.server.CitationSources.toPublic(): Citation {
   val publicationDateAsCalendar =
     publicationDate?.let {