@firebase/ai 0.0.1

package/dist/src/types/imagen/requests.d.ts

@@ -0,0 +1,211 @@
+/**
+ * @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 { ImagenImageFormat } from '../../requests/imagen-image-format';
+/**
+ * Parameters for configuring an {@link ImagenModel}.
+ *
+ * @beta
+ */
+export interface ImagenModelParams {
+    /**
+     * The Imagen model to use for generating images.
+     * For example: `imagen-3.0-generate-002`.
+     *
+     * Only Imagen 3 models (named `imagen-3.0-*`) are supported.
+     *
+     * See {@link https://firebase.google.com/docs/vertex-ai/models | model versions}
+     * for a full list of supported Imagen 3 models.
+     */
+    model: string;
+    /**
+     * Configuration options for generating images with Imagen.
+     */
+    generationConfig?: ImagenGenerationConfig;
+    /**
+     * Safety settings for filtering potentially inappropriate content.
+     */
+    safetySettings?: ImagenSafetySettings;
+}
+/**
+ * Configuration options for generating images with Imagen.
+ *
+ * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images-imagen | documentation} for
+ * more details.
+ *
+ * @beta
+ */
+export interface ImagenGenerationConfig {
+    /**
+     * A description of what should be omitted from the generated images.
+     *
+     * Support for negative prompts depends on the Imagen model.
+     *
+     * See the {@link http://firebase.google.com/docs/vertex-ai/model-parameters#imagen | documentation} for more details.
+     *
+     * This is no longer supported in the Gemini Developer API ({@link GoogleAIBackend}) in versions
+     * greater than `imagen-3.0-generate-002`.
+     */
+    negativePrompt?: string;
+    /**
+     * The number of images to generate. The default value is 1.
+     *
+     * The number of sample images that may be generated in each request depends on the model
+     * (typically up to 4); see the <a href="http://firebase.google.com/docs/vertex-ai/model-parameters#imagen">sampleCount</a>
+     * documentation for more details.
+     */
+    numberOfImages?: number;
+    /**
+     * The aspect ratio of the generated images. The default value is square 1:1.
+     * Supported aspect ratios depend on the Imagen model, see {@link ImagenAspectRatio}
+     * for more details.
+     */
+    aspectRatio?: ImagenAspectRatio;
+    /**
+     * The image format of the generated images. The default is PNG.
+     *
+     * See {@link ImagenImageFormat} for more details.
+     */
+    imageFormat?: ImagenImageFormat;
+    /**
+     * Whether to add an invisible watermark to generated images.
+     *
+     * If set to `true`, an invisible SynthID watermark is embedded in generated images to indicate
+     * that they are AI generated. If set to `false`, watermarking will be disabled.
+     *
+     * For Imagen 3 models, the default value is `true`; see the <a href="http://firebase.google.com/docs/vertex-ai/model-parameters#imagen">addWatermark</a>
+     * documentation for more details.
+     *
+     * When using the Gemini Developer API ({@link GoogleAIBackend}), this will default to true,
+     * and cannot be turned off.
+     */
+    addWatermark?: boolean;
+}
+/**
+ * A filter level controlling how aggressively to filter sensitive content.
+ *
+ * Text prompts provided as inputs and images (generated or uploaded) through Imagen on Vertex AI
+ * are assessed against a list of safety filters, which include 'harmful categories' (for example,
+ * `violence`, `sexual`, `derogatory`, and `toxic`). This filter level controls how aggressively to
+ * filter out potentially harmful content from responses. See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
+ * and the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters | Responsible AI and usage guidelines}
+ * for more details.
+ *
+ * @beta
+ */
+export declare enum ImagenSafetyFilterLevel {
+    /**
+     * The most aggressive filtering level; most strict blocking.
+     */
+    BLOCK_LOW_AND_ABOVE = "block_low_and_above",
+    /**
+     * Blocks some sensitive prompts and responses.
+     */
+    BLOCK_MEDIUM_AND_ABOVE = "block_medium_and_above",
+    /**
+     * Blocks few sensitive prompts and responses.
+     */
+    BLOCK_ONLY_HIGH = "block_only_high",
+    /**
+     * The least aggressive filtering level; blocks very few sensitive prompts and responses.
+     *
+     * Access to this feature is restricted and may require your case to be reviewed and approved by
+     * Cloud support.
+     */
+    BLOCK_NONE = "block_none"
+}
+/**
+ * A filter level controlling whether generation of images containing people or faces is allowed.
+ *
+ * See the <a href="http://firebase.google.com/docs/vertex-ai/generate-images">personGeneration</a>
+ * documentation for more details.
+ *
+ * @beta
+ */
+export declare enum ImagenPersonFilterLevel {
+    /**
+     * Disallow generation of images containing people or faces; images of people are filtered out.
+     */
+    BLOCK_ALL = "dont_allow",
+    /**
+     * Allow generation of images containing adults only; images of children are filtered out.
+     *
+     * Generation of images containing people or faces may require your use case to be
+     * reviewed and approved by Cloud support; see the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#person-face-gen | Responsible AI and usage guidelines}
+     * for more details.
+     */
+    ALLOW_ADULT = "allow_adult",
+    /**
+     * Allow generation of images containing adults only; images of children are filtered out.
+     *
+     * Generation of images containing people or faces may require your use case to be
+     * reviewed and approved by Cloud support; see the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#person-face-gen | Responsible AI and usage guidelines}
+     * for more details.
+     */
+    ALLOW_ALL = "allow_all"
+}
+/**
+ * Settings for controlling the aggressiveness of filtering out sensitive content.
+ *
+ * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
+ * for more details.
+ *
+ * @beta
+ */
+export interface ImagenSafetySettings {
+    /**
+     * A filter level controlling how aggressive to filter out sensitive content from generated
+     * images.
+     */
+    safetyFilterLevel?: ImagenSafetyFilterLevel;
+    /**
+     * A filter level controlling whether generation of images containing people or faces is allowed.
+     */
+    personFilterLevel?: ImagenPersonFilterLevel;
+}
+/**
+ * Aspect ratios for Imagen images.
+ *
+ * To specify an aspect ratio for generated images, set the `aspectRatio` property in your
+ * {@link ImagenGenerationConfig}.
+ *
+ * See the the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
+ * for more details and examples of the supported aspect ratios.
+ *
+ * @beta
+ */
+export declare enum ImagenAspectRatio {
+    /**
+     * Square (1:1) aspect ratio.
+     */
+    SQUARE = "1:1",
+    /**
+     * Landscape (3:4) aspect ratio.
+     */
+    LANDSCAPE_3x4 = "3:4",
+    /**
+     * Portrait (4:3) aspect ratio.
+     */
+    PORTRAIT_4x3 = "4:3",
+    /**
+     * Landscape (16:9) aspect ratio.
+     */
+    LANDSCAPE_16x9 = "16:9",
+    /**
+     * Portrait (9:16) aspect ratio.
+     */
+    PORTRAIT_9x16 = "9:16"
+}

