@firebase/ai 2.6.0 → 2.6.1-canary.5579b387a

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

@@ -25,4 +25,4 @@ export declare const DEFAULT_FETCH_TIMEOUT_MS: number;
 /**
  * Defines the name of the default in-cloud model to use for hybrid inference.
  */
-export declare const DEFAULT_HYBRID_IN_CLOUD_MODEL = "gemini-2.0-flash-lite";
+export declare const DEFAULT_HYBRID_IN_CLOUD_MODEL = "gemini-2.5-flash-lite";

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

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Content, GenerateContentResult, GenerateContentStreamResult, Part, RequestOptions, StartChatParams } from '../types';
+import { Content, GenerateContentResult, GenerateContentStreamResult, Part, RequestOptions, SingleRequestOptions, StartChatParams } from '../types';
 import { ApiSettings } from '../types/internal';
 import { ChromeAdapter } from '../types/chrome-adapter';
 /**
@@ -30,6 +30,10 @@ export declare class ChatSession {
     requestOptions?: RequestOptions | undefined;
     private _apiSettings;
     private _history;
+    /**
+     * Ensures sequential execution of chat messages to maintain history order.
+     * Each call waits for the previous one to settle before proceeding.
+     */
     private _sendPromise;
     constructor(apiSettings: ApiSettings, model: string, chromeAdapter?: ChromeAdapter | undefined, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
     /**
@@ -42,11 +46,11 @@ export declare class ChatSession {
      * Sends a chat message and receives a non-streaming
      * {@link GenerateContentResult}
      */
-    sendMessage(request: string | Array<string | Part>): Promise<GenerateContentResult>;
+    sendMessage(request: string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentResult>;
     /**
      * Sends a chat message and receives the response as a
      * {@link GenerateContentStreamResult} containing an iterable stream
      * and a response promise.
      */
-    sendMessageStream(request: string | Array<string | Part>): Promise<GenerateContentStreamResult>;
+    sendMessageStream(request: string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentStreamResult>;
 }

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

@@ -14,8 +14,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { CountTokensRequest, CountTokensResponse, RequestOptions } from '../types';
+import { CountTokensRequest, CountTokensResponse, SingleRequestOptions, RequestOptions } from '../types';
 import { ApiSettings } from '../types/internal';
 import { ChromeAdapter } from '../types/chrome-adapter';
-export declare function countTokensOnCloud(apiSettings: ApiSettings, model: string, params: CountTokensRequest, requestOptions?: RequestOptions): Promise<CountTokensResponse>;
+export declare function countTokensOnCloud(apiSettings: ApiSettings, model: string, params: CountTokensRequest, singleRequestOptions?: SingleRequestOptions): Promise<CountTokensResponse>;
 export declare function countTokens(apiSettings: ApiSettings, model: string, params: CountTokensRequest, chromeAdapter?: ChromeAdapter, requestOptions?: RequestOptions): Promise<CountTokensResponse>;

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

@@ -14,10 +14,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { GenerateContentRequest, GenerateContentResult, GenerateContentStreamResult, RequestOptions } from '../types';
+import { GenerateContentRequest, GenerateContentResult, GenerateContentStreamResult, SingleRequestOptions } from '../types';
 import { ApiSettings } from '../types/internal';
 import { ChromeAdapter } from '../types/chrome-adapter';
-export declare function generateContentStream(apiSettings: ApiSettings, model: string, params: GenerateContentRequest, chromeAdapter?: ChromeAdapter, requestOptions?: RequestOptions): Promise<GenerateContentStreamResult>;
-export declare function templateGenerateContent(apiSettings: ApiSettings, templateId: string, templateParams: object, requestOptions?: RequestOptions): Promise<GenerateContentResult>;
-export declare function templateGenerateContentStream(apiSettings: ApiSettings, templateId: string, templateParams: object, requestOptions?: RequestOptions): Promise<GenerateContentStreamResult>;
-export declare function generateContent(apiSettings: ApiSettings, model: string, params: GenerateContentRequest, chromeAdapter?: ChromeAdapter, requestOptions?: RequestOptions): Promise<GenerateContentResult>;
+export declare function generateContentStream(apiSettings: ApiSettings, model: string, params: GenerateContentRequest, chromeAdapter?: ChromeAdapter, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentStreamResult>;
+export declare function templateGenerateContent(apiSettings: ApiSettings, templateId: string, templateParams: object, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentResult>;
+export declare function templateGenerateContentStream(apiSettings: ApiSettings, templateId: string, templateParams: object, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentStreamResult>;
+export declare function generateContent(apiSettings: ApiSettings, model: string, params: GenerateContentRequest, chromeAdapter?: ChromeAdapter, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentResult>;

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

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Content, CountTokensRequest, CountTokensResponse, GenerateContentRequest, GenerateContentResult, GenerateContentStreamResult, GenerationConfig, ModelParams, Part, RequestOptions, SafetySetting, StartChatParams, Tool, ToolConfig } from '../types';
+import { Content, CountTokensRequest, CountTokensResponse, GenerateContentRequest, GenerateContentResult, GenerateContentStreamResult, GenerationConfig, ModelParams, Part, SafetySetting, RequestOptions, StartChatParams, Tool, ToolConfig, SingleRequestOptions } from '../types';
 import { ChatSession } from '../methods/chat-session';
 import { AI } from '../public-types';
 import { AIModel } from './ai-model';
@@ -36,14 +36,14 @@ export declare class GenerativeModel extends AIModel {
      * Makes a single non-streaming call to the model
      * and returns an object containing a single {@link GenerateContentResponse}.
      */
-    generateContent(request: GenerateContentRequest | string | Array<string | Part>): Promise<GenerateContentResult>;
+    generateContent(request: GenerateContentRequest | string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentResult>;
     /**
      * Makes a single streaming call to the model
      * and returns an object containing an iterable stream that iterates
      * over all chunks in the streaming response as well as
      * a promise that returns the final aggregated response.
      */
-    generateContentStream(request: GenerateContentRequest | string | Array<string | Part>): Promise<GenerateContentStreamResult>;
+    generateContentStream(request: GenerateContentRequest | string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentStreamResult>;
     /**
      * Gets a new {@link ChatSession} instance which can be used for
      * multi-turn chats.
@@ -52,5 +52,5 @@ export declare class GenerativeModel extends AIModel {
     /**
      * Counts the tokens in the provided request.
      */
-    countTokens(request: CountTokensRequest | string | Array<string | Part>): Promise<CountTokensResponse>;
+    countTokens(request: CountTokensRequest | string | Array<string | Part>, singleRequestOptions?: SingleRequestOptions): Promise<CountTokensResponse>;
 }

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

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import { AI } from '../public-types';
-import { ImagenGCSImage, ImagenGenerationConfig, ImagenInlineImage, RequestOptions, ImagenModelParams, ImagenGenerationResponse, ImagenSafetySettings } from '../types';
+import { ImagenGCSImage, ImagenGenerationConfig, ImagenInlineImage, RequestOptions, ImagenModelParams, ImagenGenerationResponse, ImagenSafetySettings, SingleRequestOptions } from '../types';
 import { AIModel } from './ai-model';
 /**
  * Class for Imagen model APIs.
@@ -78,7 +78,7 @@ export declare class ImagenModel extends AIModel {
      *
      * @public
      */
-    generateImages(prompt: string): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
+    generateImages(prompt: string, singleRequestOptions?: SingleRequestOptions): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
     /**
      * Generates images to Cloud Storage for Firebase using the Imagen model.
      *
@@ -98,5 +98,5 @@ export declare class ImagenModel extends AIModel {
      * returned object will have a `filteredReason` property.
      * If all images are filtered, the `images` array will be empty.
      */
-    generateImagesGCS(prompt: string, gcsURI: string): Promise<ImagenGenerationResponse<ImagenGCSImage>>;
+    generateImagesGCS(prompt: string, gcsURI: string, singleRequestOptions?: SingleRequestOptions): Promise<ImagenGenerationResponse<ImagenGCSImage>>;
 }

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

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import { GenerateContentResult, RequestOptions } from '../types';
-import { AI, GenerateContentStreamResult } from '../public-types';
+import { AI, GenerateContentStreamResult, SingleRequestOptions } from '../public-types';
 import { ApiSettings } from '../types/internal';
 /**
  * {@link GenerativeModel} APIs that execute on a server-side template.
@@ -47,7 +47,7 @@ export declare class TemplateGenerativeModel {
      *
      * @beta
      */
-    generateContent(templateId: string, templateVariables: object): Promise<GenerateContentResult>;
+    generateContent(templateId: string, templateVariables: object, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentResult>;
     /**
      * Makes a single streaming call to the model and returns an object
      * containing an iterable stream that iterates over all chunks in the
@@ -60,5 +60,5 @@ export declare class TemplateGenerativeModel {
      *
      * @beta
      */
-    generateContentStream(templateId: string, templateVariables: object): Promise<GenerateContentStreamResult>;
+    generateContentStream(templateId: string, templateVariables: object, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentStreamResult>;
 }

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

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 import { RequestOptions } from '../types';
-import { AI, ImagenGenerationResponse, ImagenInlineImage } from '../public-types';
+import { AI, ImagenGenerationResponse, ImagenInlineImage, SingleRequestOptions } from '../public-types';
 import { ApiSettings } from '../types/internal';
 /**
  * Class for Imagen model APIs that execute on a server-side template.
@@ -47,5 +47,5 @@ export declare class TemplateImagenModel {
      *
      * @beta
      */
-    generateImages(templateId: string, templateVariables: object): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
+    generateImages(templateId: string, templateVariables: object, singleRequestOptions?: SingleRequestOptions): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
 }

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

@@ -14,8 +14,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { RequestOptions } from '../types';
+import { SingleRequestOptions } from '../types';
 import { ApiSettings } from '../types/internal';
+export declare const TIMEOUT_EXPIRED_MESSAGE = "Timeout has expired.";
+export declare const ABORT_ERROR_NAME = "AbortError";
 export declare const enum Task {
     GENERATE_CONTENT = "generateContent",
     STREAM_GENERATE_CONTENT = "streamGenerateContent",
@@ -30,7 +32,7 @@ export declare const enum ServerPromptTemplateTask {
 interface BaseRequestURLParams {
     apiSettings: ApiSettings;
     stream: boolean;
-    requestOptions?: RequestOptions;
+    singleRequestOptions?: SingleRequestOptions;
 }
 /**
  * Parameters used to construct the URL of a request to use a model.

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

@@ -27,9 +27,7 @@ import { InferenceSource } from '../public-types';
  */
 export declare function processStream(response: Response, apiSettings: ApiSettings, inferenceSource?: InferenceSource): 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.
+ * Reads a raw string stream, buffers incomplete chunks, and yields parsed JSON objects.
  */
 export declare function getResponseStream<T>(inputStream: ReadableStream<string>): ReadableStream<T>;
 /**

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

@@ -396,3 +396,24 @@ export declare const Language: {
  * @beta
  */
 export type Language = (typeof Language)[keyof typeof Language];
+/**
+ * A preset that controls the model's "thinking" process. Use
+ * `ThinkingLevel.LOW` for faster responses on less complex tasks, and
+ * `ThinkingLevel.HIGH` for better reasoning on more complex tasks.
+ *
+ * @public
+ */
+export declare const ThinkingLevel: {
+    MINIMAL: string;
+    LOW: string;
+    MEDIUM: string;
+    HIGH: string;
+};
+/**
+ * A preset that controls the model's "thinking" process. Use
+ * `ThinkingLevel.LOW` for faster responses on less complex tasks, and
+ * `ThinkingLevel.HIGH` for better reasoning on more complex tasks.
+ *
+ * @public
+ */
+export type ThinkingLevel = (typeof ThinkingLevel)[keyof typeof ThinkingLevel];

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

@@ -73,7 +73,7 @@ export interface ImagenResponseInternal {
  * The parameters to be sent in the request body of the HTTP call
  * to the Vertex AI backend.
  *
- * We need a seperate internal-only interface for this because the REST
+ * We need a separate internal-only interface for this because the REST
  * API expects different parameter names than what we show to our users.
  *
  * Sample request body JSON:

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

@@ -17,7 +17,7 @@
 import { ObjectSchema, TypedSchema } from '../requests/schema-builder';
 import { Content, Part } from './content';
 import { LanguageModelCreateOptions, LanguageModelPromptOptions } from './language-model';
-import { FunctionCallingMode, HarmBlockMethod, HarmBlockThreshold, HarmCategory, InferenceMode, ResponseModality } from './enums';
+import { FunctionCallingMode, HarmBlockMethod, HarmBlockThreshold, HarmCategory, InferenceMode, ResponseModality, ThinkingLevel } from './enums';
 import { ObjectSchemaRequest, SchemaRequest } from './schema';
 /**
  * Base parameters for a number of methods.
@@ -232,6 +232,46 @@ export interface RequestOptions {
      */
     baseUrl?: string;
 }
+/**
+ * Options that can be provided per-request.
+ * Extends the base {@link RequestOptions} (like `timeout` and `baseUrl`)
+ * with request-specific controls like cancellation via `AbortSignal`.
+ *
+ * Options specified here will override any default {@link RequestOptions}
+ * configured on a model (for example, {@link GenerativeModel}).
+ *
+ * @public
+ */
+export interface SingleRequestOptions extends RequestOptions {
+    /**
+     * An `AbortSignal` instance that allows cancelling ongoing requests (like `generateContent` or
+     * `generateImages`).
+     *
+     * If provided, calling `abort()` on the corresponding `AbortController`
+     * will attempt to cancel the underlying HTTP request. An `AbortError` will be thrown
+     * if cancellation is successful.
+     *
+     * Note that this will not cancel the request in the backend, so any applicable billing charges
+     * will still be applied despite cancellation.
+     *
+     * @example
+     * ```javascript
+     * const controller = new AbortController();
+     * const model = getGenerativeModel({
+     *   // ...
+     * });
+     * model.generateContent(
+     *   "Write a story about a magic backpack.",
+     *   { signal: controller.signal }
+     * );
+     *
+     * // To cancel request:
+     * controller.abort();
+     * ```
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
+     */
+    signal?: AbortSignal;
+}
 /**
  * Defines a tool that model can call to access external knowledge.
  * @public
@@ -401,17 +441,42 @@ export interface ThinkingConfig {
     /**
      * The thinking budget, in tokens.
      *
+     * @remarks
      * 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.
+     * The range of supported thinking budget values depends on the model.
+     *
+     * <ul>
+     * <li>To use the default thinking budget for a model, leave
+     * this value undefined.</li>
+     *
+     * <li>To disable thinking, when supported by the model, set this value
+     * to `0`.</li>
+     *
+     * <li>To use dynamic thinking, which allows the model to decide on the thinking
+     * budget based on the task, set this value to `-1`.</li>
+     * </ul>
      *
      * 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.
+     *
+     * The model will also error if `thinkingLevel` and `thinkingBudget` are
+     * both set.
      */
     thinkingBudget?: number;
+    /**
+     * If not specified, Gemini will use the model's default dynamic thinking level.
+     *
+     * @remarks
+     * Note: The model will error if `thinkingLevel` and `thinkingBudget` are
+     * both set.
+     *
+     * Important: Gemini 2.5 series models do not support thinking levels; use
+     * `thinkingBudget` to set a thinking budget instead.
+     */
+    thinkingLevel?: ThinkingLevel;
     /**
      * Whether to include "thought summaries" in the model's response.
      *