@firebase/ai 1.4.0 → 1.4.1-canary.2b5731292

package/dist/ai-public.d.ts

@@ -46,7 +46,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.
      */
@@ -58,36 +58,41 @@ export declare class AIError extends FirebaseError {
  *
  * @public
  */
-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"
-}
-export { AIErrorCode }
-export { AIErrorCode as VertexAIErrorCode }
+    readonly UNSUPPORTED: "unsupported";
+};
+
+/**
+ * Standardized error codes that {@link AIError} can have.
+ *
+ * @public
+ */
+export declare type AIErrorCode = (typeof AIErrorCode)[keyof typeof AIErrorCode];
 
 /**
  * Base class for Firebase AI model APIs.
@@ -216,24 +221,30 @@ export declare interface BaseParams {
  * 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 declare type BlockReason = (typeof BlockReason)[keyof typeof BlockReason];
 
 /**
  * Schema class for "boolean" types.
@@ -346,11 +357,10 @@ export declare interface CountTokensResponse {
      */
     totalTokens: number;
     /**
+     * @deprecated Use `totalTokens` instead. This property is undefined when using models greater than `gemini-1.5-*`.
+     *
      * The total number of billable characters counted across all instances
      * from the request.
-     *
-     * This property is only supported when using the Vertex AI Gemini API ({@link VertexAIBackend}).
-     * When using the Gemini Developer API ({@link GoogleAIBackend}), this property is not supported and will default to 0.
      */
     totalBillableCharacters?: number;
     /**
@@ -451,44 +461,50 @@ export declare interface FileDataPart {
  * 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 declare type FinishReason = (typeof FinishReason)[keyof typeof FinishReason];
 
 /**
  * A predicted {@link FunctionCall} returned from the model
@@ -512,25 +528,27 @@ export declare interface FunctionCallingConfig {
 /**
  * @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 declare type FunctionCallingMode = (typeof FunctionCallingMode)[keyof typeof FunctionCallingMode];
 
 /**
  * Content part interface if the part represents a {@link FunctionCall}.
@@ -569,7 +587,7 @@ export declare interface FunctionDeclaration {
      * 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;
+    parameters?: ObjectSchema | ObjectSchemaRequest;
 }
 
 /**
@@ -716,6 +734,10 @@ export declare interface GenerationConfig {
      * @beta
      */
     responseModalities?: ResponseModality[];
+    /**
+     * Configuration for "thinking" behavior of compatible Gemini models.
+     */
+    thinkingConfig?: ThinkingConfig;
 }
 
 /**
@@ -819,22 +841,6 @@ export declare function getGenerativeModel(ai: AI, modelParams: ModelParams, req
  */
 export declare function getImagenModel(ai: AI, modelParams: ImagenModelParams, requestOptions?: RequestOptions): ImagenModel;
 
-/**
- * @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;
-
 /**
  * Configuration class for the Gemini Developer API.
  *
@@ -858,6 +864,42 @@ export declare class GoogleAIBackend extends Backend {
 
 /* Excluded from this release type: GoogleAIGenerateContentResponse */
 
