@firebase/ai 2.3.0 → 2.4.0-canary.b7e18d0ff

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";
+var version = "2.4.0-canary.b7e18d0ff";
 
 /**
  * @license
@@ -386,7 +386,7 @@ const InferenceMode = {
 /**
  * Represents the result of the code execution.
  *
- * @public
+ * @beta
  */
 const Outcome = {
     UNSPECIFIED: 'OUTCOME_UNSPECIFIED',
@@ -397,7 +397,7 @@ const Outcome = {
 /**
  * The programming language of the code.
  *
- * @public
+ * @beta
  */
 const Language = {
     UNSPECIFIED: 'LANGUAGE_UNSPECIFIED',
@@ -420,6 +420,45 @@ const Language = {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * The status of a URL retrieval.
+ *
+ * @remarks
+ * <b>URL_RETRIEVAL_STATUS_UNSPECIFIED:</b> Unspecified retrieval status.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_SUCCESS:</b> The URL retrieval was successful.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_ERROR:</b> The URL retrieval failed.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_PAYWALL:</b> The URL retrieval failed because the content is behind a paywall.
+ * <br/>
+ * <b>URL_RETRIEVAL_STATUS_UNSAFE:</b> The URL retrieval failed because the content is unsafe.
+ * <br/>
+ *
+ * @beta
+ */
+const URLRetrievalStatus = {
+    /**
+     * Unspecified retrieval status.
+     */
+    URL_RETRIEVAL_STATUS_UNSPECIFIED: 'URL_RETRIEVAL_STATUS_UNSPECIFIED',
+    /**
+     * The URL retrieval was successful.
+     */
+    URL_RETRIEVAL_STATUS_SUCCESS: 'URL_RETRIEVAL_STATUS_SUCCESS',
+    /**
+     * The URL retrieval failed.
+     */
+    URL_RETRIEVAL_STATUS_ERROR: 'URL_RETRIEVAL_STATUS_ERROR',
+    /**
+     * The URL retrieval failed because the content is behind a paywall.
+     */
+    URL_RETRIEVAL_STATUS_PAYWALL: 'URL_RETRIEVAL_STATUS_PAYWALL',
+    /**
+     * The URL retrieval failed because the content is unsafe.
+     */
+    URL_RETRIEVAL_STATUS_UNSAFE: 'URL_RETRIEVAL_STATUS_UNSAFE'
+};
 /**
  * The types of responses that can be returned by {@link LiveSession.receive}.
  *
@@ -546,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 = {
     /**
@@ -575,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 = {
     /**
@@ -608,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 = {
     /**
@@ -1880,7 +1919,7 @@ function mapGenerateContentCandidates(candidates) {
             // videoMetadata is not supported.
             // Throw early since developers may send a long video as input and only expect to pay
             // for inference on a small portion of the video.
-            if (candidate.content?.parts.some(part => part?.videoMetadata)) {
+            if (candidate.content?.parts?.some(part => part?.videoMetadata)) {
                 throw new AIError(AIErrorCode.UNSUPPORTED, 'Part.videoMetadata is not supported in the Gemini Developer API. Please remove this property.');
             }
             const mappedCandidate = {
@@ -1890,7 +1929,8 @@ function mapGenerateContentCandidates(candidates) {
                 finishMessage: candidate.finishMessage,
                 safetyRatings: mappedSafetyRatings,
                 citationMetadata,
-                groundingMetadata: candidate.groundingMetadata
+                groundingMetadata: candidate.groundingMetadata,
+                urlContextMetadata: candidate.urlContextMetadata
             };
             mappedCandidates.push(mappedCandidate);
         });
@@ -1981,6 +2021,14 @@ async function* generateResponseSequence(stream, apiSettings) {
         else {
             enhancedResponse = createEnhancedContentResponse(value);
         }
+        const firstCandidate = enhancedResponse.candidates?.[0];
+        // Don't yield a response with no useful data for the developer.
+        if (!firstCandidate?.content?.parts &&
+            !firstCandidate?.finishReason &&
+            !firstCandidate?.citationMetadata &&
+            !firstCandidate?.urlContextMetadata) {
+            continue;
+        }
         yield enhancedResponse;
     }
 }
@@ -2060,36 +2108,43 @@ function aggregateResponses(responses) {
                     candidate.safetyRatings;
                 aggregatedResponse.candidates[i].groundingMetadata =
                     candidate.groundingMetadata;
+                // The urlContextMetadata object is defined in the first chunk of the response stream.
+                // In all subsequent chunks, the urlContextMetadata object will be undefined. We need to
+                // make sure that we don't overwrite the first value urlContextMetadata object with undefined.
+                // FIXME: What happens if we receive a second, valid urlContextMetadata object?
+                const urlContextMetadata = candidate.urlContextMetadata;
+                if (typeof urlContextMetadata === 'object' &&
+                    urlContextMetadata !== null &&
+                    Object.keys(urlContextMetadata).length > 0) {
+                    aggregatedResponse.candidates[i].urlContextMetadata =
+                        urlContextMetadata;
+                }
                 /**
                  * Candidates should always have content and parts, but this handles
                  * possible malformed responses.
                  */
-                if (candidate.content && candidate.content.parts) {
+                if (candidate.content) {
+                    // Skip a candidate without parts.
+                    if (!candidate.content.parts) {
+                        continue;
+                    }
                     if (!aggregatedResponse.candidates[i].content) {
                         aggregatedResponse.candidates[i].content = {
                             role: candidate.content.role || 'user',
                             parts: []
                         };
                     }
-                    const newPart = {};
                     for (const part of candidate.content.parts) {
-                        if (part.text !== undefined) {
-                            // The backend can send empty text parts. If these are sent back
-                            // (e.g. in chat history), the backend will respond with an error.
-                            // To prevent this, ignore empty text parts.
-                            if (part.text === '') {
-                                continue;
-                            }
-                            newPart.text = part.text;
+                        const newPart = { ...part };
+                        // The backend can send empty text parts. If these are sent back
+                        // (e.g. in chat history), the backend will respond with an error.
+                        // To prevent this, ignore empty text parts.
+                        if (part.text === '') {
+                            continue;
                         }
-                        if (part.functionCall) {
-                            newPart.functionCall = part.functionCall;
+                        if (Object.keys(newPart).length > 0) {
+                            aggregatedResponse.candidates[i].content.parts.push(newPart);
                         }
-                        if (Object.keys(newPart).length === 0) {
-                            throw new AIError(AIErrorCode.INVALID_CONTENT, 'Part should have at least one property, but there are none. This is likely caused ' +
-                                'by a malformed response from the backend.');
-                        }
-                        aggregatedResponse.candidates[i].content.parts.push(newPart);
                     }
                 }
             }
@@ -2795,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}.
      *
@@ -3009,7 +3083,7 @@ class LiveGenerativeModel extends AIModel {
  * }
  * ```
  *
- * @beta
+ * @public
  */
 class ImagenModel extends AIModel {
     /**
@@ -3045,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, {
@@ -3508,7 +3582,7 @@ class AnyOfSchema extends Schema {
  * }
  * ```
  *
- * @beta
+ * @public
  */
 class ImagenImageFormat {
     constructor() {
@@ -3520,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 &&
@@ -3534,7 +3608,7 @@ class ImagenImageFormat {
      *
      * @returns An {@link ImagenImageFormat} object for a PNG image.
      *
-     * @beta
+     * @public
      */
     static png() {
         return { mimeType: 'image/png' };
@@ -3776,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) {
@@ -3998,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) {
@@ -4078,6 +4152,7 @@ exports.ResponseModality = ResponseModality;
 exports.Schema = Schema;
 exports.SchemaType = SchemaType;
 exports.StringSchema = StringSchema;
+exports.URLRetrievalStatus = URLRetrievalStatus;
 exports.VertexAIBackend = VertexAIBackend;
 exports.getAI = getAI;
 exports.getGenerativeModel = getGenerativeModel;