IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you
migrate your app to use KTX APIs from the main modules instead. For details, see the
FAQ about this initiative.
Stay organized with collections
Save and categorize content based on your preferences.
FirebaseAIKt
public final class FirebaseAIKt
Summary
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[null,null,["Last updated 2025-08-28 UTC."],[],[],null,["FirebaseAIKt\n\n\n```\npublic final class FirebaseAIKt\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nSummary \n\n| Public fields |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `final @`[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)` `[FirebaseAI](/docs/reference/android/com/google/firebase/ai/FirebaseAI) | [ai](/docs/reference/android/com/google/firebase/ai/package-summary#(com.google.firebase.Firebase).ai()) The [FirebaseAI](/docs/reference/android/com/google/firebase/ai/FirebaseAI) instance for the default [FirebaseApp](/docs/reference/android/com/google/firebase/FirebaseApp) using the Google AI Backend. |\n\n| Public methods |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `static final @`[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)` `[FirebaseAI](/docs/reference/android/com/google/firebase/ai/FirebaseAI) | [FirebaseAIKt](/docs/reference/android/com/google/firebase/ai/FirebaseAIKt)`.`[ai](/docs/reference/android/com/google/firebase/ai/FirebaseAIKt#(com.google.firebase.Firebase).ai(com.google.firebase.FirebaseApp,com.google.firebase.ai.type.GenerativeBackend))`(` ` @`[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)` `[Firebase](/docs/reference/android/com/google/firebase/Firebase)` receiver,` ` @`[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)` `[FirebaseApp](/docs/reference/android/com/google/firebase/FirebaseApp)` app,` ` @`[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)` `[GenerativeBackend](/docs/reference/android/com/google/firebase/ai/type/GenerativeBackend)` backend` `)` Returns the [FirebaseAI](/docs/reference/android/com/google/firebase/ai/FirebaseAI) instance for the provided [FirebaseApp](/docs/reference/android/com/google/firebase/FirebaseApp) and [backend](/docs/reference/android/com/google/firebase/ai/package-summary#(com.google.firebase.Firebase).ai(com.google.firebase.FirebaseApp,com.google.firebase.ai.type.GenerativeBackend)). |\n| `static final @`[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)` `[FirebaseAI](/docs/reference/android/com/google/firebase/ai/FirebaseAI) | [FirebaseAIKt](/docs/reference/android/com/google/firebase/ai/FirebaseAIKt)`.`[ai](/docs/reference/android/com/google/firebase/ai/FirebaseAIKt#(com.google.firebase.Firebase).ai(com.google.firebase.FirebaseApp,com.google.firebase.ai.type.GenerativeBackend,kotlin.Boolean))`(` ` @`[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)` `[Firebase](/docs/reference/android/com/google/firebase/Firebase)` receiver,` ` @`[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)` `[FirebaseApp](/docs/reference/android/com/google/firebase/FirebaseApp)` app,` ` @`[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)` `[GenerativeBackend](/docs/reference/android/com/google/firebase/ai/type/GenerativeBackend)` backend,` ` boolean useLimitedUseAppCheckTokens` `)` Returns the [FirebaseAI](/docs/reference/android/com/google/firebase/ai/FirebaseAI) instance for the provided [FirebaseApp](/docs/reference/android/com/google/firebase/FirebaseApp) and [backend](/docs/reference/android/com/google/firebase/ai/package-summary#(com.google.firebase.Firebase).ai(com.google.firebase.FirebaseApp,com.google.firebase.ai.type.GenerativeBackend,kotlin.Boolean)). |\n\nPublic fields \n\nai \n\n```\npublic final @NonNull FirebaseAI ai\n```\n\nThe [FirebaseAI](/docs/reference/android/com/google/firebase/ai/FirebaseAI) instance for the default [FirebaseApp](/docs/reference/android/com/google/firebase/FirebaseApp) using the Google AI Backend. \n\nPublic methods \n\nFirebaseAIKt.ai \n\n```\npublic static final @NonNull FirebaseAI FirebaseAIKt.ai(\n @NonNull Firebase receiver,\n @NonNull FirebaseApp app,\n @NonNull GenerativeBackend backend\n)\n```\n\nReturns the [FirebaseAI](/docs/reference/android/com/google/firebase/ai/FirebaseAI) instance for the provided [FirebaseApp](/docs/reference/android/com/google/firebase/FirebaseApp) and [backend](/docs/reference/android/com/google/firebase/ai/package-summary#(com.google.firebase.Firebase).ai(com.google.firebase.FirebaseApp,com.google.firebase.ai.type.GenerativeBackend)). \n\n| Parameters |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|\n| `@`[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)` `[GenerativeBackend](/docs/reference/android/com/google/firebase/ai/type/GenerativeBackend)` backend` | the backend reference to make generative AI requests to. |\n\nFirebaseAIKt.ai \n\n```\npublic static final @NonNull FirebaseAI FirebaseAIKt.ai(\n @NonNull Firebase receiver,\n @NonNull FirebaseApp app,\n @NonNull GenerativeBackend backend,\n boolean useLimitedUseAppCheckTokens\n)\n```\n\nReturns the [FirebaseAI](/docs/reference/android/com/google/firebase/ai/FirebaseAI) instance for the provided [FirebaseApp](/docs/reference/android/com/google/firebase/FirebaseApp) and [backend](/docs/reference/android/com/google/firebase/ai/package-summary#(com.google.firebase.Firebase).ai(com.google.firebase.FirebaseApp,com.google.firebase.ai.type.GenerativeBackend,kotlin.Boolean)). \n\n| Parameters |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `@`[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)` `[GenerativeBackend](/docs/reference/android/com/google/firebase/ai/type/GenerativeBackend)` backend` | the backend reference to make generative AI requests to. |\n| `boolean useLimitedUseAppCheckTokens` | use App Check's limited-use tokens when sending requests to the backend. To learn more about what this means, see the full docs on [FirebaseAI.getInstance](/docs/reference/android/com/google/firebase/ai/FirebaseAI.Companion#getInstance(com.google.firebase.FirebaseApp,com.google.firebase.ai.type.GenerativeBackend)). |"]]
