@google/genai 1.50.1 → 1.52.0

package/dist/vertex_internal/index.d.ts

@@ -500,7 +500,7 @@ declare interface BatchJob {
     createTime?: string;
     /** Output only. Time when the Job for the first time entered the `JOB_STATE_RUNNING` state. */
     startTime?: string;
-    /** The time when the BatchJob was completed. This field is for Vertex AI only.
+    /** The time when the BatchJob was completed. This field is for Gemini Enterprise Agent Platform only.
      */
     endTime?: string;
     /** The time when the BatchJob was last updated.
@@ -509,21 +509,24 @@ declare interface BatchJob {
     /** The name of the model that produces the predictions via the BatchJob.
      */
     model?: string;
-    /** Configuration for the input data. This field is for Vertex AI only.
+    /** Configuration for the input data. This field is for Gemini Enterprise Agent Platform only.
      */
     src?: BatchJobSource;
     /** Configuration for the output data.
      */
     dest?: BatchJobDestination;
-    /** Statistics on completed and failed prediction instances. This field is for Vertex AI only.
+    /** Statistics on completed and failed prediction instances. This field is for Gemini Enterprise Agent Platform only.
      */
     completionStats?: CompletionStats;
+    /** Information further describing the output of this job. Output only.
+     */
+    outputInfo?: BatchJobOutputInfo;
 }
 
 /** Config for `des` parameter. */
 declare interface BatchJobDestination {
     /** Storage format of the output files. Must be one of:
-     'jsonl', 'bigquery'.
+     'jsonl', 'bigquery', 'vertex-dataset'.
      */
     format?: string;
     /** The Google Cloud Storage URI to the output file.
@@ -549,14 +552,27 @@ declare interface BatchJobDestination {
      the input requests.
      */
     inlinedEmbedContentResponses?: InlinedEmbedContentResponse[];
+    /** This field is experimental and may change in future versions. The Vertex AI dataset destination.
+     */
+    vertexDataset?: VertexMultimodalDatasetDestination;
 }
 
 declare type BatchJobDestinationUnion = BatchJobDestination | string;
 
+/** Represents the `output_info` field in batch jobs. */
+declare interface BatchJobOutputInfo {
+    /** This field is experimental and may change in future versions. The Vertex AI dataset name containing the output data. */
+    vertexMultimodalDatasetName?: string;
+    /** The full path of the Cloud Storage directory created, into which the prediction output is written. */
+    gcsOutputDirectory?: string;
+    /** The name of the BigQuery table created, in `predictions_<timestamp>` format, into which the prediction output is written. */
+    bigqueryOutputTable?: string;
+}
+
 /** Config for `src` parameter. */
 declare interface BatchJobSource {
     /** Storage format of the input files. Must be one of:
-     'jsonl', 'bigquery'.
+     'jsonl', 'bigquery', 'vertex-dataset'.
      */
     format?: string;
     /** The Google Cloud Storage URIs to input files.
@@ -572,6 +588,9 @@ declare interface BatchJobSource {
     /** The Gemini Developer API's inlined input data to run batch job.
      */
     inlinedRequests?: InlinedRequest[];
+    /** This field is experimental and may change in future versions. The Vertex AI dataset resource name to use as input. Must be of type multimodal.
+     */
+    vertexDatasetName?: string;
 }
 
 declare type BatchJobSourceUnion = BatchJobSource | InlinedRequest[] | string;
