@firebase/ai 0.0.1

package/dist/src/requests/imagen-image-format.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @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.
+ */
+/**
+ * Defines the image format for images generated by Imagen.
+ *
+ * Use this class to specify the desired format (JPEG or PNG) and compression quality
+ * for images generated by Imagen. This is typically included as part of
+ * {@link ImagenModelParams}.
+ *
+ * @example
+ * ```javascript
+ * const imagenModelParams = {
+ *   // ... other ImagenModelParams
+ *   imageFormat: ImagenImageFormat.jpeg(75) // JPEG with a compression level of 75.
+ * }
+ * ```
+ *
+ * @beta
+ */
+export declare class ImagenImageFormat {
+    /**
+     * The MIME type.
+     */
+    mimeType: string;
+    /**
+     * The level of compression (a number between 0 and 100).
+     */
+    compressionQuality?: number;
+    private constructor();
+    /**
+     * Creates an {@link ImagenImageFormat} for a JPEG image.
+     *
+     * @param compressionQuality - The level of compression (a number between 0 and 100).
+     * @returns An {@link ImagenImageFormat} object for a JPEG image.
+     *
+     * @beta
+     */
+    static jpeg(compressionQuality?: number): ImagenImageFormat;
+    /**
+     * Creates an {@link ImagenImageFormat} for a PNG image.
+     *
+     * @returns An {@link ImagenImageFormat} object for a PNG image.
+     *
+     * @beta
+     */
+    static png(): ImagenImageFormat;
+}

package/dist/src/requests/request-helpers.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @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, GenerateContentRequest, Part } from '../types';
+import { ImagenGenerationParams, PredictRequestBody } from '../types/internal';
+export declare function formatSystemInstruction(input?: string | Part | Content): Content | undefined;
+export declare function formatNewContent(request: string | Array<string | Part>): Content;
+export declare function formatGenerateContentInput(params: GenerateContentRequest | string | Array<string | Part>): GenerateContentRequest;
+/**
+ * Convert the user-defined parameters in {@link ImagenGenerationParams} to the format
+ * that is expected from the REST API.
+ *
+ * @internal
+ */
+export declare function createPredictRequestBody(prompt: string, { gcsURI, imageFormat, addWatermark, numberOfImages, negativePrompt, aspectRatio, safetyFilterLevel, personFilterLevel }: ImagenGenerationParams): PredictRequestBody;

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

@@ -0,0 +1,43 @@
+/**
+ * @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 { RequestOptions } from '../types';
+import { ApiSettings } from '../types/internal';
+export declare enum Task {
+    GENERATE_CONTENT = "generateContent",
+    STREAM_GENERATE_CONTENT = "streamGenerateContent",
+    COUNT_TOKENS = "countTokens",
+    PREDICT = "predict"
+}
+export declare class RequestUrl {
+    model: string;
+    task: Task;
+    apiSettings: ApiSettings;
+    stream: boolean;
+    requestOptions?: RequestOptions | undefined;
+    constructor(model: string, task: Task, apiSettings: ApiSettings, stream: boolean, requestOptions?: RequestOptions | undefined);
+    toString(): string;
+    private get baseUrl();
+    private get apiVersion();
+    private get modelPath();
+    private get queryParams();
+}
+export declare function getHeaders(url: RequestUrl): Promise<Headers>;
+export declare function constructRequest(model: string, task: Task, apiSettings: ApiSettings, stream: boolean, body: string, requestOptions?: RequestOptions): Promise<{
+    url: string;
+    fetchOptions: RequestInit;
+}>;
+export declare function makeRequest(model: string, task: Task, apiSettings: ApiSettings, stream: boolean, body: string, requestOptions?: RequestOptions): Promise<Response>;

package/dist/src/requests/response-helpers.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @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 { EnhancedGenerateContentResponse, FunctionCall, GenerateContentResponse, ImagenGCSImage, ImagenInlineImage, InlineDataPart } from '../types';
+/**
+ * Creates an EnhancedGenerateContentResponse object that has helper functions and
+ * other modifications that improve usability.
+ */
+export declare function createEnhancedContentResponse(response: GenerateContentResponse): EnhancedGenerateContentResponse;
+/**
+ * Adds convenience helper methods to a response object, including stream
+ * chunks (as long as each chunk is a complete GenerateContentResponse JSON).
+ */
+export declare function addHelpers(response: GenerateContentResponse): EnhancedGenerateContentResponse;
+/**
+ * Returns all text found in all parts of first candidate.
+ */
+export declare function getText(response: GenerateContentResponse): string;
+/**
+ * Returns {@link FunctionCall}s associated with first candidate.
+ */
+export declare function getFunctionCalls(response: GenerateContentResponse): FunctionCall[] | undefined;
+/**
+ * Returns {@link InlineDataPart}s in the first candidate if present.
+ *
+ * @internal
+ */
+export declare function getInlineDataParts(response: GenerateContentResponse): InlineDataPart[] | undefined;
+export declare function formatBlockErrorMessage(response: GenerateContentResponse): string;
+/**
+ * Convert a generic successful fetch response body to an Imagen response object
+ * that can be returned to the user. This converts the REST APIs response format to our
+ * APIs representation of a response.
+ *
+ * @internal
+ */
+export declare function handlePredictResponse<T extends ImagenInlineImage | ImagenGCSImage>(response: Response): Promise<{
+    images: T[];
+    filteredReason?: string;
+}>;

