@google/genai 1.50.1 → 1.52.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/genai.d.ts CHANGED
@@ -480,7 +480,7 @@ declare interface AudioContent {
480
480
  /**
481
481
  * The sample rate of the audio.
482
482
  */
483
- rate?: number;
483
+ sample_rate?: number;
484
484
  /**
485
485
  * The URI of the audio.
486
486
  */
@@ -655,7 +655,7 @@ declare interface BaseCreateAgentInteractionParams {
655
655
  /**
656
656
  * Body param: The name of the `Agent` used for generating the interaction.
657
657
  */
658
- agent: (string & {}) | 'deep-research-pro-preview-12-2025';
658
+ agent: 'deep-research-pro-preview-12-2025' | 'deep-research-preview-04-2026' | 'deep-research-max-preview-04-2026' | (string & {});
659
659
  /**
660
660
  * Body param: The input for the interaction.
661
661
  */
@@ -954,7 +954,7 @@ declare class BaseWebhooks extends APIResource {
954
954
  /**
955
955
  * Updates an existing Webhook.
956
956
  */
957
- update(id: string, params: WebhookUpdateParams, options?: RequestOptions): APIPromise<Webhook>;
957
+ update(id: string, params?: WebhookUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Webhook>;
958
958
  /**
959
959
  * Lists all Webhooks.
960
960
  */
@@ -1107,7 +1107,7 @@ export declare interface BatchJob {
1107
1107
  createTime?: string;
1108
1108
  /** Output only. Time when the Job for the first time entered the `JOB_STATE_RUNNING` state. */
1109
1109
  startTime?: string;
1110
- /** The time when the BatchJob was completed. This field is for Vertex AI only.
1110
+ /** The time when the BatchJob was completed. This field is for Gemini Enterprise Agent Platform only.
1111
1111
  */
1112
1112
  endTime?: string;
1113
1113
  /** The time when the BatchJob was last updated.
@@ -1116,21 +1116,24 @@ export declare interface BatchJob {
1116
1116
  /** The name of the model that produces the predictions via the BatchJob.
1117
1117
  */
1118
1118
  model?: string;
1119
- /** Configuration for the input data. This field is for Vertex AI only.
1119
+ /** Configuration for the input data. This field is for Gemini Enterprise Agent Platform only.
1120
1120
  */
1121
1121
  src?: BatchJobSource;
1122
1122
  /** Configuration for the output data.
1123
1123
  */
1124
1124
  dest?: BatchJobDestination;
1125
- /** Statistics on completed and failed prediction instances. This field is for Vertex AI only.
1125
+ /** Statistics on completed and failed prediction instances. This field is for Gemini Enterprise Agent Platform only.
1126
1126
  */
1127
1127
  completionStats?: CompletionStats;
1128
+ /** Information further describing the output of this job. Output only.
1129
+ */
1130
+ outputInfo?: BatchJobOutputInfo;
1128
1131
  }
1129
1132
 
1130
1133
  /** Config for `des` parameter. */
1131
1134
  export declare interface BatchJobDestination {
1132
1135
  /** Storage format of the output files. Must be one of:
1133
- 'jsonl', 'bigquery'.
1136
+ 'jsonl', 'bigquery', 'vertex-dataset'.
1134
1137
  */
1135
1138
  format?: string;
1136
1139
  /** The Google Cloud Storage URI to the output file.
@@ -1156,14 +1159,27 @@ export declare interface BatchJobDestination {
1156
1159
  the input requests.
1157
1160
  */
1158
1161
  inlinedEmbedContentResponses?: InlinedEmbedContentResponse[];
1162
+ /** This field is experimental and may change in future versions. The Vertex AI dataset destination.
1163
+ */
1164
+ vertexDataset?: VertexMultimodalDatasetDestination;
1159
1165
  }
1160
1166
 
1161
1167
  export declare type BatchJobDestinationUnion = BatchJobDestination | string;
1162
1168
 
1169
+ /** Represents the `output_info` field in batch jobs. */
1170
+ export declare interface BatchJobOutputInfo {
1171
+ /** This field is experimental and may change in future versions. The Vertex AI dataset name containing the output data. */
1172
+ vertexMultimodalDatasetName?: string;
1173
+ /** The full path of the Cloud Storage directory created, into which the prediction output is written. */
1174
+ gcsOutputDirectory?: string;
1175
+ /** The name of the BigQuery table created, in `predictions_<timestamp>` format, into which the prediction output is written. */
1176
+ bigqueryOutputTable?: string;
1177
+ }
1178
+
1163
1179
  /** Config for `src` parameter. */
1164
1180
  export declare interface BatchJobSource {
1165
1181
  /** Storage format of the input files. Must be one of:
1166
- 'jsonl', 'bigquery'.
1182
+ 'jsonl', 'bigquery', 'vertex-dataset'.
1167
1183
  */
1168
1184
  format?: string;
1169
1185
  /** The Google Cloud Storage URIs to input files.
@@ -1179,6 +1195,9 @@ export declare interface BatchJobSource {
1179
1195
  /** The Gemini Developer API's inlined input data to run batch job.
1180
1196
  */
1181
1197
  inlinedRequests?: InlinedRequest[];
1198
+ /** 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.
1199
+ */
1200
+ vertexDatasetName?: string;
1182
1201
  }
1183
1202
 
1184
1203
  export declare type BatchJobSourceUnion = BatchJobSource | InlinedRequest[] | string;
@@ -1322,7 +1341,7 @@ export declare class Caches extends BaseModule {
1322
1341
  * @remarks
1323
1342
  * Context caching is only supported for specific models. See [Gemini
1324
1343
  * Developer API reference](https://ai.google.dev/gemini-api/docs/caching?lang=node/context-cac)
1325
- * and [Vertex AI reference](https://cloud.google.com/vertex-ai/generative-ai/docs/context-cache/context-cache-overview#supported_models)
1344
+ * and [Gemini Enterprise Agent Platform reference](https://cloud.google.com/vertex-ai/generative-ai/docs/context-cache/context-cache-overview#supported_models)
1326
1345
  * for more information.
1327
1346
  *
1328
1347
  * @param params - The parameters for the create request.
@@ -1925,9 +1944,13 @@ declare namespace ContentDelta {
1925
1944
  data?: string;
1926
1945
  mime_type?: 'audio/wav' | 'audio/mp3' | 'audio/aiff' | 'audio/aac' | 'audio/ogg' | 'audio/flac' | 'audio/mpeg' | 'audio/m4a' | 'audio/l16' | 'audio/opus' | 'audio/alaw' | 'audio/mulaw';
1927
1946
  /**
1928
- * The sample rate of the audio.
1947
+ * @deprecated Deprecated. Use sample_rate instead. The value is ignored.
1929
1948
  */
1930
1949
  rate?: number;
1950
+ /**
1951
+ * The sample rate of the audio.
1952
+ */
1953
+ sample_rate?: number;
1931
1954
  uri?: string;
1932
1955
  }
1933
1956
  interface Document {
@@ -2134,24 +2157,13 @@ declare namespace ContentDelta {
2134
2157
  * Required. ID to match the ID from the function call block.
2135
2158
  */
2136
2159
  call_id: string;
2137
- result: Array<FileSearchResult.Result>;
2160
+ result: Array<unknown>;
2138
2161
  type: 'file_search_result';
2139
2162
  /**
2140
2163
  * A signature hash for backend validation.
2141
2164
  */
2142
2165
  signature?: string;
2143
2166
  }
2144
- namespace FileSearchResult {
2145
- /**
2146
- * The result of the File Search.
2147
- */
2148
- interface Result {
2149
- /**
2150
- * User provided metadata about the FileSearchResult.
2151
- */
2152
- custom_metadata?: Array<unknown>;
2153
- }
2154
- }
2155
2167
  interface GoogleMapsResult {
2156
2168
  /**
2157
2169
  * Required. ID to match the ID from the function call block.
@@ -2181,7 +2193,7 @@ export declare interface ContentEmbedding {
2181
2193
  /** A list of floats representing an embedding.
2182
2194
  */
2183
2195
  values?: number[];
2184
- /** Vertex API only. Statistics of the input text associated with this
2196
+ /** Gemini Enterprise Agent Platform only. Statistics of the input text associated with this
2185
2197
  embedding.
2186
2198
  */
2187
2199
  statistics?: ContentEmbeddingStatistics;
@@ -2189,11 +2201,11 @@ export declare interface ContentEmbedding {
2189
2201
 
2190
2202
  /** Statistics of the input text associated with the result of content embedding. */
2191
2203
  export declare interface ContentEmbeddingStatistics {
2192
- /** Vertex API only. If the input text was truncated due to having
2204
+ /** Gemini Enterprise Agent Platform only. If the input text was truncated due to having
2193
2205
  a length longer than the allowed maximum input.
2194
2206
  */
2195
2207
  truncated?: boolean;
2196
- /** Vertex API only. Number of tokens of the input text.
2208
+ /** Gemini Enterprise Agent Platform only. Number of tokens of the input text.
2197
2209
  */
2198
2210
  tokenCount?: number;
2199
2211
  }
@@ -2583,6 +2595,10 @@ export declare interface CreateFileSearchStoreConfig {
2583
2595
  /** The human-readable display name for the file search store.
2584
2596
  */
2585
2597
  displayName?: string;
2598
+ /** The embedding model to use for the FileSearchStore.
2599
+ Format: `models/{model}`. If not specified, the default embedding model will be used.
2600
+ */
2601
+ embeddingModel?: string;
2586
2602
  }
2587
2603
 
2588
2604
  /** Config for file_search_stores.create parameters. */
@@ -2687,9 +2703,9 @@ export declare interface CreateTuningJobConfig {
2687
2703
  adapterSize?: AdapterSize;
2688
2704
  /** Tuning mode for tuning. */
2689
2705
  tuningMode?: TuningMode;
2690
- /** Custom base model for tuning. This is only supported for OSS models in Vertex. */
2706
+ /** Custom base model for tuning. This is only supported for OSS models in Gemini Enterprise Agent Platform. */
2691
2707
  customBaseModel?: string;
2692
- /** The batch size hyperparameter for tuning. This is only supported for OSS models in Vertex. */
2708
+ /** The batch size hyperparameter for tuning. This is only supported for OSS models in Gemini Enterprise Agent Platform. */
2693
2709
  batchSize?: number;
2694
2710
  /** The learning rate for tuning. OSS models only. Mutually exclusive with learning_rate_multiplier. */
2695
2711
  learningRate?: number;
@@ -3027,7 +3043,8 @@ export declare interface DistillationHyperParameters {
3027
3043
  /** Optional. Multiplier for adjusting the default learning rate. */
3028
3044
  learningRateMultiplier?: number;
3029
3045
  /** The batch size hyperparameter for tuning.
3030
- This is only supported for OSS models in Vertex. */
3046
+ This is only supported for OSS models in Gemini Enterprise Agent Platform.
3047
+ */
3031
3048
  batchSize?: number;
3032
3049
  /** The learning rate for tuning. OSS models only. */
3033
3050
  learningRate?: number;
@@ -3198,6 +3215,19 @@ export declare interface DownloadFileParameters {
3198
3215
  config?: DownloadFileConfig;
3199
3216
  }
3200
3217
 
3218
+ /** Used to override the default configuration. */
3219
+ export declare interface DownloadMediaConfig {
3220
+ /** Used to override HTTP request options. */
3221
+ httpOptions?: HttpOptions;
3222
+ /** Abort signal which can be used to cancel the request.
3223
+
3224
+ NOTE: AbortSignal is a client-only operation. Using it to cancel an
3225
+ operation will not cancel the request in the service. You will still
3226
+ be charged usage for any applicable operations.
3227
+ */
3228
+ abortSignal?: AbortSignal;
3229
+ }
3230
+
3201
3231
  /**
3202
3232
  * Configuration for dynamic agents.
3203
3233
  */
@@ -3347,27 +3377,27 @@ export declare interface EmbedContentConfig {
3347
3377
  using the earlier model (`models/embedding-001`).
3348
3378
  */
3349
3379
  outputDimensionality?: number;
3350
- /** Vertex API only. The MIME type of the input.
3380
+ /** Gemini Enterprise Agent Platform only. The MIME type of the input.
3351
3381
  */
3352
3382
  mimeType?: string;
3353
- /** Vertex API only. Whether to silently truncate inputs longer than
3383
+ /** Gemini Enterprise Agent Platform only. Whether to silently truncate inputs longer than
3354
3384
  the max sequence length. If this option is set to false, oversized inputs
3355
3385
  will lead to an INVALID_ARGUMENT error, similar to other text APIs.
3356
3386
  */
3357
3387
  autoTruncate?: boolean;
3358
- /** Vertex API only. Whether to enable OCR for document content.
3388
+ /** Gemini Enterprise Agent Platform only. Whether to enable OCR for document content.
3359
3389
  Only applicable to Gemini Embedding 2 models.
3360
3390
  */
3361
3391
  documentOcr?: boolean;
3362
- /** Vertex API only. Whether to extract audio from video content.
3392
+ /** Gemini Enterprise Agent Platform only. Whether to extract audio from video content.
3363
3393
  Only applicable to Gemini Embedding 2 models.
3364
3394
  */
3365
3395
  audioTrackExtraction?: boolean;
3366
3396
  }
3367
3397
 
3368
- /** Request-level metadata for the Vertex Embed Content API. */
3398
+ /** Request-level metadata for the Gemini Enterprise Agent Platform Embed Content API. */
3369
3399
  export declare interface EmbedContentMetadata {
3370
- /** Vertex API only. The total number of billable characters included
3400
+ /** Gemini Enterprise Agent Platform only. The total number of billable characters included
3371
3401
  in the request.
3372
3402
  */
3373
3403
  billableCharacterCount?: number;
@@ -3397,7 +3427,7 @@ export declare interface EmbedContentParametersPrivate {
3397
3427
  /** The single content to embed. Only the `parts.text` fields will be counted.
3398
3428
  */
3399
3429
  content?: ContentUnion;
3400
- /** The Vertex embedding API to use.
3430
+ /** The Gemini Enterprise Agent Platform embedding API to use.
3401
3431
  */
3402
3432
  embeddingApiType?: EmbeddingApiType;
3403
3433
  /** Configuration that contains optional parameters.
@@ -3413,12 +3443,12 @@ export declare class EmbedContentResponse {
3413
3443
  the batch request.
3414
3444
  */
3415
3445
  embeddings?: ContentEmbedding[];
3416
- /** Vertex API only. Metadata about the request.
3446
+ /** Gemini Enterprise Agent Platform only. Metadata about the request.
3417
3447
  */
3418
3448
  metadata?: EmbedContentMetadata;
3419
3449
  }
3420
3450
 
3421
- /** Enum representing the Vertex embedding API to use. */
3451
+ /** Enum representing the Gemini Enterprise Agent Platform embedding API to use. */
3422
3452
  export declare enum EmbeddingApiType {
3423
3453
  /**
3424
3454
  * predict API endpoint (default)
@@ -3701,6 +3731,12 @@ export { File_2 as File }
3701
3731
  */
3702
3732
  declare interface FileCitation {
3703
3733
  type: 'file_citation';
3734
+ /**
3735
+ * User provided metadata about the retrieved context.
3736
+ */
3737
+ custom_metadata?: {
3738
+ [key: string]: unknown;
3739
+ };
3704
3740
  /**
3705
3741
  * The URI of the file.
3706
3742
  */
@@ -3713,6 +3749,14 @@ declare interface FileCitation {
3713
3749
  * The name of the file.
3714
3750
  */
3715
3751
  file_name?: string;
3752
+ /**
3753
+ * Media ID in-case of image citations, if applicable.
3754
+ */
3755
+ media_id?: string;
3756
+ /**
3757
+ * Page number of the cited document, if applicable.
3758
+ */
3759
+ page_number?: number;
3716
3760
  /**
3717
3761
  * Source attributed for a portion of the text.
3718
3762
  */
@@ -3755,7 +3799,7 @@ export declare class Files extends BaseModule {
3755
3799
  list: (params?: types.ListFilesParameters) => Promise<Pager<types.File>>;
3756
3800
  /**
3757
3801
  * Uploads a file asynchronously to the Gemini API.
3758
- * This method is not available in Vertex AI.
3802
+ * This method is not available in Gemini Enterprise Agent Platform (previously known as Vertex AI).
3759
3803
  * Supported upload sources:
3760
3804
  * - Node.js: File path (string) or Blob object.
3761
3805
  * - Browser: Blob object (e.g., File).
@@ -3781,7 +3825,7 @@ export declare class Files extends BaseModule {
3781
3825
  * @see {@link types.UploadFileParameters#config} for the optional
3782
3826
  * config in the parameters.
3783
3827
  * @return A promise that resolves to a `types.File` object.
3784
- * @throws An error if called on a Vertex AI client.
3828
+ * @throws An error if called on a Gemini Enterprise Agent Platform (previously known as Vertex AI) client.
3785
3829
  * @throws An error if the `mimeType` is not provided and can not be inferred,
3786
3830
  * the `mimeType` can be provided in the `params.config` parameter.
3787
3831
  * @throws An error occurs if a suitable upload location cannot be established.
@@ -3888,29 +3932,17 @@ declare interface FileSearchResultContent {
3888
3932
  * Required. ID to match the ID from the function call block.
3889
3933
  */
3890
3934
  call_id: string;
3935
+ type: 'file_search_result';
3891
3936
  /**
3892
- * Required. The results of the File Search.
3937
+ * Optional. The results of the File Search.
3893
3938
  */
3894
- result: Array<FileSearchResultContent.Result>;
3895
- type: 'file_search_result';
3939
+ result?: Array<unknown>;
3896
3940
  /**
3897
3941
  * A signature hash for backend validation.
3898
3942
  */
3899
3943
  signature?: string;
3900
3944
  }
3901
3945
 
3902
- declare namespace FileSearchResultContent {
3903
- /**
3904
- * The result of the File Search.
3905
- */
3906
- interface Result {
3907
- /**
3908
- * User provided metadata about the FileSearchResult.
3909
- */
3910
- custom_metadata?: Array<unknown>;
3911
- }
3912
- }
3913
-
3914
3946
  /** A collection of Documents. */
3915
3947
  export declare interface FileSearchStore {
3916
3948
  /** The resource name of the FileSearchStore. Example: `fileSearchStores/my-file-search-store-123` */
@@ -3930,6 +3962,8 @@ export declare interface FileSearchStore {
3930
3962
  /** The size of raw bytes ingested into the FileSearchStore. This is the
3931
3963
  total size of all the documents in the FileSearchStore. */
3932
3964
  sizeBytes?: string;
3965
+ /** The embedding model used by the FileSearchStore. */
3966
+ embeddingModel?: string;
3933
3967
  }
3934
3968
 
3935
3969
  declare class FileSearchStores extends BaseModule {
@@ -3953,7 +3987,7 @@ declare class FileSearchStores extends BaseModule {
3953
3987
  list: (params?: types.ListFileSearchStoresParameters) => Promise<Pager<types.FileSearchStore>>;
3954
3988
  /**
3955
3989
  * Uploads a file asynchronously to a given File Search Store.
3956
- * This method is not available in Vertex AI.
3990
+ * This method is not available in Gemini Enterprise Agent Platform (previously known as Vertex AI).
3957
3991
  * Supported upload sources:
3958
3992
  * - Node.js: File path (string) or Blob object.
3959
3993
  * - Browser: Blob object (e.g., File).
@@ -3972,7 +4006,7 @@ declare class FileSearchStores extends BaseModule {
3972
4006
  * @see {@link types.UploadToFileSearchStoreParameters#config} for the optional
3973
4007
  * config in the parameters.
3974
4008
  * @return A promise that resolves to a long running operation.
3975
- * @throws An error if called on a Vertex AI client.
4009
+ * @throws An error if called on a Gemini Enterprise Agent Platform (previously known as Vertex AI) client.
3976
4010
  * @throws An error if the `mimeType` is not provided and can not be inferred,
3977
4011
  * the `mimeType` can be provided in the `params.config` parameter.
3978
4012
  * @throws An error occurs if a suitable upload location cannot be established.
@@ -3988,6 +4022,15 @@ declare class FileSearchStores extends BaseModule {
3988
4022
  * ```
3989
4023
  */
3990
4024
  uploadToFileSearchStore(params: types.UploadToFileSearchStoreParameters): Promise<types.UploadToFileSearchStoreOperation>;
4025
+ /**
4026
+ * Downloads media using a Media ID or URI.
4027
+ * This method is only supported in the Gemini Developer client.
4028
+ *
4029
+ * @param uri - The URI or Media ID of the blob.
4030
+ * @param config - Optional configuration for the download.
4031
+ * @returns A promise that resolves to the blob data as a Uint8Array.
4032
+ */
4033
+ downloadMedia(uri: string, config?: types.DownloadMediaConfig): Promise<Uint8Array>;
3991
4034
  /**
3992
4035
  * Creates a File Search Store.
3993
4036
  *
@@ -4568,7 +4611,7 @@ export declare interface GenerateContentConfig {
4568
4611
  */
4569
4612
  imageConfig?: ImageConfig;
4570
4613
  /** Enables enhanced civic answers. It may not be available for all
4571
- models. This field is not supported in Vertex AI.
4614
+ models. This field is not supported in Gemini Enterprise Agent Platform.
4572
4615
  */
4573
4616
  enableEnhancedCivicAnswers?: boolean;
4574
4617
  /** Settings for prompt and response sanitization using the Model Armor
@@ -4949,6 +4992,8 @@ export declare interface GenerateVideosConfig {
4949
4992
  /** Webhook configuration for receiving notifications when the
4950
4993
  video generation operation completes. */
4951
4994
  webhookConfig?: WebhookConfig;
4995
+ /** Resize mode of the image input for video generation. */
4996
+ resizeMode?: ImageResizeMode;
4952
4997
  }
4953
4998
 
4954
4999
  /** A video generation operation. */
@@ -5376,8 +5421,23 @@ export declare interface GoogleGenAIOptions {
5376
5421
  * Optional. Determines whether to use the Vertex AI or the Gemini API.
5377
5422
  *
5378
5423
  * @remarks
5424
+ * When true, the {@link https://cloud.google.com/vertex-ai/docs/reference/rest | Gemini Enterprise Agent Platform API} will used.
5425
+ * When false, the {@link https://ai.google.dev/api | Gemini API} will be used.
5426
+ * When both enterprise and vertexai are set, and they have different values,
5427
+ * an Error will be thrown.
5428
+ *
5429
+ * If unset, default SDK behavior is to use the Gemini API service.
5430
+ */
5431
+ enterprise?: boolean;
5432
+ /**
5433
+ * Optional. Determines whether to use the Vertex AI (now Gemini Enterprise Agent Platform) or the Gemini API.
5434
+ * The `enterprise` flag is recommended instead.
5435
+ *
5436
+ * @remarks
5379
5437
  * When true, the {@link https://cloud.google.com/vertex-ai/docs/reference/rest | Vertex AI API} will used.
5380
5438
  * When false, the {@link https://ai.google.dev/api | Gemini API} will be used.
5439
+ * When both enterprise and vertexai are set, and they have different values,
5440
+ * an Error will be thrown.
5381
5441
  *
5382
5442
  * If unset, default SDK behavior is to use the Gemini API service.
5383
5443
  */
@@ -5780,6 +5840,10 @@ export declare interface GroundingChunkRetrievedContext {
5780
5840
  customMetadata?: GroundingChunkCustomMetadata[];
5781
5841
  /** Optional. Name of the `FileSearchStore` containing the document. Example: `fileSearchStores/123`. This field is not supported in Vertex AI. */
5782
5842
  fileSearchStore?: string;
5843
+ /** Optional. Page number of the retrieved context. This field is not supported in Vertex AI. */
5844
+ pageNumber?: number;
5845
+ /** Optional. Media ID. This field is not supported in Vertex AI. */
5846
+ mediaId?: string;
5783
5847
  }
5784
5848
 
5785
5849
  /** A list of string values. This data type is not supported in Vertex AI. */
@@ -6040,7 +6104,7 @@ export declare interface HttpOptions {
6040
6104
  timeout?: number;
6041
6105
  /** Extra parameters to add to the request body.
6042
6106
  The structure must match the backend API's request structure.
6043
- - VertexAI backend API docs: https://cloud.google.com/vertex-ai/docs/reference/rest
6107
+ - Gemini Enterprise Agent Platform backend API docs: https://cloud.google.com/vertex-ai/docs/reference/rest
6044
6108
  - GeminiAPI backend API docs: https://ai.google.dev/api/rest */
6045
6109
  extraBody?: Record<string, unknown>;
6046
6110
  /** HTTP retry options for the request. */
@@ -6228,6 +6292,20 @@ export declare enum ImagePromptLanguage {
6228
6292
  es = "es"
6229
6293
  }
6230
6294
 
6295
+ /** Resize mode for the image input for video generation. */
6296
+ export declare enum ImageResizeMode {
6297
+ /**
6298
+ * Crop the image to fit the correct aspect ratio (so we lose parts
6299
+ of the image in the process).
6300
+ */
6301
+ CROP = "CROP",
6302
+ /**
6303
+ * Pad the image to fit the correct aspect ratio (so we don't lose
6304
+ any parts of the image in the process).
6305
+ */
6306
+ PAD = "PAD"
6307
+ }
6308
+
6231
6309
  /** Image search for grounding and related configurations. */
6232
6310
  export declare interface ImageSearch {
6233
6311
  }
@@ -6351,7 +6429,7 @@ declare interface Interaction {
6351
6429
  /**
6352
6430
  * The name of the `Agent` used for generating the interaction.
6353
6431
  */
6354
- agent?: (string & {}) | 'deep-research-pro-preview-12-2025';
6432
+ agent?: 'deep-research-pro-preview-12-2025' | 'deep-research-preview-04-2026' | 'deep-research-max-preview-04-2026' | (string & {});
6355
6433
  /**
6356
6434
  * Configuration parameters for the agent interaction.
6357
6435
  */
@@ -8001,7 +8079,7 @@ export declare interface Model {
8001
8079
  * The model that will complete your prompt.\n\nSee
8002
8080
  * [models](https://ai.google.dev/gemini-api/docs/models) for additional details.
8003
8081
  */
8004
- declare type Model_2 = 'gemini-2.5-computer-use-preview-10-2025' | 'gemini-2.5-flash' | 'gemini-2.5-flash-image' | 'gemini-2.5-flash-lite' | 'gemini-2.5-flash-lite-preview-09-2025' | 'gemini-2.5-flash-native-audio-preview-12-2025' | 'gemini-2.5-flash-preview-09-2025' | 'gemini-2.5-flash-preview-tts' | 'gemini-2.5-pro' | 'gemini-2.5-pro-preview-tts' | 'gemini-3-flash-preview' | 'gemini-3-pro-image-preview' | 'gemini-3-pro-preview' | 'gemini-3.1-pro-preview' | 'gemini-3.1-flash-image-preview' | 'gemini-3.1-flash-lite-preview' | 'lyria-3-clip-preview' | 'lyria-3-pro-preview' | (string & {});
8082
+ declare type Model_2 = 'gemini-2.5-computer-use-preview-10-2025' | 'gemini-2.5-flash' | 'gemini-2.5-flash-image' | 'gemini-2.5-flash-lite' | 'gemini-2.5-flash-lite-preview-09-2025' | 'gemini-2.5-flash-native-audio-preview-12-2025' | 'gemini-2.5-flash-preview-09-2025' | 'gemini-2.5-flash-preview-tts' | 'gemini-2.5-pro' | 'gemini-2.5-pro-preview-tts' | 'gemini-3-flash-preview' | 'gemini-3-pro-image-preview' | 'gemini-3-pro-preview' | 'gemini-3.1-pro-preview' | 'gemini-3.1-flash-image-preview' | 'gemini-3.1-flash-lite-preview' | 'gemini-3.1-flash-tts-preview' | 'lyria-3-clip-preview' | 'lyria-3-pro-preview' | (string & {});
8005
8083
 
8006
8084
  /** Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. This data type is not supported in Gemini API. */
8007
8085
  export declare interface ModelArmorConfig {
@@ -8039,7 +8117,7 @@ export declare class Models extends BaseModule {
8039
8117
  /**
8040
8118
  * Makes an API request to generate content with a given model.
8041
8119
  *
8042
- * For the `model` parameter, supported formats for Vertex AI API include:
8120
+ * For the `model` parameter, supported formats for Gemini Enterprise Agent Platform API include:
8043
8121
  * - The Gemini model ID, for example: 'gemini-2.0-flash'
8044
8122
  * - The full resource name starts with 'projects/', for example:
8045
8123
  * 'projects/my-project-id/locations/us-central1/publishers/google/models/gemini-2.0-flash'
@@ -8087,7 +8165,7 @@ export declare class Models extends BaseModule {
8087
8165
  * Makes an API request to generate content with a given model and yields the
8088
8166
  * response in chunks.
8089
8167
  *
8090
- * For the `model` parameter, supported formats for Vertex AI API include:
8168
+ * For the `model` parameter, supported formats for Gemini Enterprise Agent Platform API include:
8091
8169
  * - The Gemini model ID, for example: 'gemini-2.0-flash'
8092
8170
  * - The full resource name starts with 'projects/', for example:
8093
8171
  * 'projects/my-project-id/locations/us-central1/publishers/google/models/gemini-2.0-flash'
@@ -8178,7 +8256,7 @@ export declare class Models extends BaseModule {
8178
8256
  editImage: (params: types.EditImageParameters) => Promise<types.EditImageResponse>;
8179
8257
  /**
8180
8258
  * Upscales an image based on an image, upscale factor, and configuration.
8181
- * Only supported in Vertex AI currently.
8259
+ * Only supported in Gemini Enterprise Agent Platform currently.
8182
8260
  *
8183
8261
  * @param params - The parameters for upscaling an image.
8184
8262
  * @return The response from the API.
@@ -10771,7 +10849,7 @@ export declare interface TunedModelInfo {
10771
10849
  export declare interface TuningDataset {
10772
10850
  /** GCS URI of the file containing training dataset in JSONL format. */
10773
10851
  gcsUri?: string;
10774
- /** 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'. */
10852
+ /** 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'. */
10775
10853
  vertexDatasetResource?: string;
10776
10854
  /** Inline examples with simple input/output text. */
10777
10855
  examples?: TuningExample[];
@@ -11022,7 +11100,7 @@ export declare enum TuningTask {
11022
11100
  export declare interface TuningValidationDataset {
11023
11101
  /** GCS URI of the file containing validation dataset in JSONL format. */
11024
11102
  gcsUri?: string;
11025
- /** 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'. */
11103
+ /** 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'. */
11026
11104
  vertexDatasetResource?: string;
11027
11105
  }
11028
11106
 
@@ -11270,6 +11348,7 @@ declare namespace types {
11270
11348
  VideoGenerationReferenceType,
11271
11349
  VideoGenerationMaskMode,
11272
11350
  VideoCompressionQuality,
11351
+ ImageResizeMode,
11273
11352
  TuningMethod,
11274
11353
  FileState,
11275
11354
  FileSource,
@@ -11587,6 +11666,7 @@ declare namespace types {
11587
11666
  RegisterFilesResponse,
11588
11667
  InlinedRequest,
11589
11668
  BatchJobSource,
11669
+ VertexMultimodalDatasetDestination,
11590
11670
  JobError,
11591
11671
  InlinedResponse,
11592
11672
  SingleEmbedContentResponse,
@@ -11594,6 +11674,7 @@ declare namespace types {
11594
11674
  BatchJobDestination,
11595
11675
  CreateBatchJobConfig,
11596
11676
  CreateBatchJobParameters,
11677
+ BatchJobOutputInfo,
11597
11678
  CompletionStats,
11598
11679
  BatchJob,
11599
11680
  EmbedContentBatch,
@@ -11697,6 +11778,7 @@ declare namespace types {
11697
11778
  EmbedContentParameters,
11698
11779
  UploadToFileSearchStoreResponse,
11699
11780
  UploadToFileSearchStoreOperation,
11781
+ DownloadMediaConfig,
11700
11782
  BlobImageUnion,
11701
11783
  PartUnion,
11702
11784
  PartListUnion,
@@ -12130,6 +12212,10 @@ declare interface Usage {
12130
12212
  * A breakdown of cached token usage by modality.
12131
12213
  */
12132
12214
  cached_tokens_by_modality?: Array<Usage.CachedTokensByModality>;
12215
+ /**
12216
+ * Grounding tool count.
12217
+ */
12218
+ grounding_tool_count?: Array<Usage.GroundingToolCount>;
12133
12219
  /**
12134
12220
  * A breakdown of input token usage by modality.
12135
12221
  */
@@ -12183,6 +12269,19 @@ declare namespace Usage {
12183
12269
  */
12184
12270
  tokens?: number;
12185
12271
  }
12272
+ /**
12273
+ * The number of grounding tool counts.
12274
+ */
12275
+ interface GroundingToolCount {
12276
+ /**
12277
+ * The number of grounding tool counts.
12278
+ */
12279
+ count?: number;
12280
+ /**
12281
+ * The grounding tool type associated with the count.
12282
+ */
12283
+ type?: 'google_search' | 'google_maps' | 'retrieval';
12284
+ }
12186
12285
  /**
12187
12286
  * The token count for a single response modality.
12188
12287
  */
@@ -12311,6 +12410,16 @@ export declare interface VertexAISearchDataStoreSpec {
12311
12410
  filter?: string;
12312
12411
  }
12313
12412
 
12413
+ /** This class is experimental and may change in future versions.
12414
+
12415
+ The specification for an output Vertex AI multimodal dataset. */
12416
+ export declare interface VertexMultimodalDatasetDestination {
12417
+ /** The BigQuery destination for the multimodal dataset. */
12418
+ bigqueryDestination?: string;
12419
+ /** The display name of the multimodal dataset. */
12420
+ displayName?: string;
12421
+ }
12422
+
12314
12423
  /** Retrieve from Vertex RAG Store for grounding. This data type is not supported in Gemini API. */
12315
12424
  export declare interface VertexRagStore {
12316
12425
  /** Optional. Deprecated. Please use rag_resources instead. */
@@ -12499,26 +12608,28 @@ declare interface Webhook {
12499
12608
  * Required. The events that the webhook is subscribed to. Available events:
12500
12609
  *
12501
12610
  * - batch.succeeded
12502
- * - batch.cancelled
12503
12611
  * - batch.expired
12504
12612
  * - batch.failed
12505
12613
  * - interaction.requires_action
12506
12614
  * - interaction.completed
12507
12615
  * - interaction.failed
12508
- * - interaction.cancelled
12509
12616
  * - video.generated
12510
12617
  */
12511
- subscribed_events: Array<'batch.succeeded' | 'batch.cancelled' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'interaction.cancelled' | 'video.generated' | (string & {})>;
12618
+ subscribed_events: Array<'batch.succeeded' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'video.generated' | (string & {})>;
12512
12619
  /**
12513
12620
  * Required. The URI to which webhook events will be sent.
12514
12621
  */
12515
12622
  uri: string;
12623
+ /**
12624
+ * Output only. The ID of the webhook.
12625
+ */
12626
+ id?: string;
12516
12627
  /**
12517
12628
  * Output only. The timestamp when the webhook was created.
12518
12629
  */
12519
12630
  create_time?: string;
12520
12631
  /**
12521
- * Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`
12632
+ * Optional. The user-provided name of the webhook.
12522
12633
  */
12523
12634
  name?: string;
12524
12635
  /**
@@ -12530,7 +12641,7 @@ declare interface Webhook {
12530
12641
  */
12531
12642
  signing_secrets?: Array<SigningSecret>;
12532
12643
  /**
12533
- * The state of the webhook.
12644
+ * Output only. The state of the webhook.
12534
12645
  */
12535
12646
  state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12536
12647
  /**
@@ -12581,33 +12692,22 @@ declare interface WebhookCreateParams {
12581
12692
  * events:
12582
12693
  *
12583
12694
  * - batch.succeeded
12584
- * - batch.cancelled
12585
12695
  * - batch.expired
12586
12696
  * - batch.failed
12587
12697
  * - interaction.requires_action
12588
12698
  * - interaction.completed
12589
12699
  * - interaction.failed
12590
- * - interaction.cancelled
12591
12700
  * - video.generated
12592
12701
  */
12593
- subscribed_events: Array<'batch.succeeded' | 'batch.cancelled' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'interaction.cancelled' | 'video.generated' | (string & {})>;
12702
+ subscribed_events: Array<'batch.succeeded' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'video.generated' | (string & {})>;
12594
12703
  /**
12595
12704
  * Body param: Required. The URI to which webhook events will be sent.
12596
12705
  */
12597
12706
  uri: string;
12598
12707
  /**
12599
- * Query param: Optional. The webhook_id to use for the webhook. If not specified,
12600
- * the server will generate a unique ID.
12601
- */
12602
- webhook_id?: string;
12603
- /**
12604
- * Body param: Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`
12708
+ * Body param: Optional. The user-provided name of the webhook.
12605
12709
  */
12606
12710
  name?: string;
12607
- /**
12608
- * Body param: The state of the webhook.
12609
- */
12610
- state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12611
12711
  }
12612
12712
 
12613
12713
  declare interface WebhookDeleteParams {
@@ -12728,36 +12828,34 @@ declare interface WebhookUpdateParams {
12728
12828
  */
12729
12829
  api_version?: string;
12730
12830
  /**
12731
- * Body param: Required. The events that the webhook is subscribed to. Available
12831
+ * Query param: Optional. The list of fields to update.
12832
+ */
12833
+ update_mask?: string;
12834
+ /**
12835
+ * Body param: Optional. The user-provided name of the webhook.
12836
+ */
12837
+ name?: string;
12838
+ /**
12839
+ * Body param: Optional. The state of the webhook.
12840
+ */
12841
+ state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12842
+ /**
12843
+ * Body param: Optional. The events that the webhook is subscribed to. Available
12732
12844
  * events:
12733
12845
  *
12734
12846
  * - batch.succeeded
12735
- * - batch.cancelled
12736
12847
  * - batch.expired
12737
12848
  * - batch.failed
12738
12849
  * - interaction.requires_action
12739
12850
  * - interaction.completed
12740
12851
  * - interaction.failed
12741
- * - interaction.cancelled
12742
12852
  * - video.generated
12743
12853
  */
12744
- subscribed_events: Array<'batch.succeeded' | 'batch.cancelled' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'interaction.cancelled' | 'video.generated' | (string & {})>;
12854
+ subscribed_events?: Array<'batch.succeeded' | 'batch.expired' | 'batch.failed' | 'interaction.requires_action' | 'interaction.completed' | 'interaction.failed' | 'video.generated' | (string & {})>;
12745
12855
  /**
12746
- * Body param: Required. The URI to which webhook events will be sent.
12856
+ * Body param: Optional. The URI to which webhook events will be sent.
12747
12857
  */
12748
- uri: string;
12749
- /**
12750
- * Query param: Optional. The list of fields to update.
12751
- */
12752
- update_mask?: string;
12753
- /**
12754
- * Body param: Identifier. The name of the webhook. Format: `webhooks/{webhook_id}`
12755
- */
12756
- name?: string;
12757
- /**
12758
- * Body param: The state of the webhook.
12759
- */
12760
- state?: 'enabled' | 'disabled' | 'disabled_due_to_failed_deliveries';
12858
+ uri?: string;
12761
12859
  }
12762
12860
 
12763
12861
  /** Standard web search for grounding and related configurations. Only text results are returned. */