@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.
@@ -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;
@@ -3459,14 +3461,12 @@ export declare interface GoogleRpcStatus {
3459
3461
  message?: string;
3460
3462
  }
3461
3463
 
3462
- /** Tool to support Google Search in Model. Powered by Google. */
3464
+ /** GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
3463
3465
  export declare interface GoogleSearch {
3464
- /** Optional. Filter search results to a specific time range.
3465
- If customers set a start time, they must set an end time (and vice versa).
3466
- */
3467
- timeRangeFilter?: Interval;
3468
3466
  /** 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. */
3469
3467
  excludeDomains?: string[];
3468
+ /** 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. */
3469
+ timeRangeFilter?: Interval;
3470
3470
  }
3471
3471
 
3472
3472
  /** Tool to retrieve public web data for grounding, powered by Google. */
@@ -3607,7 +3607,7 @@ export declare interface GroundingSupport {
3607
3607
  segment?: Segment;
3608
3608
  }
3609
3609
 
3610
- /** Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. */
3610
+ /** 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. */
3611
3611
  export declare enum HarmBlockMethod {
3612
3612
  /**
3613
3613
  * The harm block method is unspecified.
@@ -3623,7 +3623,7 @@ export declare enum HarmBlockMethod {
3623
3623
  PROBABILITY = "PROBABILITY"
3624
3624
  }
3625
3625
 
3626
- /** Required. The harm block threshold. */
3626
+ /** The harm block threshold. */
3627
3627
  export declare enum HarmBlockThreshold {
3628
3628
  /**
3629
3629
  * Unspecified harm block threshold.
@@ -3651,7 +3651,7 @@ export declare enum HarmBlockThreshold {
3651
3651
  OFF = "OFF"
3652
3652
  }
3653
3653
 
3654
- /** Required. Harm category. */
3654
+ /** Harm category. */
3655
3655
  export declare enum HarmCategory {
3656
3656
  /**
3657
3657
  * The harm category is unspecified.
@@ -3723,7 +3723,7 @@ export declare enum HarmProbability {
3723
3723
  HIGH = "HIGH"
3724
3724
  }
3725
3725
 
3726
- /** Output only. Harm severity levels in the content. */
3726
+ /** Output only. Harm severity levels in the content. This enum is not supported in Gemini API. */
3727
3727
  export declare enum HarmSeverity {
3728
3728
  /**
3729
3729
  * Harm severity unspecified.
@@ -3806,7 +3806,7 @@ declare interface HttpRequest {
3806
3806
  /**
3807
3807
  * Optional set of customizable configuration for HTTP requests.
3808
3808
  */
3809
- httpOptions?: HttpOptions;
3809
+ httpOptions?: types.HttpOptions;
3810
3810
  /**
3811
3811
  * Optional abort signal which can be used to cancel the request.
3812
3812
  */
@@ -3917,17 +3917,12 @@ export declare class InlinedResponse {
3917
3917
  error?: JobError;
3918
3918
  }
3919
3919
 
3920
- /** Represents a time interval, encoded as a start time (inclusive) and an end time (exclusive).
3921
-
3922
- The start time must be less than or equal to the end time.
3923
- When the start equals the end time, the interval is an empty interval.
3924
- (matches no time)
3925
- When both start and end are unspecified, the interval matches any time. */
3920
+ /** 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. */
3926
3921
  export declare interface Interval {
3927
- /** The start time of the interval. */
3928
- startTime?: string;
3929
- /** The end time of the interval. */
3922
+ /** Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. */
3930
3923
  endTime?: string;
3924
+ /** Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. */
3925
+ startTime?: string;
3931
3926
  }
3932
3927
 
3933
3928
  /** Job error. */
@@ -3992,7 +3987,7 @@ export declare enum JobState {
3992
3987
  JOB_STATE_PARTIALLY_SUCCEEDED = "JOB_STATE_PARTIALLY_SUCCEEDED"
3993
3988
  }
3994
3989
 
3995
- /** Required. Programming language of the `code`. */
3990
+ /** Programming language of the `code`. */
3996
3991
  export declare enum Language {
3997
3992
  /**
3998
3993
  * Unspecified language. This value should not be used.
@@ -5501,9 +5496,9 @@ export declare interface ModelSelectionConfig {
5501
5496
  featureSelectionPreference?: FeatureSelectionPreference;
5502
5497
  }
5503
5498
 
5504
- /** The configuration for the multi-speaker setup. */
5499
+ /** The configuration for the multi-speaker setup. This data type is not supported in Vertex AI. */
5505
5500
  export declare interface MultiSpeakerVoiceConfig {
5506
- /** The configuration for the speaker to use. */
5501
+ /** Required. All the enabled speaker voices. */
5507
5502
  speakerVoiceConfigs?: SpeakerVoiceConfig[];
5508
5503
  }
5509
5504
 
@@ -5586,7 +5581,7 @@ export declare class Operations extends BaseModule {
5586
5581
  private fetchPredictVideosOperationInternal;
5587
5582
  }
5588
5583
 
5589
- /** Required. Outcome of the code execution. */
5584
+ /** Outcome of the code execution. */
5590
5585
  export declare enum Outcome {
5591
5586
  /**
5592
5587
  * Unspecified status. This value should not be used.
@@ -5611,10 +5606,13 @@ export declare enum PagedItem {
5611
5606
  PAGED_ITEM_MODELS = "models",
5612
5607
  PAGED_ITEM_TUNING_JOBS = "tuningJobs",
5613
5608
  PAGED_ITEM_FILES = "files",
5614
- PAGED_ITEM_CACHED_CONTENTS = "cachedContents"
5609
+ PAGED_ITEM_CACHED_CONTENTS = "cachedContents",
5610
+ PAGED_ITEM_RAG_STORES = "ragStores",
5611
+ PAGED_ITEM_DOCUMENTS = "documents"
5615
5612
  }
5616
5613
 
5617
5614
  declare interface PagedItemConfig {
5615
+ parent?: string;
5618
5616
  config?: {
5619
5617
  pageToken?: string;
5620
5618
  pageSize?: number;
@@ -5629,6 +5627,8 @@ declare interface PagedItemResponse<T> {
5629
5627
  tuningJobs?: T[];
5630
5628
  files?: T[];
5631
5629
  cachedContents?: T[];
5630
+ ragStores?: T[];
5631
+ documents?: T[];
5632
5632
  }
5633
5633
 
5634
5634
  /**
@@ -5737,17 +5737,6 @@ export declare class Pager<T> implements AsyncIterable<T> {
5737
5737
  of content being conveyed. Using multiple fields within the same `Part`
5738
5738
  instance is considered invalid. */
5739
5739
  export declare interface Part {
5740
- /** Metadata for a given video. */
5741
- videoMetadata?: VideoMetadata;
5742
- /** Indicates if the part is thought from the model. */
5743
- thought?: boolean;
5744
- /** Optional. Inlined bytes data. */
5745
- inlineData?: Blob_2;
5746
- /** Optional. URI based data. */
5747
- fileData?: FileData;
5748
- /** An opaque signature for the thought so it can be reused in subsequent requests.
5749
- * @remarks Encoded as base64 string. */
5750
- thoughtSignature?: string;
5751
5740
  /** A predicted [FunctionCall] returned from the model that contains a string
5752
5741
  representing the [FunctionDeclaration.name] and a structured JSON object
5753
5742
  containing the parameters and their values. */
@@ -5756,10 +5745,21 @@ export declare interface Part {
5756
5745
  codeExecutionResult?: CodeExecutionResult;
5757
5746
  /** Optional. Code generated by the model that is meant to be executed. */
5758
5747
  executableCode?: ExecutableCode;
5748
+ /** Optional. URI based data. */
5749
+ fileData?: FileData;
5759
5750
  /** 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. */
5760
5751
  functionResponse?: FunctionResponse;
5752
+ /** Optional. Inlined bytes data. */
5753
+ inlineData?: Blob_2;
5761
5754
  /** Optional. Text part (can be code). */
5762
5755
  text?: string;
5756
+ /** Optional. Indicates if the part is thought from the model. */
5757
+ thought?: boolean;
5758
+ /** Optional. An opaque signature for the thought so it can be reused in subsequent requests.
5759
+ * @remarks Encoded as base64 string. */
5760
+ thoughtSignature?: string;
5761
+ /** Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. */
5762
+ videoMetadata?: VideoMetadata;
5763
5763
  }
5764
5764
 
5765
5765
  export declare type PartListUnion = PartUnion[] | PartUnion;
@@ -5794,7 +5794,7 @@ export declare enum PersonGeneration {
5794
5794
 
5795
5795
  /** The configuration for the prebuilt speaker to use. */
5796
5796
  export declare interface PrebuiltVoiceConfig {
5797
- /** The name of the prebuilt voice to use. */
5797
+ /** The name of the preset voice to use. */
5798
5798
  voiceName?: string;
5799
5799
  }
5800
5800
 
@@ -5818,6 +5818,28 @@ export declare interface PreferenceOptimizationDataStats {
5818
5818
  userOutputTokenDistribution?: DatasetDistribution;
5819
5819
  }
5820
5820
 
5821
+ /** Hyperparameters for Preference Optimization. This data type is not supported in Gemini API. */
5822
+ export declare interface PreferenceOptimizationHyperParameters {
5823
+ /** Optional. Adapter size for preference optimization. */
5824
+ adapterSize?: AdapterSize;
5825
+ /** Optional. Weight for KL Divergence regularization. */
5826
+ beta?: number;
5827
+ /** Optional. Number of complete passes the model makes over the entire training dataset during training. */
5828
+ epochCount?: string;
5829
+ /** Optional. Multiplier for adjusting the default learning rate. */
5830
+ learningRateMultiplier?: number;
5831
+ }
5832
+
5833
+ /** Preference optimization tuning spec for tuning. */
5834
+ export declare interface PreferenceOptimizationSpec {
5835
+ /** Optional. Hyperparameters for Preference Optimization. */
5836
+ hyperParameters?: PreferenceOptimizationHyperParameters;
5837
+ /** Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. */
5838
+ trainingDatasetUri?: string;
5839
+ /** Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. */
5840
+ validationDatasetUri?: string;
5841
+ }
5842
+
5821
5843
  /** A pre-tuned model for continuous tuning. This data type is not supported in Gemini API. */
5822
5844
  export declare interface PreTunedModel {
5823
5845
  /** Output only. The name of the base model this PreTunedModel was tuned from. */
@@ -6101,13 +6123,13 @@ export declare interface SafetyRating {
6101
6123
  blocked?: boolean;
6102
6124
  /** Output only. Harm category. */
6103
6125
  category?: HarmCategory;
6104
- /** 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. */
6126
+ /** 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. */
6105
6127
  overwrittenThreshold?: HarmBlockThreshold;
6106
6128
  /** Output only. Harm probability levels in the content. */
6107
6129
  probability?: HarmProbability;
6108
6130
  /** Output only. Harm probability score. This field is not supported in Gemini API. */
6109
6131
  probabilityScore?: number;
6110
- /** Output only. Harm severity levels in the content. */
6132
+ /** Output only. Harm severity levels in the content. This field is not supported in Gemini API. */
6111
6133
  severity?: HarmSeverity;
6112
6134
  /** Output only. Harm severity score. This field is not supported in Gemini API. */
6113
6135
  severityScore?: number;
@@ -6115,11 +6137,10 @@ export declare interface SafetyRating {
6115
6137
 
6116
6138
  /** Safety settings. */
6117
6139
  export declare interface SafetySetting {
6118
- /** Determines if the harm block method uses probability or probability
6119
- and severity scores. */
6120
- method?: HarmBlockMethod;
6121
6140
  /** Required. Harm category. */
6122
6141
  category?: HarmCategory;
6142
+ /** 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. */
6143
+ method?: HarmBlockMethod;
6123
6144
  /** Required. The harm block threshold. */
6124
6145
  threshold?: HarmBlockThreshold;
6125
6146
  }
@@ -6533,28 +6554,22 @@ export declare interface SlidingWindow {
6533
6554
  targetTokens?: string;
6534
6555
  }
6535
6556
 
6536
- /** The configuration for the speaker to use. */
6557
+ /** The configuration for a single speaker in a multi speaker setup. This data type is not supported in Vertex AI. */
6537
6558
  export declare interface SpeakerVoiceConfig {
6538
- /** The name of the speaker to use. Should be the same as in the
6539
- prompt. */
6559
+ /** Required. The name of the speaker to use. Should be the same as in the prompt. */
6540
6560
  speaker?: string;
6541
- /** The configuration for the voice to use. */
6561
+ /** Required. The configuration for the voice to use. */
6542
6562
  voiceConfig?: VoiceConfig;
6543
6563
  }
6544
6564
 
6545
- /** The speech generation configuration. */
6565
+ /** The speech generation config. */
6546
6566
  export declare interface SpeechConfig {
6547
- /** The configuration for the speaker to use.
6548
- */
6567
+ /** Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. */
6568
+ languageCode?: string;
6569
+ /** The configuration for the speaker to use. */
6549
6570
  voiceConfig?: VoiceConfig;
6550
- /** The configuration for the multi-speaker setup.
6551
- It is mutually exclusive with the voice_config field.
6552
- */
6571
+ /** 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. */
6553
6572
  multiSpeakerVoiceConfig?: MultiSpeakerVoiceConfig;
6554
- /** Language code (ISO 639. e.g. en-US) for the speech synthesization.
6555
- Only available for Live API.
6556
- */
6557
- languageCode?: string;
6558
6573
  }
6559
6574
 
6560
6575
  export declare type SpeechConfigUnion = SpeechConfig | string;
@@ -6710,7 +6725,7 @@ export declare interface SupervisedTuningDataStats {
6710
6725
  userOutputTokenDistribution?: SupervisedTuningDatasetDistribution;
6711
6726
  }
6712
6727
 
6713
- /** Tuning Spec for Supervised Tuning for first party models. This data type is not supported in Gemini API. */
6728
+ /** Supervised tuning spec for tuning. */
6714
6729
  export declare interface SupervisedTuningSpec {
6715
6730
  /** 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. */
6716
6731
  exportLastCheckpointOnly?: boolean;
@@ -6866,25 +6881,23 @@ export declare interface Tool {
6866
6881
  functionDeclarations?: FunctionDeclaration[];
6867
6882
  /** 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. */
6868
6883
  retrieval?: Retrieval;
6869
- /** Optional. Google Search tool type. Specialized retrieval tool
6870
- that is powered by Google Search. */
6871
- googleSearch?: GoogleSearch;
6872
6884
  /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
6873
6885
  googleSearchRetrieval?: GoogleSearchRetrieval;
6874
- /** Optional. Enterprise web search tool type. Specialized retrieval
6875
- tool that is powered by Vertex AI Search and Sec4 compliance. */
6876
- enterpriseWebSearch?: EnterpriseWebSearch;
6877
6886
  /** Optional. Google Maps tool type. Specialized retrieval tool
6878
6887
  that is powered by Google Maps. */
6879
6888
  googleMaps?: GoogleMaps;
6880
- /** Optional. Tool to support URL context retrieval. */
6881
- urlContext?: UrlContext;
6882
6889
  /** Optional. Tool to support the model interacting directly with the
6883
6890
  computer. If enabled, it automatically populates computer-use specific
6884
6891
  Function Declarations. */
6885
6892
  computerUse?: ComputerUse;
6886
6893
  /** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
6887
6894
  codeExecution?: ToolCodeExecution;
6895
+ /** Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. This field is not supported in Gemini API. */
6896
+ enterpriseWebSearch?: EnterpriseWebSearch;
6897
+ /** Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
6898
+ googleSearch?: GoogleSearch;
6899
+ /** Optional. Tool to support URL context retrieval. */
6900
+ urlContext?: UrlContext;
6888
6901
  }
6889
6902
 
6890
6903
  /** 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. */
@@ -6905,7 +6918,7 @@ export declare type ToolListUnion = ToolUnion[];
6905
6918
 
6906
6919
  export declare type ToolUnion = Tool | CallableTool;
6907
6920
 
6908
- /** Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. */
6921
+ /** 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. */
6909
6922
  export declare enum TrafficType {
6910
6923
  /**
6911
6924
  * Unspecified request traffic type.
@@ -7033,6 +7046,8 @@ export declare interface TuningJob {
7033
7046
  preTunedModel?: PreTunedModel;
7034
7047
  /** Tuning Spec for Supervised Fine Tuning. */
7035
7048
  supervisedTuningSpec?: SupervisedTuningSpec;
7049
+ /** Tuning Spec for Preference Optimization. */
7050
+ preferenceOptimizationSpec?: PreferenceOptimizationSpec;
7036
7051
  /** Output only. The tuning data statistics associated with this TuningJob. */
7037
7052
  tuningDataStats?: TuningDataStats;
7038
7053
  /** 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. */
@@ -7057,7 +7072,19 @@ export declare interface TuningJob {
7057
7072
  veoTuningSpec?: VeoTuningSpec;
7058
7073
  }
7059
7074
 
7060
- /** Tuning mode. */
7075
+ /** Enum representing the tuning method. */
7076
+ export declare enum TuningMethod {
7077
+ /**
7078
+ * Supervised fine tuning.
7079
+ */
7080
+ SUPERVISED_FINE_TUNING = "SUPERVISED_FINE_TUNING",
7081
+ /**
7082
+ * Preference optimization tuning.
7083
+ */
7084
+ PREFERENCE_TUNING = "PREFERENCE_TUNING"
7085
+ }
7086
+
7087
+ /** Tuning mode. This enum is not supported in Gemini API. */
7061
7088
  export declare enum TuningMode {
7062
7089
  /**
7063
7090
  * Tuning mode is unspecified.
@@ -7138,7 +7165,7 @@ declare class Tunings extends BaseModule {
7138
7165
  private tuneMldevInternal;
7139
7166
  }
7140
7167
 
7141
- /** Optional. The tuning task. Either I2V or T2V. */
7168
+ /** The tuning task. Either I2V or T2V. This enum is not supported in Gemini API. */
7142
7169
  export declare enum TuningTask {
7143
7170
  /**
7144
7171
  * Default value. This value is unused.
@@ -7197,7 +7224,7 @@ export declare enum TurnCoverage {
7197
7224
  TURN_INCLUDES_ALL_INPUT = "TURN_INCLUDES_ALL_INPUT"
7198
7225
  }
7199
7226
 
7200
- /** Optional. The type of the data. */
7227
+ /** The type of the data. */
7201
7228
  export declare enum Type {
7202
7229
  /**
7203
7230
  * Not specified, should not be used.
@@ -7250,23 +7277,23 @@ declare namespace types {
7250
7277
  Language,
7251
7278
  FunctionResponseScheduling,
7252
7279
  Type,
7253
- HarmCategory,
7254
- HarmBlockMethod,
7255
- HarmBlockThreshold,
7256
7280
  Mode,
7257
7281
  AuthType,
7258
7282
  ApiSpec,
7259
- UrlRetrievalStatus,
7283
+ HarmCategory,
7284
+ HarmBlockMethod,
7285
+ HarmBlockThreshold,
7260
7286
  FinishReason,
7261
7287
  HarmProbability,
7262
7288
  HarmSeverity,
7289
+ UrlRetrievalStatus,
7263
7290
  BlockedReason,
7264
7291
  TrafficType,
7265
7292
  Modality,
7266
7293
  MediaResolution,
7267
- JobState,
7268
7294
  TuningMode,
7269
7295
  AdapterSize,
7296
+ JobState,
7270
7297
  TuningTask,
7271
7298
  FeatureSelectionPreference,
7272
7299
  Behavior,
@@ -7284,6 +7311,7 @@ declare namespace types {
7284
7311
  VideoGenerationReferenceType,
7285
7312
  VideoGenerationMaskMode,
7286
7313
  VideoCompressionQuality,
7314
+ TuningMethod,
7287
7315
  FileState,
7288
7316
  FileSource,
7289
7317
  TurnCompleteReason,
@@ -7295,28 +7323,24 @@ declare namespace types {
7295
7323
  Scale,
7296
7324
  MusicGenerationMode,
7297
7325
  LiveMusicPlaybackControl,
7298
- VideoMetadata,
7299
- Blob_2 as Blob,
7300
- FileData,
7301
7326
  FunctionCall,
7302
7327
  CodeExecutionResult,
7303
7328
  ExecutableCode,
7329
+ FileData,
7304
7330
  FunctionResponseBlob,
7305
7331
  FunctionResponseFileData,
7306
7332
  FunctionResponsePart,
7307
7333
  FunctionResponse,
7334
+ Blob_2 as Blob,
7335
+ VideoMetadata,
7308
7336
  Part,
7309
7337
  Content,
7310
7338
  HttpOptions,
7311
7339
  Schema,
7312
7340
  ModelSelectionConfig,
7313
- SafetySetting,
7314
7341
  FunctionDeclaration,
7315
- Interval,
7316
- GoogleSearch,
7317
7342
  DynamicRetrievalConfig,
7318
7343
  GoogleSearchRetrieval,
7319
- EnterpriseWebSearch,
7320
7344
  ApiKeyConfig,
7321
7345
  AuthConfigGoogleServiceAccountConfig,
7322
7346
  AuthConfigHttpBasicAuthConfig,
@@ -7324,7 +7348,6 @@ declare namespace types {
7324
7348
  AuthConfigOidcConfig,
7325
7349
  AuthConfig,
7326
7350
  GoogleMaps,
7327
- UrlContext,
7328
7351
  ComputerUse,
7329
7352
  ApiAuthApiKeyConfig,
7330
7353
  ApiAuth,
@@ -7343,22 +7366,22 @@ declare namespace types {
7343
7366
  VertexRagStore,
7344
7367
  Retrieval,
7345
7368
  ToolCodeExecution,
7369
+ EnterpriseWebSearch,
7370
+ Interval,
7371
+ GoogleSearch,
7372
+ UrlContext,
7346
7373
  Tool,
7347
7374
  FunctionCallingConfig,
7348
7375
  LatLng,
7349
7376
  RetrievalConfig,
7350
7377
  ToolConfig,
7351
- PrebuiltVoiceConfig,
7352
- VoiceConfig,
7353
- SpeakerVoiceConfig,
7354
- MultiSpeakerVoiceConfig,
7355
- SpeechConfig,
7356
7378
  AutomaticFunctionCallingConfig,
7357
7379
  ThinkingConfig,
7358
7380
  ImageConfig,
7359
7381
  GenerationConfigRoutingConfigAutoRoutingMode,
7360
7382
  GenerationConfigRoutingConfigManualRoutingMode,
7361
7383
  GenerationConfigRoutingConfig,
7384
+ SafetySetting,
7362
7385
  GenerateContentConfig,
7363
7386
  GenerateContentParameters,
7364
7387
  HttpResponse,
@@ -7366,8 +7389,6 @@ declare namespace types {
7366
7389
  GoogleTypeDate,
7367
7390
  Citation,
7368
7391
  CitationMetadata,
7369
- UrlMetadata,
7370
- UrlContextMetadata,
7371
7392
  GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution,
7372
7393
  GroundingChunkMapsPlaceAnswerSourcesReviewSnippet,
7373
7394
  GroundingChunkMapsPlaceAnswerSources,
@@ -7387,6 +7408,8 @@ declare namespace types {
7387
7408
  LogprobsResultTopCandidates,
7388
7409
  LogprobsResult,
7389
7410
  SafetyRating,
7411
+ UrlMetadata,
7412
+ UrlContextMetadata,
7390
7413
  Candidate,
7391
7414
  GenerateContentResponsePromptFeedback,
7392
7415
  ModalityTokenCount,
@@ -7439,6 +7462,11 @@ declare namespace types {
7439
7462
  DeleteModelConfig,
7440
7463
  DeleteModelParameters,
7441
7464
  DeleteModelResponse,
7465
+ PrebuiltVoiceConfig,
7466
+ VoiceConfig,
7467
+ SpeakerVoiceConfig,
7468
+ MultiSpeakerVoiceConfig,
7469
+ SpeechConfig,
7442
7470
  GenerationConfig,
7443
7471
  CountTokensConfig,
7444
7472
  CountTokensParameters,
@@ -7461,10 +7489,12 @@ declare namespace types {
7461
7489
  GetTuningJobParameters,
7462
7490
  TunedModelCheckpoint,
7463
7491
  TunedModel,
7464
- GoogleRpcStatus,
7465
- PreTunedModel,
7466
7492
  SupervisedHyperParameters,
7467
7493
  SupervisedTuningSpec,
7494
+ PreferenceOptimizationHyperParameters,
7495
+ PreferenceOptimizationSpec,
7496
+ GoogleRpcStatus,
7497
+ PreTunedModel,
7468
7498
  DatasetDistributionDistributionBucket,
7469
7499
  DatasetDistribution,
7470
7500
  DatasetStats,
@@ -7750,6 +7780,10 @@ export declare interface UpscaleImageConfig {
7750
7780
  abortSignal?: AbortSignal;
7751
7781
  /** Cloud Storage URI used to store the generated images. */
7752
7782
  outputGcsUri?: string;
7783
+ /** Filter level for safety filtering. */
7784
+ safetyFilterLevel?: SafetyFilterLevel;
7785
+ /** Allows generation of people by the model. */
7786
+ personGeneration?: PersonGeneration;
7753
7787
  /** Whether to include a reason for filtered-out images in the
7754
7788
  response. */
7755
7789
  includeRaiReason?: boolean;
@@ -7790,19 +7824,19 @@ export declare class UpscaleImageResponse {
7790
7824
  generatedImages?: GeneratedImage[];
7791
7825
  }
7792
7826
 
7793
- /** Tool to support URL context retrieval. */
7827
+ /** Tool to support URL context. */
7794
7828
  export declare interface UrlContext {
7795
7829
  }
7796
7830
 
7797
7831
  /** Metadata related to url context retrieval tool. */
7798
7832
  export declare interface UrlContextMetadata {
7799
- /** List of url context. */
7833
+ /** Output only. List of url context. */
7800
7834
  urlMetadata?: UrlMetadata[];
7801
7835
  }
7802
7836
 
7803
- /** Context for a single url retrieval. */
7837
+ /** Context of the a single url retrieval. */
7804
7838
  export declare interface UrlMetadata {
7805
- /** The URL retrieved by the tool. */
7839
+ /** Retrieved url by the tool. */
7806
7840
  retrievedUrl?: string;
7807
7841
  /** Status of the url retrieval. */
7808
7842
  urlRetrievalStatus?: UrlRetrievalStatus;
@@ -7811,7 +7845,7 @@ export declare interface UrlMetadata {
7811
7845
  /** Status of the url retrieval. */
7812
7846
  export declare enum UrlRetrievalStatus {
7813
7847
  /**
7814
- * Default value. This value is unused
7848
+ * Default value. This value is unused.
7815
7849
  */
7816
7850
  URL_RETRIEVAL_STATUS_UNSPECIFIED = "URL_RETRIEVAL_STATUS_UNSPECIFIED",
7817
7851
  /**
@@ -7823,11 +7857,11 @@ export declare enum UrlRetrievalStatus {
7823
7857
  */
7824
7858
  URL_RETRIEVAL_STATUS_ERROR = "URL_RETRIEVAL_STATUS_ERROR",
7825
7859
  /**
7826
- * Url retrieval is failed because the content is behind paywall.
7860
+ * Url retrieval is failed because the content is behind paywall. This enum value is not supported in Vertex AI.
7827
7861
  */
7828
7862
  URL_RETRIEVAL_STATUS_PAYWALL = "URL_RETRIEVAL_STATUS_PAYWALL",
7829
7863
  /**
7830
- * Url retrieval is failed because the content is unsafe.
7864
+ * Url retrieval is failed because the content is unsafe. This enum value is not supported in Vertex AI.
7831
7865
  */
7832
7866
  URL_RETRIEVAL_STATUS_UNSAFE = "URL_RETRIEVAL_STATUS_UNSAFE"
7833
7867
  }
@@ -8011,21 +8045,19 @@ export declare enum VideoGenerationReferenceType {
8011
8045
  STYLE = "STYLE"
8012
8046
  }
8013
8047
 
8014
- /** Describes how the video in the Part should be used by the model. */
8048
+ /** Metadata describes the input video content. */
8015
8049
  export declare interface VideoMetadata {
8016
- /** The frame rate of the video sent to the model. If not specified, the
8017
- default value will be 1.0. The fps range is (0.0, 24.0]. */
8018
- fps?: number;
8019
8050
  /** Optional. The end offset of the video. */
8020
8051
  endOffset?: string;
8052
+ /** 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]. */
8053
+ fps?: number;
8021
8054
  /** Optional. The start offset of the video. */
8022
8055
  startOffset?: string;
8023
8056
  }
8024
8057
 
8025
8058
  /** The configuration for the voice to use. */
8026
8059
  export declare interface VoiceConfig {
8027
- /** The configuration for the speaker to use.
8028
- */
8060
+ /** The configuration for the prebuilt voice to use. */
8029
8061
  prebuiltVoiceConfig?: PrebuiltVoiceConfig;
8030
8062
  }
8031
8063