@google/genai 0.2.0 → 0.3.1

package/dist/node/index.js

@@ -26,7 +26,7 @@ var fs__namespace = /*#__PURE__*/_interopNamespaceDefault(fs);
 
 /**
  * @license
- * Copyright 2024 Google LLC
+ * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
 class BaseModule {
@@ -153,7 +153,7 @@ function getValueByPath(data, keys) {
 
 /**
  * @license
- * Copyright 2024 Google LLC
+ * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
 function tModel(apiClient, model) {
@@ -521,14 +521,12 @@ function tFileName(apiClient, fromName) {
 
 /**
  * @license
- * Copyright 2024 Google LLC
+ * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
 /**
  * @fileoverview Pagers for the GenAI List APIs.
  */
-// TODO(b/401555348): Re-enable linting after enforcing strong types.
-/*  eslint-disable @typescript-eslint/no-explicit-any */
 var PagedItem;
 (function (PagedItem) {
     PagedItem["PAGED_ITEM_BATCH_JOBS"] = "batchJobs";
@@ -543,6 +541,7 @@ var PagedItem;
 class Pager {
     constructor(name, request, response, params) {
         this.pageInternal = [];
+        this.paramsInternal = {};
         this.requestInternal = request;
         this.init(name, response, params);
     }
@@ -699,7 +698,7 @@ class Pager {
 
 /**
  * @license
- * Copyright 2024 Google LLC
+ * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
 // Code generated by the Google Gen AI SDK generator DO NOT EDIT.
@@ -1288,7 +1287,7 @@ class SessionSendToolResponseParameters {
 
 /**
  * @license
- * Copyright 2024 Google LLC
+ * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
 class Caches extends BaseModule {
@@ -1303,7 +1302,7 @@ class Caches extends BaseModule {
          *
          * @example
          * ```ts
-         * const cachedContents = await client.caches.list({config: {'pageSize': 2}});
+         * const cachedContents = await ai.caches.list({config: {'pageSize': 2}});
          * for (const cachedContent of cachedContents) {
          *   console.log(cachedContent);
          * }
@@ -1322,7 +1321,7 @@ class Caches extends BaseModule {
      * @example
      * ```ts
      * const contents = ...; // Initialize the content to cache.
-     * const response = await client.caches.create({
+     * const response = await ai.caches.create({
      *   model: 'gemini-2.0-flash',
      *   config: {
      *    'contents': contents,
@@ -1393,7 +1392,7 @@ class Caches extends BaseModule {
      *
      * @example
      * ```ts
-     * await client.caches.get({name: 'gemini-1.5-flash'});
+     * await ai.caches.get({name: 'gemini-1.5-flash'});
      * ```
      */
     async get(params) {
@@ -1456,7 +1455,7 @@ class Caches extends BaseModule {
      *
      * @example
      * ```ts
-     * await client.caches.delete({name: 'gemini-1.5-flash'});
+     * await ai.caches.delete({name: 'gemini-1.5-flash'});
      * ```
      */
     async delete(params) {
@@ -1523,7 +1522,7 @@ class Caches extends BaseModule {
      *
      * @example
      * ```ts
-     * const response = await client.caches.update({
+     * const response = await ai.caches.update({
      *   name: 'gemini-1.5-flash',
      *   config: {'ttl': '7600s'}
      * });
@@ -2527,7 +2526,7 @@ typeof SuppressedError === "function" ? SuppressedError : function (error, suppr
 
 /**
  * @license
- * Copyright 2024 Google LLC
+ * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
 /**
@@ -2632,16 +2631,35 @@ class Chats {
     /**
      * Creates a new chat session.
      *
+     * @remarks
+     * The config in the params will be used for all requests within the chat
+     * session unless overridden by a per-request `config` in
+     * {@link ./types.SendMessageParameters}.
+     *
      * @param params - Parameters for creating a chat session.
      * @returns A new chat session.
+     *
+     * @example
+     * ```ts
+     * const chat = ai.chats.create({
+     *   model: 'gemini-2.0-flash'
+     *   config: {
+     *     temperature: 0.5,
+     *     maxOutputTokens: 1024,
+     *   }
+     * });
+     * ```
      */
     create(params) {
         return new Chat(this.apiClient, this.modelsModule, params.model, params.config, params.history);
     }
 }
 /**
- * Chat session that enables sending messages and stores the chat history so
- * far.
+ * Chat session that enables sending messages to the model with previous
+ * conversation context.
+ *
+ * @remarks
+ * The session maintains all the turns between user and model.
  */
 class Chat {
     constructor(apiClient, modelsModule, model, config = {}, history = []) {
@@ -2665,6 +2683,15 @@ class Chat {
      * @see {@link Chat#sendMessageStream} for streaming method.
      * @param params - parameters for sending messages within a chat session.
      * @returns The model's response.
+     *
+     * @example
+     * ```ts
+     * const chat = ai.chats.create({model: 'gemini-2.0-flash'});
+     * const response = await chat.sendMessage({
+     *   message: 'Why is the sky blue?'
+     * });
+     * console.log(response.text);
+     * ```
      */
     async sendMessage(params) {
         var _a;
@@ -2696,6 +2723,17 @@ class Chat {
      * @see {@link Chat#sendMessage} for non-streaming method.
      * @param params - parameters for sending the message.
      * @return The model's response.
+     *
+     * @example
+     * ```ts
+     * const chat = ai.chats.create({model: 'gemini-2.0-flash'});
+     * const response = await chat.sendMessageStream({
+     *   message: 'Why is the sky blue?'
+     * });
+     * for await (const chunk of response) {
+     *   console.log(chunk.text);
+     * }
+     * ```
      */
     async sendMessageStream(params) {
         var _a;
@@ -2787,7 +2825,7 @@ class Chat {
 
 /**
  * @license
- * Copyright 2024 Google LLC
+ * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
 class Models extends BaseModule {
@@ -2817,14 +2855,12 @@ class Models extends BaseModule {
          *
          * Some models support multimodal input and output.
          *
-         * @param model - The model to use for generating content.
-         * @param contents - The input contents to use for generating content.
-         * @param [config] - The configuration for generating content.
+         * @param params - The parameters for generating content.
          * @return The response from generating content.
          *
          * @example
          * ```ts
-         * const response = await client.models.generateContent({
+         * const response = await ai.models.generateContent({
          *   model: 'gemini-2.0-flash',
          *   contents: 'why is the sky blue?',
          *   config: {
@@ -2861,14 +2897,12 @@ class Models extends BaseModule {
          *
          * Some models support multimodal input and output.
          *
-         * @param model - The model to use for generating content.
-         * @param contents - The input contents to use for generating content.
-         * @param [config] - The configuration for generating content.
+         * @param params - The parameters for generating content with streaming response.
          * @return The response from generating content.
          *
          * @example
          * ```ts
-         * const response = await client.models.generateContentStream({
+         * const response = await ai.models.generateContentStream({
          *   model: 'gemini-2.0-flash',
          *   contents: 'why is the sky blue?',
          *   config: {
@@ -3027,14 +3061,12 @@ class Models extends BaseModule {
     /**
      * Calculates embeddings for the given contents. Only text is supported.
      *
-     * @param model - The model to use.
-     * @param contents - The contents to embed.
-     * @param [config] - The config for embedding contents.
+     * @param params - The parameters for embedding contents.
      * @return The response from the API.
      *
      * @example
      * ```ts
-     * const response = await client.models.embedContent({
+     * const response = await ai.models.embedContent({
      *  model: 'text-embedding-004',
      *  contents: [
      *    'What is your name?',
@@ -3106,14 +3138,12 @@ class Models extends BaseModule {
     /**
      * Generates an image based on a text description and configuration.
      *
-     * @param model - The model to use.
-     * @param prompt - A text description of the image to generate.
-     * @param [config] - The config for image generation.
+     * @param params - The parameters for generating images.
      * @return The response from the API.
      *
      * @example
      * ```ts
-     * const response = await client.models.generateImages({
+     * const response = await ai.models.generateImages({
      *  model: 'imagen-3.0-generate-002',
      *  prompt: 'Robot holding a red skateboard',
      *  config: {
@@ -3184,14 +3214,12 @@ class Models extends BaseModule {
      * Counts the number of tokens in the given contents. Multimodal input is
      * supported for Gemini models.
      *
-     * @param model - The model to use for counting tokens.
-     * @param contents - The contents to count tokens for.
-     * @param [config] - The config for counting tokens.
+     * @param params - The parameters for counting tokens.
      * @return The response from the API.
      *
      * @example
      * ```ts
-     * const response = await client.models.countTokens({
+     * const response = await ai.models.countTokens({
      *  model: 'gemini-2.0-flash',
      *  contents: 'The quick brown fox jumps over the lazy dog.'
      * });
@@ -3260,14 +3288,12 @@ class Models extends BaseModule {
      *
      * This method is not supported by the Gemini Developer API.
      *
-     * @param model - The model to use.
-     * @param contents - The content to compute tokens for.
-     * @param [config] - The config for computing tokens.
+     * @param params - The parameters for computing tokens.
      * @return The response from the API.
      *
      * @example
      * ```ts
-     * const response = await client.models.computeTokens({
+     * const response = await ai.models.computeTokens({
      *  model: 'gemini-2.0-flash',
      *  contents: 'What is your name?'
      * });
@@ -5246,7 +5272,7 @@ function computeTokensResponseFromVertex(apiClient, fromObject) {
 
 /**
  * @license
- * Copyright 2024 Google LLC
+ * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
 const FUNCTION_RESPONSE_REQUIRES_ID = 'FunctionResponse request must have an `id` field from the response of a ToolCall.FunctionalCalls in Google AI.';
@@ -5507,6 +5533,12 @@ function liveServerMessageFromVertex(apiClient, fromObject) {
 /**
  * Handles incoming messages from the WebSocket.
  *
+ * @remarks
+ * This function is responsible for parsing incoming messages, transforming them
+ * into LiveServerMessages, and then calling the onmessage callback. Note that
+ * the first message which is received from the server is a setupComplete
+ * message.
+ *
  * @param apiClient The ApiClient instance.
  * @param onmessage The user-provided onmessage callback (if any).
  * @param event The MessageEvent from the WebSocket.
@@ -5544,20 +5576,14 @@ class Live {
        Establishes a connection to the specified model with the given
        configuration and returns a Session object representing that connection.
   
-      > [!CAUTION] This SDK does not yet support the live API for **Google Vertex AI**.
-  
        @experimental
   
-       @param model - Model to use for the Live session.
-       @param config - Configuration parameters for the Live session.
-       @param callbacks - Optional callbacks for websocket events. If not
-           provided, default no-op callbacks will be used. Generally, prefer to
-           provide explicit callbacks to allow for proper handling of websocket
-           events (e.g. connection errors).
+       @param params - The parameters for establishing a connection to the model.
+       @return A live session.
   
        @example
        ```ts
-       const session = await client.live.connect({
+       const session = await ai.live.connect({
          model: 'gemini-2.0-flash-exp',
          config: {
            responseModalities: [Modality.AUDIO],
@@ -5581,9 +5607,6 @@ class Live {
       */
     async connect(params) {
         var _a, _b;
-        if (this.apiClient.isVertexAI()) {
-            throw new Error('This SDK does not yet support the live API for **Google Vertex AI**.');
-        }
         const websocketBaseUrl = this.apiClient.getWebsocketBaseUrl();
         const apiVersion = this.apiClient.getApiVersion();
         let url;
@@ -5659,8 +5682,7 @@ class Session {
         if (params.turns !== null && params.turns !== undefined) {
             let contents = [];
             try {
-                contents =
-                    tContents(apiClient, params.turns);
+                contents = tContents(apiClient, params.turns);
                 if (apiClient.isVertexAI()) {
                     contents = contents.map((item) => contentToVertex(apiClient, item));
                 }
@@ -5700,8 +5722,10 @@ class Session {
             throw new Error('functionResponses is required.');
         }
         for (const functionResponse of functionResponses) {
-            if (typeof functionResponse !== 'object' || functionResponse === null ||
-                !('name' in functionResponse) || !('response' in functionResponse)) {
+            if (typeof functionResponse !== 'object' ||
+                functionResponse === null ||
+                !('name' in functionResponse) ||
+                !('response' in functionResponse)) {
                 throw new Error(`Could not parse function response, type '${typeof functionResponse}'.`);
             }
             if (!apiClient.isVertexAI() && !('id' in functionResponse)) {
@@ -5709,7 +5733,7 @@ class Session {
             }
         }
         const clientMessage = {
-            toolResponse: { functionResponses: functionResponses }
+            toolResponse: { functionResponses: functionResponses },
         };
         return clientMessage;
     }
@@ -5827,7 +5851,7 @@ class Session {
   
        @example
        ```ts
-       const session = await client.live.connect({
+       const session = await ai.live.connect({
          model: 'gemini-2.0-flash-exp',
          config: {
            responseModalities: [Modality.AUDIO],
@@ -5864,13 +5888,13 @@ function mapToHeaders(map) {
 
 /**
  * @license
- * Copyright 2024 Google LLC
+ * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
 const CONTENT_TYPE_HEADER = 'Content-Type';
 const USER_AGENT_HEADER = 'User-Agent';
 const GOOGLE_API_CLIENT_HEADER = 'x-goog-api-client';
-const SDK_VERSION = '0.2.0'; // x-release-please-version
+const SDK_VERSION = '0.3.1'; // 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';
@@ -6082,7 +6106,7 @@ class ApiClient {
     async unaryApiCall(url, requestInit, httpMethod) {
         return this.apiCall(url.toString(), Object.assign(Object.assign({}, requestInit), { method: httpMethod }))
             .then(async (response) => {
-            await throwErrorIfNotOK(response, url.toString());
+            await throwErrorIfNotOK(response);
             return new HttpResponse(response);
         })
             .catch((e) => {
@@ -6097,7 +6121,7 @@ class ApiClient {
     async streamApiCall(url, requestInit, httpMethod) {
         return this.apiCall(url.toString(), Object.assign(Object.assign({}, requestInit), { method: httpMethod }))
             .then(async (response) => {
-            await throwErrorIfNotOK(response, url.toString());
+            await throwErrorIfNotOK(response);
             return this.processStreamResponse(response);
         })
             .catch((e) => {
@@ -6242,7 +6266,7 @@ class ApiClient {
         return uploadUrl;
     }
 }
-async function throwErrorIfNotOK(response, url, requestInit) {
+async function throwErrorIfNotOK(response) {
     var _a;
     if (response === undefined) {
         throw new ServerError('response is undefined');
@@ -6278,7 +6302,7 @@ async function throwErrorIfNotOK(response, url, requestInit) {
 
 /**
  * @license
- * Copyright 2024 Google LLC
+ * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
 class Files extends BaseModule {
@@ -6296,7 +6320,7 @@ class Files extends BaseModule {
          * size of each page is 10.
          *
          * ```ts
-         * const listResponse = await client.files.list({config: {'pageSize': 10}});
+         * const listResponse = await ai.files.list({config: {'pageSize': 10}});
          * for await (const file of listResponse) {
          *   console.log(file.name);
          * }
@@ -6329,30 +6353,32 @@ class Files extends BaseModule {
      *
      * This section can contain multiple paragraphs and code examples.
      *
-     * @param file The string path to the file to be uploaded or a Blob object.
-     * @param config Optional parameters specified in the `types.UploadFileConfig`
-     *     interface. Optional @see {@link types.UploadFileConfig}
+     * @param params - Optional parameters specified in the
+     *        `common.UploadFileParameters` interface.
+     *        Optional @see {@link common.UploadFileParameters}
      * @return A promise that resolves to a `types.File` object.
      * @throws An error if called on a Vertex AI client.
      * @throws An error if the `mimeType` is not provided and can not be inferred,
-     * the `mimeType` can be provided in the `config` parameter.
+     * the `mimeType` can be provided in the `params.config` parameter.
      * @throws An error occurs if a suitable upload location cannot be established.
      *
      * @example
      * The following code uploads a file to Gemini API.
      *
      * ```ts
-     * const file = await client.files.upload('file.txt', {
+     * const file = await ai.files.upload({file: 'file.txt', config: {
      *   mimeType: 'text/plain',
-     * });
+     * }});
      * console.log(file.name);
      * ```
      */
-    async upload(file, config) {
+    async upload(params) {
         if (this.apiClient.isVertexAI()) {
             throw new Error('Vertex AI does not support uploading files. You can share files through a GCS bucket.');
         }
-        return this.apiClient.uploadFile(file, config).then((response) => {
+        return this.apiClient
+            .uploadFile(params.file, params.config)
+            .then((response) => {
             const file = fileFromMldev(this.apiClient, response);
             return file;
         });
@@ -6480,7 +6506,7 @@ class Files extends BaseModule {
      * const config: GetFileParameters = {
      *   name: fileName,
      * };
-     * file = await client.files.get(config);
+     * file = await ai.files.get(config);
      * console.log(file.name);
      * ```
      */
@@ -6904,7 +6930,7 @@ class NodeWebSocket {
         this.callbacks = callbacks;
     }
     connect() {
-        this.ws = new NodeWs__namespace.WebSocket(this.url, this.headers);
+        this.ws = new NodeWs__namespace.WebSocket(this.url, { headers: this.headers });
         this.ws.onopen = this.callbacks.onopen;
         this.ws.onerror = this.callbacks.onerror;
         this.ws.onclose = this.callbacks.onclose;
@@ -7181,7 +7207,7 @@ class NodeUploader {
 
 /**
  * @license
- * Copyright 2024 Google LLC
+ * Copyright 2025 Google LLC
  * SPDX-License-Identifier: Apache-2.0
  */
 const LANGUAGE_LABEL_PREFIX = 'gl-node/';
@@ -7194,23 +7220,21 @@ const LANGUAGE_LABEL_PREFIX = 'gl-node/';
  *
  * The {@link GoogleGenAIOptions.vertexai} value determines which of the API services to use.
  *
- * When using the Gemini API, a {@link GoogleGenAIOptions.apiKey} must be set,
- * when using Vertex AI {@link GoogleGenAIOptions.project}
- * and {@link GoogleGenAIOptions.location} must be set,
- * and the {@link GoogleGenAIOptions.vertexai} must be set to `true`.
+ * When using the Gemini API, a {@link GoogleGenAIOptions.apiKey} must also be set,
+ * when using Vertex AI {@link GoogleGenAIOptions.project} and {@link GoogleGenAIOptions.location} must also be set.
  *
  * @example
  * Initializing the SDK for using the Gemini API:
  * ```ts
  * import {GoogleGenAI} from '@google/genai';
- * const ai = genai.GoogleGenAI({apiKey: 'GEMINI_API_KEY'});
+ * const ai = new GoogleGenAI({apiKey: 'GEMINI_API_KEY'});
  * ```
  *
  * @example
  * Initializing the SDK for using the Vertex AI API:
  * ```ts
  * import {GoogleGenAI} from '@google/genai';
- * const ai = genai.GoogleGenAI({
+ * const ai = new GoogleGenAI({
  *   vertexai: true,
  *   project: 'PROJECT_ID',
  *   location: 'PROJECT_LOCATION'
@@ -7220,7 +7244,7 @@ const LANGUAGE_LABEL_PREFIX = 'gl-node/';
  */
 class GoogleGenAI {
     constructor(options) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e;
         this.vertexai =
             (_b = (_a = options.vertexai) !== null && _a !== void 0 ? _a : getBooleanEnv('GOOGLE_GENAI_USE_VERTEXAI')) !== null && _b !== void 0 ? _b : false;
         // The tests currently assume that an API key is never set if vertexai is true.
@@ -7232,7 +7256,7 @@ class GoogleGenAI {
         this.project = (_d = options.project) !== null && _d !== void 0 ? _d : getEnv('GOOGLE_CLOUD_PROJECT');
         this.location = (_e = options.location) !== null && _e !== void 0 ? _e : getEnv('GOOGLE_CLOUD_LOCATION');
         this.apiVersion = options.apiVersion;
-        const auth = (_f = options.auth) !== null && _f !== void 0 ? _f : new NodeAuth({
+        const auth = new NodeAuth({
             apiKey: this.apiKey,
             googleAuthOptions: options.googleAuthOptions,
         });