package/dist/src/requests/schema-builder.d.ts

@@ -0,0 +1,145 @@
+/**
+ * @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 { SchemaInterface, SchemaType, SchemaParams, SchemaRequest } from '../types/schema';
+/**
+ * Parent class encompassing all Schema types, with static methods that
+ * allow building specific Schema types. This class can be converted with
+ * `JSON.stringify()` into a JSON string accepted by Vertex AI REST endpoints.
+ * (This string conversion is automatically done when calling SDK methods.)
+ * @public
+ */
+export declare abstract class Schema implements SchemaInterface {
+    /**
+     * Optional. The type of the property. {@link
+     * SchemaType}.
+     */
+    type: SchemaType;
+    /** Optional. The format of the property.
+     * Supported formats:<br/>
+     * <ul>
+     *  <li>for NUMBER type: "float", "double"</li>
+     *  <li>for INTEGER type: "int32", "int64"</li>
+     *  <li>for STRING type: "email", "byte", etc</li>
+     * </ul>
+     */
+    format?: string;
+    /** Optional. The description of the property. */
+    description?: string;
+    /** Optional. Whether the property is nullable. Defaults to false. */
+    nullable: boolean;
+    /** Optional. The example of the property. */
+    example?: unknown;
+    /**
+     * Allows user to add other schema properties that have not yet
+     * been officially added to the SDK.
+     */
+    [key: string]: unknown;
+    constructor(schemaParams: SchemaInterface);
+    /**
+     * Defines how this Schema should be serialized as JSON.
+     * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#tojson_behavior
+     * @internal
+     */
+    toJSON(): SchemaRequest;
+    static array(arrayParams: SchemaParams & {
+        items: Schema;
+    }): ArraySchema;
+    static object(objectParams: SchemaParams & {
+        properties: {
+            [k: string]: Schema;
+        };
+        optionalProperties?: string[];
+    }): ObjectSchema;
+    static string(stringParams?: SchemaParams): StringSchema;
+    static enumString(stringParams: SchemaParams & {
+        enum: string[];
+    }): StringSchema;
+    static integer(integerParams?: SchemaParams): IntegerSchema;
+    static number(numberParams?: SchemaParams): NumberSchema;
+    static boolean(booleanParams?: SchemaParams): BooleanSchema;
+}
+/**
+ * A type that includes all specific Schema types.
+ * @public
+ */
+export type TypedSchema = IntegerSchema | NumberSchema | StringSchema | BooleanSchema | ObjectSchema | ArraySchema;
+/**
+ * Schema class for "integer" types.
+ * @public
+ */
+export declare class IntegerSchema extends Schema {
+    constructor(schemaParams?: SchemaParams);
+}
+/**
+ * Schema class for "number" types.
+ * @public
+ */
+export declare class NumberSchema extends Schema {
+    constructor(schemaParams?: SchemaParams);
+}
+/**
+ * Schema class for "boolean" types.
+ * @public
+ */
+export declare class BooleanSchema extends Schema {
+    constructor(schemaParams?: SchemaParams);
+}
+/**
+ * Schema class for "string" types. Can be used with or without
+ * enum values.
+ * @public
+ */
+export declare class StringSchema extends Schema {
+    enum?: string[];
+    constructor(schemaParams?: SchemaParams, enumValues?: string[]);
+    /**
+     * @internal
+     */
+    toJSON(): SchemaRequest;
+}
+/**
+ * Schema class for "array" types.
+ * The `items` param should refer to the type of item that can be a member
+ * of the array.
+ * @public
+ */
+export declare class ArraySchema extends Schema {
+    items: TypedSchema;
+    constructor(schemaParams: SchemaParams, items: TypedSchema);
+    /**
+     * @internal
+     */
+    toJSON(): SchemaRequest;
+}
+/**
+ * Schema class for "object" types.
+ * The `properties` param must be a map of `Schema` objects.
+ * @public
+ */
+export declare class ObjectSchema extends Schema {
+    properties: {
+        [k: string]: TypedSchema;
+    };
+    optionalProperties: string[];
+    constructor(schemaParams: SchemaParams, properties: {
+        [k: string]: TypedSchema;
+    }, optionalProperties?: string[]);
+    /**
+     * @internal
+     */
+    toJSON(): SchemaRequest;
+}

