@firebase/ai 2.6.1-canary.9cf4b7e35 → 2.6.1-canary.b2827448b

package/dist/ai-public.d.ts

@@ -312,6 +312,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);
     /**
@@ -324,13 +328,13 @@ 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>;
 }
 
 /**
@@ -991,14 +995,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.
@@ -1007,7 +1011,7 @@ 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>;
 }
 
 /**
@@ -1698,7 +1702,7 @@ export declare class ImagenModel extends AIModel {
      *
      * @public
      */
-    generateImages(prompt: string): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
+    generateImages(prompt: string, singleRequestOptions?: SingleRequestOptions): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
     /* Excluded from this release type: generateImagesGCS */
 }
 
@@ -2852,6 +2856,47 @@ export declare interface Segment {
     text: 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 declare 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;
+}
+
 /**
  * Configures speech synthesis.
  *
@@ -2975,7 +3020,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
@@ -2988,7 +3033,7 @@ export declare class TemplateGenerativeModel {
      *
      * @beta
      */
-    generateContentStream(templateId: string, templateVariables: object): Promise<GenerateContentStreamResult>;
+    generateContentStream(templateId: string, templateVariables: object, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentStreamResult>;
 }
 
 /**
@@ -3018,7 +3063,7 @@ export declare class TemplateImagenModel {
      *
      * @beta
      */
-    generateImages(templateId: string, templateVariables: object): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
+    generateImages(templateId: string, templateVariables: object, singleRequestOptions?: SingleRequestOptions): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
 }
 
 /**
@@ -3048,17 +3093,42 @@ export declare 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.
      *
@@ -3070,6 +3140,29 @@ export declare interface ThinkingConfig {
     includeThoughts?: boolean;
 }
 
+/**
+ * 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 declare type ThinkingLevel = (typeof ThinkingLevel)[keyof typeof ThinkingLevel];
+
 /**
  * Defines a tool that model can call to access external knowledge.
  * @public

package/dist/ai.d.ts

@@ -358,6 +358,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);
     /**
@@ -370,13 +374,13 @@ 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>;
 }
 
 /**
@@ -1058,14 +1062,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.
@@ -1074,7 +1078,7 @@ 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>;
 }
 
 /**
@@ -1806,7 +1810,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.
      *
@@ -1826,7 +1830,7 @@ 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>>;
 }
 
 /**
@@ -3003,6 +3007,47 @@ export declare interface Segment {
     text: 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 declare 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;
+}
+
 /**
  * Configures speech synthesis.
  *
@@ -3132,7 +3177,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
@@ -3145,7 +3190,7 @@ export declare class TemplateGenerativeModel {
      *
      * @beta
      */
-    generateContentStream(templateId: string, templateVariables: object): Promise<GenerateContentStreamResult>;
+    generateContentStream(templateId: string, templateVariables: object, singleRequestOptions?: SingleRequestOptions): Promise<GenerateContentStreamResult>;
 }
 
 /**
@@ -3178,7 +3223,7 @@ export declare class TemplateImagenModel {
      *
      * @beta
      */
-    generateImages(templateId: string, templateVariables: object): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
+    generateImages(templateId: string, templateVariables: object, singleRequestOptions?: SingleRequestOptions): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
 }
 
 /**
@@ -3211,17 +3256,42 @@ export declare 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.
      *
@@ -3233,6 +3303,29 @@ export declare interface ThinkingConfig {
     includeThoughts?: boolean;
 }
 
+/**
+ * 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 declare type ThinkingLevel = (typeof ThinkingLevel)[keyof typeof ThinkingLevel];
+
 /**
  * Defines a tool that model can call to access external knowledge.
  * @public