package/dist/src/types/imagen/responses.d.ts

@@ -0,0 +1,78 @@
+/**
+ * @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.
+ */
+/**
+ * An image generated by Imagen, represented as inline data.
+ *
+ * @beta
+ */
+export interface ImagenInlineImage {
+    /**
+     * The MIME type of the image; either `"image/png"` or `"image/jpeg"`.
+     *
+     * To request a different format, set the `imageFormat` property in your {@link ImagenGenerationConfig}.
+     */
+    mimeType: string;
+    /**
+     * The base64-encoded image data.
+     */
+    bytesBase64Encoded: string;
+}
+/**
+ * An image generated by Imagen, stored in a Cloud Storage for Firebase bucket.
+ *
+ * This feature is not available yet.
+ */
+export interface ImagenGCSImage {
+    /**
+     * The MIME type of the image; either `"image/png"` or `"image/jpeg"`.
+     *
+     * To request a different format, set the `imageFormat` property in your {@link ImagenGenerationConfig}.
+     */
+    mimeType: string;
+    /**
+     * The URI of the file stored in a Cloud Storage for Firebase bucket.
+     *
+     * @example `"gs://bucket-name/path/sample_0.jpg"`.
+     */
+    gcsURI: string;
+}
+/**
+ * The response from a request to generate images with Imagen.
+ *
+ * @beta
+ */
+export interface ImagenGenerationResponse<T extends ImagenInlineImage | ImagenGCSImage> {
+    /**
+     * The images generated by Imagen.
+     *
+     * The number of images generated may be fewer than the number requested if one or more were
+     * filtered out; see `filteredReason`.
+     */
+    images: T[];
+    /**
+     * The reason that images were filtered out. This property will only be defined if one
+     * or more images were filtered.
+     *
+     * Images may be filtered out due to the {@link ImagenSafetyFilterLevel},
+     * {@link ImagenPersonFilterLevel}, or filtering included in the model.
+     * The filter levels may be adjusted in your {@link ImagenSafetySettings}.
+     *
+     * See the {@link https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen | Responsible AI and usage guidelines for Imagen}
+     * for more details.
+     */
+    filteredReason?: string;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * @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 * from './content';
+export * from './enums';
+export * from './requests';
+export * from './responses';
+export * from './error';
+export * from './schema';
+export * from './imagen';
+export * from './googleai';

package/dist/src/types/internal.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @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 { AppCheckTokenResult } from '@firebase/app-check-interop-types';
+import { FirebaseAuthTokenData } from '@firebase/auth-interop-types';
+import { Backend } from '../backend';
+export * from './imagen/internal';
+export interface ApiSettings {
+    apiKey: string;
+    project: string;
+    appId: string;
+    automaticDataCollectionEnabled?: boolean;
+    /**
+     * @deprecated Use `backend.location` instead.
+     */
+    location: string;
+    backend: Backend;
+    getAuthToken?: () => Promise<FirebaseAuthTokenData | null>;
+    getAppCheckToken?: () => Promise<AppCheckTokenResult>;
+}

package/dist/src/types/requests.d.ts

@@ -0,0 +1,213 @@
+/**
+ * @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 { TypedSchema } from '../requests/schema-builder';
+import { Content, Part } from './content';
+import { FunctionCallingMode, HarmBlockMethod, HarmBlockThreshold, HarmCategory, ResponseModality } from './enums';
+import { ObjectSchemaInterface, SchemaRequest } from './schema';
+/**
+ * Base parameters for a number of methods.
+ * @public
+ */
+export interface BaseParams {
+    safetySettings?: SafetySetting[];
+    generationConfig?: GenerationConfig;
+}
+/**
+ * Params passed to {@link getGenerativeModel}.
+ * @public
+ */
+export interface ModelParams extends BaseParams {
+    model: string;
+    tools?: Tool[];
+    toolConfig?: ToolConfig;
+    systemInstruction?: string | Part | Content;
+}
+/**
+ * Request sent through {@link GenerativeModel.generateContent}
+ * @public
+ */
+export interface GenerateContentRequest extends BaseParams {
+    contents: Content[];
+    tools?: Tool[];
+    toolConfig?: ToolConfig;
+    systemInstruction?: string | Part | Content;
+}
+/**
+ * Safety setting that can be sent as part of request parameters.
+ * @public
+ */
+export interface SafetySetting {
+    category: HarmCategory;
+    threshold: HarmBlockThreshold;
+    /**
+     * The harm block method.
+     *
+     * This property is only supported in the Vertex AI Gemini API ({@link VertexAIBackend}).
+     * When using the Gemini Developer API ({@link GoogleAIBackend}), an {@link AIError} will be
+     * thrown if this property is defined.
+     */
+    method?: HarmBlockMethod;
+}
+/**
+ * Config options for content-related requests
+ * @public
+ */
+export interface GenerationConfig {
+    candidateCount?: number;
+    stopSequences?: string[];
+    maxOutputTokens?: number;
+    temperature?: number;
+    topP?: number;
+    topK?: number;
+    presencePenalty?: number;
+    frequencyPenalty?: number;
+    /**
+     * Output response MIME type of the generated candidate text.
+     * Supported MIME types are `text/plain` (default, text output),
+     * `application/json` (JSON response in the candidates), and
+     * `text/x.enum`.
+     */
+    responseMimeType?: string;
+    /**
+     * Output response schema of the generated candidate text. This
+     * value can be a class generated with a {@link Schema} static method
+     * like `Schema.string()` or `Schema.object()` or it can be a plain
+     * JS object matching the {@link SchemaRequest} interface.
+     * <br/>Note: This only applies when the specified `responseMIMEType` supports a schema; currently
+     * this is limited to `application/json` and `text/x.enum`.
+     */
+    responseSchema?: TypedSchema | SchemaRequest;
+    /**
+     * Generation modalities to be returned in generation responses.
+     *
+     * @remarks
+     *  - Multimodal response generation is only supported by some Gemini models and versions; see {@link https://firebase.google.com/docs/vertex-ai/models | model versions}.
+     *  - Only image generation (`ResponseModality.IMAGE`) is supported.
+     *
+     * @beta
+     */
+    responseModalities?: ResponseModality[];
+}
+/**
+ * Params for {@link GenerativeModel.startChat}.
+ * @public
+ */
+export interface StartChatParams extends BaseParams {
+    history?: Content[];
+    tools?: Tool[];
+    toolConfig?: ToolConfig;
+    systemInstruction?: string | Part | Content;
+}
+/**
+ * Params for calling {@link GenerativeModel.countTokens}
+ * @public
+ */
+export interface CountTokensRequest {
+    contents: Content[];
+    /**
+     * Instructions that direct the model to behave a certain way.
+     */
+    systemInstruction?: string | Part | Content;
+    /**
+     * {@link Tool} configuration.
+     */
+    tools?: Tool[];
+    /**
+     * Configuration options that control how the model generates a response.
+     */
+    generationConfig?: GenerationConfig;
+}
+/**
+ * Params passed to {@link getGenerativeModel}.
+ * @public
+ */
+export interface RequestOptions {
+    /**
+     * Request timeout in milliseconds. Defaults to 180 seconds (180000ms).
+     */
+    timeout?: number;
+    /**
+     * Base url for endpoint. Defaults to https://firebasevertexai.googleapis.com
+     */
+    baseUrl?: string;
+}
+/**
+ * Defines a tool that model can call to access external knowledge.
+ * @public
+ */
+export declare type Tool = FunctionDeclarationsTool;
+/**
+ * Structured representation of a function declaration as defined by the
+ * {@link https://spec.openapis.org/oas/v3.0.3 | OpenAPI 3.0 specification}.
+ * Included
+ * in this declaration are the function name and parameters. This
+ * `FunctionDeclaration` is a representation of a block of code that can be used
+ * as a Tool by the model and executed by the client.
+ * @public
+ */
+export declare interface FunctionDeclaration {
+    /**
+     * The name of the function to call. Must start with a letter or an
+     * underscore. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with
+     * a max length of 64.
+     */
+    name: string;
+    /**
+     * Description and purpose of the function. Model uses it to decide
+     * how and whether to call the function.
+     */
+    description: string;
+    /**
+     * Optional. Describes the parameters to this function in JSON Schema Object
+     * format. Reflects the Open API 3.03 Parameter Object. Parameter names are
+     * case-sensitive. For a function with no parameters, this can be left unset.
+     */
+    parameters?: ObjectSchemaInterface;
+}
+/**
+ * A `FunctionDeclarationsTool` is a piece of code that enables the system to
+ * interact with external systems to perform an action, or set of actions,
+ * outside of knowledge and scope of the model.
+ * @public
+ */
+export declare interface FunctionDeclarationsTool {
+    /**
+     * Optional. One or more function declarations
+     * to be passed to the model along with the current user query. Model may
+     * decide to call a subset of these functions by populating
+     * {@link FunctionCall} in the response. User should
+     * provide a {@link FunctionResponse} for each
+     * function call in the next turn. Based on the function responses, the model will
+     * generate the final response back to the user. Maximum 64 function
+     * declarations can be provided.
+     */
+    functionDeclarations?: FunctionDeclaration[];
+}
+/**
+ * Tool config. This config is shared for all tools provided in the request.
+ * @public
+ */
+export interface ToolConfig {
+    functionCallingConfig?: FunctionCallingConfig;
+}
+/**
+ * @public
+ */
+export interface FunctionCallingConfig {
+    mode?: FunctionCallingMode;
+    allowedFunctionNames?: string[];
+}