@firebase/ai 0.0.1

package/dist/esm/src/constants.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare const AI_TYPE = "AI";
+export declare const DEFAULT_LOCATION = "us-central1";
+export declare const DEFAULT_BASE_URL = "https://firebasevertexai.googleapis.com";
+export declare const DEFAULT_API_VERSION = "v1beta";
+export declare const PACKAGE_VERSION: string;
+export declare const LANGUAGE_TAG = "gl-js";
+export declare const DEFAULT_FETCH_TIMEOUT_MS: number;

package/dist/esm/src/errors.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { FirebaseError } from '@firebase/util';
+import { AIErrorCode, CustomErrorData } from './types';
+/**
+ * Error class for the Firebase AI SDK.
+ *
+ * @public
+ */
+export declare class AIError extends FirebaseError {
+    readonly code: AIErrorCode;
+    readonly customErrorData?: CustomErrorData | undefined;
+    /**
+     * Constructs a new instance of the `AIError` class.
+     *
+     * @param code - The error code from {@link AIErrorCode}.
+     * @param message - A human-readable message describing the error.
+     * @param customErrorData - Optional error data.
+     */
+    constructor(code: AIErrorCode, message: string, customErrorData?: CustomErrorData | undefined);
+}

package/dist/esm/src/googleai-mappers.d.ts

@@ -0,0 +1,73 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { CountTokensRequest, GenerateContentCandidate, GenerateContentRequest, GenerateContentResponse, PromptFeedback } from './types';
+import { GoogleAIGenerateContentResponse, GoogleAIGenerateContentCandidate, GoogleAICountTokensRequest } from './types/googleai';
+/**
+ * This SDK supports both the Vertex AI Gemini API and the Gemini Developer API (using Google AI).
+ * The public API prioritizes the format used by the Vertex AI Gemini API.
+ * We avoid having two sets of types by translating requests and responses between the two API formats.
+ * This translation allows developers to switch between the Vertex AI Gemini API and the Gemini Developer API
+ * with minimal code changes.
+ *
+ * In here are functions that map requests and responses between the two API formats.
+ * Requests in the Vertex AI format are mapped to the Google AI format before being sent.
+ * Responses from the Google AI backend are mapped back to the Vertex AI format before being returned to the user.
+ */
+/**
+ * Maps a Vertex AI {@link GenerateContentRequest} to a format that can be sent to Google AI.
+ *
+ * @param generateContentRequest The {@link GenerateContentRequest} to map.
+ * @returns A {@link GenerateContentResponse} that conforms to the Google AI format.
+ *
+ * @throws If the request contains properties that are unsupported by Google AI.
+ *
+ * @internal
+ */
+export declare function mapGenerateContentRequest(generateContentRequest: GenerateContentRequest): GenerateContentRequest;
+/**
+ * Maps a {@link GenerateContentResponse} from Google AI to the format of the
+ * {@link GenerateContentResponse} that we get from VertexAI that is exposed in the public API.
+ *
+ * @param googleAIResponse The {@link GenerateContentResponse} from Google AI.
+ * @returns A {@link GenerateContentResponse} that conforms to the public API's format.
+ *
+ * @internal
+ */
+export declare function mapGenerateContentResponse(googleAIResponse: GoogleAIGenerateContentResponse): GenerateContentResponse;
+/**
+ * Maps a Vertex AI {@link CountTokensRequest} to a format that can be sent to Google AI.
+ *
+ * @param countTokensRequest The {@link CountTokensRequest} to map.
+ * @param model The model to count tokens with.
+ * @returns A {@link CountTokensRequest} that conforms to the Google AI format.
+ *
+ * @internal
+ */
+export declare function mapCountTokensRequest(countTokensRequest: CountTokensRequest, model: string): GoogleAICountTokensRequest;
+/**
+ * Maps a Google AI {@link GoogleAIGenerateContentCandidate} to a format that conforms
+ * to the Vertex AI API format.
+ *
+ * @param candidates The {@link GoogleAIGenerateContentCandidate} to map.
+ * @returns A {@link GenerateContentCandidate} that conforms to the Vertex AI format.
+ *
+ * @throws If any {@link Part} in the candidates has a `videoMetadata` property.
+ *
+ * @internal
+ */
+export declare function mapGenerateContentCandidates(candidates: GoogleAIGenerateContentCandidate[]): GenerateContentCandidate[];
+export declare function mapPromptFeedback(promptFeedback: PromptFeedback): PromptFeedback;

