@firebase/ai 1.4.0 → 1.4.1-canary.25b60fdaa

package/dist/src/api.d.ts

@@ -17,8 +17,8 @@
 import { FirebaseApp } from '@firebase/app';
 import { AI_TYPE } from './constants';
 import { AIService } from './service';
-import { AI, AIOptions, VertexAI, VertexAIOptions } from './public-types';
-import { ImagenModelParams, ModelParams, RequestOptions, AIErrorCode } from './types';
+import { AI, AIOptions } from './public-types';
+import { ImagenModelParams, ModelParams, RequestOptions } from './types';
 import { AIError } from './errors';
 import { AIModel, GenerativeModel, ImagenModel } from './models';
 export { ChatSession } from './methods/chat-session';
@@ -26,47 +26,11 @@ export * from './requests/schema-builder';
 export { ImagenImageFormat } from './requests/imagen-image-format';
 export { AIModel, GenerativeModel, ImagenModel, AIError };
 export { Backend, VertexAIBackend, GoogleAIBackend } from './backend';
-export { AIErrorCode as VertexAIErrorCode };
-/**
- * @deprecated Use the new {@link AIModel} 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}.
- *
- * Base class for Firebase AI model APIs.
- *
- * @public
- */
-export declare const VertexAIModel: typeof AIModel;
-/**
- * @deprecated Use the new {@link AIError} 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}.
- *
- * Error class for the Firebase AI SDK.
- *
- * @public
- */
-export declare const VertexAIError: typeof AIError;
 declare module '@firebase/component' {
     interface NameServiceMapping {
         [AI_TYPE]: AIService;
     }
 }
-/**
- * @deprecated Use the new {@link getAI | getAI()} 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}.
- *
- * Returns a {@link VertexAI} instance for the given app, configured to use the
- * Vertex AI Gemini API. This instance will be
- * configured to use the Vertex AI Gemini API.
- *
- * @param app - The {@link @firebase/app#FirebaseApp} to use.
- * @param options - Options to configure the Vertex AI instance, including the location.
- *
- * @public
- */
-export declare function getVertexAI(app?: FirebaseApp, options?: VertexAIOptions): VertexAI;
 /**
  * Returns the default {@link AI} instance that is associated with the provided
  * {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new instance with the

package/dist/src/errors.d.ts

@@ -27,7 +27,7 @@ export declare class AIError extends FirebaseError {
     /**
      * Constructs a new instance of the `AIError` class.
      *
-     * @param code - The error code from {@link AIErrorCode}.
+     * @param code - The error code from {@link (AIErrorCode:type)}.
      * @param message - A human-readable message describing the error.
      * @param customErrorData - Optional error data.
      */

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

@@ -17,24 +17,6 @@
 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.
  *

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

@@ -24,10 +24,11 @@ import { SchemaInterface, SchemaType, SchemaParams, SchemaRequest } from '../typ
  */
 export declare abstract class Schema implements SchemaInterface {
     /**
-     * Optional. The type of the property. {@link
-     * SchemaType}.
+     * Optional. The type of the property.
+     * This can only be undefined when using `anyOf` schemas, which do not have an
+     * explicit type in the {@link https://swagger.io/docs/specification/v3_0/data-models/data-types/#any-type | OpenAPI specification}.
      */
-    type: SchemaType;
+    type?: SchemaType;
     /** Optional. The format of the property.
      * Supported formats:<br/>
      * <ul>
@@ -41,9 +42,9 @@ export declare abstract class Schema implements SchemaInterface {
     description?: string;
     /** Optional. The items of the property. */
     items?: SchemaInterface;
-    /** The minimum number of items (elements) in a schema of type {@link SchemaType.ARRAY}. */
+    /** The minimum number of items (elements) in a schema of {@link (SchemaType:type)} `array`. */
     minItems?: number;
-    /** The maximum number of items (elements) in a schema of type {@link SchemaType.ARRAY}. */
+    /** The maximum number of items (elements) in a schema of {@link (SchemaType:type)} `array`. */
     maxItems?: number;
     /** Optional. Whether the property is nullable. Defaults to false. */
     nullable: boolean;
@@ -77,12 +78,15 @@ export declare abstract class Schema implements SchemaInterface {
     static integer(integerParams?: SchemaParams): IntegerSchema;
     static number(numberParams?: SchemaParams): NumberSchema;
     static boolean(booleanParams?: SchemaParams): BooleanSchema;
+    static anyOf(anyOfParams: SchemaParams & {
+        anyOf: TypedSchema[];
+    }): AnyOfSchema;
 }
 /**
  * A type that includes all specific Schema types.
  * @public
  */
-export type TypedSchema = IntegerSchema | NumberSchema | StringSchema | BooleanSchema | ObjectSchema | ArraySchema;
+export type TypedSchema = IntegerSchema | NumberSchema | StringSchema | BooleanSchema | ObjectSchema | ArraySchema | AnyOfSchema;
 /**
  * Schema class for "integer" types.
  * @public
@@ -149,3 +153,18 @@ export declare class ObjectSchema extends Schema {
      */
     toJSON(): SchemaRequest;
 }