@@ -934,7 +953,7 @@ declare interface ContentEmbedding {
     /** A list of floats representing an embedding.
      */
     values?: number[];
-    /** Vertex API only. Statistics of the input text associated with this
+    /** Gemini Enterprise Agent Platform only. Statistics of the input text associated with this
      embedding.
      */
     statistics?: ContentEmbeddingStatistics;
@@ -942,11 +961,11 @@ declare interface ContentEmbedding {
 
 /** Statistics of the input text associated with the result of content embedding. */
 declare interface ContentEmbeddingStatistics {
-    /** Vertex API only. If the input text was truncated due to having
+    /** Gemini Enterprise Agent Platform only. If the input text was truncated due to having
      a length longer than the allowed maximum input.
      */
     truncated?: boolean;
-    /** Vertex API only. Number of tokens of the input text.
+    /** Gemini Enterprise Agent Platform only. Number of tokens of the input text.
      */
     tokenCount?: number;
 }
@@ -1300,6 +1319,10 @@ declare interface CreateFileSearchStoreConfig {
     /** The human-readable display name for the file search store.
      */
     displayName?: string;
+    /** The embedding model to use for the FileSearchStore.
+     Format: `models/{model}`. If not specified, the default embedding model will be used.
+     */
+    embeddingModel?: string;
 }
 
 /** Config for file_search_stores.create parameters. */
@@ -1390,9 +1413,9 @@ declare interface CreateTuningJobConfig {
     adapterSize?: AdapterSize;
     /** Tuning mode for tuning. */
     tuningMode?: TuningMode;
-    /** Custom base model for tuning. This is only supported for OSS models in Vertex. */
+    /** Custom base model for tuning. This is only supported for OSS models in Gemini Enterprise Agent Platform. */
     customBaseModel?: string;
-    /** The batch size hyperparameter for tuning. This is only supported for OSS models in Vertex. */
+    /** The batch size hyperparameter for tuning. This is only supported for OSS models in Gemini Enterprise Agent Platform. */
     batchSize?: number;
     /** The learning rate for tuning. OSS models only. Mutually exclusive with learning_rate_multiplier. */
     learningRate?: number;
@@ -1708,7 +1731,8 @@ declare interface DistillationHyperParameters {
     /** Optional. Multiplier for adjusting the default learning rate. */
     learningRateMultiplier?: number;
     /** The batch size hyperparameter for tuning.
-     This is only supported for OSS models in Vertex. */
+     This is only supported for OSS models in Gemini Enterprise Agent Platform.
+     */
     batchSize?: number;
     /** The learning rate for tuning. OSS models only. */
     learningRate?: number;
@@ -1822,6 +1846,19 @@ declare interface DownloadFileParameters {
     config?: DownloadFileConfig;
 }
 
+/** Used to override the default configuration. */
+declare interface DownloadMediaConfig {
+    /** Used to override HTTP request options. */
+    httpOptions?: HttpOptions;
+    /** Abort signal which can be used to cancel the request.
+
+     NOTE: AbortSignal is a client-only operation. Using it to cancel an
+     operation will not cancel the request in the service. You will still
+     be charged usage for any applicable operations.
+     */
+    abortSignal?: AbortSignal;
+}
+
 /** Describes the options to customize dynamic retrieval. */
 declare interface DynamicRetrievalConfig {
     /** Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. */
@@ -1963,27 +2000,27 @@ declare interface EmbedContentConfig {
      using the earlier model (`models/embedding-001`).
      */
     outputDimensionality?: number;
-    /** Vertex API only. The MIME type of the input.
+    /** Gemini Enterprise Agent Platform only. The MIME type of the input.
      */
     mimeType?: string;
-    /** Vertex API only. Whether to silently truncate inputs longer than
+    /** Gemini Enterprise Agent Platform only. Whether to silently truncate inputs longer than
      the max sequence length. If this option is set to false, oversized inputs
      will lead to an INVALID_ARGUMENT error, similar to other text APIs.
      */
     autoTruncate?: boolean;
-    /** Vertex API only. Whether to enable OCR for document content.
+    /** Gemini Enterprise Agent Platform only. Whether to enable OCR for document content.
      Only applicable to Gemini Embedding 2 models.
      */
     documentOcr?: boolean;
-    /** Vertex API only. Whether to extract audio from video content.
+    /** Gemini Enterprise Agent Platform only. Whether to extract audio from video content.
      Only applicable to Gemini Embedding 2 models.
      */
     audioTrackExtraction?: boolean;
 }
 
-/** Request-level metadata for the Vertex Embed Content API. */
+/** Request-level metadata for the Gemini Enterprise Agent Platform Embed Content API. */
 declare interface EmbedContentMetadata {
-    /** Vertex API only. The total number of billable characters included
+    /** Gemini Enterprise Agent Platform only. The total number of billable characters included
      in the request.
      */
     billableCharacterCount?: number;
@@ -2013,7 +2050,7 @@ declare interface EmbedContentParametersPrivate {
     /** The single content to embed. Only the `parts.text` fields will be counted.
      */
     content?: ContentUnion;
-    /** The Vertex embedding API to use.
+    /** The Gemini Enterprise Agent Platform embedding API to use.
      */
     embeddingApiType?: EmbeddingApiType;
     /** Configuration that contains optional parameters.
@@ -2029,12 +2066,12 @@ declare class EmbedContentResponse {
      the batch request.
      */
     embeddings?: ContentEmbedding[];
-    /** Vertex API only. Metadata about the request.
+    /** Gemini Enterprise Agent Platform only. Metadata about the request.
      */
     metadata?: EmbedContentMetadata;
 }
 
-/** Enum representing the Vertex embedding API to use. */
+/** Enum representing the Gemini Enterprise Agent Platform embedding API to use. */
 declare enum EmbeddingApiType {
     /**
      * predict API endpoint (default)
@@ -2294,6 +2331,8 @@ declare interface FileSearchStore {
     /** The size of raw bytes ingested into the FileSearchStore. This is the
      total size of all the documents in the FileSearchStore. */
     sizeBytes?: string;
+    /** The embedding model used by the FileSearchStore. */
+    embeddingModel?: string;
 }
 
 /** Source of the File. */
@@ -2757,7 +2796,7 @@ declare interface GenerateContentConfig {
      */
     imageConfig?: ImageConfig;
     /** Enables enhanced civic answers. It may not be available for all
-     models. This field is not supported in Vertex AI.
+     models. This field is not supported in Gemini Enterprise Agent Platform.
      */
     enableEnhancedCivicAnswers?: boolean;
     /** Settings for prompt and response sanitization using the Model Armor
@@ -3138,6 +3177,8 @@ declare interface GenerateVideosConfig {
     /** Webhook configuration for receiving notifications when the
      video generation operation completes. */
     webhookConfig?: WebhookConfig;
+    /** Resize mode of the image input for video generation. */
+    resizeMode?: ImageResizeMode;
 }
 
 /** A video generation operation. */
@@ -3636,6 +3677,10 @@ declare interface GroundingChunkRetrievedContext {
     customMetadata?: GroundingChunkCustomMetadata[];
     /** Optional. Name of the `FileSearchStore` containing the document. Example: `fileSearchStores/123`. This field is not supported in Vertex AI. */
     fileSearchStore?: string;
+    /** Optional. Page number of the retrieved context. This field is not supported in Vertex AI. */
+    pageNumber?: number;
+    /** Optional. Media ID. This field is not supported in Vertex AI. */
+    mediaId?: string;
 }
 
 /** A list of string values. This data type is not supported in Vertex AI. */
@@ -3885,7 +3930,7 @@ declare interface HttpOptions {
     timeout?: number;
     /** Extra parameters to add to the request body.
      The structure must match the backend API's request structure.
-     - VertexAI backend API docs: https://cloud.google.com/vertex-ai/docs/reference/rest
+     - Gemini Enterprise Agent Platform backend API docs: https://cloud.google.com/vertex-ai/docs/reference/rest
      - GeminiAPI backend API docs: https://ai.google.dev/api/rest */
     extraBody?: Record<string, unknown>;
     /** HTTP retry options for the request. */
@@ -4041,6 +4086,20 @@ declare enum ImagePromptLanguage {
     es = "es"
 }
 
+/** Resize mode for the image input for video generation. */
+declare enum ImageResizeMode {
+    /**
+     * Crop the image to fit the correct aspect ratio (so we lose parts
+     of the image in the process).
+     */
+    CROP = "CROP",
+    /**
+     * Pad the image to fit the correct aspect ratio (so we don't lose
+     any parts of the image in the process).
+     */
+    PAD = "PAD"
+}
+
 /** Image search for grounding and related configurations. */
 declare interface ImageSearch {
 }
@@ -6901,7 +6960,7 @@ declare interface TunedModelInfo {
 declare interface TuningDataset {
     /** GCS URI of the file containing training dataset in JSONL format. */
     gcsUri?: string;
-    /** The resource name of the Vertex Multimodal Dataset that is used as training dataset. Example: 'projects/my-project-id-or-number/locations/my-location/datasets/my-dataset-id'. */
+    /** The resource name of the Gemini Enterprise Agent Platform (previously known as Vertex AI) Multimodal Dataset that is used as training dataset. Example: 'projects/my-project-id-or-number/locations/my-location/datasets/my-dataset-id'. */
     vertexDatasetResource?: string;
     /** Inline examples with simple input/output text. */
     examples?: TuningExample[];
@@ -7096,7 +7155,7 @@ declare enum TuningTask {
 declare interface TuningValidationDataset {
     /** GCS URI of the file containing validation dataset in JSONL format. */
     gcsUri?: string;
-    /** The resource name of the Vertex Multimodal Dataset that is used as validation dataset. Example: 'projects/my-project-id-or-number/locations/my-location/datasets/my-dataset-id'. */
+    /** The resource name of the Gemini Enterprise Agent Platform (previously known as Vertex AI) Multimodal Dataset that is used as validation dataset. Example: 'projects/my-project-id-or-number/locations/my-location/datasets/my-dataset-id'. */
     vertexDatasetResource?: string;
 }
 
@@ -7336,6 +7395,7 @@ declare namespace types {
         VideoGenerationReferenceType,
         VideoGenerationMaskMode,
         VideoCompressionQuality,
+        ImageResizeMode,
         TuningMethod,
         FileState,
         FileSource,
@@ -7653,6 +7713,7 @@ declare namespace types {
         RegisterFilesResponse,
         InlinedRequest,
         BatchJobSource,
+        VertexMultimodalDatasetDestination,
         JobError,
         InlinedResponse,
         SingleEmbedContentResponse,
@@ -7660,6 +7721,7 @@ declare namespace types {
         BatchJobDestination,
         CreateBatchJobConfig,
         CreateBatchJobParameters,
+        BatchJobOutputInfo,
         CompletionStats,
         BatchJob,
         EmbedContentBatch,
@@ -7763,6 +7825,7 @@ declare namespace types {
         EmbedContentParameters,
         UploadToFileSearchStoreResponse,
         UploadToFileSearchStoreOperation,
+        DownloadMediaConfig,
         BlobImageUnion,
         PartUnion,
         PartListUnion,
@@ -8153,6 +8216,16 @@ declare interface VertexAISearchDataStoreSpec {
     filter?: string;
 }
 
+/** This class is experimental and may change in future versions.
+
+ The specification for an output Vertex AI multimodal dataset. */
+declare interface VertexMultimodalDatasetDestination {
+    /** The BigQuery destination for the multimodal dataset. */
+    bigqueryDestination?: string;
+    /** The display name of the multimodal dataset. */
+    displayName?: string;
+}
+
 /** Retrieve from Vertex RAG Store for grounding. This data type is not supported in Gemini API. */
 declare interface VertexRagStore {
     /** Optional. Deprecated. Please use rag_resources instead. */

package/dist/vertex_internal/index.js

@@ -274,60 +274,6 @@ function _moveValueRecursive(data, sourceKeys, destKeys, keyIdx, excludeKeys) {
     }
 }
 
-/**
- * @license
- * Copyright 2025 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-// Code generated by the Google Gen AI SDK generator DO NOT EDIT.
-function uploadToFileSearchStoreConfigToMldev(fromObject, parentObject) {
-    const toObject = {};
-    const fromMimeType = getValueByPath(fromObject, ['mimeType']);
-    if (parentObject !== undefined && fromMimeType != null) {
-        setValueByPath(parentObject, ['mimeType'], fromMimeType);
-    }
-    const fromDisplayName = getValueByPath(fromObject, ['displayName']);
-    if (parentObject !== undefined && fromDisplayName != null) {
-        setValueByPath(parentObject, ['displayName'], fromDisplayName);
-    }
-    const fromCustomMetadata = getValueByPath(fromObject, [
-        'customMetadata',
-    ]);
-    if (parentObject !== undefined && fromCustomMetadata != null) {
-        let transformedList = fromCustomMetadata;
-        if (Array.isArray(transformedList)) {
-            transformedList = transformedList.map((item) => {
-                return item;
-            });
-        }
-        setValueByPath(parentObject, ['customMetadata'], transformedList);
-    }
-    const fromChunkingConfig = getValueByPath(fromObject, [
-        'chunkingConfig',
-    ]);
-    if (parentObject !== undefined && fromChunkingConfig != null) {
-        setValueByPath(parentObject, ['chunkingConfig'], fromChunkingConfig);
-    }
-    return toObject;
-}
-
-/**
- * @license
- * Copyright 2025 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * API errors raised by the GenAI API.
- */
-class ApiError extends Error {
-    constructor(options) {
-        super(options.message);
-        this.name = 'ApiError';
-        this.status = options.status;
-        Object.setPrototypeOf(this, ApiError.prototype);
-    }
-}
-
 /**
  * @license
  * Copyright 2025 Google LLC
@@ -1398,7 +1344,7 @@ var FeatureSelectionPreference;
     FeatureSelectionPreference["BALANCED"] = "BALANCED";
     FeatureSelectionPreference["PRIORITIZE_COST"] = "PRIORITIZE_COST";
 })(FeatureSelectionPreference || (FeatureSelectionPreference = {}));
-/** Enum representing the Vertex embedding API to use. */
+/** Enum representing the Gemini Enterprise Agent Platform embedding API to use. */
 var EmbeddingApiType;
 (function (EmbeddingApiType) {
     /**
@@ -1556,6 +1502,20 @@ var VideoCompressionQuality;
      */
     VideoCompressionQuality["LOSSLESS"] = "LOSSLESS";
 })(VideoCompressionQuality || (VideoCompressionQuality = {}));
+/** Resize mode for the image input for video generation. */
+var ImageResizeMode;
+(function (ImageResizeMode) {
+    /**
+     * Crop the image to fit the correct aspect ratio (so we lose parts
+        of the image in the process).
+     */
+    ImageResizeMode["CROP"] = "CROP";
+    /**
+     * Pad the image to fit the correct aspect ratio (so we don't lose
+        any parts of the image in the process).
+     */
+    ImageResizeMode["PAD"] = "PAD";
+})(ImageResizeMode || (ImageResizeMode = {}));
 /** Enum representing the tuning method. */
 var TuningMethod;
 (function (TuningMethod) {
@@ -1967,6 +1927,120 @@ class UploadToFileSearchStoreOperation {
     }
 }
 
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+function _isFile(origin) {
+    return (origin !== null &&
+        origin !== undefined &&
+        typeof origin === 'object' &&
+        'name' in origin);
+}
+function isGeneratedVideo(origin) {
+    return (origin !== null &&
+        origin !== undefined &&
+        typeof origin === 'object' &&
+        'video' in origin);
+}
+function isVideo(origin) {
+    return (origin !== null &&
+        origin !== undefined &&
+        typeof origin === 'object' &&
+        'uri' in origin);
+}
+function tFileName(fromName) {
+    var _a;
+    let name;
+    if (_isFile(fromName)) {
+        name = fromName.name;
+    }
+    if (isVideo(fromName)) {
+        name = fromName.uri;
+        if (name === undefined) {
+            return undefined;
+        }
+    }
+    if (isGeneratedVideo(fromName)) {
+        name = (_a = fromName.video) === null || _a === void 0 ? void 0 : _a.uri;
+        if (name === undefined) {
+            return undefined;
+        }
+    }
+    if (typeof fromName === 'string') {
+        name = fromName;
+    }
+    if (name === undefined) {
+        throw new Error('Could not extract file name from the provided input.');
+    }
+    if (name.startsWith('https://')) {
+        const suffix = name.split('files/')[1];
+        const match = suffix.match(/[a-z0-9]+/);
+        if (match === null) {
+            throw new Error(`Could not extract file name from URI ${name}`);
+        }
+        name = match[0];
+    }
+    else if (name.startsWith('files/')) {
+        name = name.split('files/')[1];
+    }
+    return name;
+}
+
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+function uploadToFileSearchStoreConfigToMldev(fromObject, parentObject) {
+    const toObject = {};
+    const fromMimeType = getValueByPath(fromObject, ['mimeType']);
+    if (parentObject !== undefined && fromMimeType != null) {
+        setValueByPath(parentObject, ['mimeType'], fromMimeType);
+    }
+    const fromDisplayName = getValueByPath(fromObject, ['displayName']);
+    if (parentObject !== undefined && fromDisplayName != null) {
+        setValueByPath(parentObject, ['displayName'], fromDisplayName);
+    }
+    const fromCustomMetadata = getValueByPath(fromObject, [
+        'customMetadata',
+    ]);
+    if (parentObject !== undefined && fromCustomMetadata != null) {
+        let transformedList = fromCustomMetadata;
+        if (Array.isArray(transformedList)) {
+            transformedList = transformedList.map((item) => {
+                return item;
+            });
+        }
+        setValueByPath(parentObject, ['customMetadata'], transformedList);
+    }
+    const fromChunkingConfig = getValueByPath(fromObject, [
+        'chunkingConfig',
+    ]);
+    if (parentObject !== undefined && fromChunkingConfig != null) {
+        setValueByPath(parentObject, ['chunkingConfig'], fromChunkingConfig);
+    }
+    return toObject;
+}
+
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * API errors raised by the GenAI API.
+ */
+class ApiError extends Error {
+    constructor(options) {
+        super(options.message);
+        this.name = 'ApiError';
+        this.status = options.status;
+        Object.setPrototypeOf(this, ApiError.prototype);
+    }
+}
+
 /**
  * @license
  * Copyright 2025 Google LLC
@@ -1976,7 +2050,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.50.1'; // x-release-please-version
+const SDK_VERSION = '1.52.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';
@@ -2725,67 +2799,6 @@ function buildGoogleAuthOptions(googleAuthOptions) {
     }
 }
 
-/**
- * @license
- * Copyright 2025 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-function _isFile(origin) {
-    return (origin !== null &&
-        origin !== undefined &&
-        typeof origin === 'object' &&
-        'name' in origin);
-}
-function isGeneratedVideo(origin) {
-    return (origin !== null &&
-        origin !== undefined &&
-        typeof origin === 'object' &&
-        'video' in origin);
-}
-function isVideo(origin) {
-    return (origin !== null &&
-        origin !== undefined &&
-        typeof origin === 'object' &&
-        'uri' in origin);
-}
-function tFileName(fromName) {
-    var _a;
-    let name;
-    if (_isFile(fromName)) {
-        name = fromName.name;
-    }
-    if (isVideo(fromName)) {
-        name = fromName.uri;
-        if (name === undefined) {
-            return undefined;
-        }
-    }
-    if (isGeneratedVideo(fromName)) {
-        name = (_a = fromName.video) === null || _a === void 0 ? void 0 : _a.uri;
-        if (name === undefined) {
-            return undefined;
-        }
-    }
-    if (typeof fromName === 'string') {
-        name = fromName;
-    }
-    if (name === undefined) {
-        throw new Error('Could not extract file name from the provided input.');
-    }
-    if (name.startsWith('https://')) {
-        const suffix = name.split('files/')[1];
-        const match = suffix.match(/[a-z0-9]+/);
-        if (match === null) {
-            throw new Error(`Could not extract file name from URI ${name}`);
-        }
-        name = match[0];
-    }
-    else if (name.startsWith('files/')) {
-        name = name.split('files/')[1];
-    }
-    return name;
-}
-
 /**
  * @license
  * Copyright 2025 Google LLC