@google/genai 1.3.0 → 1.4.0

package/README.md

@@ -21,7 +21,21 @@ The Google Gen AI SDK is designed to work with Gemini 2.0 features.
 
 ## Prerequisites
 
-* Node.js version 18 or later
+1. Node.js version 20 or later
+
+### The following are required for Vertex AI users (excluding Vertex AI Studio)
+1.  [Select](https://console.cloud.google.com/project) or [create](https://cloud.google.com/resource-manager/docs/creating-managing-projects#creating_a_project) a Google Cloud project.
+1.  [Enable billing for your project](https://cloud.google.com/billing/docs/how-to/modify-project).
+1.  [Enable the Vertex AI API](https://console.cloud.google.com/flows/enableapi?apiid=aiplatform.googleapis.com).
+1.  [Configure authentication](https://cloud.google.com/docs/authentication) for your project.
+    *   [Install the gcloud CLI](https://cloud.google.com/sdk/docs/install).
+    *   [Initialize the gcloud CLI](https://cloud.google.com/sdk/docs/initializing).
+    *   Create local authentication credentials for your user account:
+
+    ```sh
+    gcloud auth application-default login
+    ```
+A list of accepted authentication options are listed in [GoogleAuthOptions](https://github.com/googleapis/google-auth-library-nodejs/blob/3ae120d0a45c95e36c59c9ac8286483938781f30/src/auth/googleauth.ts#L87) interface of google-auth-library-node.js GitHub repo.
 
 ## Installation
 
@@ -98,6 +112,33 @@ const ai = new GoogleGenAI({
 });
 ```
 
+### (Optional) (NodeJS only) Using environment variables:
+
+For NodeJS environments, you can create a client by configuring the necessary
+environment variables. Configuration setup instructions depends on whether
+you're using the Gemini Developer API or the Gemini API in Vertex AI.
+
+**Gemini Developer API:** Set `GOOGLE_API_KEY` as shown below:
+
+```bash
+export GOOGLE_API_KEY='your-api-key'
+```
+
+**Gemini API on Vertex AI:** Set `GOOGLE_GENAI_USE_VERTEXAI`,
+`GOOGLE_CLOUD_PROJECT` and `GOOGLE_CLOUD_LOCATION`, as shown below:
+
+```bash
+export GOOGLE_GENAI_USE_VERTEXAI=true
+export GOOGLE_CLOUD_PROJECT='your-project-id'
+export GOOGLE_CLOUD_LOCATION='us-central1'
+```
+
+```typescript
+import {GoogleGenAI} from '@google/genai';
+
+const ai = new GoogleGenAI();
+```
+
 ## API Selection
 
 By default, the SDK uses the beta API endpoints provided by Google to support

package/dist/index.cjs

@@ -1925,16 +1925,16 @@ function flattenTypeArrayToAnyOf(typeList, resultingSchema) {
     }
     const listWithoutNull = typeList.filter((type) => type !== 'null');
     if (listWithoutNull.length === 1) {
-        resultingSchema['type'] = Object.keys(exports.Type).includes(listWithoutNull[0].toUpperCase())
-            ? exports.Type[listWithoutNull[0].toUpperCase()]
+        resultingSchema['type'] = Object.values(exports.Type).includes(listWithoutNull[0].toUpperCase())
+            ? listWithoutNull[0].toUpperCase()
             : exports.Type.TYPE_UNSPECIFIED;
     }
     else {
         resultingSchema['anyOf'] = [];
         for (const i of listWithoutNull) {
             resultingSchema['anyOf'].push({
-                'type': Object.keys(exports.Type).includes(i.toUpperCase())
-                    ? exports.Type[i.toUpperCase()]
+                'type': Object.values(exports.Type).includes(i.toUpperCase())
+                    ? i.toUpperCase()
                     : exports.Type.TYPE_UNSPECIFIED,
             });
         }
@@ -2018,7 +2018,7 @@ function processJsonSchema(_jsonSchema) {
                 // beginning of this function.
                 continue;
             }
-            genAISchema['type'] = Object.keys(exports.Type).includes(fieldValue.toUpperCase())
+            genAISchema['type'] = Object.values(exports.Type).includes(fieldValue.toUpperCase())
                 ? fieldValue.toUpperCase()
                 : exports.Type.TYPE_UNSPECIFIED;
         }
@@ -2377,7 +2377,7 @@ function filterToJsonSchema(schema) {
         }
         else if (fieldName === 'type') {
             const typeValue = fieldValue.toUpperCase();
-            filteredSchema[fieldName] = Object.keys(exports.Type).includes(typeValue)
+            filteredSchema[fieldName] = Object.values(exports.Type).includes(typeValue)
                 ? typeValue
                 : exports.Type.TYPE_UNSPECIFIED;
         }
@@ -3054,6 +3054,10 @@ function googleMapsToVertex$2(apiClient, fromObject) {
     }
     return toObject;
 }
+function urlContextToVertex$2() {
+    const toObject = {};
+    return toObject;
+}
 function toolToVertex$2(apiClient, fromObject) {
     const toObject = {};
     const fromFunctionDeclarations = getValueByPath(fromObject, [
@@ -3092,8 +3096,9 @@ function toolToVertex$2(apiClient, fromObject) {
     if (fromGoogleMaps != null) {
         setValueByPath(toObject, ['googleMaps'], googleMapsToVertex$2(apiClient, fromGoogleMaps));
     }
-    if (getValueByPath(fromObject, ['urlContext']) !== undefined) {
-        throw new Error('urlContext parameter is not supported in Vertex AI.');
+    const fromUrlContext = getValueByPath(fromObject, ['urlContext']);
+    if (fromUrlContext != null) {
+        setValueByPath(toObject, ['urlContext'], urlContextToVertex$2());
     }
     const fromCodeExecution = getValueByPath(fromObject, [
         'codeExecution',
@@ -4348,7 +4353,7 @@ const CONTENT_TYPE_HEADER = 'Content-Type';
 const SERVER_TIMEOUT_HEADER = 'X-Server-Timeout';
 const USER_AGENT_HEADER = 'User-Agent';
 const GOOGLE_API_CLIENT_HEADER = 'x-goog-api-client';
-const SDK_VERSION = '1.3.0'; // x-release-please-version
+const SDK_VERSION = '1.4.0'; // x-release-please-version
 const LIBRARY_LABEL = `google-genai-sdk/${SDK_VERSION}`;
 const VERTEX_AI_API_DEFAULT_VERSION = 'v1beta1';
 const GOOGLE_AI_API_DEFAULT_VERSION = 'v1beta';
@@ -6042,6 +6047,10 @@ function urlContextToMldev$2() {
     const toObject = {};
     return toObject;
 }
+function urlContextToVertex$1() {
+    const toObject = {};
+    return toObject;
+}
 function toolToMldev$2(apiClient, fromObject) {
     const toObject = {};
     const fromFunctionDeclarations = getValueByPath(fromObject, [
@@ -6125,8 +6134,9 @@ function toolToVertex$1(apiClient, fromObject) {
     if (fromGoogleMaps != null) {
         setValueByPath(toObject, ['googleMaps'], googleMapsToVertex$1(apiClient, fromGoogleMaps));
     }
-    if (getValueByPath(fromObject, ['urlContext']) !== undefined) {
-        throw new Error('urlContext parameter is not supported in Vertex AI.');
+    const fromUrlContext = getValueByPath(fromObject, ['urlContext']);
+    if (fromUrlContext != null) {
+        setValueByPath(toObject, ['urlContext'], urlContextToVertex$1());
     }
     const fromCodeExecution = getValueByPath(fromObject, [
         'codeExecution',
@@ -8722,8 +8732,11 @@ function generateVideosConfigToMldev(apiClient, fromObject, parentObject) {
     if (parentObject !== undefined && fromNegativePrompt != null) {
         setValueByPath(parentObject, ['parameters', 'negativePrompt'], fromNegativePrompt);
     }
-    if (getValueByPath(fromObject, ['enhancePrompt']) !== undefined) {
-        throw new Error('enhancePrompt parameter is not supported in Gemini API.');
+    const fromEnhancePrompt = getValueByPath(fromObject, [
+        'enhancePrompt',
+    ]);
+    if (parentObject !== undefined && fromEnhancePrompt != null) {
+        setValueByPath(parentObject, ['parameters', 'enhancePrompt'], fromEnhancePrompt);
     }
     if (getValueByPath(fromObject, ['generateAudio']) !== undefined) {
         throw new Error('generateAudio parameter is not supported in Gemini API.');
@@ -9115,6 +9128,10 @@ function googleMapsToVertex(apiClient, fromObject) {
     }
     return toObject;
 }
+function urlContextToVertex() {
+    const toObject = {};
+    return toObject;
+}
 function toolToVertex(apiClient, fromObject) {
     const toObject = {};
     const fromFunctionDeclarations = getValueByPath(fromObject, [
@@ -9153,8 +9170,9 @@ function toolToVertex(apiClient, fromObject) {
     if (fromGoogleMaps != null) {
         setValueByPath(toObject, ['googleMaps'], googleMapsToVertex(apiClient, fromGoogleMaps));
     }
-    if (getValueByPath(fromObject, ['urlContext']) !== undefined) {
-        throw new Error('urlContext parameter is not supported in Vertex AI.');
+    const fromUrlContext = getValueByPath(fromObject, ['urlContext']);
+    if (fromUrlContext != null) {
+        setValueByPath(toObject, ['urlContext'], urlContextToVertex());
     }
     const fromCodeExecution = getValueByPath(fromObject, [
         'codeExecution',
@@ -10745,6 +10763,34 @@ function citationMetadataFromVertex(apiClient, fromObject) {
     }
     return toObject;
 }
+function urlMetadataFromVertex(apiClient, fromObject) {
+    const toObject = {};
+    const fromRetrievedUrl = getValueByPath(fromObject, ['retrievedUrl']);
+    if (fromRetrievedUrl != null) {
+        setValueByPath(toObject, ['retrievedUrl'], fromRetrievedUrl);
+    }
+    const fromUrlRetrievalStatus = getValueByPath(fromObject, [
+        'urlRetrievalStatus',
+    ]);
+    if (fromUrlRetrievalStatus != null) {
+        setValueByPath(toObject, ['urlRetrievalStatus'], fromUrlRetrievalStatus);
+    }
+    return toObject;
+}
+function urlContextMetadataFromVertex(apiClient, fromObject) {
+    const toObject = {};
+    const fromUrlMetadata = getValueByPath(fromObject, ['urlMetadata']);
+    if (fromUrlMetadata != null) {
+        let transformedList = fromUrlMetadata;
+        if (Array.isArray(transformedList)) {
+            transformedList = transformedList.map((item) => {
+                return urlMetadataFromVertex(apiClient, item);
+            });
+        }
+        setValueByPath(toObject, ['urlMetadata'], transformedList);
+    }
+    return toObject;
+}
 function candidateFromVertex(apiClient, fromObject) {
     const toObject = {};
     const fromContent = getValueByPath(fromObject, ['content']);
@@ -10767,6 +10813,12 @@ function candidateFromVertex(apiClient, fromObject) {
     if (fromFinishReason != null) {
         setValueByPath(toObject, ['finishReason'], fromFinishReason);
     }
+    const fromUrlContextMetadata = getValueByPath(fromObject, [
+        'urlContextMetadata',
+    ]);
+    if (fromUrlContextMetadata != null) {
+        setValueByPath(toObject, ['urlContextMetadata'], urlContextMetadataFromVertex(apiClient, fromUrlContextMetadata));
+    }
     const fromAvgLogprobs = getValueByPath(fromObject, ['avgLogprobs']);
     if (fromAvgLogprobs != null) {
         setValueByPath(toObject, ['avgLogprobs'], fromAvgLogprobs);

package/dist/index.mjs

@@ -1923,16 +1923,16 @@ function flattenTypeArrayToAnyOf(typeList, resultingSchema) {
     }
     const listWithoutNull = typeList.filter((type) => type !== 'null');
     if (listWithoutNull.length === 1) {
-        resultingSchema['type'] = Object.keys(Type).includes(listWithoutNull[0].toUpperCase())
-            ? Type[listWithoutNull[0].toUpperCase()]
+        resultingSchema['type'] = Object.values(Type).includes(listWithoutNull[0].toUpperCase())
+            ? listWithoutNull[0].toUpperCase()
             : Type.TYPE_UNSPECIFIED;
     }
     else {
         resultingSchema['anyOf'] = [];
         for (const i of listWithoutNull) {
             resultingSchema['anyOf'].push({
-                'type': Object.keys(Type).includes(i.toUpperCase())
-                    ? Type[i.toUpperCase()]
+                'type': Object.values(Type).includes(i.toUpperCase())
+                    ? i.toUpperCase()
                     : Type.TYPE_UNSPECIFIED,
             });
         }
@@ -2016,7 +2016,7 @@ function processJsonSchema(_jsonSchema) {
                 // beginning of this function.
                 continue;
             }
-            genAISchema['type'] = Object.keys(Type).includes(fieldValue.toUpperCase())
+            genAISchema['type'] = Object.values(Type).includes(fieldValue.toUpperCase())
                 ? fieldValue.toUpperCase()
                 : Type.TYPE_UNSPECIFIED;
         }
@@ -2375,7 +2375,7 @@ function filterToJsonSchema(schema) {
         }
         else if (fieldName === 'type') {
             const typeValue = fieldValue.toUpperCase();
-            filteredSchema[fieldName] = Object.keys(Type).includes(typeValue)
+            filteredSchema[fieldName] = Object.values(Type).includes(typeValue)
                 ? typeValue
                 : Type.TYPE_UNSPECIFIED;
         }
@@ -3052,6 +3052,10 @@ function googleMapsToVertex$2(apiClient, fromObject) {
     }
     return toObject;
 }
+function urlContextToVertex$2() {
+    const toObject = {};
+    return toObject;
+}
 function toolToVertex$2(apiClient, fromObject) {
     const toObject = {};
     const fromFunctionDeclarations = getValueByPath(fromObject, [
@@ -3090,8 +3094,9 @@ function toolToVertex$2(apiClient, fromObject) {
     if (fromGoogleMaps != null) {
         setValueByPath(toObject, ['googleMaps'], googleMapsToVertex$2(apiClient, fromGoogleMaps));
     }
-    if (getValueByPath(fromObject, ['urlContext']) !== undefined) {
-        throw new Error('urlContext parameter is not supported in Vertex AI.');
+    const fromUrlContext = getValueByPath(fromObject, ['urlContext']);
+    if (fromUrlContext != null) {
+        setValueByPath(toObject, ['urlContext'], urlContextToVertex$2());
     }
     const fromCodeExecution = getValueByPath(fromObject, [
         'codeExecution',
@@ -4346,7 +4351,7 @@ const CONTENT_TYPE_HEADER = 'Content-Type';
 const SERVER_TIMEOUT_HEADER = 'X-Server-Timeout';
 const USER_AGENT_HEADER = 'User-Agent';
 const GOOGLE_API_CLIENT_HEADER = 'x-goog-api-client';
-const SDK_VERSION = '1.3.0'; // x-release-please-version
+const SDK_VERSION = '1.4.0'; // x-release-please-version
 const LIBRARY_LABEL = `google-genai-sdk/${SDK_VERSION}`;
 const VERTEX_AI_API_DEFAULT_VERSION = 'v1beta1';
 const GOOGLE_AI_API_DEFAULT_VERSION = 'v1beta';
@@ -6040,6 +6045,10 @@ function urlContextToMldev$2() {
     const toObject = {};
     return toObject;
 }
+function urlContextToVertex$1() {
+    const toObject = {};
+    return toObject;
+}
 function toolToMldev$2(apiClient, fromObject) {
     const toObject = {};
     const fromFunctionDeclarations = getValueByPath(fromObject, [
@@ -6123,8 +6132,9 @@ function toolToVertex$1(apiClient, fromObject) {
     if (fromGoogleMaps != null) {
         setValueByPath(toObject, ['googleMaps'], googleMapsToVertex$1(apiClient, fromGoogleMaps));
     }
-    if (getValueByPath(fromObject, ['urlContext']) !== undefined) {
-        throw new Error('urlContext parameter is not supported in Vertex AI.');
+    const fromUrlContext = getValueByPath(fromObject, ['urlContext']);
+    if (fromUrlContext != null) {
+        setValueByPath(toObject, ['urlContext'], urlContextToVertex$1());
     }
     const fromCodeExecution = getValueByPath(fromObject, [
         'codeExecution',
@@ -8720,8 +8730,11 @@ function generateVideosConfigToMldev(apiClient, fromObject, parentObject) {
     if (parentObject !== undefined && fromNegativePrompt != null) {
         setValueByPath(parentObject, ['parameters', 'negativePrompt'], fromNegativePrompt);
     }
-    if (getValueByPath(fromObject, ['enhancePrompt']) !== undefined) {
-        throw new Error('enhancePrompt parameter is not supported in Gemini API.');
+    const fromEnhancePrompt = getValueByPath(fromObject, [
+        'enhancePrompt',
+    ]);
+    if (parentObject !== undefined && fromEnhancePrompt != null) {
+        setValueByPath(parentObject, ['parameters', 'enhancePrompt'], fromEnhancePrompt);
     }
     if (getValueByPath(fromObject, ['generateAudio']) !== undefined) {
         throw new Error('generateAudio parameter is not supported in Gemini API.');
@@ -9113,6 +9126,10 @@ function googleMapsToVertex(apiClient, fromObject) {
     }
     return toObject;
 }
+function urlContextToVertex() {
+    const toObject = {};
+    return toObject;
+}
 function toolToVertex(apiClient, fromObject) {
     const toObject = {};
     const fromFunctionDeclarations = getValueByPath(fromObject, [
@@ -9151,8 +9168,9 @@ function toolToVertex(apiClient, fromObject) {
     if (fromGoogleMaps != null) {
         setValueByPath(toObject, ['googleMaps'], googleMapsToVertex(apiClient, fromGoogleMaps));
     }
-    if (getValueByPath(fromObject, ['urlContext']) !== undefined) {
-        throw new Error('urlContext parameter is not supported in Vertex AI.');
+    const fromUrlContext = getValueByPath(fromObject, ['urlContext']);
+    if (fromUrlContext != null) {
+        setValueByPath(toObject, ['urlContext'], urlContextToVertex());
     }
     const fromCodeExecution = getValueByPath(fromObject, [
         'codeExecution',
@@ -10743,6 +10761,34 @@ function citationMetadataFromVertex(apiClient, fromObject) {
     }
     return toObject;
 }
+function urlMetadataFromVertex(apiClient, fromObject) {
+    const toObject = {};
+    const fromRetrievedUrl = getValueByPath(fromObject, ['retrievedUrl']);
+    if (fromRetrievedUrl != null) {
+        setValueByPath(toObject, ['retrievedUrl'], fromRetrievedUrl);
+    }
+    const fromUrlRetrievalStatus = getValueByPath(fromObject, [
+        'urlRetrievalStatus',
+    ]);
+    if (fromUrlRetrievalStatus != null) {
+        setValueByPath(toObject, ['urlRetrievalStatus'], fromUrlRetrievalStatus);
+    }
+    return toObject;
+}
+function urlContextMetadataFromVertex(apiClient, fromObject) {
+    const toObject = {};
+    const fromUrlMetadata = getValueByPath(fromObject, ['urlMetadata']);
+    if (fromUrlMetadata != null) {
+        let transformedList = fromUrlMetadata;
+        if (Array.isArray(transformedList)) {
+            transformedList = transformedList.map((item) => {
+                return urlMetadataFromVertex(apiClient, item);
+            });
+        }
+        setValueByPath(toObject, ['urlMetadata'], transformedList);
+    }
+    return toObject;
+}
 function candidateFromVertex(apiClient, fromObject) {
     const toObject = {};
     const fromContent = getValueByPath(fromObject, ['content']);
@@ -10765,6 +10811,12 @@ function candidateFromVertex(apiClient, fromObject) {
     if (fromFinishReason != null) {
         setValueByPath(toObject, ['finishReason'], fromFinishReason);
     }
+    const fromUrlContextMetadata = getValueByPath(fromObject, [
+        'urlContextMetadata',
+    ]);
+    if (fromUrlContextMetadata != null) {
+        setValueByPath(toObject, ['urlContextMetadata'], urlContextMetadataFromVertex(apiClient, fromUrlContextMetadata));
+    }
     const fromAvgLogprobs = getValueByPath(fromObject, ['avgLogprobs']);
     if (fromAvgLogprobs != null) {
         setValueByPath(toObject, ['avgLogprobs'], fromAvgLogprobs);