alternative

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

@@ -0,0 +1,272 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.google.firebase.vertexai
+
+import android.annotation.SuppressLint
+import android.util.Log
+import com.google.firebase.Firebase
+import com.google.firebase.FirebaseApp
+import com.google.firebase.annotations.concurrent.Background
+import com.google.firebase.app
+import com.google.firebase.appcheck.interop.InteropAppCheckTokenProvider
+import com.google.firebase.auth.internal.InternalAuthProvider
+import com.google.firebase.inject.Provider
+import com.google.firebase.vertexai.type.Content
+import com.google.firebase.vertexai.type.GenerationConfig
+import com.google.firebase.vertexai.type.GenerativeBackend
+import com.google.firebase.vertexai.type.ImagenGenerationConfig
+import com.google.firebase.vertexai.type.ImagenSafetySettings
+import com.google.firebase.vertexai.type.InvalidStateException
+import com.google.firebase.vertexai.type.LiveGenerationConfig
+import com.google.firebase.vertexai.type.PublicPreviewAPI
+import com.google.firebase.vertexai.type.RequestOptions
+import com.google.firebase.vertexai.type.SafetySetting
+import com.google.firebase.vertexai.type.Tool
+import com.google.firebase.vertexai.type.ToolConfig
+import kotlin.coroutines.CoroutineContext
+
+/** Entry point for all _Vertex AI for Firebase_ functionality. */
+public class FirebaseAi
+internal constructor(
+  private val firebaseApp: FirebaseApp,
+  private val backend: GenerativeBackend,
+  @Background private val backgroundDispatcher: CoroutineContext,
+  private val appCheckProvider: Provider<InteropAppCheckTokenProvider>,
+  private val internalAuthProvider: Provider<InternalAuthProvider>,
+) {
+
+  /**
+   * Instantiates a new [GenerativeModel] given the provided parameters.
+   *
+   * @param modelName The name of the model to use, for example `"gemini-2.0-flash-exp"`.
+   * @param generationConfig The configuration parameters to use for content generation.
+   * @param safetySettings The safety bounds the model will abide to during content generation.
+   * @param tools A list of [Tool]s the model may use to generate content.
+   * @param toolConfig The [ToolConfig] that defines how the model handles the tools provided.
+   * @param systemInstruction [Content] instructions that direct the model to behave a certain way.
+   * Currently only text content is supported.
+   * @param requestOptions Configuration options for sending requests to the backend.
+   * @return The initialized [GenerativeModel] instance.
+   */
+  @JvmOverloads
+  public fun generativeModel(
+    modelName: String,
+    generationConfig: GenerationConfig? = null,
+    safetySettings: List<SafetySetting>? = null,
+    tools: List<Tool>? = null,
+    toolConfig: ToolConfig? = null,
+    systemInstruction: Content? = null,
+    requestOptions: RequestOptions = RequestOptions(),
+  ): GenerativeModel {
+    if (backend is GenerativeBackend.VertexAI) {
+      backend.validateLocation()
+    }
+    val modelUri =
+      when (backend) {
+        is GenerativeBackend.VertexAI ->
+          "projects/${firebaseApp.options.projectId}/locations/${backend.location}/publishers/google/models/${modelName}"
+        is GenerativeBackend.GoogleAI ->
+          "projects/${firebaseApp.options.projectId}/models/${modelName}"
+        else -> throw InvalidStateException("Unknown backend: $backend")
+      }
+    if (!modelName.startsWith(GEMINI_MODEL_NAME_PREFIX)) {
+      Log.w(
+        TAG,
+        """Unsupported Gemini model "${modelName}"; see
+      https://firebase.google.com/docs/vertex-ai/models for a list supported Gemini model names.
+      """
+          .trimIndent(),
+      )
+    }
+    return GenerativeModel(
+      modelUri,
+      firebaseApp.options.apiKey,
+      firebaseApp,
+      generationConfig,
+      safetySettings,
+      tools,
+      toolConfig,
+      systemInstruction,
+      requestOptions,
+      backend,
+      appCheckProvider.get(),
+      internalAuthProvider.get(),
+    )
+  }
+
+  /**
+   * Instantiates a new [LiveGenerationConfig] given the provided parameters.
+   *
+   * @param modelName The name of the model to use, for example `"gemini-2.0-flash-exp"`.
+   * @param generationConfig The configuration parameters to use for content generation.
+   * @param tools A list of [Tool]s the model may use to generate content.
+   * @param systemInstruction [Content] instructions that direct the model to behave a certain way.
+   * Currently only text content is supported.
+   * @param requestOptions Configuration options for sending requests to the backend.
+   * @return The initialized [LiveGenerativeModel] instance.
+   */
+  @JvmOverloads
+  @PublicPreviewAPI
+  public fun liveModel(
+    modelName: String,
+    generationConfig: LiveGenerationConfig? = null,
+    tools: List<Tool>? = null,
+    systemInstruction: Content? = null,
+    requestOptions: RequestOptions = RequestOptions(),
+  ): LiveGenerativeModel {
+    if (!modelName.startsWith(GEMINI_MODEL_NAME_PREFIX)) {
+      Log.w(
+        TAG,
+        """Unsupported Gemini model "$modelName"; see
+      https://firebase.google.com/docs/vertex-ai/models for a list supported Gemini model names.
+      """
+          .trimIndent(),
+      )
+    }
+    if (backend !is GenerativeBackend.VertexAI) {
+      throw UnsupportedOperationException("Only supported in vertex for now")
+    }
+
+    backend.validateLocation()
+
+    return LiveGenerativeModel(
+      "projects/${firebaseApp.options.projectId}/locations/${backend.location}/publishers/google/models/${modelName}",
+      firebaseApp.options.apiKey,
+      firebaseApp,
+      backgroundDispatcher,
+      generationConfig,
+      tools,
+      systemInstruction,
+      backend.location,
+      requestOptions,
+      appCheckProvider.get(),
+      internalAuthProvider.get(),
+    )
+  }
+
+  /**
+   * Instantiates a new [ImagenModel] given the provided parameters.
+   *
+   * @param modelName The name of the model to use, for example `"imagen-3.0-generate-001"`.
+   * @param generationConfig The configuration parameters to use for image generation.
+   * @param safetySettings The safety bounds the model will abide by during image generation.
+   * @param requestOptions Configuration options for sending requests to the backend.
+   * @return The initialized [ImagenModel] instance.
+   */
+  @JvmOverloads
+  @PublicPreviewAPI
+  public fun imagenModel(
+    modelName: String,
+    generationConfig: ImagenGenerationConfig? = null,
+    safetySettings: ImagenSafetySettings? = null,
+    requestOptions: RequestOptions = RequestOptions(),
+  ): ImagenModel {
+    val modelUri =
+      when (backend) {
+        is GenerativeBackend.VertexAI ->
+          "projects/${firebaseApp.options.projectId}/locations/${backend.location}/publishers/google/models/${modelName}"
+        is GenerativeBackend.GoogleAI ->
+          "projects/${firebaseApp.options.projectId}/models/${modelName}"
+        else -> throw InvalidStateException("Unknown backend: $backend")
+      }
+    if (backend is GenerativeBackend.VertexAI) {
+      backend.validateLocation()
+    }
+    if (!modelName.startsWith(IMAGEN_MODEL_NAME_PREFIX)) {
+      Log.w(
+        TAG,
+        """Unsupported Imagen model "${modelName}"; see
+      https://firebase.google.com/docs/vertex-ai/models for a list supported Imagen model names.
+      """
+          .trimIndent(),
+      )
+    }
+    return ImagenModel(
+      modelUri,
+      firebaseApp.options.apiKey,
+      firebaseApp,
+      generationConfig,
+      safetySettings,
+      requestOptions,
+      appCheckProvider.get(),
+      internalAuthProvider.get(),
+    )
+  }
+
+  public companion object {
+    /** The [FirebaseAi] instance for the default [FirebaseApp] and the GoogleAI backend. */
+    @JvmStatic
+    public val instance: FirebaseAi
+      get() = getInstance(Firebase.app)
+
+    /**
+     * Returns the [FirebaseVertexAI] instance for the provided [FirebaseApp] and [location].
+     *
+     * @param location location identifier, defaults to `us-central1`; see available
+     * [Vertex AI regions](https://firebase.google.com/docs/vertex-ai/locations?platform=android#available-locations)
+     * .
+     */
+    @JvmStatic
+    public fun getInstance(
+      backend: GenerativeBackend
+    ): FirebaseAi = getInstance(Firebase.app, backend)
+
+    /**
+     * Returns the [FirebaseVertexAI] instance for the provided [FirebaseApp] and [location].
+     *
+     * @param location location identifier, defaults to `us-central1`; see available
+     * [Vertex AI regions](https://firebase.google.com/docs/vertex-ai/locations?platform=android#available-locations)
+     * .
+     */
+    @JvmStatic
+    public fun getInstance(
+      app: FirebaseApp
+    ): FirebaseAi = getInstance(app, GenerativeBackend.GoogleAI())
+
+    /**
+     * Returns the [FirebaseVertexAI] instance for the provided [FirebaseApp] and [location].
+     *
+     * @param location location identifier, defaults to `us-central1`; see available
+     * [Vertex AI regions](https://firebase.google.com/docs/vertex-ai/locations?platform=android#available-locations)
+     * .
+     */
+    @SuppressLint("FirebaseUseExplicitDependencies")
+    @JvmStatic
+    public fun getInstance(
+      app: FirebaseApp,
+      backend: GenerativeBackend
+    ): FirebaseAi {
+      val multiResourceComponent = app[FirebaseVertexAIMultiResourceComponent::class.java]
+      return multiResourceComponent.getFirebaseAI(backend)
+    }
+
+    private const val GEMINI_MODEL_NAME_PREFIX = "gemini-"
+
+    private const val IMAGEN_MODEL_NAME_PREFIX = "imagen-"
+
+    private val TAG = FirebaseVertexAI::class.java.simpleName
+  }
+}
+
+/** Returns the [FirebaseVertexAI] instance of the default [FirebaseApp]. */
+public val Firebase.ai: FirebaseAi
+  get() = FirebaseAi.instance
+
+/** Returns the [FirebaseVertexAI] instance of a given [FirebaseApp]. */
+public fun Firebase.ai(
+  app: FirebaseApp = Firebase.app,
+  backend: GenerativeBackend = GenerativeBackend.GoogleAI()
+): FirebaseAi = FirebaseAi.getInstance(app, backend)