+/**
+ * Specifies the Google Search configuration.
+ *
+ * @remarks Currently, this is an empty object, but it's reserved for future configuration options.
+ *
+ * @public
+ */
+export declare interface GoogleSearch {
+}
+
+/**
+ * A tool that allows a Gemini model to connect to Google Search to access and incorporate
+ * up-to-date information from the web into its responses.
+ *
+ * Important: If using Grounding with Google Search, you are required to comply with the
+ * "Grounding with Google Search" usage requirements for your chosen API provider: {@link https://ai.google.dev/gemini-api/terms#grounding-with-google-search | Gemini Developer API}
+ * or Vertex AI Gemini API (see {@link https://cloud.google.com/terms/service-terms | Service Terms}
+ * section within the Service Specific Terms).
+ *
+ * @public
+ */
+export declare interface GoogleSearchTool {
+    /**
+     * Specifies the Google Search configuration.
+     * Currently, this is an empty object, but it's reserved for future configuration options.
+     * Specifies the Google Search configuration. Currently, this is an empty object, but it's
+     * reserved for future configuration options.
+     *
+     * When using this feature, you are required to comply with the "Grounding with Google Search"
+     * usage requirements for your chosen API provider: {@link https://ai.google.dev/gemini-api/terms#grounding-with-google-search | Gemini Developer API}
+     * or Vertex AI Gemini API (see {@link https://cloud.google.com/terms/service-terms | Service Terms}
+     * section within the Service Specific Terms).
+     */
+    googleSearch: GoogleSearch;
+}
+
 /**
  * @deprecated
  * @public
@@ -870,125 +912,221 @@ export declare interface GroundingAttribution {
 }
 
 /**
- * Metadata returned to client when grounding is enabled.
+ * Represents a chunk of retrieved data that supports a claim in the model's response. This is part
+ * of the grounding information provided when grounding is enabled.
+ *
+ * @public
+ */
+export declare interface GroundingChunk {
+    /**
+     * Contains details if the grounding chunk is from a web source.
+     */
+    web?: WebGroundingChunk;
+}
+
+/**
+ * Metadata returned when grounding is enabled.
+ *
+ * Currently, only Grounding with Google Search is supported (see {@link GoogleSearchTool}).
+ *
+ * Important: If using Grounding with Google Search, you are required to comply with the
+ * "Grounding with Google Search" usage requirements for your chosen API provider: {@link https://ai.google.dev/gemini-api/terms#grounding-with-google-search | Gemini Developer API}
+ * or Vertex AI Gemini API (see {@link https://cloud.google.com/terms/service-terms | Service Terms}
+ * section within the Service Specific Terms).
+ *
  * @public
  */
 export declare interface GroundingMetadata {
+    /**
+     * Google Search entry point for web searches. This contains an HTML/CSS snippet that must be
+     * embedded in an app to display a Google Search entry point for follow-up web searches related to
+     * a model's “Grounded Response”.
+     */
+    searchEntryPoint?: SearchEntrypoint;
+    /**
+     * A list of {@link GroundingChunk} objects. Each chunk represents a piece of retrieved content
+     * (for example, from a web page). that the model used to ground its response.
+     */
+    groundingChunks?: GroundingChunk[];
+    /**
+     * A list of {@link GroundingSupport} objects. Each object details how specific segments of the
+     * model's response are supported by the `groundingChunks`.
+     */
+    groundingSupports?: GroundingSupport[];
+    /**
+     * A list of web search queries that the model performed to gather the grounding information.
+     * These can be used to allow users to explore the search results themselves.
+     */
     webSearchQueries?: string[];
+    /**
+     * @deprecated Use {@link GroundingSupport} instead.
+     */
     retrievalQueries?: string[];
     /**
-     * @deprecated
+     * @deprecated Use {@link GroundingChunk} instead.
      */
     groundingAttributions: GroundingAttribution[];
 }
 
+/**
+ * Provides information about how a specific segment of the model's response is supported by the
+ * retrieved grounding chunks.
+ *
+ * @public
+ */
+export declare interface GroundingSupport {
+    /**
+     * Specifies the segment of the model's response content that this grounding support pertains to.
+     */
+    segment?: Segment;
+    /**
+     * A list of indices that refer to specific {@link GroundingChunk} objects within the
+     * {@link GroundingMetadata.groundingChunks} array. These referenced chunks
+     * are the sources that support the claim made in the associated `segment` of the response.
+     * For example, an array `[1, 3, 4]` means that `groundingChunks[1]`, `groundingChunks[3]`,
+     * and `groundingChunks[4]` are the retrieved content supporting this part of the response.
+     */
+    groundingChunkIndices?: number[];
+}
+
 /**
  * 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 declare type HarmBlockMethod = (typeof HarmBlockMethod)[keyof typeof HarmBlockMethod];
 
 /**
  * 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 declare type HarmBlockThreshold = (typeof HarmBlockThreshold)[keyof typeof HarmBlockThreshold];
 
 /**
  * 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 declare type HarmCategory = (typeof HarmCategory)[keyof typeof HarmCategory];
 
 /**
  * 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 declare 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 declare type HarmSeverity = (typeof HarmSeverity)[keyof typeof HarmSeverity];
 
 /**
  * Aspect ratios for Imagen images.
@@ -1001,28 +1139,41 @@ export declare enum HarmSeverity {
  *
  * @beta
  */