package/dist/esm/src/helpers.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Backend } from './backend';
+/**
+ * Encodes a {@link Backend} into a string that will be used to uniquely identify {@link AI}
+ * instances by backend type.
+ *
+ * @internal
+ */
+export declare function encodeInstanceIdentifier(backend: Backend): string;
+/**
+ * Decodes an instance identifier string into a {@link Backend}.
+ *
+ * @internal
+ */
+export declare function decodeInstanceIdentifier(instanceIdentifier: string): Backend;

package/dist/esm/src/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The Firebase AI Web SDK.
+ *
+ * @packageDocumentation
+ */
+declare global {
+    interface Window {
+        [key: string]: unknown;
+    }
+}
+export * from './api';
+export * from './public-types';

package/dist/esm/src/index.node.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The Firebase AI Web SDK.
+ *
+ * @packageDocumentation
+ */
+export * from './api';
+export * from './public-types';

package/dist/esm/src/logger.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Logger } from '@firebase/logger';
+export declare const logger: Logger;

package/dist/esm/src/methods/chat-session-helpers.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Content } from '../types';
+export declare function validateChatHistory(history: Content[]): void;

package/dist/esm/src/methods/chat-session.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Content, GenerateContentResult, GenerateContentStreamResult, Part, RequestOptions, StartChatParams } from '../types';
+import { ApiSettings } from '../types/internal';
+/**
+ * ChatSession class that enables sending chat messages and stores
+ * history of sent and received messages so far.
+ *
+ * @public
+ */
+export declare class ChatSession {
+    model: string;
+    params?: StartChatParams | undefined;
+    requestOptions?: RequestOptions | undefined;
+    private _apiSettings;
+    private _history;
+    private _sendPromise;
+    constructor(apiSettings: ApiSettings, model: string, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
+    /**
+     * Gets the chat history so far. Blocked prompts are not added to history.
+     * Neither blocked candidates nor the prompts that generated them are added
+     * to history.
+     */
+    getHistory(): Promise<Content[]>;
+    /**
+     * Sends a chat message and receives a non-streaming
+     * {@link GenerateContentResult}
+     */
+    sendMessage(request: string | Array<string | Part>): Promise<GenerateContentResult>;
+    /**
+     * Sends a chat message and receives the response as a
+     * {@link GenerateContentStreamResult} containing an iterable stream
+     * and a response promise.
+     */
+    sendMessageStream(request: string | Array<string | Part>): Promise<GenerateContentStreamResult>;
+}

package/dist/esm/src/methods/count-tokens.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { CountTokensRequest, CountTokensResponse, RequestOptions } from '../types';
+import { ApiSettings } from '../types/internal';
+export declare function countTokens(apiSettings: ApiSettings, model: string, params: CountTokensRequest, requestOptions?: RequestOptions): Promise<CountTokensResponse>;

package/dist/esm/src/methods/generate-content.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { GenerateContentRequest, GenerateContentResult, GenerateContentStreamResult, RequestOptions } from '../types';
+import { ApiSettings } from '../types/internal';
+export declare function generateContentStream(apiSettings: ApiSettings, model: string, params: GenerateContentRequest, requestOptions?: RequestOptions): Promise<GenerateContentStreamResult>;
+export declare function generateContent(apiSettings: ApiSettings, model: string, params: GenerateContentRequest, requestOptions?: RequestOptions): Promise<GenerateContentResult>;

package/dist/esm/src/models/ai-model.d.ts

@@ -0,0 +1,72 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { AI, BackendType } from '../public-types';
+import { ApiSettings } from '../types/internal';
+/**
+ * Base class for Firebase AI model APIs.
+ *
+ * Instances of this class are associated with a specific Firebase AI {@link Backend}
+ * and provide methods for interacting with the configured generative model.
+ *
+ * @public
+ */
+export declare abstract class AIModel {
+    /**
+     * The fully qualified model resource name to use for generating images
+     * (for example, `publishers/google/models/imagen-3.0-generate-002`).
+     */
+    readonly model: string;
+    /**
+     * @internal
+     */
+    protected _apiSettings: ApiSettings;
+    /**
+     * Constructs a new instance of the {@link AIModel} class.
+     *
+     * This constructor should only be called from subclasses that provide
+     * a model API.
+     *
+     * @param ai - an {@link AI} instance.
+     * @param modelName - The name of the model being used. It can be in one of the following formats:
+     * - `my-model` (short name, will resolve to `publishers/google/models/my-model`)
+     * - `models/my-model` (will resolve to `publishers/google/models/my-model`)
+     * - `publishers/my-publisher/models/my-model` (fully qualified model name)
+     *
+     * @throws If the `apiKey` or `projectId` fields are missing in your
+     * Firebase config.
+     *
+     * @internal
+     */
+    protected constructor(ai: AI, modelName: string);
+    /**
+     * Normalizes the given model name to a fully qualified model resource name.
+     *
+     * @param modelName - The model name to normalize.
+     * @returns The fully qualified model resource name.
+     *
+     * @internal
+     */
+    static normalizeModelName(modelName: string, backendType: BackendType): string;
+    /**
+     * @internal
+     */
+    private static normalizeGoogleAIModelName;
+    /**
+     * @internal
+     */
+    private static normalizeVertexAIModelName;
+}

package/dist/esm/src/models/generative-model.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Content, CountTokensRequest, CountTokensResponse, GenerateContentRequest, GenerateContentResult, GenerateContentStreamResult, GenerationConfig, ModelParams, Part, RequestOptions, SafetySetting, StartChatParams, Tool, ToolConfig } from '../types';
+import { ChatSession } from '../methods/chat-session';
+import { AI } from '../public-types';
+import { AIModel } from './ai-model';
+/**
+ * Class for generative model APIs.
+ * @public
+ */
+export declare class GenerativeModel extends AIModel {
+    generationConfig: GenerationConfig;
+    safetySettings: SafetySetting[];
+    requestOptions?: RequestOptions;
+    tools?: Tool[];
+    toolConfig?: ToolConfig;
+    systemInstruction?: Content;
+    constructor(ai: AI, modelParams: ModelParams, requestOptions?: RequestOptions);
+    /**
+     * Makes a single non-streaming call to the model
+     * and returns an object containing a single {@link GenerateContentResponse}.
+     */
+    generateContent(request: GenerateContentRequest | string | Array<string | Part>): Promise<GenerateContentResult>;
+    /**
+     * Makes a single streaming call to the model
+     * and returns an object containing an iterable stream that iterates
+     * over all chunks in the streaming response as well as
+     * a promise that returns the final aggregated response.
+     */
+    generateContentStream(request: GenerateContentRequest | string | Array<string | Part>): Promise<GenerateContentStreamResult>;
+    /**
+     * Gets a new {@link ChatSession} instance which can be used for
+     * multi-turn chats.
+     */
+    startChat(startChatParams?: StartChatParams): ChatSession;
+    /**
+     * Counts the tokens in the provided request.
+     */
+    countTokens(request: CountTokensRequest | string | Array<string | Part>): Promise<CountTokensResponse>;
+}

