@google/genai 1.27.0 → 1.28.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/web/web.d.ts CHANGED
@@ -32,7 +32,7 @@ export declare enum ActivityHandling {
32
32
  export declare interface ActivityStart {
33
33
  }
34
34
 
35
- /** Optional. Adapter size for tuning. */
35
+ /** Adapter size for tuning. This enum is not supported in Gemini API. */
36
36
  export declare enum AdapterSize {
37
37
  /**
38
38
  * Adapter size is unspecified.
@@ -114,13 +114,13 @@ declare class ApiClient {
114
114
  setBaseUrl(url: string): void;
115
115
  private constructUrl;
116
116
  private shouldPrependVertexProjectPath;
117
- request(request: HttpRequest): Promise<HttpResponse>;
117
+ request(request: HttpRequest): Promise<types.HttpResponse>;
118
118
  private patchHttpOptions;
119
- requestStream(request: HttpRequest): Promise<AsyncGenerator<HttpResponse>>;
119
+ requestStream(request: HttpRequest): Promise<AsyncGenerator<types.HttpResponse>>;
120
120
  private includeExtraHttpOptionsToRequestInit;
121
121
  private unaryApiCall;
122
122
  private streamApiCall;
123
- processStreamResponse(response: Response): AsyncGenerator<HttpResponse>;
123
+ processStreamResponse(response: Response): AsyncGenerator<types.HttpResponse>;
124
124
  private apiCall;
125
125
  getDefaultHeaders(): Record<string, string>;
126
126
  private getHeadersInternal;
@@ -130,19 +130,19 @@ declare class ApiClient {
130
130
  *
131
131
  * @param file The string path to the file to be uploaded or a Blob object.
132
132
  * @param config Optional parameters specified in the `UploadFileConfig`
133
- * interface. @see {@link UploadFileConfig}
133
+ * interface. @see {@link types.UploadFileConfig}
134
134
  * @return A promise that resolves to a `File` object.
135
135
  * @throws An error if called on a Vertex AI client.
136
136
  * @throws An error if the `mimeType` is not provided and can not be inferred,
137
137
  */
138
- uploadFile(file: string | Blob, config?: UploadFileConfig): Promise<File_2>;
138
+ uploadFile(file: string | Blob, config?: types.UploadFileConfig): Promise<types.File>;
139
139
  /**
140
140
  * Downloads a file asynchronously to the specified path.
141
141
  *
142
142
  * @params params - The parameters for the download request, see {@link
143
- * DownloadFileParameters}
143
+ * types.DownloadFileParameters}
144
144
  */
145
- downloadFile(params: DownloadFileParameters): Promise<void>;
145
+ downloadFile(params: types.DownloadFileParameters): Promise<void>;
146
146
  private fetchUploadUrl;
147
147
  }
148
148
 
@@ -195,7 +195,7 @@ declare interface ApiClientInitOptions {
195
195
  /**
196
196
  * Optional. A set of customizable configuration for HTTP requests.
197
197
  */
198
- httpOptions?: HttpOptions;
198
+ httpOptions?: types.HttpOptions;
199
199
  /**
200
200
  * Optional. An extra string to append at the end of the User-Agent header.
201
201
  *
@@ -234,7 +234,7 @@ export declare interface ApiKeyConfig {
234
234
  apiKeyString?: string;
235
235
  }
236
236
 
237
- /** The API spec that the external API implements. */
237
+ /** The API spec that the external API implements. This enum is not supported in Gemini API. */
238
238
  export declare enum ApiSpec {
239
239
  /**
240
240
  * Unspecified API spec. This value should not be used.
@@ -333,7 +333,7 @@ export declare interface AuthToken {
333
333
  name?: string;
334
334
  }
335
335
 
336
- /** Type of auth scheme. */
336
+ /** Type of auth scheme. This enum is not supported in Gemini API. */
337
337
  export declare enum AuthType {
338
338
  AUTH_TYPE_UNSPECIFIED = "AUTH_TYPE_UNSPECIFIED",
339
339
  /**
@@ -635,11 +635,11 @@ export declare enum Behavior {
635
635
 
636
636
  /** Content blob. */
637
637
  declare interface Blob_2 {
638
- /** Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is not currently used in the Gemini GenerateContent calls. */
639
- displayName?: string;
640
638
  /** Required. Raw bytes.
641
639
  * @remarks Encoded as base64 string. */
642
640
  data?: string;
641
+ /** Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. This field is not supported in Gemini API. */
642
+ displayName?: string;
643
643
  /** Required. The IANA standard MIME type of the source data. */
644
644
  mimeType?: string;
645
645
  }
@@ -896,8 +896,6 @@ export declare interface Candidate {
896
896
  If empty, the model has not stopped generating the tokens.
897
897
  */
898
898
  finishReason?: FinishReason;
899
- /** Metadata related to url context retrieval tool. */
900
- urlContextMetadata?: UrlContextMetadata;
901
899
  /** Output only. Average log probability score of the candidate. */
902
900
  avgLogprobs?: number;
903
901
  /** Output only. Metadata specifies sources used to ground generated content. */
@@ -908,6 +906,8 @@ export declare interface Candidate {
908
906
  logprobsResult?: LogprobsResult;
909
907
  /** Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */
910
908
  safetyRatings?: SafetyRating[];
909
+ /** Output only. Metadata related to url context retrieval tool. */
910
+ urlContextMetadata?: UrlContextMetadata;
911
911
  }
912
912
 
913
913
  /**
@@ -1125,9 +1125,7 @@ export declare interface Content {
1125
1125
  /** List of parts that constitute a single message. Each part may have
1126
1126
  a different IANA MIME type. */
1127
1127
  parts?: Part[];
1128
- /** Optional. The producer of the content. Must be either 'user' or
1129
- 'model'. Useful to set for multi-turn conversations, otherwise can be
1130
- empty. If role is not specified, SDK will determine the role. */
1128
+ /** Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. */
1131
1129
  role?: string;
1132
1130
  }
1133
1131
 
@@ -1528,7 +1526,7 @@ export declare function createPartFromText(text: string): Part;
1528
1526
  */
1529
1527
  export declare function createPartFromUri(uri: string, mimeType: string): Part;
1530
1528
 
1531
- /** Supervised fine-tuning job creation request - optional fields. */
1529
+ /** Fine-tuning job creation request - optional fields. */
1532
1530
  export declare interface CreateTuningJobConfig {
1533
1531
  /** Used to override HTTP request options. */
1534
1532
  httpOptions?: HttpOptions;
@@ -1539,6 +1537,8 @@ export declare interface CreateTuningJobConfig {
1539
1537
  be charged usage for any applicable operations.
1540
1538
  */
1541
1539
  abortSignal?: AbortSignal;
1540
+ /** The method to use for tuning (SUPERVISED_FINE_TUNING or PREFERENCE_TUNING). If not set, the default method (SFT) will be used. */
1541
+ method?: TuningMethod;
1542
1542
  /** Validation dataset for tuning. The dataset must be formatted as a JSONL file. */
1543
1543
  validationDataset?: TuningValidationDataset;
1544
1544
  /** The display name of the tuned Model. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
@@ -1549,7 +1549,7 @@ export declare interface CreateTuningJobConfig {
1549
1549
  epochCount?: number;
1550
1550
  /** Multiplier for adjusting the default learning rate. */
1551
1551
  learningRateMultiplier?: number;
1552
- /** If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. */
1552
+ /** If set to true, disable intermediate checkpoints and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints. */
1553
1553
  exportLastCheckpointOnly?: boolean;
1554
1554
  /** The optional checkpoint id of the pre-tuned model to use for tuning, if applicable. */
1555
1555
  preTunedModelCheckpointId?: string;
@@ -1561,9 +1561,11 @@ export declare interface CreateTuningJobConfig {
1561
1561
  learningRate?: number;
1562
1562
  /** Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. */
1563
1563
  labels?: Record<string, string>;
1564
+ /** Weight for KL Divergence regularization, Preference Optimization tuning only. */
1565
+ beta?: number;
1564
1566
  }
1565
1567
 
1566
- /** Supervised fine-tuning job creation parameters - optional fields. */
1568
+ /** Fine-tuning job creation parameters - optional fields. */
1567
1569
  export declare interface CreateTuningJobParameters {
1568
1570
  /** The base model that is being tuned, e.g., "gemini-2.5-flash". */
1569
1571
  baseModel: string;
@@ -1573,7 +1575,7 @@ export declare interface CreateTuningJobParameters {
1573
1575
  config?: CreateTuningJobConfig;
1574
1576
  }
1575
1577
 
1576
- /** Supervised fine-tuning job creation parameters - optional fields. */
1578
+ /** Fine-tuning job creation parameters - optional fields. */
1577
1579
  export declare interface CreateTuningJobParametersPrivate {
1578
1580
  /** The base model that is being tuned, e.g., "gemini-2.5-flash". */
1579
1581
  baseModel?: string;
@@ -2021,7 +2023,7 @@ export declare enum EndSensitivity {
2021
2023
  END_SENSITIVITY_LOW = "END_SENSITIVITY_LOW"
2022
2024
  }
2023
2025
 
2024
- /** Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. */
2026
+ /** Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. This data type is not supported in Gemini API. */
2025
2027
  export declare interface EnterpriseWebSearch {
2026
2028
  /** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. */
2027
2029
  excludeDomains?: string[];
@@ -2149,7 +2151,7 @@ export { File_2 as File }
2149
2151
 
2150
2152
  /** URI based data. */
2151
2153
  export declare interface FileData {
2152
- /** Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. It is not currently used in the Gemini GenerateContent calls. */
2154
+ /** Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. This field is not supported in Gemini API. */
2153
2155
  displayName?: string;
2154
2156
  /** Required. URI. */
2155
2157
  fileUri?: string;
@@ -3452,14 +3454,12 @@ export declare interface GoogleRpcStatus {
3452
3454
  message?: string;
3453
3455
  }
3454
3456
 
3455
- /** Tool to support Google Search in Model. Powered by Google. */
3457
+ /** GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
3456
3458
  export declare interface GoogleSearch {
3457
- /** Optional. Filter search results to a specific time range.
3458
- If customers set a start time, they must set an end time (and vice versa).
3459
- */
3460
- timeRangeFilter?: Interval;
3461
3459
  /** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. This field is not supported in Gemini API. */
3462
3460
  excludeDomains?: string[];
3461
+ /** Optional. Filter search results to a specific time range. If customers set a start time, they must set an end time (and vice versa). This field is not supported in Vertex AI. */
3462
+ timeRangeFilter?: Interval;
3463
3463
  }
3464
3464
 
3465
3465
  /** Tool to retrieve public web data for grounding, powered by Google. */
@@ -3600,7 +3600,7 @@ export declare interface GroundingSupport {
3600
3600
  segment?: Segment;
3601
3601
  }
3602
3602
 
3603
- /** Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. */
3603
+ /** Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. This enum is not supported in Gemini API. */
3604
3604
  export declare enum HarmBlockMethod {
3605
3605
  /**
3606
3606
  * The harm block method is unspecified.
@@ -3616,7 +3616,7 @@ export declare enum HarmBlockMethod {
3616
3616
  PROBABILITY = "PROBABILITY"
3617
3617
  }
3618
3618
 
3619
- /** Required. The harm block threshold. */
3619
+ /** The harm block threshold. */
3620
3620
  export declare enum HarmBlockThreshold {
3621
3621
  /**
3622
3622
  * Unspecified harm block threshold.
@@ -3644,7 +3644,7 @@ export declare enum HarmBlockThreshold {
3644
3644
  OFF = "OFF"
3645
3645
  }
3646
3646
 
3647
- /** Required. Harm category. */
3647
+ /** Harm category. */
3648
3648
  export declare enum HarmCategory {
3649
3649
  /**
3650
3650
  * The harm category is unspecified.
@@ -3716,7 +3716,7 @@ export declare enum HarmProbability {
3716
3716
  HIGH = "HIGH"
3717
3717
  }
3718
3718
 
3719
- /** Output only. Harm severity levels in the content. */
3719
+ /** Output only. Harm severity levels in the content. This enum is not supported in Gemini API. */
3720
3720
  export declare enum HarmSeverity {
3721
3721
  /**
3722
3722
  * Harm severity unspecified.
@@ -3799,7 +3799,7 @@ declare interface HttpRequest {
3799
3799
  /**
3800
3800
  * Optional set of customizable configuration for HTTP requests.
3801
3801
  */
3802
- httpOptions?: HttpOptions;
3802
+ httpOptions?: types.HttpOptions;
3803
3803
  /**
3804
3804
  * Optional abort signal which can be used to cancel the request.
3805
3805
  */
@@ -3910,17 +3910,12 @@ export declare class InlinedResponse {
3910
3910
  error?: JobError;
3911
3911
  }
3912
3912
 
3913
- /** Represents a time interval, encoded as a start time (inclusive) and an end time (exclusive).
3914
-
3915
- The start time must be less than or equal to the end time.
3916
- When the start equals the end time, the interval is an empty interval.
3917
- (matches no time)
3918
- When both start and end are unspecified, the interval matches any time. */
3913
+ /** Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. */
3919
3914
  export declare interface Interval {
3920
- /** The start time of the interval. */
3921
- startTime?: string;
3922
- /** The end time of the interval. */
3915
+ /** Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. */
3923
3916
  endTime?: string;
3917
+ /** Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. */
3918
+ startTime?: string;
3924
3919
  }
3925
3920
 
3926
3921
  /** Job error. */
@@ -3985,7 +3980,7 @@ export declare enum JobState {
3985
3980
  JOB_STATE_PARTIALLY_SUCCEEDED = "JOB_STATE_PARTIALLY_SUCCEEDED"
3986
3981
  }
3987
3982
 
3988
- /** Required. Programming language of the `code`. */
3983
+ /** Programming language of the `code`. */
3989
3984
  export declare enum Language {
3990
3985
  /**
3991
3986
  * Unspecified language. This value should not be used.
@@ -5494,9 +5489,9 @@ export declare interface ModelSelectionConfig {
5494
5489
  featureSelectionPreference?: FeatureSelectionPreference;
5495
5490
  }
5496
5491
 
5497
- /** The configuration for the multi-speaker setup. */
5492
+ /** The configuration for the multi-speaker setup. This data type is not supported in Vertex AI. */
5498
5493
  export declare interface MultiSpeakerVoiceConfig {
5499
- /** The configuration for the speaker to use. */
5494
+ /** Required. All the enabled speaker voices. */
5500
5495
  speakerVoiceConfigs?: SpeakerVoiceConfig[];
5501
5496
  }
5502
5497
 
@@ -5579,7 +5574,7 @@ export declare class Operations extends BaseModule {
5579
5574
  private fetchPredictVideosOperationInternal;
5580
5575
  }
5581
5576
 
5582
- /** Required. Outcome of the code execution. */
5577
+ /** Outcome of the code execution. */
5583
5578
  export declare enum Outcome {
5584
5579
  /**
5585
5580
  * Unspecified status. This value should not be used.
@@ -5604,10 +5599,13 @@ export declare enum PagedItem {
5604
5599
  PAGED_ITEM_MODELS = "models",
5605
5600
  PAGED_ITEM_TUNING_JOBS = "tuningJobs",
5606
5601
  PAGED_ITEM_FILES = "files",
5607
- PAGED_ITEM_CACHED_CONTENTS = "cachedContents"
5602
+ PAGED_ITEM_CACHED_CONTENTS = "cachedContents",
5603
+ PAGED_ITEM_RAG_STORES = "ragStores",
5604
+ PAGED_ITEM_DOCUMENTS = "documents"
5608
5605
  }
5609
5606
 
5610
5607
  declare interface PagedItemConfig {
5608
+ parent?: string;
5611
5609
  config?: {
5612
5610
  pageToken?: string;
5613
5611
  pageSize?: number;
@@ -5622,6 +5620,8 @@ declare interface PagedItemResponse<T> {
5622
5620
  tuningJobs?: T[];
5623
5621
  files?: T[];
5624
5622
  cachedContents?: T[];
5623
+ ragStores?: T[];
5624
+ documents?: T[];
5625
5625
  }
5626
5626
 
5627
5627
  /**
@@ -5730,17 +5730,6 @@ export declare class Pager<T> implements AsyncIterable<T> {
5730
5730
  of content being conveyed. Using multiple fields within the same `Part`
5731
5731
  instance is considered invalid. */
5732
5732
  export declare interface Part {
5733
- /** Metadata for a given video. */
5734
- videoMetadata?: VideoMetadata;
5735
- /** Indicates if the part is thought from the model. */
5736
- thought?: boolean;
5737
- /** Optional. Inlined bytes data. */
5738
- inlineData?: Blob_2;
5739
- /** Optional. URI based data. */
5740
- fileData?: FileData;
5741
- /** An opaque signature for the thought so it can be reused in subsequent requests.
5742
- * @remarks Encoded as base64 string. */
5743
- thoughtSignature?: string;
5744
5733
  /** A predicted [FunctionCall] returned from the model that contains a string
5745
5734
  representing the [FunctionDeclaration.name] and a structured JSON object
5746
5735
  containing the parameters and their values. */
@@ -5749,10 +5738,21 @@ export declare interface Part {
5749
5738
  codeExecutionResult?: CodeExecutionResult;
5750
5739
  /** Optional. Code generated by the model that is meant to be executed. */
5751
5740
  executableCode?: ExecutableCode;
5741
+ /** Optional. URI based data. */
5742
+ fileData?: FileData;
5752
5743
  /** Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. */
5753
5744
  functionResponse?: FunctionResponse;
5745
+ /** Optional. Inlined bytes data. */
5746
+ inlineData?: Blob_2;
5754
5747
  /** Optional. Text part (can be code). */
5755
5748
  text?: string;
5749
+ /** Optional. Indicates if the part is thought from the model. */
5750
+ thought?: boolean;
5751
+ /** Optional. An opaque signature for the thought so it can be reused in subsequent requests.
5752
+ * @remarks Encoded as base64 string. */
5753
+ thoughtSignature?: string;
5754
+ /** Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. */
5755
+ videoMetadata?: VideoMetadata;
5756
5756
  }
5757
5757
 
5758
5758
  export declare type PartListUnion = PartUnion[] | PartUnion;
@@ -5787,7 +5787,7 @@ export declare enum PersonGeneration {
5787
5787
 
5788
5788
  /** The configuration for the prebuilt speaker to use. */
5789
5789
  export declare interface PrebuiltVoiceConfig {
5790
- /** The name of the prebuilt voice to use. */
5790
+ /** The name of the preset voice to use. */
5791
5791
  voiceName?: string;
5792
5792
  }
5793
5793
 
@@ -5811,6 +5811,28 @@ export declare interface PreferenceOptimizationDataStats {
5811
5811
  userOutputTokenDistribution?: DatasetDistribution;
5812
5812
  }
5813
5813
 
5814
+ /** Hyperparameters for Preference Optimization. This data type is not supported in Gemini API. */
5815
+ export declare interface PreferenceOptimizationHyperParameters {
5816
+ /** Optional. Adapter size for preference optimization. */
5817
+ adapterSize?: AdapterSize;
5818
+ /** Optional. Weight for KL Divergence regularization. */
5819
+ beta?: number;
5820
+ /** Optional. Number of complete passes the model makes over the entire training dataset during training. */
5821
+ epochCount?: string;
5822
+ /** Optional. Multiplier for adjusting the default learning rate. */
5823
+ learningRateMultiplier?: number;
5824
+ }
5825
+
5826
+ /** Preference optimization tuning spec for tuning. */
5827
+ export declare interface PreferenceOptimizationSpec {
5828
+ /** Optional. Hyperparameters for Preference Optimization. */
5829
+ hyperParameters?: PreferenceOptimizationHyperParameters;
5830
+ /** Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. */
5831
+ trainingDatasetUri?: string;
5832
+ /** Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. */
5833
+ validationDatasetUri?: string;
5834
+ }
5835
+
5814
5836
  /** A pre-tuned model for continuous tuning. This data type is not supported in Gemini API. */
5815
5837
  export declare interface PreTunedModel {
5816
5838
  /** Output only. The name of the base model this PreTunedModel was tuned from. */
@@ -6094,13 +6116,13 @@ export declare interface SafetyRating {
6094
6116
  blocked?: boolean;
6095
6117
  /** Output only. Harm category. */
6096
6118
  category?: HarmCategory;
6097
- /** Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. */
6119
+ /** Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. This field is not supported in Gemini API. */
6098
6120
  overwrittenThreshold?: HarmBlockThreshold;
6099
6121
  /** Output only. Harm probability levels in the content. */
6100
6122
  probability?: HarmProbability;
6101
6123
  /** Output only. Harm probability score. This field is not supported in Gemini API. */
6102
6124
  probabilityScore?: number;
6103
- /** Output only. Harm severity levels in the content. */
6125
+ /** Output only. Harm severity levels in the content. This field is not supported in Gemini API. */
6104
6126
  severity?: HarmSeverity;
6105
6127
  /** Output only. Harm severity score. This field is not supported in Gemini API. */
6106
6128
  severityScore?: number;
@@ -6108,11 +6130,10 @@ export declare interface SafetyRating {
6108
6130
 
6109
6131
  /** Safety settings. */
6110
6132
  export declare interface SafetySetting {
6111
- /** Determines if the harm block method uses probability or probability
6112
- and severity scores. */
6113
- method?: HarmBlockMethod;
6114
6133
  /** Required. Harm category. */
6115
6134
  category?: HarmCategory;
6135
+ /** Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. This field is not supported in Gemini API. */
6136
+ method?: HarmBlockMethod;
6116
6137
  /** Required. The harm block threshold. */
6117
6138
  threshold?: HarmBlockThreshold;
6118
6139
  }
@@ -6526,28 +6547,22 @@ export declare interface SlidingWindow {
6526
6547
  targetTokens?: string;
6527
6548
  }
6528
6549
 
6529
- /** The configuration for the speaker to use. */
6550
+ /** The configuration for a single speaker in a multi speaker setup. This data type is not supported in Vertex AI. */
6530
6551
  export declare interface SpeakerVoiceConfig {
6531
- /** The name of the speaker to use. Should be the same as in the
6532
- prompt. */
6552
+ /** Required. The name of the speaker to use. Should be the same as in the prompt. */
6533
6553
  speaker?: string;
6534
- /** The configuration for the voice to use. */
6554
+ /** Required. The configuration for the voice to use. */
6535
6555
  voiceConfig?: VoiceConfig;
6536
6556
  }
6537
6557
 
6538
- /** The speech generation configuration. */
6558
+ /** The speech generation config. */
6539
6559
  export declare interface SpeechConfig {
6540
- /** The configuration for the speaker to use.
6541
- */
6560
+ /** Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. */
6561
+ languageCode?: string;
6562
+ /** The configuration for the speaker to use. */
6542
6563
  voiceConfig?: VoiceConfig;
6543
- /** The configuration for the multi-speaker setup.
6544
- It is mutually exclusive with the voice_config field.
6545
- */
6564
+ /** Optional. The configuration for the multi-speaker setup. It is mutually exclusive with the voice_config field. This field is not supported in Vertex AI. */
6546
6565
  multiSpeakerVoiceConfig?: MultiSpeakerVoiceConfig;
6547
- /** Language code (ISO 639. e.g. en-US) for the speech synthesization.
6548
- Only available for Live API.
6549
- */
6550
- languageCode?: string;
6551
6566
  }
6552
6567
 
6553
6568
  export declare type SpeechConfigUnion = SpeechConfig | string;
@@ -6703,7 +6718,7 @@ export declare interface SupervisedTuningDataStats {
6703
6718
  userOutputTokenDistribution?: SupervisedTuningDatasetDistribution;
6704
6719
  }
6705
6720
 
6706
- /** Tuning Spec for Supervised Tuning for first party models. This data type is not supported in Gemini API. */
6721
+ /** Supervised tuning spec for tuning. */
6707
6722
  export declare interface SupervisedTuningSpec {
6708
6723
  /** Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false. */
6709
6724
  exportLastCheckpointOnly?: boolean;
@@ -6859,25 +6874,23 @@ export declare interface Tool {
6859
6874
  functionDeclarations?: FunctionDeclaration[];
6860
6875
  /** Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. This field is not supported in Gemini API. */
6861
6876
  retrieval?: Retrieval;
6862
- /** Optional. Google Search tool type. Specialized retrieval tool
6863
- that is powered by Google Search. */
6864
- googleSearch?: GoogleSearch;
6865
6877
  /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
6866
6878
  googleSearchRetrieval?: GoogleSearchRetrieval;
6867
- /** Optional. Enterprise web search tool type. Specialized retrieval
6868
- tool that is powered by Vertex AI Search and Sec4 compliance. */
6869
- enterpriseWebSearch?: EnterpriseWebSearch;
6870
6879
  /** Optional. Google Maps tool type. Specialized retrieval tool
6871
6880
  that is powered by Google Maps. */
6872
6881
  googleMaps?: GoogleMaps;
6873
- /** Optional. Tool to support URL context retrieval. */
6874
- urlContext?: UrlContext;
6875
6882
  /** Optional. Tool to support the model interacting directly with the
6876
6883
  computer. If enabled, it automatically populates computer-use specific
6877
6884
  Function Declarations. */
6878
6885
  computerUse?: ComputerUse;
6879
6886
  /** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
6880
6887
  codeExecution?: ToolCodeExecution;
6888
+ /** Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. This field is not supported in Gemini API. */
6889
+ enterpriseWebSearch?: EnterpriseWebSearch;
6890
+ /** Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
6891
+ googleSearch?: GoogleSearch;
6892
+ /** Optional. Tool to support URL context retrieval. */
6893
+ urlContext?: UrlContext;
6881
6894
  }
6882
6895
 
6883
6896
  /** Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. This data type is not supported in Gemini API. */
@@ -6898,7 +6911,7 @@ export declare type ToolListUnion = ToolUnion[];
6898
6911
 
6899
6912
  export declare type ToolUnion = Tool | CallableTool;
6900
6913
 
6901
- /** Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. */
6914
+ /** Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. This enum is not supported in Gemini API. */
6902
6915
  export declare enum TrafficType {
6903
6916
  /**
6904
6917
  * Unspecified request traffic type.
@@ -7026,6 +7039,8 @@ export declare interface TuningJob {
7026
7039
  preTunedModel?: PreTunedModel;
7027
7040
  /** Tuning Spec for Supervised Fine Tuning. */
7028
7041
  supervisedTuningSpec?: SupervisedTuningSpec;
7042
+ /** Tuning Spec for Preference Optimization. */
7043
+ preferenceOptimizationSpec?: PreferenceOptimizationSpec;
7029
7044
  /** Output only. The tuning data statistics associated with this TuningJob. */
7030
7045
  tuningDataStats?: TuningDataStats;
7031
7046
  /** Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key. */
@@ -7050,7 +7065,19 @@ export declare interface TuningJob {
7050
7065
  veoTuningSpec?: VeoTuningSpec;
7051
7066
  }
7052
7067
 
7053
- /** Tuning mode. */
7068
+ /** Enum representing the tuning method. */
7069
+ export declare enum TuningMethod {
7070
+ /**
7071
+ * Supervised fine tuning.
7072
+ */
7073
+ SUPERVISED_FINE_TUNING = "SUPERVISED_FINE_TUNING",
7074
+ /**
7075
+ * Preference optimization tuning.
7076
+ */
7077
+ PREFERENCE_TUNING = "PREFERENCE_TUNING"
7078
+ }
7079
+
7080
+ /** Tuning mode. This enum is not supported in Gemini API. */
7054
7081
  export declare enum TuningMode {
7055
7082
  /**
7056
7083
  * Tuning mode is unspecified.
@@ -7131,7 +7158,7 @@ declare class Tunings extends BaseModule {
7131
7158
  private tuneMldevInternal;
7132
7159
  }
7133
7160
 
7134
- /** Optional. The tuning task. Either I2V or T2V. */
7161
+ /** The tuning task. Either I2V or T2V. This enum is not supported in Gemini API. */
7135
7162
  export declare enum TuningTask {
7136
7163
  /**
7137
7164
  * Default value. This value is unused.
@@ -7190,7 +7217,7 @@ export declare enum TurnCoverage {
7190
7217
  TURN_INCLUDES_ALL_INPUT = "TURN_INCLUDES_ALL_INPUT"
7191
7218
  }
7192
7219
 
7193
- /** Optional. The type of the data. */
7220
+ /** The type of the data. */
7194
7221
  export declare enum Type {
7195
7222
  /**
7196
7223
  * Not specified, should not be used.
@@ -7243,23 +7270,23 @@ declare namespace types {
7243
7270
  Language,
7244
7271
  FunctionResponseScheduling,
7245
7272
  Type,
7246
- HarmCategory,
7247
- HarmBlockMethod,
7248
- HarmBlockThreshold,
7249
7273
  Mode,
7250
7274
  AuthType,
7251
7275
  ApiSpec,
7252
- UrlRetrievalStatus,
7276
+ HarmCategory,
7277
+ HarmBlockMethod,
7278
+ HarmBlockThreshold,
7253
7279
  FinishReason,
7254
7280
  HarmProbability,
7255
7281
  HarmSeverity,
7282
+ UrlRetrievalStatus,
7256
7283
  BlockedReason,
7257
7284
  TrafficType,
7258
7285
  Modality,
7259
7286
  MediaResolution,
7260
- JobState,
7261
7287
  TuningMode,
7262
7288
  AdapterSize,
7289
+ JobState,
7263
7290
  TuningTask,
7264
7291
  FeatureSelectionPreference,
7265
7292
  Behavior,
@@ -7277,6 +7304,7 @@ declare namespace types {
7277
7304
  VideoGenerationReferenceType,
7278
7305
  VideoGenerationMaskMode,
7279
7306
  VideoCompressionQuality,
7307
+ TuningMethod,
7280
7308
  FileState,
7281
7309
  FileSource,
7282
7310
  TurnCompleteReason,
@@ -7288,28 +7316,24 @@ declare namespace types {
7288
7316
  Scale,
7289
7317
  MusicGenerationMode,
7290
7318
  LiveMusicPlaybackControl,
7291
- VideoMetadata,
7292
- Blob_2 as Blob,
7293
- FileData,
7294
7319
  FunctionCall,
7295
7320
  CodeExecutionResult,
7296
7321
  ExecutableCode,
7322
+ FileData,
7297
7323
  FunctionResponseBlob,
7298
7324
  FunctionResponseFileData,
7299
7325
  FunctionResponsePart,
7300
7326
  FunctionResponse,
7327
+ Blob_2 as Blob,
7328
+ VideoMetadata,
7301
7329
  Part,
7302
7330
  Content,
7303
7331
  HttpOptions,
7304
7332
  Schema,
7305
7333
  ModelSelectionConfig,
7306
- SafetySetting,
7307
7334
  FunctionDeclaration,
7308
- Interval,
7309
- GoogleSearch,
7310
7335
  DynamicRetrievalConfig,
7311
7336
  GoogleSearchRetrieval,
7312
- EnterpriseWebSearch,
7313
7337
  ApiKeyConfig,
7314
7338
  AuthConfigGoogleServiceAccountConfig,
7315
7339
  AuthConfigHttpBasicAuthConfig,
@@ -7317,7 +7341,6 @@ declare namespace types {
7317
7341
  AuthConfigOidcConfig,
7318
7342
  AuthConfig,
7319
7343
  GoogleMaps,
7320
- UrlContext,
7321
7344
  ComputerUse,
7322
7345
  ApiAuthApiKeyConfig,
7323
7346
  ApiAuth,
@@ -7336,22 +7359,22 @@ declare namespace types {
7336
7359
  VertexRagStore,
7337
7360
  Retrieval,
7338
7361
  ToolCodeExecution,
7362
+ EnterpriseWebSearch,
7363
+ Interval,
7364
+ GoogleSearch,
7365
+ UrlContext,
7339
7366
  Tool,
7340
7367
  FunctionCallingConfig,
7341
7368
  LatLng,
7342
7369
  RetrievalConfig,
7343
7370
  ToolConfig,
7344
- PrebuiltVoiceConfig,
7345
- VoiceConfig,
7346
- SpeakerVoiceConfig,
7347
- MultiSpeakerVoiceConfig,
7348
- SpeechConfig,
7349
7371
  AutomaticFunctionCallingConfig,
7350
7372
  ThinkingConfig,
7351
7373
  ImageConfig,
7352
7374
  GenerationConfigRoutingConfigAutoRoutingMode,
7353
7375
  GenerationConfigRoutingConfigManualRoutingMode,
7354
7376
  GenerationConfigRoutingConfig,
7377
+ SafetySetting,
7355
7378
  GenerateContentConfig,
7356
7379
  GenerateContentParameters,
7357
7380
  HttpResponse,
@@ -7359,8 +7382,6 @@ declare namespace types {
7359
7382
  GoogleTypeDate,
7360
7383
  Citation,
7361
7384
  CitationMetadata,
7362
- UrlMetadata,
7363
- UrlContextMetadata,
7364
7385
  GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution,
7365
7386
  GroundingChunkMapsPlaceAnswerSourcesReviewSnippet,
7366
7387
  GroundingChunkMapsPlaceAnswerSources,
@@ -7380,6 +7401,8 @@ declare namespace types {
7380
7401
  LogprobsResultTopCandidates,
7381
7402
  LogprobsResult,
7382
7403
  SafetyRating,
7404
+ UrlMetadata,
7405
+ UrlContextMetadata,
7383
7406
  Candidate,
7384
7407
  GenerateContentResponsePromptFeedback,
7385
7408
  ModalityTokenCount,
@@ -7432,6 +7455,11 @@ declare namespace types {
7432
7455
  DeleteModelConfig,
7433
7456
  DeleteModelParameters,
7434
7457
  DeleteModelResponse,
7458
+ PrebuiltVoiceConfig,
7459
+ VoiceConfig,
7460
+ SpeakerVoiceConfig,
7461
+ MultiSpeakerVoiceConfig,
7462
+ SpeechConfig,
7435
7463
  GenerationConfig,
7436
7464
  CountTokensConfig,
7437
7465
  CountTokensParameters,
@@ -7454,10 +7482,12 @@ declare namespace types {
7454
7482
  GetTuningJobParameters,
7455
7483
  TunedModelCheckpoint,
7456
7484
  TunedModel,
7457
- GoogleRpcStatus,
7458
- PreTunedModel,
7459
7485
  SupervisedHyperParameters,
7460
7486
  SupervisedTuningSpec,
7487
+ PreferenceOptimizationHyperParameters,
7488
+ PreferenceOptimizationSpec,
7489
+ GoogleRpcStatus,
7490
+ PreTunedModel,
7461
7491
  DatasetDistributionDistributionBucket,
7462
7492
  DatasetDistribution,
7463
7493
  DatasetStats,
@@ -7743,6 +7773,10 @@ export declare interface UpscaleImageConfig {
7743
7773
  abortSignal?: AbortSignal;
7744
7774
  /** Cloud Storage URI used to store the generated images. */
7745
7775
  outputGcsUri?: string;
7776
+ /** Filter level for safety filtering. */
7777
+ safetyFilterLevel?: SafetyFilterLevel;
7778
+ /** Allows generation of people by the model. */
7779
+ personGeneration?: PersonGeneration;
7746
7780
  /** Whether to include a reason for filtered-out images in the
7747
7781
  response. */
7748
7782
  includeRaiReason?: boolean;
@@ -7783,19 +7817,19 @@ export declare class UpscaleImageResponse {
7783
7817
  generatedImages?: GeneratedImage[];
7784
7818
  }
7785
7819
 
7786
- /** Tool to support URL context retrieval. */
7820
+ /** Tool to support URL context. */
7787
7821
  export declare interface UrlContext {
7788
7822
  }
7789
7823
 
7790
7824
  /** Metadata related to url context retrieval tool. */
7791
7825
  export declare interface UrlContextMetadata {
7792
- /** List of url context. */
7826
+ /** Output only. List of url context. */
7793
7827
  urlMetadata?: UrlMetadata[];
7794
7828
  }
7795
7829
 
7796
- /** Context for a single url retrieval. */
7830
+ /** Context of the a single url retrieval. */
7797
7831
  export declare interface UrlMetadata {
7798
- /** The URL retrieved by the tool. */
7832
+ /** Retrieved url by the tool. */
7799
7833
  retrievedUrl?: string;
7800
7834
  /** Status of the url retrieval. */
7801
7835
  urlRetrievalStatus?: UrlRetrievalStatus;
@@ -7804,7 +7838,7 @@ export declare interface UrlMetadata {
7804
7838
  /** Status of the url retrieval. */
7805
7839
  export declare enum UrlRetrievalStatus {
7806
7840
  /**
7807
- * Default value. This value is unused
7841
+ * Default value. This value is unused.
7808
7842
  */
7809
7843
  URL_RETRIEVAL_STATUS_UNSPECIFIED = "URL_RETRIEVAL_STATUS_UNSPECIFIED",
7810
7844
  /**
@@ -7816,11 +7850,11 @@ export declare enum UrlRetrievalStatus {
7816
7850
  */
7817
7851
  URL_RETRIEVAL_STATUS_ERROR = "URL_RETRIEVAL_STATUS_ERROR",
7818
7852
  /**
7819
- * Url retrieval is failed because the content is behind paywall.
7853
+ * Url retrieval is failed because the content is behind paywall. This enum value is not supported in Vertex AI.
7820
7854
  */
7821
7855
  URL_RETRIEVAL_STATUS_PAYWALL = "URL_RETRIEVAL_STATUS_PAYWALL",
7822
7856
  /**
7823
- * Url retrieval is failed because the content is unsafe.
7857
+ * Url retrieval is failed because the content is unsafe. This enum value is not supported in Vertex AI.
7824
7858
  */
7825
7859
  URL_RETRIEVAL_STATUS_UNSAFE = "URL_RETRIEVAL_STATUS_UNSAFE"
7826
7860
  }
@@ -8004,21 +8038,19 @@ export declare enum VideoGenerationReferenceType {
8004
8038
  STYLE = "STYLE"
8005
8039
  }
8006
8040
 
8007
- /** Describes how the video in the Part should be used by the model. */
8041
+ /** Metadata describes the input video content. */
8008
8042
  export declare interface VideoMetadata {
8009
- /** The frame rate of the video sent to the model. If not specified, the
8010
- default value will be 1.0. The fps range is (0.0, 24.0]. */
8011
- fps?: number;
8012
8043
  /** Optional. The end offset of the video. */
8013
8044
  endOffset?: string;
8045
+ /** Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. */
8046
+ fps?: number;
8014
8047
  /** Optional. The start offset of the video. */
8015
8048
  startOffset?: string;
8016
8049
  }
8017
8050
 
8018
8051
  /** The configuration for the voice to use. */
8019
8052
  export declare interface VoiceConfig {
8020
- /** The configuration for the speaker to use.
8021
- */
8053
+ /** The configuration for the prebuilt voice to use. */
8022
8054
  prebuiltVoiceConfig?: PrebuiltVoiceConfig;
8023
8055
  }
8024
8056