@google/genai 1.41.0 → 1.42.0

package/dist/genai.d.ts

@@ -1730,12 +1730,12 @@ export declare interface Content {
 declare type Content_2 = TextContent | ImageContent | AudioContent | DocumentContent | VideoContent | ThoughtContent | FunctionCallContent | FunctionResultContent | CodeExecutionCallContent | CodeExecutionResultContent | URLContextCallContent | URLContextResultContent | GoogleSearchCallContent | GoogleSearchResultContent | MCPServerToolCallContent | MCPServerToolResultContent | FileSearchCallContent | FileSearchResultContent;
 
 declare interface ContentDelta {
+    event_type: 'content.delta';
     delta?: ContentDelta.TextDelta | ContentDelta.ImageDelta | ContentDelta.AudioDelta | ContentDelta.DocumentDelta | ContentDelta.VideoDelta | ContentDelta.ThoughtSummaryDelta | ContentDelta.ThoughtSignatureDelta | ContentDelta.FunctionCallDelta | ContentDelta.FunctionResultDelta | ContentDelta.CodeExecutionCallDelta | ContentDelta.CodeExecutionResultDelta | ContentDelta.URLContextCallDelta | ContentDelta.URLContextResultDelta | ContentDelta.GoogleSearchCallDelta | ContentDelta.GoogleSearchResultDelta | ContentDelta.MCPServerToolCallDelta | ContentDelta.MCPServerToolResultDelta | ContentDelta.FileSearchCallDelta | ContentDelta.FileSearchResultDelta;
     /**
      * The event_id token to be used to resume the interaction stream, from this event.
      */
     event_id?: string;
-    event_type?: 'content.delta';
     index?: number;
 }
 
@@ -2001,6 +2001,7 @@ export declare class ContentReferenceImage {
 }
 
 declare interface ContentStart {
+    event_type: 'content.start';
     /**
      * The content of the response.
      */
@@ -2009,16 +2010,15 @@ declare interface ContentStart {
      * The event_id token to be used to resume the interaction stream, from this event.
      */
     event_id?: string;
-    event_type?: 'content.start';
     index?: number;
 }
 
 declare interface ContentStop {
+    event_type: 'content.stop';
     /**
      * The event_id token to be used to resume the interaction stream, from this event.
      */
     event_id?: string;
-    event_type?: 'content.stop';
     index?: number;
 }
 
@@ -2582,11 +2582,11 @@ export declare interface DatasetStats {
  * Configuration for the Deep Research agent.
  */
 declare interface DeepResearchAgentConfig {
+    type: 'deep-research';
     /**
      * Whether to include thought summaries in the response.
      */
     thinking_summaries?: 'auto' | 'none';
-    type?: 'deep-research';
 }
 
 /** Optional parameters for models.get method. */
@@ -2922,7 +2922,7 @@ export declare interface DownloadFileParameters {
  * Configuration for dynamic agents.
  */
 declare interface DynamicAgentConfig {
-    type?: 'dynamic';
+    type: 'dynamic';
     [k: string]: unknown;
 }
 
@@ -3098,6 +3098,25 @@ export declare interface EmbedContentParameters {
     config?: EmbedContentConfig;
 }
 
+/** Parameters for the _embed_content method. */
+export declare interface EmbedContentParametersPrivate {
+    /** ID of the model to use. For a list of models, see `Google models
+     <https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models>`_. */
+    model: string;
+    /** The content to embed. Only the `parts.text` fields will be counted.
+     */
+    contents?: ContentListUnion;
+    /** The single content to embed. Only the `parts.text` fields will be counted.
+     */
+    content?: ContentUnion;
+    /** The Vertex embedding API to use.
+     */
+    embeddingApiType?: EmbeddingApiType;
+    /** Configuration that contains optional parameters.
+     */
+    config?: EmbedContentConfig;
+}
+
 /** Response for the embed_content method. */
 export declare class EmbedContentResponse {
     /** Used to retain the full HTTP response. */
@@ -3111,6 +3130,18 @@ export declare class EmbedContentResponse {
     metadata?: EmbedContentMetadata;
 }
 
+/** Enum representing the Vertex embedding API to use. */
+export declare enum EmbeddingApiType {
+    /**
+     * predict API endpoint (default)
+     */
+    PREDICT = "PREDICT",
+    /**
+     * embedContent API Endpoint
+     */
+    EMBED_CONTENT = "EMBED_CONTENT"
+}
+
 export declare interface EmbeddingsBatchJobSource {
     /** The Gemini Developer API's file resource name of the input data
      (e.g. "files/12345").
@@ -3180,6 +3211,7 @@ export declare enum Environment {
 }
 
 declare interface ErrorEvent_2 {
+    event_type: 'error';
     /**
      * Error message from an interaction.
      */
@@ -3188,7 +3220,6 @@ declare interface ErrorEvent_2 {
      * The event_id token to be used to resume the interaction stream, from this event.
      */
     event_id?: string;
-    event_type?: 'error';
 }
 
 declare namespace ErrorEvent_2 {
@@ -5761,11 +5792,11 @@ declare interface InteractionCancelParams {
 }
 
 declare interface InteractionCompleteEvent {
+    event_type: 'interaction.complete';
     /**
      * The event_id token to be used to resume the interaction stream, from this event.
      */
     event_id?: string;
-    event_type?: 'interaction.complete';
     /**
      * The Interaction resource.
      */
@@ -5907,11 +5938,11 @@ declare namespace InteractionsAPI {
 declare type InteractionSSEEvent = InteractionStartEvent | InteractionCompleteEvent | InteractionStatusUpdate | ContentStart | ContentDelta | ContentStop | ErrorEvent_2;
 
 declare interface InteractionStartEvent {
+    event_type: 'interaction.start';
     /**
      * The event_id token to be used to resume the interaction stream, from this event.
      */
     event_id?: string;
-    event_type?: 'interaction.start';
     /**
      * The Interaction resource.
      */
@@ -5919,11 +5950,11 @@ declare interface InteractionStartEvent {
 }
 
 declare interface InteractionStatusUpdate {
+    event_type: 'interaction.status_update';
     /**
      * The event_id token to be used to resume the interaction stream, from this event.
      */
     event_id?: string;
-    event_type?: 'interaction.status_update';
     interaction_id?: string;
     status?: 'in_progress' | 'requires_action' | 'completed' | 'failed' | 'cancelled' | 'incomplete';
 }
@@ -7316,6 +7347,28 @@ export declare interface ModelArmorConfig {
 export declare class Models extends BaseModule {
     private readonly apiClient;
     constructor(apiClient: ApiClient);
+    /**
+     * Calculates embeddings for the given contents.
+     *
+     * @param params - The parameters for embedding contents.
+     * @return The response from the API.
+     *
+     * @example
+     * ```ts
+     * const response = await ai.models.embedContent({
+     *  model: 'text-embedding-004',
+     *  contents: [
+     *    'What is your name?',
+     *    'What is your favorite color?',
+     *  ],
+     *  config: {
+     *    outputDimensionality: 64,
+     *  },
+     * });
+     * console.log(response);
+     * ```
+     */
+    embedContent: (params: types.EmbedContentParameters) => Promise<types.EmbedContentResponse>;
     /**
      * Makes an API request to generate content with a given model.
      *
@@ -7526,7 +7579,7 @@ export declare class Models extends BaseModule {
      * console.log(response);
      * ```
      */
-    embedContent(params: types.EmbedContentParameters): Promise<types.EmbedContentResponse>;
+    private embedContentInternal;
     /**
      * Private method for generating images.
      */
@@ -10019,6 +10072,7 @@ declare namespace types {
         ResourceScope,
         FeatureSelectionPreference,
         Environment,
+        EmbeddingApiType,
         SafetyFilterLevel,
         PersonGeneration,
         ImagePromptLanguage,
@@ -10151,7 +10205,7 @@ declare namespace types {
         ReferenceImage,
         EditImageParameters,
         EmbedContentConfig,
-        EmbedContentParameters,
+        EmbedContentParametersPrivate,
         ContentEmbeddingStatistics,
         ContentEmbedding,
         EmbedContentMetadata,
@@ -10419,6 +10473,7 @@ declare namespace types {
         CountTokensResult,
         ComputeTokensResult,
         CreateTuningJobParameters,
+        EmbedContentParameters,
         UploadToFileSearchStoreResponse,
         UploadToFileSearchStoreOperation,
         BlobImageUnion,

package/dist/index.cjs

@@ -1330,6 +1330,18 @@ exports.Environment = void 0;
      */
     Environment["ENVIRONMENT_BROWSER"] = "ENVIRONMENT_BROWSER";
 })(exports.Environment || (exports.Environment = {}));
+/** Enum representing the Vertex embedding API to use. */
+exports.EmbeddingApiType = void 0;
+(function (EmbeddingApiType) {
+    /**
+     * predict API endpoint (default)
+     */
+    EmbeddingApiType["PREDICT"] = "PREDICT";
+    /**
+     * embedContent API Endpoint
+     */
+    EmbeddingApiType["EMBED_CONTENT"] = "EMBED_CONTENT";
+})(exports.EmbeddingApiType || (exports.EmbeddingApiType = {}));
 /** Enum that controls the safety filter level for objectionable content. */
 exports.SafetyFilterLevel = void 0;
 (function (SafetyFilterLevel) {
@@ -3361,6 +3373,10 @@ function tJobState(state) {
         return stateString;
     }
 }
+function tIsVertexEmbedContentModel(model) {
+    return ((model.includes('gemini') && model !== 'gemini-embedding-001') ||
+        model.includes('maas'));
+}
 
 /**
  * @license
@@ -6933,7 +6949,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.41.0'; // x-release-please-version
+const SDK_VERSION = '1.42.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';
@@ -10661,6 +10677,13 @@ class BaseGeminiNextGenAPIClient {
                 (Symbol.iterator in body && 'next' in body && typeof body.next === 'function'))) {
             return { bodyHeaders: undefined, body: ReadableStreamFrom(body) };
         }
+        else if (typeof body === 'object' &&
+            headers.values.get('content-type') === 'application/x-www-form-urlencoded') {
+            return {
+                bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
+                body: this.stringifyQuery(body),
+            };
+        }
         else {
             return this.encoder({ body, headers });
         }
@@ -12164,33 +12187,103 @@ function embedContentConfigToMldev(fromObject, parentObject, _rootObject) {
     }
     return toObject;
 }
-function embedContentConfigToVertex(fromObject, parentObject, _rootObject) {
+function embedContentConfigToVertex(fromObject, parentObject, rootObject) {
     const toObject = {};
-    const fromTaskType = getValueByPath(fromObject, ['taskType']);
-    if (parentObject !== undefined && fromTaskType != null) {
-        setValueByPath(parentObject, ['instances[]', 'task_type'], fromTaskType);
+    let discriminatorTaskType = getValueByPath(rootObject, [
+        'embeddingApiType',
+    ]);
+    if (discriminatorTaskType === undefined) {
+        discriminatorTaskType = 'PREDICT';
     }
-    const fromTitle = getValueByPath(fromObject, ['title']);
-    if (parentObject !== undefined && fromTitle != null) {
-        setValueByPath(parentObject, ['instances[]', 'title'], fromTitle);
+    if (discriminatorTaskType === 'PREDICT') {
+        const fromTaskType = getValueByPath(fromObject, ['taskType']);
+        if (parentObject !== undefined && fromTaskType != null) {
+            setValueByPath(parentObject, ['instances[]', 'task_type'], fromTaskType);
+        }
     }
-    const fromOutputDimensionality = getValueByPath(fromObject, [
-        'outputDimensionality',
+    else if (discriminatorTaskType === 'EMBED_CONTENT') {
+        const fromTaskType = getValueByPath(fromObject, ['taskType']);
+        if (parentObject !== undefined && fromTaskType != null) {
+            setValueByPath(parentObject, ['taskType'], fromTaskType);
+        }
+    }
+    let discriminatorTitle = getValueByPath(rootObject, [
+        'embeddingApiType',
     ]);
-    if (parentObject !== undefined && fromOutputDimensionality != null) {
-        setValueByPath(parentObject, ['parameters', 'outputDimensionality'], fromOutputDimensionality);
+    if (discriminatorTitle === undefined) {
+        discriminatorTitle = 'PREDICT';
     }
-    const fromMimeType = getValueByPath(fromObject, ['mimeType']);
-    if (parentObject !== undefined && fromMimeType != null) {
-        setValueByPath(parentObject, ['instances[]', 'mimeType'], fromMimeType);
+    if (discriminatorTitle === 'PREDICT') {
+        const fromTitle = getValueByPath(fromObject, ['title']);
+        if (parentObject !== undefined && fromTitle != null) {
+            setValueByPath(parentObject, ['instances[]', 'title'], fromTitle);
+        }
+    }
+    else if (discriminatorTitle === 'EMBED_CONTENT') {
+        const fromTitle = getValueByPath(fromObject, ['title']);
+        if (parentObject !== undefined && fromTitle != null) {
+            setValueByPath(parentObject, ['title'], fromTitle);
+        }
+    }
+    let discriminatorOutputDimensionality = getValueByPath(rootObject, [
+        'embeddingApiType',
+    ]);
+    if (discriminatorOutputDimensionality === undefined) {
+        discriminatorOutputDimensionality = 'PREDICT';
+    }
+    if (discriminatorOutputDimensionality === 'PREDICT') {
+        const fromOutputDimensionality = getValueByPath(fromObject, [
+            'outputDimensionality',
+        ]);
+        if (parentObject !== undefined && fromOutputDimensionality != null) {
+            setValueByPath(parentObject, ['parameters', 'outputDimensionality'], fromOutputDimensionality);
+        }
+    }
+    else if (discriminatorOutputDimensionality === 'EMBED_CONTENT') {
+        const fromOutputDimensionality = getValueByPath(fromObject, [
+            'outputDimensionality',
+        ]);
+        if (parentObject !== undefined && fromOutputDimensionality != null) {
+            setValueByPath(parentObject, ['outputDimensionality'], fromOutputDimensionality);
+        }
     }
-    const fromAutoTruncate = getValueByPath(fromObject, ['autoTruncate']);
-    if (parentObject !== undefined && fromAutoTruncate != null) {
-        setValueByPath(parentObject, ['parameters', 'autoTruncate'], fromAutoTruncate);
+    let discriminatorMimeType = getValueByPath(rootObject, [
+        'embeddingApiType',
+    ]);
+    if (discriminatorMimeType === undefined) {
+        discriminatorMimeType = 'PREDICT';
+    }
+    if (discriminatorMimeType === 'PREDICT') {
+        const fromMimeType = getValueByPath(fromObject, ['mimeType']);
+        if (parentObject !== undefined && fromMimeType != null) {
+            setValueByPath(parentObject, ['instances[]', 'mimeType'], fromMimeType);
+        }
+    }
+    let discriminatorAutoTruncate = getValueByPath(rootObject, [
+        'embeddingApiType',
+    ]);
+    if (discriminatorAutoTruncate === undefined) {
+        discriminatorAutoTruncate = 'PREDICT';
+    }
+    if (discriminatorAutoTruncate === 'PREDICT') {
+        const fromAutoTruncate = getValueByPath(fromObject, [
+            'autoTruncate',
+        ]);
+        if (parentObject !== undefined && fromAutoTruncate != null) {
+            setValueByPath(parentObject, ['parameters', 'autoTruncate'], fromAutoTruncate);
+        }
+    }
+    else if (discriminatorAutoTruncate === 'EMBED_CONTENT') {
+        const fromAutoTruncate = getValueByPath(fromObject, [
+            'autoTruncate',
+        ]);
+        if (parentObject !== undefined && fromAutoTruncate != null) {
+            setValueByPath(parentObject, ['autoTruncate'], fromAutoTruncate);
+        }
     }
     return toObject;
 }
-function embedContentParametersToMldev(apiClient, fromObject, rootObject) {
+function embedContentParametersPrivateToMldev(apiClient, fromObject, rootObject) {
     const toObject = {};
     const fromModel = getValueByPath(fromObject, ['model']);
     if (fromModel != null) {
@@ -12206,6 +12299,10 @@ function embedContentParametersToMldev(apiClient, fromObject, rootObject) {
         }
         setValueByPath(toObject, ['requests[]', 'content'], transformedList);
     }
+    const fromContent = getValueByPath(fromObject, ['content']);
+    if (fromContent != null) {
+        contentToMldev$1(tContent(fromContent));
+    }
     const fromConfig = getValueByPath(fromObject, ['config']);
     if (fromConfig != null) {
         embedContentConfigToMldev(fromConfig, toObject);
@@ -12216,25 +12313,45 @@ function embedContentParametersToMldev(apiClient, fromObject, rootObject) {
     }
     return toObject;
 }
-function embedContentParametersToVertex(apiClient, fromObject, rootObject) {
+function embedContentParametersPrivateToVertex(apiClient, fromObject, rootObject) {
     const toObject = {};
     const fromModel = getValueByPath(fromObject, ['model']);
     if (fromModel != null) {
         setValueByPath(toObject, ['_url', 'model'], tModel(apiClient, fromModel));
     }
-    const fromContents = getValueByPath(fromObject, ['contents']);
-    if (fromContents != null) {
-        let transformedList = tContentsForEmbed(apiClient, fromContents);
-        if (Array.isArray(transformedList)) {
-            transformedList = transformedList.map((item) => {
-                return item;
-            });
+    let discriminatorContents = getValueByPath(rootObject, [
+        'embeddingApiType',
+    ]);
+    if (discriminatorContents === undefined) {
+        discriminatorContents = 'PREDICT';
+    }
+    if (discriminatorContents === 'PREDICT') {
+        const fromContents = getValueByPath(fromObject, ['contents']);
+        if (fromContents != null) {
+            let transformedList = tContentsForEmbed(apiClient, fromContents);
+            if (Array.isArray(transformedList)) {
+                transformedList = transformedList.map((item) => {
+                    return item;
+                });
+            }
+            setValueByPath(toObject, ['instances[]', 'content'], transformedList);
+        }
+    }
+    let discriminatorContent = getValueByPath(rootObject, [
+        'embeddingApiType',
+    ]);
+    if (discriminatorContent === undefined) {
+        discriminatorContent = 'PREDICT';
+    }
+    if (discriminatorContent === 'EMBED_CONTENT') {
+        const fromContent = getValueByPath(fromObject, ['content']);
+        if (fromContent != null) {
+            setValueByPath(toObject, ['content'], tContent(fromContent));
         }
-        setValueByPath(toObject, ['instances[]', 'content'], transformedList);
     }
     const fromConfig = getValueByPath(fromObject, ['config']);
     if (fromConfig != null) {
-        embedContentConfigToVertex(fromConfig, toObject);
+        embedContentConfigToVertex(fromConfig, toObject, rootObject);
     }
     return toObject;
 }
@@ -12287,6 +12404,24 @@ function embedContentResponseFromVertex(fromObject, rootObject) {
     if (fromMetadata != null) {
         setValueByPath(toObject, ['metadata'], fromMetadata);
     }
+    if (rootObject &&
+        getValueByPath(rootObject, ['embeddingApiType']) === 'EMBED_CONTENT') {
+        const embedding = getValueByPath(fromObject, ['embedding']);
+        const usageMetadata = getValueByPath(fromObject, ['usageMetadata']);
+        const truncated = getValueByPath(fromObject, ['truncated']);
+        if (embedding) {
+            const stats = {};
+            if (usageMetadata &&
+                usageMetadata['promptTokenCount']) {
+                stats.tokenCount = usageMetadata['promptTokenCount'];
+            }
+            if (truncated) {
+                stats.truncated = truncated;
+            }
+            embedding.statistics = stats;
+            setValueByPath(toObject, ['embeddings'], [embedding]);
+        }
+    }
     return toObject;
 }
 function endpointFromVertex(fromObject, _rootObject) {
@@ -15835,6 +15970,47 @@ class Models extends BaseModule {
     constructor(apiClient) {
         super();
         this.apiClient = apiClient;
+        /**
+         * Calculates embeddings for the given contents.
+         *
+         * @param params - The parameters for embedding contents.
+         * @return The response from the API.
+         *
+         * @example
+         * ```ts
+         * const response = await ai.models.embedContent({
+         *  model: 'text-embedding-004',
+         *  contents: [
+         *    'What is your name?',
+         *    'What is your favorite color?',
+         *  ],
+         *  config: {
+         *    outputDimensionality: 64,
+         *  },
+         * });
+         * console.log(response);
+         * ```
+         */
+        this.embedContent = async (params) => {
+            if (!this.apiClient.isVertexAI()) {
+                return await this.embedContentInternal(params);
+            }
+            const isVertexEmbedContentModel = (params.model.includes('gemini') &&
+                params.model !== 'gemini-embedding-001') ||
+                params.model.includes('maas');
+            if (isVertexEmbedContentModel) {
+                const contents = tContents(params.contents);
+                if (contents.length > 1) {
+                    throw new Error('The embedContent API for this model only supports one content at a time.');
+                }
+                const paramsPrivate = Object.assign(Object.assign({}, params), { content: contents[0], embeddingApiType: exports.EmbeddingApiType.EMBED_CONTENT });
+                return await this.embedContentInternal(paramsPrivate);
+            }
+            else {
+                const paramsPrivate = Object.assign(Object.assign({}, params), { embeddingApiType: exports.EmbeddingApiType.PREDICT });
+                return await this.embedContentInternal(paramsPrivate);
+            }
+        };
         /**
          * Makes an API request to generate content with a given model.
          *
@@ -16522,14 +16698,17 @@ class Models extends BaseModule {
      * console.log(response);
      * ```
      */
-    async embedContent(params) {
+    async embedContentInternal(params) {
         var _a, _b, _c, _d;
         let response;
         let path = '';
         let queryParams = {};
         if (this.apiClient.isVertexAI()) {
-            const body = embedContentParametersToVertex(this.apiClient, params);
-            path = formatMap('{model}:predict', body['_url']);
+            const body = embedContentParametersPrivateToVertex(this.apiClient, params, params);
+            const endpointUrl = tIsVertexEmbedContentModel(params.model)
+                ? '{model}:embedContent'
+                : '{model}:predict';
+            path = formatMap(endpointUrl, body['_url']);
             queryParams = body['_query'];
             delete body['_url'];
             delete body['_query'];
@@ -16552,14 +16731,14 @@ class Models extends BaseModule {
                 });
             });
             return response.then((apiResponse) => {
-                const resp = embedContentResponseFromVertex(apiResponse);
+                const resp = embedContentResponseFromVertex(apiResponse, params);
                 const typedResp = new EmbedContentResponse();
                 Object.assign(typedResp, resp);
                 return typedResp;
             });
         }
         else {
-            const body = embedContentParametersToMldev(this.apiClient, params);
+            const body = embedContentParametersPrivateToMldev(this.apiClient, params);
             path = formatMap('{model}:batchEmbedContents', body['_url']);
             queryParams = body['_query'];
             delete body['_url'];