-export declare enum ImagenAspectRatio {
+export declare const ImagenAspectRatio: {
     /**
      * Square (1:1) aspect ratio.
      */
-    SQUARE = "1:1",
+    readonly SQUARE: "1:1";
     /**
      * Landscape (3:4) aspect ratio.
      */
-    LANDSCAPE_3x4 = "3:4",
+    readonly LANDSCAPE_3x4: "3:4";
     /**
      * Portrait (4:3) aspect ratio.
      */
-    PORTRAIT_4x3 = "4:3",
+    readonly PORTRAIT_4x3: "4:3";
     /**
      * Landscape (16:9) aspect ratio.
      */
-    LANDSCAPE_16x9 = "16:9",
+    readonly LANDSCAPE_16x9: "16:9";
     /**
      * Portrait (9:16) aspect ratio.
      */
-    PORTRAIT_9x16 = "9:16"
-}
+    readonly PORTRAIT_9x16: "9:16";
+};
+
+/**
+ * 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 type ImagenAspectRatio = (typeof ImagenAspectRatio)[keyof typeof ImagenAspectRatio];
 
 /**
  * An image generated by Imagen, stored in a Cloud Storage for Firebase bucket.
@@ -1074,7 +1225,7 @@ export declare interface ImagenGenerationConfig {
     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}
+     * Supported aspect ratios depend on the Imagen model, see {@link (ImagenAspectRatio:type)}
      * for more details.
      */
     aspectRatio?: ImagenAspectRatio;
@@ -1116,8 +1267,8 @@ export declare interface ImagenGenerationResponse<T extends ImagenInlineImage |
      * 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.
