@firebase/ai 2.3.0-canary.ea8512812 → 2.4.0-20251007135320

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

@@ -81,7 +81,7 @@ export declare function getGenerativeModel(ai: AI, modelParams: ModelParams | Hy
  * @throws If the `apiKey` or `projectId` fields are missing in your
  * Firebase config.
  *
- * @beta
+ * @public
  */
 export declare function getImagenModel(ai: AI, modelParams: ImagenModelParams, requestOptions?: RequestOptions): ImagenModel;
 /**

package/dist/esm/src/methods/live-session-helpers.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { LiveServerToolCall, Part } from '../types';
+import { FunctionCall, FunctionResponse } from '../types';
 import { LiveSession } from './live-session';
 /**
  * A controller for managing an active audio conversation.
@@ -39,7 +39,7 @@ export interface StartAudioConversationOptions {
      * The handler should perform the function call and return the result as a `Part`,
      * which will then be sent back to the model.
      */
-    functionCallingHandler?: (functionCalls: LiveServerToolCall['functionCalls']) => Promise<Part>;
+    functionCallingHandler?: (functionCalls: FunctionCall[]) => Promise<FunctionResponse>;
 }
 /**
  * Dependencies needed by the {@link AudioConversationRunner}.

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

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { GenerativeContentBlob, LiveServerContent, LiveServerToolCall, LiveServerToolCallCancellation, Part } from '../public-types';
+import { FunctionResponse, GenerativeContentBlob, LiveServerContent, LiveServerToolCall, LiveServerToolCallCancellation, Part } from '../public-types';
 import { WebSocketHandler } from '../websocket';
 /**
  * Represents an active, real-time, bidirectional conversation with the model.
@@ -61,6 +61,15 @@ export declare class LiveSession {
      * @beta
      */
     sendMediaChunks(mediaChunks: GenerativeContentBlob[]): Promise<void>;
