Swift

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

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

   • Option 2: Update Firebase individually: Navigate to the Firebasepackage in the section calledPackage Dependencies. Right-click onthe Firebase package, and then selectUpdate Package.

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

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

4. Add the new library: Select the+ button, and then addFirebaseAIfrom the Firebase package.

5. After you've finished migrating your app (see the remaining sections inthis guide), make sure to remove the old library:
   SelectFirebaseVertexAI-Preview,and then press the— button.

Kotlin

1. In yourmodule (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 (seethe remaining sections in this guide) before deleting the old dependency.

   // BEFOREdependencies{implementation("com.google.firebase:firebase-vertexai:16.0.0-betaXX")}// AFTERdependencies{// Import theBoM for the Firebase platformimplementation(platform("com.google.firebase:firebase-bom:34.3.0"))// Add the dependency for theFirebase AI Logic library// When using theBoM, you don't specify versions in Firebase library dependenciesimplementation("com.google.firebase:firebase-ai")}

2. Sync your Android project with Gradle files.

Note that if you choose to not use theFirebase Android BoM, then just addthe dependency for thefirebase-ai library and accept the latest versionthat's suggested by Android Studio.

Java

1. In yourmodule (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 (seethe remaining sections in this guide) before deleting the old dependency.

   // BEFOREdependencies{implementation("com.google.firebase:firebase-vertexai:16.0.0-betaXX")}// AFTERdependencies{// Import theBoM for the Firebase platformimplementation(platform("com.google.firebase:firebase-bom:34.3.0"))// Add the dependency for theFirebase AI Logic library// When using theBoM, you don't specify versions in Firebase library dependenciesimplementation("com.google.firebase:firebase-ai")}

2. Sync your Android project with Gradle files.

Note that if you choose to not use theFirebase Android BoM, then just addthe dependency for thefirebase-ai library and accept the latest versionthat'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 usefirebase/ai instead.

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

   // BEFOREimport{initializeApp}from"firebase/app";import{getVertexAI,getGenerativeModel}from"firebase/vertexai-preview";// AFTERimport{initializeApp}from"firebase/app";import{getAI,getGenerativeModel}from"firebase/ai";

Dart

1. Update to the use thefirebase_ai package in yourpubspec.yaml file byrunning 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 inthis 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 toget started with theFirebase AI Logic SDK for Unity.

Swift

importFirebaseAI// Initialize the Gemini Developer API backend serviceletai=FirebaseAI.firebaseAI(backend:.googleAI())// Create a `GenerativeModel` instance with a model that supports your use caseletmodel=ai.generativeModel(modelName:"gemini-2.5-flash")

Kotlin

// Initialize the Gemini Developer API backend service// Create a `GenerativeModel` instance with a model that supports your use casevalmodel=Firebase.ai(backend=GenerativeBackend.googleAI()).generativeModel("gemini-2.5-flash")

Java

// Initialize the Gemini Developer API backend service// Create a `GenerativeModel` instance with a model that supports your use caseGenerativeModelai=FirebaseAI.getInstance(GenerativeBackend.googleAI()).generativeModel("gemini-2.5-flash");// Use the GenerativeModelFutures Java compatibility layer which offers// support for ListenableFuture and Publisher APIsGenerativeModelFuturesmodel=GenerativeModelFutures.from(ai);

Web

import{initializeApp}from"firebase/app";import{getAI,getGenerativeModel,GoogleAIBackend}from"firebase/ai";// TODO(developer) Replace the following with your app's Firebase configuration// See: https://firebase.google.com/docs/web/learn-more#config-objectconstfirebaseConfig={// ...};// Initialize FirebaseAppconstfirebaseApp=initializeApp(firebaseConfig);// Initialize the Gemini Developer API backend serviceconstai=getAI(firebaseApp,{backend:newGoogleAIBackend()});// Create a `GenerativeModel` instance with a model that supports your use caseconstmodel=getGenerativeModel(ai,{model:"gemini-2.5-flash"});

Dart

import'package:firebase_ai/firebase_ai.dart';import'package:firebase_core/firebase_core.dart';import'firebase_options.dart';// Initialize FirebaseAppawaitFirebase.initializeApp(options:DefaultFirebaseOptions.currentPlatform,);// Initialize the Gemini Developer API backend service// Create a `GenerativeModel` instance with a model that supports your use casefinalmodel=FirebaseAI.googleAI().generativeModel(model:'gemini-2.5-flash');

Unity

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

Learn how toget started with theFirebase AI Logic SDK for Unity.

Swift

• Enumerations

  • Replaced mostenum types withstructs with static variables. Thischange allows more flexibility for evolving the API in abackward-compatible way. When usingswitch statements, you must nowinclude adefault: case to cover unknown or unhandled values,including new values that are added to the SDK in the future.

  • Renamed theBlockThreshold enumeration toHarmBlockThreshold; thistype is now astruct.

  • Removedunknown andunspecified cases from the followingenumerations (nowstructs):HarmCategory,HarmBlockThreshold,HarmProbability,BlockReason, andFinishReason.

  • Replaced the enumerationModelContent.Part with a protocol namedPart to allow new types to be added in a backward-compatible way. Thischange is described in greater detail in theContent parts section.

• Content parts

  • Removed theThrowingPartsRepresentable protocol, and simplifiedthe initializers forModelContent to avoid occasional compiler errors.Images that don't encode properly will still throw errors when beingused ingenerateContent.

  • Replaced theModelContent.Part cases with the followingstruct typesconforming to thePart protocol:

    • .text toTextPart
    • .data toInlineDataPart
    • .fileData toFileDataPart
    • .functionCall toFunctionCallPart
    • .functionResponse toFunctionResponsePart

• Harm category

  • Changed theHarmCategory to no longer be nested in theSafetySettingtype. If you're referring to it asSafetySetting.HarmCategory, thatcan be replaced withHarmCategory.

• Safety feedback

  • Removed theSafetyFeedback type, since it wasn't used in any of theresponses.

• Citation metadata

  • Renamed thecitationSources property tocitations inCitationMetadata.

• Total billable characters

  • Changed thetotalBillableCharacters property inCountTokensResponseto be optional to reflect situations where no characters are sent.

• Candidate response

  • RenamedCandidateResponse toCandidate to match other platforms.

• Generation configuration

  • Changed the public properties ofGenerationConfig tointernal. Theyall remain configurable in the initializer.

Kotlin

• Enumerations

  • Replacedenum classes andsealed classes with regular classes. Thischange allows more flexibility for evolving the API in a backwardcompatible way.

  • Renamed theBlockThreshold enumeration toHarmBlockThreshold.

  • Removed values from the following enumerations:HarmBlockThreshold,HarmProbability,HarmSeverity,BlockReason, andFinishReason.

• Blob methods

  • Renamed all methods that includedBlob as part of their name to useInlineData instead.

• Safety settings

  • Changed the fieldmethod to be nullable.

• Duration class

  • Removed all usages of Kotlin'sDuration class, and replaced it withlong. This change provides better interoperability with Java.

• Citation metadata

  • Wrapped all the fields previously declared inCitationMetadata into anew class calledCitation. Citations can be found in the list calledcitations inCitationMetadata. This change allows better alignmentof types across platforms.

• Count tokens

  • Changed the fieldtotalBillableCharacters to be nullable.

• Total billable characters

  • Changed thetotalBillableCharacters property inCountTokensResponseto be optional to reflect situations where no characters are sent.

• Instantiating a model

  • Moved therequestOptions parameter to the end of the parameter list toalign with other platforms.

• Live API

  • RemovedUNSPECIFIED value for enum classResponseModality. Insteadusenull.

  • RenamedLiveGenerationConfig.setResponseModalities toLiveGenerationConfig.setResponseModality.

  • Removed theLiveContentResponse.Status class, and instead have nestedthe status fields as properties ofLiveContentResponse.

  • Removed theLiveContentResponse class, and instead have providedsubclasses ofLiveServerMessage that match the responses from themodel.

  • ChangedLiveModelFutures.connect to returnListenableFuture<LiveSessionFutures> instead ofListenableFuture<LiveSession>.

Java

• Enumerations

  • Replacedenum classes andsealed classes with regular classes. Thischange allows more flexibility for evolving the API in a backwardcompatible way.

  • Renamed theBlockThreshold enumeration toHarmBlockThreshold.

  • Removed values from the following enumerations:HarmBlockThreshold,HarmProbability,HarmSeverity,BlockReason, andFinishReason.

• Blob methods

  • Renamed all methods that includedBlob as part of their name to useInlineData instead.

• Safety settings

  • Changed the fieldmethod to be nullable.

• Duration class

  • Removed all usages of Kotlin'sDuration class, and replaced it withlong. This change provides better interoperability with Java.

• Citation metadata

  • Wrapped all the fields previously declared inCitationMetadata into anew class calledCitation. Citations can be found in the list calledcitations inCitationMetadata. This change allows better alignmentof types across platforms.

• Count tokens

  • Changed the fieldtotalBillableCharacters to be nullable.

• Total billable characters

  • Changed thetotalBillableCharacters property inCountTokensResponseto be optional to reflect situations where no characters are sent.

• Instantiating a model

  • Moved therequestOptions parameter to the end of the parameter list toalign with other platforms.

• Live API

  • RemovedUNSPECIFIED value for enum classResponseModality. Insteadusenull.

  • RenamedLiveGenerationConfig.setResponseModalities toLiveGenerationConfig.setResponseModality.

  • Removed theLiveContentResponse.Status class, and instead have nestedthe status fields as properties ofLiveContentResponse.

  • Removed theLiveContentResponse class, and instead have providedsubclasses ofLiveServerMessage that match the responses from themodel.

  • ChangedLiveModelFutures.connect to returnListenableFuture<LiveSessionFutures> instead ofListenableFuture<LiveSession>.

• Changed various Java builder methods to now correctly return the instanceof their class, instead ofvoid.

Web

• Enumerations

  • Removed values from the following enumerations:HarmCategory,BlockThreshold,HarmProbability,HarmSeverity,BlockReason, andFinishReason.

• Block reason

  • ChangedblockReason inPromptFeedback to be optional.

Changes requiredonly if you're starting to use theGemini Developer API (instead of theVertex AI Gemini API):

• Safety settings

  • Removed usages of the unsupportedSafetySetting.method.

• Inline data

  • Removed usages of the unsupportedInlineDataPart.videoMetadata.

Dart

• Enumerations

  • Removed values from the following enumerations:HarmCategory,HarmProbability,BlockReason, andFinishReason.

• Data part

  • RenamedDataPart toInlineDataPart, and thestaticdata functiontoinlineData to align with other platforms.

• Request options

  • RemovedRequestOptions sincetimeout wasn't functional. It will bere-added in the near future, but it will be moved to theGenerativeModel type to match other platforms.

• Stop sequences

  • Changed thestopSequences parameter inGenerationConfig to beoptional and to default tonull instead of an empty array.

• Citations

  • Renamed thecitationSources property tocitations inCitationMetadata. TheCitationSource type was renamed toCitationto match other platforms.

• Unnecessary public types, methods, and properties

  • Removed the following types, methods, and properties which wereunintentionally exposed:defaultTimeout,CountTokensResponseFields,parseCountTokensResponse,parseEmbedContentResponse,parseGenerateContentResponse,parseContent,BatchEmbedContentsResponse,ContentEmbedding,EmbedContentRequest,andEmbedContentResponse.

• Count tokens

  • Removed extra fields from thecountTokens function that are no longernecessary. Onlycontents is needed.

• Instantiating a model

  • Moved thesystemInstruction parameter to the end of the parameter listto align with other platforms.

• Embedding functionality

  • Removed unsupported embedding functionality (embedContent andbatchEmbedContents) from the model.

Unity

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

Learn how toget started with theFirebase AI Logic SDK for Unity.