Swift

Use Swift Package Manager to install and manage Firebase dependencies.

TheFirebase AI Logic library provides access to the APIs for interactingwithGemini andImagen models. The library is includedas part of the Firebase SDK for Apple platforms (firebase-ios-sdk).

If you're already using Firebase, then make sure your Firebase package isv11.13.0 or later.

1. In Xcode, with your app project open, navigate toFile > Add Package Dependencies.

2. When prompted, add the Firebase Apple platforms SDK repository:

   https://github.com/firebase/firebase-ios-sdk

3. Select the latest SDK version.

4. Select theFirebaseAI library.

When finished, Xcode will automatically begin resolving and downloading yourdependencies in the background.

Kotlin

TheFirebase AI Logic SDK for Android (firebase-ai) providesaccess to the APIs for interacting withGemini andImagen models.

In yourmodule (app-level) Gradle file(like<project>/<app-module>/build.gradle.kts),add the dependency for theFirebase AI Logic library for Android.We recommend using theFirebase Android BoMto control library versioning.

dependencies{// ... other androidx dependencies// 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")}

By using theFirebase Android BoM,your app will always use compatible versions of Firebase Android libraries.

dependencies{// Add the dependency for theFirebase AI Logic library// When NOT using theBoM, you must specify versions in Firebase library dependenciesimplementation("com.google.firebase:firebase-ai:17.3.0")}

Java

TheFirebase AI Logic SDK for Android (firebase-ai) providesaccess to the APIs for interacting withGemini andImagen models.

In yourmodule (app-level) Gradle file(like<project>/<app-module>/build.gradle.kts),add the dependency for theFirebase AI Logic library for Android.We recommend using theFirebase Android BoMto control library versioning.

For Java, you need to add two additional libraries.

dependencies{// ... other androidx dependencies// 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")// Required for one-shot operations (to use `ListenableFuture` from Guava Android)implementation("com.google.guava:guava:31.0.1-android")// Required for streaming operations (to use `Publisher` from Reactive Streams)implementation("org.reactivestreams:reactive-streams:1.0.4")}

By using theFirebase Android BoM,your app will always use compatible versions of Firebase Android libraries.

dependencies{// Add the dependency for theFirebase AI Logic library// When NOT using theBoM, you must specify versions in Firebase library dependenciesimplementation("com.google.firebase:firebase-ai:17.3.0")}

Web

TheFirebase AI Logic library provides access to the APIs for interactingwithGemini andImagen models. The library is includedas part of the Firebase JavaScript SDK for Web.

1. Install the Firebase JS SDK for Web using npm:

   npm install firebase

2. Initialize Firebase in your app:

   import{initializeApp}from"firebase/app";// 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);

Dart

TheFirebase AI Logic plugin for Flutter (firebase_ai) providesaccess to the APIs for interacting withGemini andImagen models.

1. From your Flutter project directory, run the following command toinstall the core plugin and theFirebase AI Logic plugin:

   flutterpubaddfirebase_corefirebase_ai

2. In yourlib/main.dart file, import the Firebase core plugin, theFirebase AI Logic plugin, and the configuration file you generatedearlier:

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

3. Also in yourlib/main.dart file, initialize Firebase using theDefaultFirebaseOptions object exported by the configuration file:

   awaitFirebase.initializeApp(options:DefaultFirebaseOptions.currentPlatform,);

4. Rebuild your Flutter application:

   flutterrun

Unity

Support for Unity wasn't available from theGoogle AI client SDKs.

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

Swift

Remove the old library:

1. In Xcode, with your app project open, navigate to thePackages Dependencies pane.

2. Select thegenerative-ai-swift package from the list of packagedependencies.

3. Click the- button from the bottom of the list and clickRemoveto confirm.

Kotlin

dependencies{implementation("com.google.ai.client.generativeai:generativeai:VERSION")}

Java

dependencies{implementation("com.google.ai.client.generativeai:generativeai:VERSION")}

Web

// BEFOREimport{initializeApp}from"firebase/app";import{GoogleGenerativeAI}from"@google/generative-ai";

Dart

Delete the old package:
flutter pub remove google_generative_ai

Unity

Support for Unity wasn't available fromGoogle AI client SDKs.

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

Swift

// BEFOREimportGoogleGenerativeAIletmodel=GenerativeModel(name:"MODEL_NAME",apiKey:APIKey.default)// AFTERimportFirebaseAI// 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

// BEFOREimportcom.google.ai.client.generativeai.Chatimportcom.google.ai.client.generativeai.type.Contentimportcom.google.ai.client.generativeai.java.GenerativeModuleFutures...valgenerativeModel=GenerativeModel(modelName="MODEL_NAME",// Access your API key as a Build Configuration variableapiKey=BuildConfig.apiKey)// AFTERimportcom.google.firebase.Firebaseimportcom.google.firebase.ai.aiimportcom.google.firebase.ai.type.GenerativeBackend...// 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

// BEFOREimportcom.google.ai.client.generativeai.Chat;importcom.google.ai.client.generativeai.type.Content;importcom.google.ai.client.generativeai.java.GenerativeModuleFutures;...GenerativeModelgm=newGenerativeModel("MODEL_NAME",// Access your API key as a Build Configuration variableBuildConfig.apiKey);GenerativeModelFuturesmodel=GenerativeModelFutures.from(gm);// AFTERimportcom.google.firebase.ai.FirebaseAI;importcom.google.firebase.ai.GenerativeModel;importcom.google.firebase.ai.java.GenerativeModelFutures;importcom.google.firebase.ai.type.GenerativeBackend;...// 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

// BEFOREimport{GoogleGenerativeAI}from"@google/generative-ai";// Fetch your API_KEY and access your APIconstAPI_KEY="...";constgenAI=newGoogleGenerativeAI(API_KEY);...constmodel=genAI.getGenerativeModel({model:"MODEL_NAME"});// AFTERimport{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

// BEFOREimport'package:google_generative_ai/google_generative_ai.dart';finalapiKey=Platform.environment['API_KEY'];if(apiKey==null){print('No\$API_KEY environment variable');exit(1);}finalmodel=GenerativeModel(model:'MODEL_NAME',apiKey:apiKey);// AFTERimport'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 fromGoogle AI client SDKs.

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.

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.

Web

Note that theGoogle AI client SDK for JavaScript has had manychanges since the time that theFirebase AI Logic client SDKs branched from it. Thefollowing list are some potential changes that you might need to consider asyou migrate to theFirebase AI Logic client SDKs.

• Enumerations

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

• Block reason

  • ChangedblockReason inPromptFeedback to be optional.

• Search Grounding

  • Removed all usages of this feature, since it's not yet supported in theFirebase AI Logic SDKs.

• Errors

  • Removed all usages ofGoogleGenerativeAIError, and optionally move toAIError.

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 fromGoogle AI client SDKs.

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