+     * Images may be filtered out due to the {@link (ImagenSafetyFilterLevel:type)},
+     * {@link (ImagenPersonFilterLevel:type)}, 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}
@@ -1321,11 +1472,11 @@ export declare interface ImagenModelParams {
  *
  * @beta
  */
-export declare enum ImagenPersonFilterLevel {
+export declare const ImagenPersonFilterLevel: {
     /**
      * Disallow generation of images containing people or faces; images of people are filtered out.
      */
-    BLOCK_ALL = "dont_allow",
+    readonly BLOCK_ALL: "dont_allow";
     /**
      * Allow generation of images containing adults only; images of children are filtered out.
      *
@@ -1333,7 +1484,7 @@ export declare enum ImagenPersonFilterLevel {
      * 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",
+    readonly ALLOW_ADULT: "allow_adult";
     /**
      * Allow generation of images containing adults only; images of children are filtered out.
      *
@@ -1341,8 +1492,18 @@ export declare enum ImagenPersonFilterLevel {
      * 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"
-}
+    readonly ALLOW_ALL: "allow_all";
+};
+
+/**
+ * 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 type ImagenPersonFilterLevel = (typeof ImagenPersonFilterLevel)[keyof typeof ImagenPersonFilterLevel];
 
 /**
  * A filter level controlling how aggressively to filter sensitive content.
@@ -1356,27 +1517,41 @@ export declare enum ImagenPersonFilterLevel {
  *
  * @beta
  */
-export declare enum ImagenSafetyFilterLevel {
+export declare const ImagenSafetyFilterLevel: {
     /**
      * The most aggressive filtering level; most strict blocking.
      */
-    BLOCK_LOW_AND_ABOVE = "block_low_and_above",
+    readonly BLOCK_LOW_AND_ABOVE: "block_low_and_above";
     /**
      * Blocks some sensitive prompts and responses.
      */
-    BLOCK_MEDIUM_AND_ABOVE = "block_medium_and_above",
+    readonly BLOCK_MEDIUM_AND_ABOVE: "block_medium_and_above";
     /**
      * Blocks few sensitive prompts and responses.
      */
-    BLOCK_ONLY_HIGH = "block_only_high",
+    readonly 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"
-}
+    readonly BLOCK_NONE: "block_none";
+};
+
+/**
+ * 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 type ImagenSafetyFilterLevel = (typeof ImagenSafetyFilterLevel)[keyof typeof ImagenSafetyFilterLevel];
 
 /**
  * Settings for controlling the aggressiveness of filtering out sensitive content.
@@ -1425,32 +1600,38 @@ export declare class IntegerSchema extends Schema {
  * 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 declare type Modality = (typeof Modality)[keyof typeof Modality];
 
 /**
  * Represents token counting info for a single modality.
@@ -1500,12 +1681,20 @@ export declare class ObjectSchema extends Schema {
 }
 
 /**
- * Interface for {@link ObjectSchema} class.
+ * Interface for JSON parameters in a schema of {@link SchemaType}
+ * "object" when not using the `Schema.object()` helper.
  * @public
  */
-export declare interface ObjectSchemaInterface extends SchemaInterface {
-    type: SchemaType.OBJECT;
-    optionalProperties?: string[];
+export declare interface ObjectSchemaRequest extends SchemaRequest {
+    type: 'object';
+    /**
+     * This is not a property accepted in the final request to the backend, but is
+     * a client-side convenience property that is only usable by constructing
+     * a schema through the `Schema.object()` helper method. Populating this
+     * property will cause response errors if the object is not wrapped with
+     * `Schema.object()`.
+     */
+    optionalProperties?: never;
 }
 
 /**
@@ -1665,7 +1854,7 @@ export declare interface SafetySetting {
 export declare abstract class Schema implements SchemaInterface {
     /**
      * Optional. The type of the property. {@link
-     * SchemaType}.
+     * (SchemaType:type)}.
      */
     type: SchemaType;
     /** Optional. The format of the property.
@@ -1681,9 +1870,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;
@@ -1721,7 +1910,7 @@ export declare abstract class Schema implements SchemaInterface {
 export declare interface SchemaInterface extends SchemaShared<SchemaInterface> {
     /**
      * The type of the property. {@link
-     * SchemaType}.
+     * (SchemaType:type)}.
      */
     type: SchemaType;
 }
@@ -1741,7 +1930,7 @@ export declare interface SchemaParams extends SchemaShared<SchemaInterface> {
 export declare interface SchemaRequest extends SchemaShared<SchemaRequest> {
     /**
      * The type of the property. {@link
-     * SchemaType}.
+     * (SchemaType:type)}.
      */
     type: SchemaType;
     /** Optional. Array of required property. */
@@ -1769,9 +1958,9 @@ export declare interface SchemaShared<T> {
     title?: string;
     /** Optional. The items of the property. */
     items?: T;
-    /** 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. Map of `Schema` objects. */
     properties?: {
@@ -1792,50 +1981,88 @@ export declare interface SchemaShared<T> {
     [key: string]: unknown;
 }
 
-/**
- * @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.
- */
 /**
  * Contains the list of OpenAPI data types
  * as defined by the
  * {@link https://swagger.io/docs/specification/data-models/data-types/ | OpenAPI specification}
  * @public
  */
-export declare enum SchemaType {
+export declare const SchemaType: {
     /** String type. */
-    STRING = "string",
+    readonly STRING: "string";
     /** Number type. */
-    NUMBER = "number",
+    readonly NUMBER: "number";
     /** Integer type. */
-    INTEGER = "integer",
+    readonly INTEGER: "integer";
     /** Boolean type. */
-    BOOLEAN = "boolean",
+    readonly BOOLEAN: "boolean";
     /** Array type. */
-    ARRAY = "array",
+    readonly ARRAY: "array";
     /** Object type. */
-    OBJECT = "object"
+    readonly OBJECT: "object";
+};
+
+/**
+ * Contains the list of OpenAPI data types
+ * as defined by the
+ * {@link https://swagger.io/docs/specification/data-models/data-types/ | OpenAPI specification}
+ * @public
+ */
+export declare type SchemaType = (typeof SchemaType)[keyof typeof SchemaType];
+
+/**
+ * Google search entry point.
+ *
+ * @public
+ */
+export declare interface SearchEntrypoint {
+    /**
+     * HTML/CSS snippet that must be embedded in a web page. The snippet is designed to avoid
+     * undesired interaction with the rest of the page's CSS.
+     *
+     * To ensure proper rendering and prevent CSS conflicts, it is recommended
+     * to encapsulate this `renderedContent` within a shadow DOM when embedding it
+     * into a webpage. See {@link https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_shadow_DOM | MDN: Using shadow DOM}.
+     *
+     * @example
+     * ```javascript
+     * const container = document.createElement('div');
+     * document.body.appendChild(container);
+     * container.attachShadow({ mode: 'open' }).innerHTML = renderedContent;
+     * ```
+     */
+    renderedContent?: string;
 }
 
 /**
+ * Represents a specific segment within a {@link Content} object, often used to
+ * pinpoint the exact location of text or data that grounding information refers to.
+ *
  * @public
  */
 export declare interface Segment {
+    /**
+     * The zero-based index of the {@link Part} object within the `parts` array
+     * of its parent {@link Content} object. This identifies which part of the
+     * content the segment belongs to.
+     */
     partIndex: number;
+    /**
+     * The zero-based start index of the segment within the specified `Part`,
+     * measured in UTF-8 bytes. This offset is inclusive, starting from 0 at the
+     * beginning of the part's content (e.g., `Part.text`).
+     */
     startIndex: number;
+    /**
+     * The zero-based end index of the segment within the specified `Part`,
+     * measured in UTF-8 bytes. This offset is exclusive, meaning the character
+     * at this index is not included in the segment.
+     */
     endIndex: number;
+    /**
+     * The text corresponding to the segment from the response.
+     */
+    text: string;
 }
 
 /**
@@ -1871,11 +2098,36 @@ export declare interface TextPart {
     functionResponse?: never;
 }
 
+/**
+ * Configuration for "thinking" behavior of compatible Gemini models.
+ *
+ * Certain models utilize a thinking process before generating a response. This allows them to
+ * reason through complex problems and plan a more coherent and accurate answer.
+ *
+ * @public
+ */
+export declare interface ThinkingConfig {
+    /**
+     * The thinking budget, in tokens.
+     *
+     * This parameter sets an upper limit on the number of tokens the model can use for its internal
+     * "thinking" process. A higher budget may result in higher quality responses for complex tasks
+     * but can also increase latency and cost.
+     *
+     * If you don't specify a budget, the model will determine the appropriate amount
+     * of thinking based on the complexity of the prompt.
+     *
+     * An error will be thrown if you set a thinking budget for a model that does not support this
+     * feature or if the specified budget is not within the model's supported range.
+     */
+    thinkingBudget?: number;
+}
+
 /**
  * Defines a tool that model can call to access external knowledge.
  * @public
  */
-export declare type Tool = FunctionDeclarationsTool;
+export declare type Tool = FunctionDeclarationsTool | GoogleSearchTool;
 
 /**
  * Tool config. This config is shared for all tools provided in the request.
@@ -1899,22 +2151,15 @@ export declare type TypedSchema = IntegerSchema | NumberSchema | StringSchema |
 export declare interface UsageMetadata {
     promptTokenCount: number;
     candidatesTokenCount: number;
+    /**
+     * The number of tokens used by the model's internal "thinking" process.
+     */
+    thoughtsTokenCount?: number;
     totalTokenCount: number;
     promptTokensDetails?: ModalityTokenCount[];
     candidatesTokensDetails?: ModalityTokenCount[];
 }
 
-/**
- * @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 declare type VertexAI = AI;
-
 /**
  * Configuration class for the Vertex AI Gemini API.
  *
@@ -1940,37 +2185,6 @@ export declare class VertexAIBackend extends Backend {
     constructor(location?: string);
 }
 
-/**
- * @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;
-
-/**
- * @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;
-
-/**
- * Options when initializing the Firebase AI SDK.
- *
- * @public
- */
-export declare interface VertexAIOptions {
-    location?: string;
-}
-
 /**
  * Describes the input video content.
  * @public
@@ -1996,4 +2210,31 @@ export declare interface WebAttribution {
     title: string;
 }
 
+/**
+ * A grounding chunk from the web.
+ *
+ * Important: If using Grounding with Google Search, you are required to comply with the
+ * {@link https://cloud.google.com/terms/service-terms | Service Specific Terms} for "Grounding with Google Search".
+ *
+ * @public
+ */
+export declare interface WebGroundingChunk {
+    /**
+     * The URI of the retrieved web page.
+     */
+    uri?: string;
+    /**
+     * The title of the retrieved web page.
+     */
+    title?: string;
+    /**
+     * The domain of the original URI from which the content was retrieved.
+     *
+     * This property is only supported in the Vertex AI Gemini API ({@link VertexAIBackend}).
+     * When using the Gemini Developer API ({@link GoogleAIBackend}), this property will be
+     * `undefined`.
+     */
+    domain?: string;
+}
+
 export { }