docs-devsite/ai.ai.md
Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference
{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}
An instance of the Firebase AI SDK.
Do not create this instance directly. Instead, use getAI()<!-- -->.
<b>Signature:</b>
export interface AI
| Property | Type | Description |
|---|---|---|
| app | FirebaseApp | The FirebaseApp this AI instance is associated with. |
| backend | Backend | A Backend instance that specifies the configuration for the target backend, either the Gemini Developer API (using GoogleAIBackend<!-- -->) or the Vertex AI Gemini API (using VertexAIBackend<!-- -->). |
| location | string | |
| options | AIOptions | Options applied to this AI instance. |
The FirebaseApp this AI instance is associated with.
<b>Signature:</b>
app: FirebaseApp;
A Backend instance that specifies the configuration for the target backend, either the Gemini Developer API (using GoogleAIBackend<!-- -->) or the Vertex AI Gemini API (using VertexAIBackend<!-- -->).
<b>Signature:</b>
backend: Backend;
Warning: This API is now obsolete.
use
AI.backend.locationinstead.The location configured for this AI service instance, relevant for Vertex AI backends.
<b>Signature:</b>
location: string;
Options applied to this AI instance.
<b>Signature:</b>
options?: AIOptions;