Prepare VertexAI SDK for release (#6941)

Per [b/414829218](https://b.corp.google.com/issues/414829218),

This ensures the Vertex AI SDK is properly aligned for the upcoming
release. More specifically, this PR does the following:

- Adds deprecation notices for all the public classes and interfaces,
**besides** the root `FirebaseVertexAI` class and the relevant extension
methods.
- Updates the golden file version.
- Adds the change from #6925 for working around invalid
`SafetyRating`(s).
- Adds a changelog entry that aligns with the deprecation notices.
- Adds the changes from #6939 for tracking bidi usage.
- Adds the changes from #6910 for aligning the bidi protos.

---------

Co-authored-by: Rodrigo Lazo <[email protected]>

Author: daymxn

firebase-vertexai/CHANGELOG.md

@@ -1,4 +1,17 @@
 # Unreleased
+* [changed] **Renamed / Replaced:** Vertex AI in Firebase (`FirebaseVertexAI`) has been renamed and
+ replaced by the new Firebase AI SDK: `FirebaseAI`. This is to accommodate the evolving set of
+ supported features and services. Please migrate to the new `FirebaseAI` package. See details in the
+ [migration guide](/docs/vertex-ai/migrate-to-latest-sdk).
+
+ Note: Existing Vertex AI in Firebase users may continue to use the SDK and receive bug fixes but,
+ going forward, new features will only be added into the new Firebase AI SDK.
+* [changed] **Breaking Change**: Removed the `LiveContentResponse.Status` class, and instead have nested the status
+  fields as properties of `LiveContentResponse`. (#6941)
+* [changed] **Breaking Change**: Removed the `LiveContentResponse` class, and instead have provided subclasses
+  of `LiveServerMessage` that match the responses from the model. (#6941)
+* [feature] Added support for the `id` field on `FunctionResponsePart` and `FunctionCallPart`. (#6941)
+* [feature] Added a helper field for getting all the `InlineDataPart` from a `GenerateContentResponse`. (#6941)
 
 
 # 16.4.0

firebase-vertexai/api.txt

@@ -44,6 +44,10 @@ import kotlinx.coroutines.flow.onEach
  * from the model. This will be provided to the model for each message sent (as context for the
  * discussion).
  */
+@Deprecated(
+  """The Vertex AI in Firebase SDK (firebase-vertexai) has been replaced with the FirebaseAI SDK (firebase-ai) to accommodate the evolving set of supported features and services.
+For migration details, see the migration guide: https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk"""
+)
 public class Chat(
   private val model: GenerativeModel,
   public val history: MutableList<Content> = ArrayList()

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

@@ -37,7 +37,7 @@ 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. */
+/** Entry point for all _Vertex AI in Firebase_ functionality. */
 public class FirebaseVertexAI
 internal constructor(
   private val firebaseApp: FirebaseApp,

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

@@ -25,7 +25,7 @@ import com.google.firebase.inject.Provider
 import kotlin.coroutines.CoroutineContext
 
 /**
- * Multi-resource container for Firebase Vertex AI.
+ * Multi-resource container for Vertex AI in Firebase.
  *
  * @hide
  */

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

@@ -47,6 +47,10 @@ import kotlinx.serialization.ExperimentalSerializationApi
  * Represents a multimodal model (like Gemini), capable of generating content based on various input
  * types.
  */
+@Deprecated(
+  """The Vertex AI in Firebase SDK (firebase-vertexai) has been replaced with the FirebaseAI SDK (firebase-ai) to accommodate the evolving set of supported features and services.
+For migration details, see the migration guide: https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk"""
+)
 public class GenerativeModel
 internal constructor(
   private val modelName: String,

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

@@ -36,6 +36,10 @@ import com.google.firebase.vertexai.type.RequestOptions
  * types.
  */
 @PublicPreviewAPI
+@Deprecated(
+  """The Vertex AI in Firebase SDK (firebase-vertexai) has been replaced with the FirebaseAI SDK (firebase-ai) to accommodate the evolving set of supported features and services.
+For migration details, see the migration guide: https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk"""
+)
 public class ImagenModel
 internal constructor(
   private val modelName: String,

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

@@ -46,6 +46,10 @@ import kotlinx.serialization.json.JsonObject
  * various input types, supporting bidirectional streaming.
  */
 @PublicPreviewAPI
+@Deprecated(
+  """The Vertex AI in Firebase SDK (firebase-vertexai) has been replaced with the FirebaseAI SDK (firebase-ai) to accommodate the evolving set of supported features and services.
+For migration details, see the migration guide: https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk"""
+)
 public class LiveGenerativeModel
 internal constructor(
   private val modelName: String,

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

@@ -164,7 +164,7 @@ internal constructor(
     "wss://firebasevertexai.googleapis.com/ws/google.firebase.vertexai.v1beta.LlmBidiService/BidiGenerateContent/locations/$location?key=$key"
 
   suspend fun getWebSocketSession(location: String): ClientWebSocketSession =
-    client.webSocketSession(getBidiEndpoint(location))
+    client.webSocketSession(getBidiEndpoint(location)) { applyCommonHeaders() }
 
   fun generateContentStream(
     request: GenerateContentRequest
@@ -197,6 +197,11 @@ internal constructor(
       is CountTokensRequest -> setBody<CountTokensRequest>(request)
       is GenerateImageRequest -> setBody<GenerateImageRequest>(request)
     }
+
+    applyCommonHeaders()
+  }
+
+  private fun HttpRequestBuilder.applyCommonHeaders() {
     contentType(ContentType.Application.Json)
     header("x-goog-api-key", key)
     header("x-goog-api-client", apiClient)

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

@@ -30,6 +30,10 @@ import org.reactivestreams.Publisher
  *
  * @see [Chat]
  */
+@Deprecated(
+  """The Vertex AI in Firebase SDK (firebase-vertexai) has been replaced with the FirebaseAI SDK (firebase-ai) to accommodate the evolving set of supported features and services.
+For migration details, see the migration guide: https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk"""
+)
 public abstract class ChatFutures internal constructor() {
 
   /**