package/dist/esm/src/models/imagen-model.d.ts

@@ -0,0 +1,102 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { AI } from '../public-types';
+import { ImagenGCSImage, ImagenGenerationConfig, ImagenInlineImage, RequestOptions, ImagenModelParams, ImagenGenerationResponse, ImagenSafetySettings } from '../types';
+import { AIModel } from './ai-model';
+/**
+ * Class for Imagen model APIs.
+ *
+ * This class provides methods for generating images using the Imagen model.
+ *
+ * @example
+ * ```javascript
+ * const imagen = new ImagenModel(
+ *   ai,
+ *   {
+ *     model: 'imagen-3.0-generate-002'
+ *   }
+ * );
+ *
+ * const response = await imagen.generateImages('A photo of a cat');
+ * if (response.images.length > 0) {
+ *   console.log(response.images[0].bytesBase64Encoded);
+ * }
+ * ```
+ *
+ * @beta
+ */
+export declare class ImagenModel extends AIModel {
+    requestOptions?: RequestOptions | undefined;
+    /**
+     * The Imagen generation configuration.
+     */
+    generationConfig?: ImagenGenerationConfig;
+    /**
+     * Safety settings for filtering inappropriate content.
+     */
+    safetySettings?: ImagenSafetySettings;
+    /**
+     * Constructs a new instance of the {@link ImagenModel} class.
+     *
+     * @param ai - an {@link AI} instance.
+     * @param modelParams - Parameters to use when making requests to Imagen.
+     * @param requestOptions - Additional options to use when making requests.
+     *
+     * @throws If the `apiKey` or `projectId` fields are missing in your
+     * Firebase config.
+     */
+    constructor(ai: AI, modelParams: ImagenModelParams, requestOptions?: RequestOptions | undefined);
+    /**
+     * Generates images using the Imagen model and returns them as
+     * base64-encoded strings.
+     *
+     * @param prompt - A text prompt describing the image(s) to generate.
+     * @returns A promise that resolves to an {@link ImagenGenerationResponse}
+     * object containing the generated images.
+     *
+     * @throws If the request to generate images fails. This happens if the
+     * prompt is blocked.
+     *
+     * @remarks
+     * If the prompt was not blocked, but one or more of the generated images were filtered, the
+     * returned object will have a `filteredReason` property.
+     * If all images are filtered, the `images` array will be empty.
+     *
+     * @beta
+     */
+    generateImages(prompt: string): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
+    /**
+     * Generates images to Cloud Storage for Firebase using the Imagen model.
+     *
+     * @internal This method is temporarily internal.
+     *
+     * @param prompt - A text prompt describing the image(s) to generate.
+     * @param gcsURI - The URI of file stored in a Cloud Storage for Firebase bucket.
+     * This should be a directory. For example, `gs://my-bucket/my-directory/`.
+     * @returns A promise that resolves to an {@link ImagenGenerationResponse}
+     * object containing the URLs of the generated images.
+     *
+     * @throws If the request fails to generate images fails. This happens if
+     * the prompt is blocked.
+     *
+     * @remarks
+     * If the prompt was not blocked, but one or more of the generated images were filtered, the
+     * returned object will have a `filteredReason` property.
+     * If all images are filtered, the `images` array will be empty.
+     */
+    generateImagesGCS(prompt: string, gcsURI: string): Promise<ImagenGenerationResponse<ImagenGCSImage>>;
+}