+    /**
+     * Sends function responses to the server.
+     *
+     * @param functionResponses - The function responses to send.
+     * @throws If this session has been closed.
+     *
+     * @beta
+     */
+    sendFunctionResponses(functionResponses: FunctionResponse[]): Promise<void>;
     /**
      * Sends a stream of {@link GenerativeContentBlob}.
      *

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

@@ -37,7 +37,7 @@ import { AIModel } from './ai-model';
  * }
  * ```
  *
- * @beta
+ * @public
  */
 export declare class ImagenModel extends AIModel {
     requestOptions?: RequestOptions | undefined;
@@ -76,7 +76,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.
      *
-     * @beta
+     * @public
      */
     generateImages(prompt: string): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
     /**

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

@@ -29,7 +29,7 @@
  * }
  * ```
  *
- * @beta
+ * @public
  */
 export declare class ImagenImageFormat {
     /**
@@ -47,7 +47,7 @@ export declare class ImagenImageFormat {
      * @param compressionQuality - The level of compression (a number between 0 and 100).
      * @returns An {@link ImagenImageFormat} object for a JPEG image.
      *
-     * @beta
+     * @public
      */
     static jpeg(compressionQuality?: number): ImagenImageFormat;
     /**
@@ -55,7 +55,7 @@ export declare class ImagenImageFormat {
      *
      * @returns An {@link ImagenImageFormat} object for a PNG image.
      *
-     * @beta
+     * @public
      */
     static png(): ImagenImageFormat;
 }

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

@@ -18,7 +18,7 @@ import { ImagenImageFormat } from '../../requests/imagen-image-format';
 /**
  * Parameters for configuring an {@link ImagenModel}.
  *
- * @beta
+ * @public
  */
 export interface ImagenModelParams {
     /**
@@ -46,7 +46,7 @@ export interface ImagenModelParams {
  * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images-imagen | documentation} for
  * more details.
  *
- * @beta
+ * @public
  */
 export interface ImagenGenerationConfig {
     /**
@@ -104,7 +104,7 @@ export interface ImagenGenerationConfig {
  * 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
+ * @public
  */
 export declare const ImagenSafetyFilterLevel: {
     /**
@@ -137,7 +137,7 @@ export declare const ImagenSafetyFilterLevel: {
  * 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
+ * @public
  */
 export type ImagenSafetyFilterLevel = (typeof ImagenSafetyFilterLevel)[keyof typeof ImagenSafetyFilterLevel];
 /**
@@ -146,7 +146,7 @@ export type ImagenSafetyFilterLevel = (typeof ImagenSafetyFilterLevel)[keyof typ
  * See the <a href="http://firebase.google.com/docs/vertex-ai/generate-images">personGeneration</a>
  * documentation for more details.
  *
- * @beta
+ * @public
  */
 export declare const ImagenPersonFilterLevel: {
     /**
@@ -176,7 +176,7 @@ export declare const ImagenPersonFilterLevel: {
  * See the <a href="http://firebase.google.com/docs/vertex-ai/generate-images">personGeneration</a>
  * documentation for more details.
  *
- * @beta
+ * @public
  */
 export type ImagenPersonFilterLevel = (typeof ImagenPersonFilterLevel)[keyof typeof ImagenPersonFilterLevel];
 /**
@@ -185,7 +185,7 @@ export type ImagenPersonFilterLevel = (typeof ImagenPersonFilterLevel)[keyof typ
  * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details.
  *
- * @beta
+ * @public
  */
 export interface ImagenSafetySettings {
     /**
@@ -207,7 +207,7 @@ export interface ImagenSafetySettings {
  * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details and examples of the supported aspect ratios.
  *
- * @beta
+ * @public
  */
 export declare const ImagenAspectRatio: {
     /**
@@ -240,6 +240,6 @@ export declare const ImagenAspectRatio: {
  * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details and examples of the supported aspect ratios.
  *
- * @beta
+ * @public
  */
 export type ImagenAspectRatio = (typeof ImagenAspectRatio)[keyof typeof ImagenAspectRatio];

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

@@ -17,7 +17,7 @@
 /**
  * An image generated by Imagen, represented as inline data.
  *
- * @beta
+ * @public
  */
 export interface ImagenInlineImage {
     /**
@@ -35,7 +35,7 @@ export interface ImagenInlineImage {
  * An image generated by Imagen, stored in a Cloud Storage for Firebase bucket.
  *
  * This feature is not available yet.
- * @beta
+ * @public
  */
 export interface ImagenGCSImage {
     /**
@@ -54,7 +54,7 @@ export interface ImagenGCSImage {
 /**
  * The response from a request to generate images with Imagen.
  *
- * @beta
+ * @public
  */
 export interface ImagenGenerationResponse<T extends ImagenInlineImage | ImagenGCSImage> {
     /**

package/dist/esm/src/types/live-responses.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Content, GenerativeContentBlob, Part } from './content';
+import { Content, FunctionResponse, GenerativeContentBlob, Part } from './content';
 import { LiveGenerationConfig, Tool, ToolConfig } from './requests';
 /**
  * User input that is sent to the model.
@@ -37,6 +37,14 @@ export interface _LiveClientRealtimeInput {
         mediaChunks: GenerativeContentBlob[];
     };
 }
+/**
+ * Function responses that are sent to the model in real time.
+ */
+export interface _LiveClientToolResponse {
+    toolResponse: {
+        functionResponses: FunctionResponse[];
+    };
+}
 /**
  * The first message in a Live session, used to configure generation options.
  *

package/dist/index.cjs.js

@@ -8,7 +8,7 @@ var util = require('@firebase/util');
 var logger$1 = require('@firebase/logger');
 
 var name = "@firebase/ai";
-var version = "2.3.0-canary.ea8512812";
+var version = "2.4.0-20251007135320";
 
 /**
  * @license
@@ -585,7 +585,7 @@ const SchemaType = {
  * 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
+ * @public
  */
 const ImagenSafetyFilterLevel = {
     /**
@@ -614,7 +614,7 @@ const ImagenSafetyFilterLevel = {
  * See the <a href="http://firebase.google.com/docs/vertex-ai/generate-images">personGeneration</a>
  * documentation for more details.
  *
- * @beta
+ * @public
  */
 const ImagenPersonFilterLevel = {
     /**
@@ -647,7 +647,7 @@ const ImagenPersonFilterLevel = {
  * See the {@link http://firebase.google.com/docs/vertex-ai/generate-images | documentation }
  * for more details and examples of the supported aspect ratios.
  *
- * @beta
+ * @public
  */
 const ImagenAspectRatio = {
     /**
@@ -2850,6 +2850,25 @@ class LiveSession {
             this.webSocketHandler.send(JSON.stringify(message));
         });
     }
+    /**
+     * Sends function responses to the server.
+     *
+     * @param functionResponses - The function responses to send.
+     * @throws If this session has been closed.
+     *
+     * @beta
+     */
+    async sendFunctionResponses(functionResponses) {
+        if (this.isClosed) {
+            throw new AIError(AIErrorCode.REQUEST_ERROR, 'This LiveSession has been closed and cannot be used.');
+        }
+        const message = {
+            toolResponse: {
+                functionResponses
+            }
+        };
+        this.webSocketHandler.send(JSON.stringify(message));
+    }
     /**
      * Sends a stream of {@link GenerativeContentBlob}.
      *
@@ -3064,7 +3083,7 @@ class LiveGenerativeModel extends AIModel {
  * }
  * ```
  *
- * @beta
+ * @public
  */
 class ImagenModel extends AIModel {
     /**
@@ -3100,7 +3119,7 @@ class ImagenModel extends AIModel {
      * returned object will have a `filteredReason` property.
      * If all images are filtered, the `images` array will be empty.
      *
-     * @beta
+     * @public
      */
     async generateImages(prompt) {
         const body = createPredictRequestBody(prompt, {
@@ -3563,7 +3582,7 @@ class AnyOfSchema extends Schema {
  * }
  * ```
  *
- * @beta
+ * @public
  */
 class ImagenImageFormat {
     constructor() {
@@ -3575,7 +3594,7 @@ class ImagenImageFormat {
      * @param compressionQuality - The level of compression (a number between 0 and 100).
      * @returns An {@link ImagenImageFormat} object for a JPEG image.
      *
-     * @beta
+     * @public
      */
     static jpeg(compressionQuality) {
         if (compressionQuality &&
@@ -3589,7 +3608,7 @@ class ImagenImageFormat {
      *
      * @returns An {@link ImagenImageFormat} object for a PNG image.
      *
-     * @beta
+     * @public
      */
     static png() {
         return { mimeType: 'image/png' };
@@ -3831,9 +3850,9 @@ class AudioConversationRunner {
                 }
                 else {
                     try {
-                        const resultPart = await this.options.functionCallingHandler(message.functionCalls);
+                        const functionResponse = await this.options.functionCallingHandler(message.functionCalls);
                         if (!this.isStopped) {
-                            void this.liveSession.send([resultPart]);
+                            void this.liveSession.sendFunctionResponses([functionResponse]);
                         }
                     }
                     catch (e) {
@@ -4053,7 +4072,7 @@ function getGenerativeModel(ai, modelParams, requestOptions) {
  * @throws If the `apiKey` or `projectId` fields are missing in your
  * Firebase config.
  *
- * @beta
+ * @public
  */
 function getImagenModel(ai, modelParams, requestOptions) {
     if (!modelParams.model) {