firebase-js-sdk/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 %}

AI interface

An instance of the Firebase AI SDK.

Do not create this instance directly. Instead, use getAI().

Signature:

export interface AI 

Properties

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 Agent Platform Gemini API (using AgentPlatformBackend).
location	string
options	AIOptions	Options applied to this AI instance.

AI.app

The FirebaseApp this AI instance is associated with.

Signature:

app: FirebaseApp;

AI.backend

A Backend instance that specifies the configuration for the target backend, either the Gemini Developer API (using GoogleAIBackend) or the Agent Platform Gemini API (using AgentPlatformBackend).

Signature:

backend: Backend;

AI.location

Warning: This API is now obsolete.

use AI.backend.location instead.

The location configured for this AI service instance, relevant for Agent Platform Gemini API backends.

Signature:

location: string;

AI.options

Options applied to this AI instance.

Signature:

options?: AIOptions;