package/dist/esm/src/models/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from './ai-model';
+export * from './generative-model';
+export * from './imagen-model';

package/dist/esm/src/public-types.d.ts

@@ -0,0 +1,106 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { FirebaseApp } from '@firebase/app';
+import { Backend } from './backend';
+export * from './types';
+/**
+ * @deprecated Use the new {@link AI | AI} instead. The Vertex AI in Firebase SDK has been
+ * replaced with the Firebase AI SDK to accommodate the evolving set of supported features and
+ * services. For migration details, see the {@link https://firebase.google.com/docs/vertex-ai/migrate-to-latest-sdk | migration guide}.
+ *
+ * An instance of the Firebase AI SDK.
+ *
+ * @public
+ */
+export type VertexAI = AI;
+/**
+ * Options when initializing the Firebase AI SDK.
+ *
+ * @public
+ */
+export interface VertexAIOptions {
+    location?: string;
+}
+/**
+ * An instance of the Firebase AI SDK.
+ *
+ * Do not create this instance directly. Instead, use {@link getAI | getAI()}.
+ *
+ * @public
+ */
+export interface AI {
+    /**
+     * The {@link @firebase/app#FirebaseApp} this {@link AI} instance is associated with.
+     */
+    app: FirebaseApp;
+    /**
+     * A {@link Backend} instance that specifies the configuration for the target backend,
+     * either the Gemini Developer API (using {@link GoogleAIBackend}) or the
+     * Vertex AI Gemini API (using {@link VertexAIBackend}).
+     */
+    backend: Backend;
+    /**
+     * @deprecated use `AI.backend.location` instead.
+     *
+     * The location configured for this AI service instance, relevant for Vertex AI backends.
+     */
+    location: string;
+}
+/**
+ * An enum-like object containing constants that represent the supported backends
+ * for the Firebase AI SDK.
+ * This determines which backend service (Vertex AI Gemini API or Gemini Developer API)
+ * the SDK will communicate with.
+ *
+ * These values are assigned to the `backendType` property within the specific backend
+ * configuration objects ({@link GoogleAIBackend} or {@link VertexAIBackend}) to identify
+ * which service to target.
+ *
+ * @public
+ */
+export declare const BackendType: {
+    /**
+     * Identifies the backend service for the Vertex AI Gemini API provided through Google Cloud.
+     * Use this constant when creating a {@link VertexAIBackend} configuration.
+     */
+    readonly VERTEX_AI: "VERTEX_AI";
+    /**
+     * Identifies the backend service for the Gemini Developer API ({@link https://ai.google/ | Google AI}).
+     * Use this constant when creating a {@link GoogleAIBackend} configuration.
+     */
+    readonly GOOGLE_AI: "GOOGLE_AI";
+};
+/**
+ * Type alias representing valid backend types.
+ * It can be either `'VERTEX_AI'` or `'GOOGLE_AI'`.
+ *
+ * @public
+ */
+export type BackendType = (typeof BackendType)[keyof typeof BackendType];
+/**
+ * Options for initializing the AI service using {@link getAI | getAI()}.
+ * This allows specifying which backend to use (Vertex AI Gemini API or Gemini Developer API)
+ * and configuring its specific options (like location for Vertex AI).
+ *
+ * @public
+ */
+export interface AIOptions {
+    /**
+     * The backend configuration to use for the AI service instance.
+     */
+    backend: Backend;
+}