Migrate to the Firebase AI Logic SDKs from the GA version of Vertex AI in Firebase SDKs

Stay organized with collections Save and categorize content based on your preferences.

Swift

1. In Xcode, with your app project open, update your Firebase package to v11.13.0 or later using one of the following options:

   • Option 1: Update all packages: Navigate to File > Packages > Update to Latest Package Versions.

   • Option 2: Update Firebase individually: Navigate to the Firebase package in the section called Package Dependencies. Right-click on the Firebase package, and then select Update Package.

2. Make sure that the Firebase package now shows v11.13.0 or later. If it doesn't, verify that your specified Package Requirements allow updating to v11.13.0 or later.

3. Select your app's target in the Project Editor, and then navigate to the Frameworks, Libraries, and Embedded Content section.

4. Add the new library: Select the + button, and then add FirebaseAI from the Firebase package.

5. After you've finished migrating your app (see the remaining sections in this guide), make sure to remove the old library:
   Select FirebaseVertexAI, and then press the — button.

Kotlin

1. In your module (app-level) Gradle file (usually <project>/<app-module>/build.gradle.kts or <project>/<app-module>/build.gradle), replace old dependencies (as applicable) with the following.

   Note that it might be easier to migrate your app's codebase (see the remaining sections in this guide) before deleting the old dependency.

   // BEFORE
   dependencies {
     implementation(platform("com.google.firebase:firebase-bom:33.x.y"))
     implementation("com.google.firebase:firebase-vertexai")
     // OR if not using the BoM
     implementation("com.google.firebase:firebase-vertexai:16.x.y")
   }
   
   
   // AFTER
   dependencies {
     // Import the BoM for the Firebase platform
     implementation(platform("com.google.firebase:firebase-bom:33.13.0"))
   
     // Add the dependency for the Firebase AI Logic library
     // When using the BoM, you don't specify versions in Firebase library dependencies
     implementation("com.google.firebase:firebase-ai")
   }

2. Sync your Android project with Gradle files.

Note that if you choose to not use the Firebase Android BoM, then just add the dependency for the firebase-ai library and accept the latest version that's suggested by Android Studio.

Java

1. In your module (app-level) Gradle file (usually <project>/<app-module>/build.gradle.kts or <project>/<app-module>/build.gradle), replace old dependencies (as applicable) with the following.

   Note that it might be easier to migrate your app's codebase (see the remaining sections in this guide) before deleting the old dependency.

   // BEFORE
   dependencies {
     implementation(platform("com.google.firebase:firebase-bom:33.x.y"))
     implementation("com.google.firebase:firebase-vertexai")
     // OR if not using the BoM
     implementation("com.google.firebase:firebase-vertexai:16.x.y")
   }
   
   
   // AFTER
   dependencies {
     // Import the BoM for the Firebase platform
     implementation(platform("com.google.firebase:firebase-bom:33.13.0"))
   
     // Add the dependency for the Firebase AI Logic library
     // When using the BoM, you don't specify versions in Firebase library dependencies
     implementation("com.google.firebase:firebase-ai")
   }

2. Sync your Android project with Gradle files.

Note that if you choose to not use the Firebase Android BoM, then just add the dependency for the firebase-ai library and accept the latest version that's suggested by Android Studio.

Web

1. Get the latest version of the Firebase JS SDK for Web using npm:

   npm i firebase@latest

   OR

   yarn add firebase@latest

2. Wherever you've imported the library, update your import statements to use firebase/ai instead.

   Note that it might be easier to migrate your app's codebase (see the remaining sections in this guide) before deleting the old imports.

   // BEFORE
   import { initializeApp } from "firebase/app";
   import { getVertexAI, getGenerativeModel } from "firebase/vertexai";
   
   
   // AFTER
   import { initializeApp } from "firebase/app";
   import { getAI, getGenerativeModel } from "firebase/ai";

Dart

1. Update to the use the firebase_ai package in your pubspec.yaml file by running the following command from your Flutter project directory:

   flutter pub add firebase_ai

2. Rebuild your Flutter project:

   flutter run

3. After you've finished migrating your app (see the remaining sections in this guide), make sure to delete the old package:

   flutter pub remove firebase_vertexai

Unity

Support for Unity wasn't available from "Vertex AI in Firebase".

Learn how to get started with the Firebase AI Logic SDK for Unity.

Swift

import FirebaseAI

// Initialize the Vertex AI Gemini API backend service
let ai = FirebaseAI.firebaseAI(backend: .vertexAI())

// Create a `GenerativeModel` instance with a model that supports your use case
let model = ai.generativeModel(modelName: "gemini-2.0-flash")

Kotlin

// Initialize the Vertex AI Gemini API backend service
// Create a `GenerativeModel` instance with a model that supports your use case
val model = Firebase.ai(backend = GenerativeBackend.vertexAI())
                        .generativeModel("gemini-2.0-flash")

Java

// Initialize the Vertex AI Gemini API backend service
// Create a `GenerativeModel` instance with a model that supports your use case
GenerativeModel ai = FirebaseAI.getInstance(GenerativeBackend.vertexAI())
        .generativeModel("gemini-2.0-flash");

// Use the GenerativeModelFutures Java compatibility layer which offers
// support for ListenableFuture and Publisher APIs
GenerativeModelFutures model = GenerativeModelFutures.from(ai);

Web

import { initializeApp } from "firebase/app";
import { getAI, getGenerativeModel, VertexAIBackend } from "firebase/ai";

// TODO(developer) Replace the following with your app's Firebase configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize FirebaseApp
const firebaseApp = initializeApp(firebaseConfig);

// Initialize the Vertex AI Gemini API backend service
const ai = getAI(firebaseApp, { backend: new VertexAIBackend() });

// Create a `GenerativeModel` instance with a model that supports your use case
const model = getGenerativeModel(ai, { model: "gemini-2.0-flash" });

Dart

import 'package:firebase_ai/firebase_ai.dart';
import 'package:firebase_core/firebase_core.dart';
import 'firebase_options.dart';

// Initialize FirebaseApp
await Firebase.initializeApp(
  options: DefaultFirebaseOptions.currentPlatform,
);

// Initialize the Vertex AI Gemini API backend service
// Create a `GenerativeModel` instance with a model that supports your use case
final model =
      FirebaseAI.vertexAI().generativeModel(model: 'gemini-2.0-flash');

Unity

Support for Unity wasn't available from "Vertex AI in Firebase".

Learn how to get started with the Firebase AI Logic SDK for Unity.

Swift

No additional changes.

Kotlin

• Live API

  • Removed UNSPECIFIED value for enum class ResponseModality. Instead use null.

Java

• Live API

  • Removed UNSPECIFIED value for enum class ResponseModality. Instead use null.

• Changed various Java builder methods to now correctly return the instance of their class, instead of void.

Web

Changes required only if you're starting to use the Gemini Developer API (instead of the Vertex AI Gemini API):

• Safety settings

  • Removed usages of the unsupported SafetySetting.method.

• Inline data

  • Removed usages of the unsupported InlineDataPart.videoMetadata.

Dart

No additional changes.

Unity

Support for Unity wasn't available from "Vertex AI in Firebase".

Learn how to get started with the Firebase AI Logic SDK for Unity.