package/dist/src/requests/stream-reader.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @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 { GenerateContentResponse, GenerateContentStreamResult } from '../types';
+import { ApiSettings } from '../types/internal';
+/**
+ * Process a response.body stream from the backend and return an
+ * iterator that provides one complete GenerateContentResponse at a time
+ * and a promise that resolves with a single aggregated
+ * GenerateContentResponse.
+ *
+ * @param response - Response from a fetch call
+ */
+export declare function processStream(response: Response, apiSettings: ApiSettings): GenerateContentStreamResult;
+/**
+ * Reads a raw stream from the fetch response and join incomplete
+ * chunks, returning a new stream that provides a single complete
+ * GenerateContentResponse in each iteration.
+ */
+export declare function getResponseStream<T>(inputStream: ReadableStream<string>): ReadableStream<T>;
+/**
+ * Aggregates an array of `GenerateContentResponse`s into a single
+ * GenerateContentResponse.
+ */
+export declare function aggregateResponses(responses: GenerateContentResponse[]): GenerateContentResponse;

package/dist/src/service.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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, _FirebaseService } from '@firebase/app';
+import { AI } from './public-types';
+import { AppCheckInternalComponentName, FirebaseAppCheckInternal } from '@firebase/app-check-interop-types';
+import { Provider } from '@firebase/component';
+import { FirebaseAuthInternal, FirebaseAuthInternalName } from '@firebase/auth-interop-types';
+import { Backend } from './backend';
+export declare class AIService implements AI, _FirebaseService {
+    app: FirebaseApp;
+    backend: Backend;
+    auth: FirebaseAuthInternal | null;
+    appCheck: FirebaseAppCheckInternal | null;
+    location: string;
+    constructor(app: FirebaseApp, backend: Backend, authProvider?: Provider<FirebaseAuthInternalName>, appCheckProvider?: Provider<AppCheckInternalComponentName>);
+    _delete(): Promise<void>;
+}

package/dist/src/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "0.1.2"
+    }
+  ]
+}

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

@@ -0,0 +1,144 @@
+/**
+ * @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 { Role } from './enums';
+/**
+ * Content type for both prompts and response candidates.
+ * @public
+ */
+export interface Content {
+    role: Role;
+    parts: Part[];
+}
+/**
+ * Content part - includes text, image/video, or function call/response
+ * part types.
+ * @public
+ */
+export type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;
+/**
+ * Content part interface if the part represents a text string.
+ * @public
+ */
+export interface TextPart {
+    text: string;
+    inlineData?: never;
+    functionCall?: never;
+    functionResponse?: never;
+}
+/**
+ * Content part interface if the part represents an image.
+ * @public
+ */
+export interface InlineDataPart {
+    text?: never;
+    inlineData: GenerativeContentBlob;
+    functionCall?: never;
+    functionResponse?: never;
+    /**
+     * Applicable if `inlineData` is a video.
+     */
+    videoMetadata?: VideoMetadata;
+}
+/**
+ * Describes the input video content.
+ * @public
+ */
+export interface VideoMetadata {
+    /**
+     * The start offset of the video in
+     * protobuf {@link https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-v1/latest/Google-Protobuf-Duration#json-mapping | Duration} format.
+     */
+    startOffset: string;
+    /**
+     * The end offset of the video in
+     * protobuf {@link https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-v1/latest/Google-Protobuf-Duration#json-mapping | Duration} format.
+     */
+    endOffset: string;
+}
+/**
+ * Content part interface if the part represents a {@link FunctionCall}.
+ * @public
+ */
+export interface FunctionCallPart {
+    text?: never;
+    inlineData?: never;
+    functionCall: FunctionCall;
+    functionResponse?: never;
+}
+/**
+ * Content part interface if the part represents {@link FunctionResponse}.
+ * @public
+ */
+export interface FunctionResponsePart {
+    text?: never;
+    inlineData?: never;
+    functionCall?: never;
+    functionResponse: FunctionResponse;
+}
+/**
+ * Content part interface if the part represents {@link FileData}
+ * @public
+ */
+export interface FileDataPart {
+    text?: never;
+    inlineData?: never;
+    functionCall?: never;
+    functionResponse?: never;
+    fileData: FileData;
+}
+/**
+ * A predicted {@link FunctionCall} returned from the model
+ * that contains a string representing the {@link FunctionDeclaration.name}
+ * and a structured JSON object containing the parameters and their values.
+ * @public
+ */
+export interface FunctionCall {
+    name: string;
+    args: object;
+}
+/**
+ * The result output from a {@link FunctionCall} that contains a string
+ * representing the {@link FunctionDeclaration.name}
+ * and a structured JSON object containing any output
+ * from the function is used as context to the model.
+ * This should contain the result of a {@link FunctionCall}
+ * made based on model prediction.
+ * @public
+ */
+export interface FunctionResponse {
+    name: string;
+    response: object;
+}
+/**
+ * Interface for sending an image.
+ * @public
+ */
+export interface GenerativeContentBlob {
+    mimeType: string;
+    /**
+     * Image as a base64 string.
+     */
+    data: string;
+}
+/**
+ * Data pointing to a file uploaded on Google Cloud Storage.
+ * @public
+ */
+export interface FileData {
+    mimeType: string;
+    fileUri: string;
+}