+/**
+ * Schema class representing a value that can conform to any of the provided sub-schemas. This is
+ * useful when a field can accept multiple distinct types or structures.
+ * @public
+ */
+export declare class AnyOfSchema extends Schema {
+    anyOf: TypedSchema[];
+    constructor(schemaParams: SchemaParams & {
+        anyOf: TypedSchema[];
+    });
+    /**
+     * @internal
+     */
+    toJSON(): SchemaRequest;
+}

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

@@ -28,221 +28,263 @@ export declare const POSSIBLE_ROLES: readonly ["user", "model", "function", "sys
  * Harm categories that would cause prompts or candidates to be blocked.
  * @public
  */
-export declare enum HarmCategory {
-    HARM_CATEGORY_HATE_SPEECH = "HARM_CATEGORY_HATE_SPEECH",
-    HARM_CATEGORY_SEXUALLY_EXPLICIT = "HARM_CATEGORY_SEXUALLY_EXPLICIT",
-    HARM_CATEGORY_HARASSMENT = "HARM_CATEGORY_HARASSMENT",
-    HARM_CATEGORY_DANGEROUS_CONTENT = "HARM_CATEGORY_DANGEROUS_CONTENT"
-}
+export declare const HarmCategory: {
+    readonly HARM_CATEGORY_HATE_SPEECH: "HARM_CATEGORY_HATE_SPEECH";
+    readonly HARM_CATEGORY_SEXUALLY_EXPLICIT: "HARM_CATEGORY_SEXUALLY_EXPLICIT";
+    readonly HARM_CATEGORY_HARASSMENT: "HARM_CATEGORY_HARASSMENT";
+    readonly HARM_CATEGORY_DANGEROUS_CONTENT: "HARM_CATEGORY_DANGEROUS_CONTENT";
+};
+/**
+ * Harm categories that would cause prompts or candidates to be blocked.
+ * @public
+ */
+export type HarmCategory = (typeof HarmCategory)[keyof typeof HarmCategory];
 /**
  * Threshold above which a prompt or candidate will be blocked.
  * @public
  */
-export declare enum HarmBlockThreshold {
+export declare const HarmBlockThreshold: {
     /**
      * Content with `NEGLIGIBLE` will be allowed.
      */
-    BLOCK_LOW_AND_ABOVE = "BLOCK_LOW_AND_ABOVE",
+    readonly BLOCK_LOW_AND_ABOVE: "BLOCK_LOW_AND_ABOVE";
     /**
      * Content with `NEGLIGIBLE` and `LOW` will be allowed.
      */
-    BLOCK_MEDIUM_AND_ABOVE = "BLOCK_MEDIUM_AND_ABOVE",
+    readonly BLOCK_MEDIUM_AND_ABOVE: "BLOCK_MEDIUM_AND_ABOVE";
     /**
      * Content with `NEGLIGIBLE`, `LOW`, and `MEDIUM` will be allowed.
      */
-    BLOCK_ONLY_HIGH = "BLOCK_ONLY_HIGH",
+    readonly BLOCK_ONLY_HIGH: "BLOCK_ONLY_HIGH";
     /**
      * All content will be allowed.
      */
-    BLOCK_NONE = "BLOCK_NONE",
+    readonly BLOCK_NONE: "BLOCK_NONE";
     /**
      * All content will be allowed. This is the same as `BLOCK_NONE`, but the metadata corresponding
      * to the {@link HarmCategory} will not be present in the response.
      */
-    OFF = "OFF"
-}
+    readonly OFF: "OFF";
+};
+/**
+ * Threshold above which a prompt or candidate will be blocked.
+ * @public
+ */
+export type HarmBlockThreshold = (typeof HarmBlockThreshold)[keyof typeof HarmBlockThreshold];
 /**
  * This property is not supported in the Gemini Developer API ({@link GoogleAIBackend}).
  *
  * @public
  */
-export declare enum HarmBlockMethod {
+export declare const HarmBlockMethod: {
     /**
      * The harm block method uses both probability and severity scores.
      */
-    SEVERITY = "SEVERITY",
+    readonly SEVERITY: "SEVERITY";
     /**
      * The harm block method uses the probability score.
      */
-    PROBABILITY = "PROBABILITY"
-}
+    readonly PROBABILITY: "PROBABILITY";
+};
+/**
+ * This property is not supported in the Gemini Developer API ({@link GoogleAIBackend}).
+ *
+ * @public
+ */
+export type HarmBlockMethod = (typeof HarmBlockMethod)[keyof typeof HarmBlockMethod];
 /**
  * Probability that a prompt or candidate matches a harm category.
  * @public
  */
-export declare enum HarmProbability {
+export declare const HarmProbability: {
     /**
      * Content has a negligible chance of being unsafe.
      */
-    NEGLIGIBLE = "NEGLIGIBLE",
+    readonly NEGLIGIBLE: "NEGLIGIBLE";
     /**
      * Content has a low chance of being unsafe.
      */
-    LOW = "LOW",
+    readonly LOW: "LOW";
     /**
      * Content has a medium chance of being unsafe.
      */
-    MEDIUM = "MEDIUM",
+    readonly MEDIUM: "MEDIUM";
     /**
      * Content has a high chance of being unsafe.
      */
-    HIGH = "HIGH"
-}
+    readonly HIGH: "HIGH";
+};
+/**
+ * Probability that a prompt or candidate matches a harm category.
+ * @public
+ */
+export type HarmProbability = (typeof HarmProbability)[keyof typeof HarmProbability];
 /**
  * Harm severity levels.
  * @public
  */
-export declare enum HarmSeverity {
+export declare const HarmSeverity: {
     /**
      * Negligible level of harm severity.
      */
-    HARM_SEVERITY_NEGLIGIBLE = "HARM_SEVERITY_NEGLIGIBLE",
+    readonly HARM_SEVERITY_NEGLIGIBLE: "HARM_SEVERITY_NEGLIGIBLE";
     /**
      * Low level of harm severity.
      */
-    HARM_SEVERITY_LOW = "HARM_SEVERITY_LOW",
+    readonly HARM_SEVERITY_LOW: "HARM_SEVERITY_LOW";
     /**
      * Medium level of harm severity.
      */
-    HARM_SEVERITY_MEDIUM = "HARM_SEVERITY_MEDIUM",
+    readonly HARM_SEVERITY_MEDIUM: "HARM_SEVERITY_MEDIUM";
     /**
      * High level of harm severity.
      */
-    HARM_SEVERITY_HIGH = "HARM_SEVERITY_HIGH",
+    readonly HARM_SEVERITY_HIGH: "HARM_SEVERITY_HIGH";
     /**
      * Harm severity is not supported.
      *
      * @remarks
      * The GoogleAI backend does not support `HarmSeverity`, so this value is used as a fallback.
      */
-    HARM_SEVERITY_UNSUPPORTED = "HARM_SEVERITY_UNSUPPORTED"
-}
+    readonly HARM_SEVERITY_UNSUPPORTED: "HARM_SEVERITY_UNSUPPORTED";
+};
+/**
+ * Harm severity levels.
+ * @public
+ */
+export type HarmSeverity = (typeof HarmSeverity)[keyof typeof HarmSeverity];
 /**
  * Reason that a prompt was blocked.
  * @public
  */
-export declare enum BlockReason {
+export declare const BlockReason: {
     /**
      * Content was blocked by safety settings.
      */
-    SAFETY = "SAFETY",
+    readonly SAFETY: "SAFETY";
     /**
      * Content was blocked, but the reason is uncategorized.
      */
-    OTHER = "OTHER",
+    readonly OTHER: "OTHER";
     /**
      * Content was blocked because it contained terms from the terminology blocklist.
      */
-    BLOCKLIST = "BLOCKLIST",
+    readonly BLOCKLIST: "BLOCKLIST";
     /**
      * Content was blocked due to prohibited content.
      */
-    PROHIBITED_CONTENT = "PROHIBITED_CONTENT"
-}
+    readonly PROHIBITED_CONTENT: "PROHIBITED_CONTENT";
+};
+/**
+ * Reason that a prompt was blocked.
+ * @public
+ */
+export type BlockReason = (typeof BlockReason)[keyof typeof BlockReason];
 /**
  * Reason that a candidate finished.
  * @public
  */
-export declare enum FinishReason {
+export declare const FinishReason: {
     /**
      * Natural stop point of the model or provided stop sequence.
      */
-    STOP = "STOP",
+    readonly STOP: "STOP";
     /**
      * The maximum number of tokens as specified in the request was reached.
      */
-    MAX_TOKENS = "MAX_TOKENS",
+    readonly MAX_TOKENS: "MAX_TOKENS";
     /**
      * The candidate content was flagged for safety reasons.
      */
-    SAFETY = "SAFETY",
+    readonly SAFETY: "SAFETY";
     /**
      * The candidate content was flagged for recitation reasons.
      */
-    RECITATION = "RECITATION",
+    readonly RECITATION: "RECITATION";
     /**
      * Unknown reason.
      */
-    OTHER = "OTHER",
+    readonly OTHER: "OTHER";
     /**
      * The candidate content contained forbidden terms.
      */
-    BLOCKLIST = "BLOCKLIST",
+    readonly BLOCKLIST: "BLOCKLIST";
     /**
      * The candidate content potentially contained prohibited content.
      */
-    PROHIBITED_CONTENT = "PROHIBITED_CONTENT",
+    readonly PROHIBITED_CONTENT: "PROHIBITED_CONTENT";
     /**
      * The candidate content potentially contained Sensitive Personally Identifiable Information (SPII).
      */
-    SPII = "SPII",
+    readonly SPII: "SPII";
     /**
      * The function call generated by the model was invalid.
      */
-    MALFORMED_FUNCTION_CALL = "MALFORMED_FUNCTION_CALL"
-}
+    readonly MALFORMED_FUNCTION_CALL: "MALFORMED_FUNCTION_CALL";
+};
+/**
+ * Reason that a candidate finished.
+ * @public
+ */
+export type FinishReason = (typeof FinishReason)[keyof typeof FinishReason];
 /**
  * @public
  */
-export declare enum FunctionCallingMode {
+export declare const FunctionCallingMode: {
     /**
      * Default model behavior; model decides to predict either a function call
      * or a natural language response.
      */
-    AUTO = "AUTO",
+    readonly AUTO: "AUTO";
     /**
      * Model is constrained to always predicting a function call only.
      * If `allowed_function_names` is set, the predicted function call will be
      * limited to any one of `allowed_function_names`, else the predicted
      * function call will be any one of the provided `function_declarations`.
      */
-    ANY = "ANY",
+    readonly ANY: "ANY";
     /**
      * Model will not predict any function call. Model behavior is same as when
      * not passing any function declarations.
      */
-    NONE = "NONE"
-}
+    readonly NONE: "NONE";
+};
+export type FunctionCallingMode = (typeof FunctionCallingMode)[keyof typeof FunctionCallingMode];
 /**
  * Content part modality.
  * @public
  */
-export declare enum Modality {
+export declare const Modality: {
     /**
      * Unspecified modality.
      */
-    MODALITY_UNSPECIFIED = "MODALITY_UNSPECIFIED",
+    readonly MODALITY_UNSPECIFIED: "MODALITY_UNSPECIFIED";
     /**
      * Plain text.
      */
-    TEXT = "TEXT",
+    readonly TEXT: "TEXT";
     /**
      * Image.
      */
-    IMAGE = "IMAGE",
+    readonly IMAGE: "IMAGE";
     /**
      * Video.
      */
-    VIDEO = "VIDEO",
+    readonly VIDEO: "VIDEO";
     /**
      * Audio.
      */
-    AUDIO = "AUDIO",
+    readonly AUDIO: "AUDIO";
     /**
      * Document (for example, PDF).
      */
-    DOCUMENT = "DOCUMENT"
-}
+    readonly DOCUMENT: "DOCUMENT";
+};
+/**
+ * Content part modality.
+ * @public
+ */
+export type Modality = (typeof Modality)[keyof typeof Modality];
 /**
  * Generation modalities to be returned in generation responses.
  *

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

@@ -51,31 +51,37 @@ export interface CustomErrorData {
  *
  * @public
  */
-export declare const enum AIErrorCode {
+export declare const AIErrorCode: {
     /** A generic error occurred. */
-    ERROR = "error",
+    readonly ERROR: "error";
     /** An error occurred in a request. */
-    REQUEST_ERROR = "request-error",
+    readonly REQUEST_ERROR: "request-error";
     /** An error occurred in a response. */
-    RESPONSE_ERROR = "response-error",
+    readonly RESPONSE_ERROR: "response-error";
     /** An error occurred while performing a fetch. */
-    FETCH_ERROR = "fetch-error",
+    readonly FETCH_ERROR: "fetch-error";
     /** An error associated with a Content object.  */
-    INVALID_CONTENT = "invalid-content",
+    readonly INVALID_CONTENT: "invalid-content";
     /** An error due to the Firebase API not being enabled in the Console. */
-    API_NOT_ENABLED = "api-not-enabled",
+    readonly API_NOT_ENABLED: "api-not-enabled";
     /** An error due to invalid Schema input.  */
-    INVALID_SCHEMA = "invalid-schema",
+    readonly INVALID_SCHEMA: "invalid-schema";
     /** An error occurred due to a missing Firebase API key. */
-    NO_API_KEY = "no-api-key",
+    readonly NO_API_KEY: "no-api-key";
     /** An error occurred due to a missing Firebase app ID. */
-    NO_APP_ID = "no-app-id",
+    readonly NO_APP_ID: "no-app-id";
     /** An error occurred due to a model name not being specified during initialization. */
-    NO_MODEL = "no-model",
+    readonly NO_MODEL: "no-model";
     /** An error occurred due to a missing project ID. */
-    NO_PROJECT_ID = "no-project-id",
+    readonly NO_PROJECT_ID: "no-project-id";
     /** An error occurred while parsing. */
-    PARSE_FAILED = "parse-failed",
+    readonly PARSE_FAILED: "parse-failed";
     /** An error occurred due an attempt to use an unsupported feature. */
-    UNSUPPORTED = "unsupported"
-}
+    readonly UNSUPPORTED: "unsupported";
+};
+/**
+ * Standardized error codes that {@link AIError} can have.
+ *
+ * @public
+ */
+export type AIErrorCode = (typeof AIErrorCode)[keyof typeof AIErrorCode];