@google/genai 1.26.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/genai.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.
@@ -64,13 +64,13 @@ export declare enum AdapterSize {
64
64
  ADAPTER_SIZE_THIRTY_TWO = "ADAPTER_SIZE_THIRTY_TWO"
65
65
  }
66
66
 
67
- /** The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. */
67
+ /** The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. This data type is not supported in Gemini API. */
68
68
  export declare interface ApiAuth {
69
69
  /** The API secret. */
70
70
  apiKeyConfig?: ApiAuthApiKeyConfig;
71
71
  }
72
72
 
73
- /** The API secret. */
73
+ /** The API secret. This data type is not supported in Gemini API. */
74
74
  export declare interface ApiAuthApiKeyConfig {
75
75
  /** Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} */
76
76
  apiKeySecretVersion?: string;
@@ -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.
@@ -278,8 +278,9 @@ declare interface Auth {
278
278
  * Sets the headers needed to authenticate with the API service.
279
279
  *
280
280
  * @param headers - The Headers object that will be updated with the authentication headers.
281
+ * @param url - The URL of the request.
281
282
  */
282
- addAuthHeaders(headers: Headers): Promise<void>;
283
+ addAuthHeaders(headers: Headers, url?: string): Promise<void>;
283
284
  }
284
285
 
285
286
  /** Auth configuration to run the extension. */
@@ -298,19 +299,19 @@ export declare interface AuthConfig {
298
299
  oidcConfig?: AuthConfigOidcConfig;
299
300
  }
300
301
 
301
- /** Config for Google Service Account Authentication. */
302
+ /** Config for Google Service Account Authentication. This data type is not supported in Gemini API. */
302
303
  export declare interface AuthConfigGoogleServiceAccountConfig {
303
304
  /** Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. */
304
305
  serviceAccount?: string;
305
306
  }
306
307
 
307
- /** Config for HTTP Basic Authentication. */
308
+ /** Config for HTTP Basic Authentication. This data type is not supported in Gemini API. */
308
309
  export declare interface AuthConfigHttpBasicAuthConfig {
309
310
  /** Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. */
310
311
  credentialSecret?: string;
311
312
  }
312
313
 
313
- /** Config for user oauth. */
314
+ /** Config for user oauth. This data type is not supported in Gemini API. */
314
315
  export declare interface AuthConfigOauthConfig {
315
316
  /** Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. */
316
317
  accessToken?: string;
@@ -318,7 +319,7 @@ export declare interface AuthConfigOauthConfig {
318
319
  serviceAccount?: string;
319
320
  }
320
321
 
321
- /** Config for user OIDC auth. */
322
+ /** Config for user OIDC auth. This data type is not supported in Gemini API. */
322
323
  export declare interface AuthConfigOidcConfig {
323
324
  /** OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. */
324
325
  idToken?: string;
@@ -332,7 +333,7 @@ export declare interface AuthToken {
332
333
  name?: string;
333
334
  }
334
335
 
335
- /** Type of auth scheme. */
336
+ /** Type of auth scheme. This enum is not supported in Gemini API. */
336
337
  export declare enum AuthType {
337
338
  AUTH_TYPE_UNSPECIFIED = "AUTH_TYPE_UNSPECIFIED",
338
339
  /**
@@ -634,11 +635,11 @@ export declare enum Behavior {
634
635
 
635
636
  /** Content blob. */
636
637
  declare interface Blob_2 {
637
- /** 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. */
638
- displayName?: string;
639
638
  /** Required. Raw bytes.
640
639
  * @remarks Encoded as base64 string. */
641
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;
642
643
  /** Required. The IANA standard MIME type of the source data. */
643
644
  mimeType?: string;
644
645
  }
@@ -673,11 +674,11 @@ export declare enum BlockedReason {
673
674
  */
674
675
  IMAGE_SAFETY = "IMAGE_SAFETY",
675
676
  /**
676
- * The prompt was blocked by Model Armor.
677
+ * The prompt was blocked by Model Armor. This enum value is not supported in Gemini API.
677
678
  */
678
679
  MODEL_ARMOR = "MODEL_ARMOR",
679
680
  /**
680
- * The prompt was blocked as a jailbreak attempt.
681
+ * The prompt was blocked as a jailbreak attempt. This enum value is not supported in Gemini API.
681
682
  */
682
683
  JAILBREAK = "JAILBREAK"
683
684
  }
@@ -702,15 +703,15 @@ export declare interface CachedContent {
702
703
 
703
704
  /** Metadata on the usage of the cached content. */
704
705
  export declare interface CachedContentUsageMetadata {
705
- /** Duration of audio in seconds. */
706
+ /** Duration of audio in seconds. This field is not supported in Gemini API. */
706
707
  audioDurationSeconds?: number;
707
- /** Number of images. */
708
+ /** Number of images. This field is not supported in Gemini API. */
708
709
  imageCount?: number;
709
- /** Number of text characters. */
710
+ /** Number of text characters. This field is not supported in Gemini API. */
710
711
  textCount?: number;
711
712
  /** Total number of tokens that the cached content consumes. */
712
713
  totalTokenCount?: number;
713
- /** Duration of video in seconds. */
714
+ /** Duration of video in seconds. This field is not supported in Gemini API. */
714
715
  videoDurationSeconds?: number;
715
716
  }
716
717
 
@@ -895,8 +896,6 @@ export declare interface Candidate {
895
896
  If empty, the model has not stopped generating the tokens.
896
897
  */
897
898
  finishReason?: FinishReason;
898
- /** Metadata related to url context retrieval tool. */
899
- urlContextMetadata?: UrlContextMetadata;
900
899
  /** Output only. Average log probability score of the candidate. */
901
900
  avgLogprobs?: number;
902
901
  /** Output only. Metadata specifies sources used to ground generated content. */
@@ -907,6 +906,8 @@ export declare interface Candidate {
907
906
  logprobsResult?: LogprobsResult;
908
907
  /** Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */
909
908
  safetyRatings?: SafetyRating[];
909
+ /** Output only. Metadata related to url context retrieval tool. */
910
+ urlContextMetadata?: UrlContextMetadata;
910
911
  }
911
912
 
912
913
  /**
@@ -1041,7 +1042,7 @@ export declare interface Checkpoint {
1041
1042
  step?: string;
1042
1043
  }
1043
1044
 
1044
- /** Source attributions for content. */
1045
+ /** Source attributions for content. This data type is not supported in Gemini API. */
1045
1046
  export declare interface Citation {
1046
1047
  /** Output only. End index into the content. */
1047
1048
  endIndex?: number;
@@ -1124,9 +1125,7 @@ export declare interface Content {
1124
1125
  /** List of parts that constitute a single message. Each part may have
1125
1126
  a different IANA MIME type. */
1126
1127
  parts?: Part[];
1127
- /** Optional. The producer of the content. Must be either 'user' or
1128
- 'model'. Useful to set for multi-turn conversations, otherwise can be
1129
- 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. */
1130
1129
  role?: string;
1131
1130
  }
1132
1131
 
@@ -1527,7 +1526,7 @@ export declare function createPartFromText(text: string): Part;
1527
1526
  */
1528
1527
  export declare function createPartFromUri(uri: string, mimeType: string): Part;
1529
1528
 
1530
- /** Supervised fine-tuning job creation request - optional fields. */
1529
+ /** Fine-tuning job creation request - optional fields. */
1531
1530
  export declare interface CreateTuningJobConfig {
1532
1531
  /** Used to override HTTP request options. */
1533
1532
  httpOptions?: HttpOptions;
@@ -1538,7 +1537,9 @@ export declare interface CreateTuningJobConfig {
1538
1537
  be charged usage for any applicable operations.
1539
1538
  */
1540
1539
  abortSignal?: AbortSignal;
1541
- /** Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. */
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
+ /** Validation dataset for tuning. The dataset must be formatted as a JSONL file. */
1542
1543
  validationDataset?: TuningValidationDataset;
1543
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. */
1544
1545
  tunedModelDisplayName?: string;
@@ -1548,7 +1549,7 @@ export declare interface CreateTuningJobConfig {
1548
1549
  epochCount?: number;
1549
1550
  /** Multiplier for adjusting the default learning rate. */
1550
1551
  learningRateMultiplier?: number;
1551
- /** 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. */
1552
1553
  exportLastCheckpointOnly?: boolean;
1553
1554
  /** The optional checkpoint id of the pre-tuned model to use for tuning, if applicable. */
1554
1555
  preTunedModelCheckpointId?: string;
@@ -1560,9 +1561,11 @@ export declare interface CreateTuningJobConfig {
1560
1561
  learningRate?: number;
1561
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. */
1562
1563
  labels?: Record<string, string>;
1564
+ /** Weight for KL Divergence regularization, Preference Optimization tuning only. */
1565
+ beta?: number;
1563
1566
  }
1564
1567
 
1565
- /** Supervised fine-tuning job creation parameters - optional fields. */
1568
+ /** Fine-tuning job creation parameters - optional fields. */
1566
1569
  export declare interface CreateTuningJobParameters {
1567
1570
  /** The base model that is being tuned, e.g., "gemini-2.5-flash". */
1568
1571
  baseModel: string;
@@ -1572,7 +1575,7 @@ export declare interface CreateTuningJobParameters {
1572
1575
  config?: CreateTuningJobConfig;
1573
1576
  }
1574
1577
 
1575
- /** Supervised fine-tuning job creation parameters - optional fields. */
1578
+ /** Fine-tuning job creation parameters - optional fields. */
1576
1579
  export declare interface CreateTuningJobParametersPrivate {
1577
1580
  /** The base model that is being tuned, e.g., "gemini-2.5-flash". */
1578
1581
  baseModel?: string;
@@ -1589,7 +1592,7 @@ export declare interface CreateTuningJobParametersPrivate {
1589
1592
  */
1590
1593
  export declare function createUserContent(partOrString: PartListUnion | string): Content;
1591
1594
 
1592
- /** Distribution computed over a tuning dataset. */
1595
+ /** Distribution computed over a tuning dataset. This data type is not supported in Gemini API. */
1593
1596
  export declare interface DatasetDistribution {
1594
1597
  /** Output only. Defines the histogram bucket. */
1595
1598
  buckets?: DatasetDistributionDistributionBucket[];
@@ -1609,7 +1612,7 @@ export declare interface DatasetDistribution {
1609
1612
  sum?: number;
1610
1613
  }
1611
1614
 
1612
- /** Dataset bucket used to create a histogram for the distribution given a population of values. */
1615
+ /** Dataset bucket used to create a histogram for the distribution given a population of values. This data type is not supported in Gemini API. */
1613
1616
  export declare interface DatasetDistributionDistributionBucket {
1614
1617
  /** Output only. Number of values in the bucket. */
1615
1618
  count?: string;
@@ -1619,7 +1622,7 @@ export declare interface DatasetDistributionDistributionBucket {
1619
1622
  right?: number;
1620
1623
  }
1621
1624
 
1622
- /** Statistics computed over a tuning dataset. */
1625
+ /** Statistics computed over a tuning dataset. This data type is not supported in Gemini API. */
1623
1626
  export declare interface DatasetStats {
1624
1627
  /** Output only. Number of billable characters in the tuning dataset. */
1625
1628
  totalBillableCharacterCount?: string;
@@ -1753,7 +1756,7 @@ export declare interface DeleteResourceJob {
1753
1756
  error?: JobError;
1754
1757
  }
1755
1758
 
1756
- /** Statistics computed for datasets used for distillation. */
1759
+ /** Statistics computed for datasets used for distillation. This data type is not supported in Gemini API. */
1757
1760
  export declare interface DistillationDataStats {
1758
1761
  /** Output only. Statistics computed for the training dataset. */
1759
1762
  trainingDatasetStats?: DatasetStats;
@@ -1990,7 +1993,7 @@ export declare interface EmbeddingsBatchJobSource {
1990
1993
  inlinedRequests?: EmbedContentBatch;
1991
1994
  }
1992
1995
 
1993
- /** Represents a customer-managed encryption key spec that can be applied to a top-level resource. */
1996
+ /** Represents a customer-managed encryption key spec that can be applied to a top-level resource. This data type is not supported in Gemini API. */
1994
1997
  export declare interface EncryptionSpec {
1995
1998
  /** Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. */
1996
1999
  kmsKeyName?: string;
@@ -2020,7 +2023,7 @@ export declare enum EndSensitivity {
2020
2023
  END_SENSITIVITY_LOW = "END_SENSITIVITY_LOW"
2021
2024
  }
2022
2025
 
2023
- /** 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. */
2024
2027
  export declare interface EnterpriseWebSearch {
2025
2028
  /** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. */
2026
2029
  excludeDomains?: string[];
@@ -2054,7 +2057,7 @@ export declare interface ExecutableCode {
2054
2057
  language?: Language;
2055
2058
  }
2056
2059
 
2057
- /** Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. */
2060
+ /** Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. This data type is not supported in Gemini API. */
2058
2061
  export declare interface ExternalApi {
2059
2062
  /** The authentication config to access the API. Deprecated. Please use auth_config instead. */
2060
2063
  apiAuth?: ApiAuth;
@@ -2070,7 +2073,7 @@ export declare interface ExternalApi {
2070
2073
  simpleSearchParams?: ExternalApiSimpleSearchParams;
2071
2074
  }
2072
2075
 
2073
- /** The search parameters to use for the ELASTIC_SEARCH spec. */
2076
+ /** The search parameters to use for the ELASTIC_SEARCH spec. This data type is not supported in Gemini API. */
2074
2077
  export declare interface ExternalApiElasticSearchParams {
2075
2078
  /** The ElasticSearch index to use. */
2076
2079
  index?: string;
@@ -2080,7 +2083,7 @@ export declare interface ExternalApiElasticSearchParams {
2080
2083
  searchTemplate?: string;
2081
2084
  }
2082
2085
 
2083
- /** The search parameters to use for SIMPLE_SEARCH spec. */
2086
+ /** The search parameters to use for SIMPLE_SEARCH spec. This data type is not supported in Gemini API. */
2084
2087
  export declare interface ExternalApiSimpleSearchParams {
2085
2088
  }
2086
2089
 
@@ -2148,7 +2151,7 @@ export { File_2 as File }
2148
2151
 
2149
2152
  /** URI based data. */
2150
2153
  export declare interface FileData {
2151
- /** 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. */
2152
2155
  displayName?: string;
2153
2156
  /** Required. URI. */
2154
2157
  fileUri?: string;
@@ -2517,7 +2520,7 @@ export declare enum FunctionResponseScheduling {
2517
2520
  INTERRUPT = "INTERRUPT"
2518
2521
  }
2519
2522
 
2520
- /** Input example for preference optimization. */
2523
+ /** Input example for preference optimization. This data type is not supported in Gemini API. */
2521
2524
  export declare interface GeminiPreferenceExample {
2522
2525
  /** List of completions for a given prompt. */
2523
2526
  completions?: GeminiPreferenceExampleCompletion[];
@@ -2525,7 +2528,7 @@ export declare interface GeminiPreferenceExample {
2525
2528
  contents?: Content[];
2526
2529
  }
2527
2530
 
2528
- /** Completion and its preference score. */
2531
+ /** Completion and its preference score. This data type is not supported in Gemini API. */
2529
2532
  export declare interface GeminiPreferenceExampleCompletion {
2530
2533
  /** Single turn completion for the given prompt. */
2531
2534
  completion?: Content;
@@ -2851,13 +2854,13 @@ export declare class GenerateContentResponse {
2851
2854
  export declare class GenerateContentResponsePromptFeedback {
2852
2855
  /** Output only. The reason why the prompt was blocked. */
2853
2856
  blockReason?: BlockedReason;
2854
- /** Output only. A readable message that explains the reason why the prompt was blocked. */
2857
+ /** Output only. A readable message that explains the reason why the prompt was blocked. This field is not supported in Gemini API. */
2855
2858
  blockReasonMessage?: string;
2856
2859
  /** Output only. A list of safety ratings for the prompt. There is one rating per category. */
2857
2860
  safetyRatings?: SafetyRating[];
2858
2861
  }
2859
2862
 
2860
- /** Usage metadata about response(s). */
2863
+ /** Usage metadata about response(s). This data type is not supported in Gemini API. */
2861
2864
  export declare class GenerateContentResponseUsageMetadata {
2862
2865
  /** Output only. List of modalities of the cached content in the request input. */
2863
2866
  cacheTokensDetails?: ModalityTokenCount[];
@@ -3117,11 +3120,11 @@ export declare interface GenerateVideosSource {
3117
3120
  export declare interface GenerationConfig {
3118
3121
  /** Optional. Config for model selection. */
3119
3122
  modelSelectionConfig?: ModelSelectionConfig;
3120
- /** Optional. If enabled, audio timestamp will be included in the request to the model. */
3123
+ /** Optional. If enabled, audio timestamp will be included in the request to the model. This field is not supported in Gemini API. */
3121
3124
  audioTimestamp?: boolean;
3122
3125
  /** Optional. Number of candidates to generate. */
3123
3126
  candidateCount?: number;
3124
- /** Optional. If enabled, the model will detect emotions and adapt its responses accordingly. */
3127
+ /** Optional. If enabled, the model will detect emotions and adapt its responses accordingly. This field is not supported in Gemini API. */
3125
3128
  enableAffectiveDialog?: boolean;
3126
3129
  /** Optional. Frequency penalties. */
3127
3130
  frequencyPenalty?: number;
@@ -3143,7 +3146,7 @@ export declare interface GenerationConfig {
3143
3146
  responseModalities?: Modality[];
3144
3147
  /** Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. */
3145
3148
  responseSchema?: Schema;
3146
- /** Optional. Routing configuration. */
3149
+ /** Optional. Routing configuration. This field is not supported in Gemini API. */
3147
3150
  routingConfig?: GenerationConfigRoutingConfig;
3148
3151
  /** Optional. Seed. */
3149
3152
  seed?: number;
@@ -3159,11 +3162,11 @@ export declare interface GenerationConfig {
3159
3162
  topK?: number;
3160
3163
  /** Optional. If specified, nucleus sampling will be used. */
3161
3164
  topP?: number;
3162
- /** Optional. Enables enhanced civic answers. It may not be available for all models. */
3165
+ /** Optional. Enables enhanced civic answers. It may not be available for all models. This field is not supported in Vertex AI. */
3163
3166
  enableEnhancedCivicAnswers?: boolean;
3164
3167
  }
3165
3168
 
3166
- /** The configuration for routing the request to a specific model. */
3169
+ /** The configuration for routing the request to a specific model. This data type is not supported in Gemini API. */
3167
3170
  export declare interface GenerationConfigRoutingConfig {
3168
3171
  /** Automated routing. */
3169
3172
  autoMode?: GenerationConfigRoutingConfigAutoRoutingMode;
@@ -3171,13 +3174,13 @@ export declare interface GenerationConfigRoutingConfig {
3171
3174
  manualMode?: GenerationConfigRoutingConfigManualRoutingMode;
3172
3175
  }
3173
3176
 
3174
- /** When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. */
3177
+ /** When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. This data type is not supported in Gemini API. */
3175
3178
  export declare interface GenerationConfigRoutingConfigAutoRoutingMode {
3176
3179
  /** The model routing preference. */
3177
3180
  modelRoutingPreference?: 'UNKNOWN' | 'PRIORITIZE_QUALITY' | 'BALANCED' | 'PRIORITIZE_COST';
3178
3181
  }
3179
3182
 
3180
- /** When manual routing is set, the specified model will be used directly. */
3183
+ /** When manual routing is set, the specified model will be used directly. This data type is not supported in Gemini API. */
3181
3184
  export declare interface GenerationConfigRoutingConfigManualRoutingMode {
3182
3185
  /** The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). */
3183
3186
  modelName?: string;
@@ -3436,7 +3439,7 @@ export declare interface GoogleMaps {
3436
3439
  enableWidget?: boolean;
3437
3440
  }
3438
3441
 
3439
- /** The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */
3442
+ /** The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). This data type is not supported in Gemini API. */
3440
3443
  export declare interface GoogleRpcStatus {
3441
3444
  /** The status code, which should be an enum value of google.rpc.Code. */
3442
3445
  code?: number;
@@ -3446,14 +3449,12 @@ export declare interface GoogleRpcStatus {
3446
3449
  message?: string;
3447
3450
  }
3448
3451
 
3449
- /** Tool to support Google Search in Model. Powered by Google. */
3452
+ /** GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
3450
3453
  export declare interface GoogleSearch {
3451
- /** Optional. Filter search results to a specific time range.
3452
- If customers set a start time, they must set an end time (and vice versa).
3453
- */
3454
- timeRangeFilter?: Interval;
3455
- /** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. */
3454
+ /** 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. */
3456
3455
  excludeDomains?: string[];
3456
+ /** 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. */
3457
+ timeRangeFilter?: Interval;
3457
3458
  }
3458
3459
 
3459
3460
  /** Tool to retrieve public web data for grounding, powered by Google. */
@@ -3462,7 +3463,7 @@ export declare interface GoogleSearchRetrieval {
3462
3463
  dynamicRetrievalConfig?: DynamicRetrievalConfig;
3463
3464
  }
3464
3465
 
3465
- /** Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp */
3466
+ /** Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp. This data type is not supported in Gemini API. */
3466
3467
  export declare interface GoogleTypeDate {
3467
3468
  /** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
3468
3469
  day?: number;
@@ -3474,15 +3475,15 @@ export declare interface GoogleTypeDate {
3474
3475
 
3475
3476
  /** Grounding chunk. */
3476
3477
  export declare interface GroundingChunk {
3477
- /** Grounding chunk from Google Maps. */
3478
+ /** Grounding chunk from Google Maps. This field is not supported in Gemini API. */
3478
3479
  maps?: GroundingChunkMaps;
3479
- /** Grounding chunk from context retrieved by the retrieval tools. */
3480
+ /** Grounding chunk from context retrieved by the retrieval tools. This field is not supported in Gemini API. */
3480
3481
  retrievedContext?: GroundingChunkRetrievedContext;
3481
3482
  /** Grounding chunk from the web. */
3482
3483
  web?: GroundingChunkWeb;
3483
3484
  }
3484
3485
 
3485
- /** Chunk from Google Maps. */
3486
+ /** Chunk from Google Maps. This data type is not supported in Gemini API. */
3486
3487
  export declare interface GroundingChunkMaps {
3487
3488
  /** Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. */
3488
3489
  placeAnswerSources?: GroundingChunkMapsPlaceAnswerSources;
@@ -3496,7 +3497,7 @@ export declare interface GroundingChunkMaps {
3496
3497
  uri?: string;
3497
3498
  }
3498
3499
 
3499
- /** Sources used to generate the place answer. */
3500
+ /** Sources used to generate the place answer. This data type is not supported in Gemini API. */
3500
3501
  export declare interface GroundingChunkMapsPlaceAnswerSources {
3501
3502
  /** A link where users can flag a problem with the generated answer. */
3502
3503
  flagContentUri?: string;
@@ -3504,7 +3505,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSources {
3504
3505
  reviewSnippets?: GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
3505
3506
  }
3506
3507
 
3507
- /** Author attribution for a photo or review. */
3508
+ /** Author attribution for a photo or review. This data type is not supported in Gemini API. */
3508
3509
  export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
3509
3510
  /** Name of the author of the Photo or Review. */
3510
3511
  displayName?: string;
@@ -3514,7 +3515,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
3514
3515
  uri?: string;
3515
3516
  }
3516
3517
 
3517
- /** Encapsulates a review snippet. */
3518
+ /** Encapsulates a review snippet. This data type is not supported in Gemini API. */
3518
3519
  export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
3519
3520
  /** This review's author. */
3520
3521
  authorAttribution?: GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution;
@@ -3532,7 +3533,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
3532
3533
  title?: string;
3533
3534
  }
3534
3535
 
3535
- /** Chunk from context retrieved by the retrieval tools. */
3536
+ /** Chunk from context retrieved by the retrieval tools. This data type is not supported in Gemini API. */
3536
3537
  export declare interface GroundingChunkRetrievedContext {
3537
3538
  /** Output only. The full document name for the referenced Vertex AI Search document. */
3538
3539
  documentName?: string;
@@ -3548,7 +3549,7 @@ export declare interface GroundingChunkRetrievedContext {
3548
3549
 
3549
3550
  /** Chunk from the web. */
3550
3551
  export declare interface GroundingChunkWeb {
3551
- /** Domain of the (original) URI. */
3552
+ /** Domain of the (original) URI. This field is not supported in Gemini API. */
3552
3553
  domain?: string;
3553
3554
  /** Title of the chunk. */
3554
3555
  title?: string;
@@ -3558,7 +3559,7 @@ export declare interface GroundingChunkWeb {
3558
3559
 
3559
3560
  /** Metadata returned to client when grounding is enabled. */
3560
3561
  export declare interface GroundingMetadata {
3561
- /** Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. */
3562
+ /** Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. This field is not supported in Gemini API. */
3562
3563
  googleMapsWidgetContextToken?: string;
3563
3564
  /** List of supporting references retrieved from specified grounding source. */
3564
3565
  groundingChunks?: GroundingChunk[];
@@ -3566,17 +3567,17 @@ export declare interface GroundingMetadata {
3566
3567
  groundingSupports?: GroundingSupport[];
3567
3568
  /** Optional. Output only. Retrieval metadata. */
3568
3569
  retrievalMetadata?: RetrievalMetadata;
3569
- /** Optional. Queries executed by the retrieval tools. */
3570
+ /** Optional. Queries executed by the retrieval tools. This field is not supported in Gemini API. */
3570
3571
  retrievalQueries?: string[];
3571
3572
  /** Optional. Google search entry for the following-up web searches. */
3572
3573
  searchEntryPoint?: SearchEntryPoint;
3573
- /** Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. */
3574
+ /** Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. This field is not supported in Gemini API. */
3574
3575
  sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
3575
3576
  /** Optional. Web search queries for the following-up web search. */
3576
3577
  webSearchQueries?: string[];
3577
3578
  }
3578
3579
 
3579
- /** Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. */
3580
+ /** Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. This data type is not supported in Gemini API. */
3580
3581
  export declare interface GroundingMetadataSourceFlaggingUri {
3581
3582
  /** A link where users can flag a problem with the source (place or review). */
3582
3583
  flagContentUri?: string;
@@ -3594,7 +3595,7 @@ export declare interface GroundingSupport {
3594
3595
  segment?: Segment;
3595
3596
  }
3596
3597
 
3597
- /** Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. */
3598
+ /** 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. */
3598
3599
  export declare enum HarmBlockMethod {
3599
3600
  /**
3600
3601
  * The harm block method is unspecified.
@@ -3610,7 +3611,7 @@ export declare enum HarmBlockMethod {
3610
3611
  PROBABILITY = "PROBABILITY"
3611
3612
  }
3612
3613
 
3613
- /** Required. The harm block threshold. */
3614
+ /** The harm block threshold. */
3614
3615
  export declare enum HarmBlockThreshold {
3615
3616
  /**
3616
3617
  * Unspecified harm block threshold.
@@ -3638,7 +3639,7 @@ export declare enum HarmBlockThreshold {
3638
3639
  OFF = "OFF"
3639
3640
  }
3640
3641
 
3641
- /** Required. Harm category. */
3642
+ /** Harm category. */
3642
3643
  export declare enum HarmCategory {
3643
3644
  /**
3644
3645
  * The harm category is unspecified.
@@ -3665,23 +3666,23 @@ export declare enum HarmCategory {
3665
3666
  */
3666
3667
  HARM_CATEGORY_CIVIC_INTEGRITY = "HARM_CATEGORY_CIVIC_INTEGRITY",
3667
3668
  /**
3668
- * The harm category is image hate.
3669
+ * The harm category is image hate. This enum value is not supported in Gemini API.
3669
3670
  */
3670
3671
  HARM_CATEGORY_IMAGE_HATE = "HARM_CATEGORY_IMAGE_HATE",
3671
3672
  /**
3672
- * The harm category is image dangerous content.
3673
+ * The harm category is image dangerous content. This enum value is not supported in Gemini API.
3673
3674
  */
3674
3675
  HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT = "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT",
3675
3676
  /**
3676
- * The harm category is image harassment.
3677
+ * The harm category is image harassment. This enum value is not supported in Gemini API.
3677
3678
  */
3678
3679
  HARM_CATEGORY_IMAGE_HARASSMENT = "HARM_CATEGORY_IMAGE_HARASSMENT",
3679
3680
  /**
3680
- * The harm category is image sexually explicit content.
3681
+ * The harm category is image sexually explicit content. This enum value is not supported in Gemini API.
3681
3682
  */
3682
3683
  HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT = "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT",
3683
3684
  /**
3684
- * The harm category is for jailbreak prompts.
3685
+ * The harm category is for jailbreak prompts. This enum value is not supported in Gemini API.
3685
3686
  */
3686
3687
  HARM_CATEGORY_JAILBREAK = "HARM_CATEGORY_JAILBREAK"
3687
3688
  }
@@ -3710,7 +3711,7 @@ export declare enum HarmProbability {
3710
3711
  HIGH = "HIGH"
3711
3712
  }
3712
3713
 
3713
- /** Output only. Harm severity levels in the content. */
3714
+ /** Output only. Harm severity levels in the content. This enum is not supported in Gemini API. */
3714
3715
  export declare enum HarmSeverity {
3715
3716
  /**
3716
3717
  * Harm severity unspecified.
@@ -3793,7 +3794,7 @@ declare interface HttpRequest {
3793
3794
  /**
3794
3795
  * Optional set of customizable configuration for HTTP requests.
3795
3796
  */
3796
- httpOptions?: HttpOptions;
3797
+ httpOptions?: types.HttpOptions;
3797
3798
  /**
3798
3799
  * Optional abort signal which can be used to cancel the request.
3799
3800
  */
@@ -3904,17 +3905,12 @@ export declare class InlinedResponse {
3904
3905
  error?: JobError;
3905
3906
  }
3906
3907
 
3907
- /** Represents a time interval, encoded as a start time (inclusive) and an end time (exclusive).
3908
-
3909
- The start time must be less than or equal to the end time.
3910
- When the start equals the end time, the interval is an empty interval.
3911
- (matches no time)
3912
- When both start and end are unspecified, the interval matches any time. */
3908
+ /** 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. */
3913
3909
  export declare interface Interval {
3914
- /** The start time of the interval. */
3915
- startTime?: string;
3916
- /** The end time of the interval. */
3910
+ /** Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. */
3917
3911
  endTime?: string;
3912
+ /** Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. */
3913
+ startTime?: string;
3918
3914
  }
3919
3915
 
3920
3916
  /** Job error. */
@@ -3979,7 +3975,7 @@ export declare enum JobState {
3979
3975
  JOB_STATE_PARTIALLY_SUCCEEDED = "JOB_STATE_PARTIALLY_SUCCEEDED"
3980
3976
  }
3981
3977
 
3982
- /** Required. Programming language of the `code`. */
3978
+ /** Programming language of the `code`. */
3983
3979
  export declare enum Language {
3984
3980
  /**
3985
3981
  * Unspecified language. This value should not be used.
@@ -5488,9 +5484,9 @@ export declare interface ModelSelectionConfig {
5488
5484
  featureSelectionPreference?: FeatureSelectionPreference;
5489
5485
  }
5490
5486
 
5491
- /** The configuration for the multi-speaker setup. */
5487
+ /** The configuration for the multi-speaker setup. This data type is not supported in Vertex AI. */
5492
5488
  export declare interface MultiSpeakerVoiceConfig {
5493
- /** The configuration for the speaker to use. */
5489
+ /** Required. All the enabled speaker voices. */
5494
5490
  speakerVoiceConfigs?: SpeakerVoiceConfig[];
5495
5491
  }
5496
5492
 
@@ -5573,7 +5569,7 @@ export declare class Operations extends BaseModule {
5573
5569
  private fetchPredictVideosOperationInternal;
5574
5570
  }
5575
5571
 
5576
- /** Required. Outcome of the code execution. */
5572
+ /** Outcome of the code execution. */
5577
5573
  export declare enum Outcome {
5578
5574
  /**
5579
5575
  * Unspecified status. This value should not be used.
@@ -5598,10 +5594,13 @@ export declare enum PagedItem {
5598
5594
  PAGED_ITEM_MODELS = "models",
5599
5595
  PAGED_ITEM_TUNING_JOBS = "tuningJobs",
5600
5596
  PAGED_ITEM_FILES = "files",
5601
- PAGED_ITEM_CACHED_CONTENTS = "cachedContents"
5597
+ PAGED_ITEM_CACHED_CONTENTS = "cachedContents",
5598
+ PAGED_ITEM_RAG_STORES = "ragStores",
5599
+ PAGED_ITEM_DOCUMENTS = "documents"
5602
5600
  }
5603
5601
 
5604
5602
  declare interface PagedItemConfig {
5603
+ parent?: string;
5605
5604
  config?: {
5606
5605
  pageToken?: string;
5607
5606
  pageSize?: number;
@@ -5616,6 +5615,8 @@ declare interface PagedItemResponse<T> {
5616
5615
  tuningJobs?: T[];
5617
5616
  files?: T[];
5618
5617
  cachedContents?: T[];
5618
+ ragStores?: T[];
5619
+ documents?: T[];
5619
5620
  }
5620
5621
 
5621
5622
  /**
@@ -5724,17 +5725,6 @@ export declare class Pager<T> implements AsyncIterable<T> {
5724
5725
  of content being conveyed. Using multiple fields within the same `Part`
5725
5726
  instance is considered invalid. */
5726
5727
  export declare interface Part {
5727
- /** Metadata for a given video. */
5728
- videoMetadata?: VideoMetadata;
5729
- /** Indicates if the part is thought from the model. */
5730
- thought?: boolean;
5731
- /** Optional. Inlined bytes data. */
5732
- inlineData?: Blob_2;
5733
- /** Optional. URI based data. */
5734
- fileData?: FileData;
5735
- /** An opaque signature for the thought so it can be reused in subsequent requests.
5736
- * @remarks Encoded as base64 string. */
5737
- thoughtSignature?: string;
5738
5728
  /** A predicted [FunctionCall] returned from the model that contains a string
5739
5729
  representing the [FunctionDeclaration.name] and a structured JSON object
5740
5730
  containing the parameters and their values. */
@@ -5743,15 +5733,26 @@ export declare interface Part {
5743
5733
  codeExecutionResult?: CodeExecutionResult;
5744
5734
  /** Optional. Code generated by the model that is meant to be executed. */
5745
5735
  executableCode?: ExecutableCode;
5736
+ /** Optional. URI based data. */
5737
+ fileData?: FileData;
5746
5738
  /** 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. */
5747
5739
  functionResponse?: FunctionResponse;
5740
+ /** Optional. Inlined bytes data. */
5741
+ inlineData?: Blob_2;
5748
5742
  /** Optional. Text part (can be code). */
5749
5743
  text?: string;
5744
+ /** Optional. Indicates if the part is thought from the model. */
5745
+ thought?: boolean;
5746
+ /** Optional. An opaque signature for the thought so it can be reused in subsequent requests.
5747
+ * @remarks Encoded as base64 string. */
5748
+ thoughtSignature?: string;
5749
+ /** Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. */
5750
+ videoMetadata?: VideoMetadata;
5750
5751
  }
5751
5752
 
5752
5753
  export declare type PartListUnion = PartUnion[] | PartUnion;
5753
5754
 
5754
- /** Tuning spec for Partner models. */
5755
+ /** Tuning spec for Partner models. This data type is not supported in Gemini API. */
5755
5756
  export declare interface PartnerModelTuningSpec {
5756
5757
  /** Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model. */
5757
5758
  hyperParameters?: Record<string, unknown>;
@@ -5781,11 +5782,11 @@ export declare enum PersonGeneration {
5781
5782
 
5782
5783
  /** The configuration for the prebuilt speaker to use. */
5783
5784
  export declare interface PrebuiltVoiceConfig {
5784
- /** The name of the prebuilt voice to use. */
5785
+ /** The name of the preset voice to use. */
5785
5786
  voiceName?: string;
5786
5787
  }
5787
5788
 
5788
- /** Statistics computed for datasets used for preference optimization. */
5789
+ /** Statistics computed for datasets used for preference optimization. This data type is not supported in Gemini API. */
5789
5790
  export declare interface PreferenceOptimizationDataStats {
5790
5791
  /** Output only. Dataset distributions for scores variance per example. */
5791
5792
  scoreVariancePerExampleDistribution?: DatasetDistribution;
@@ -5805,7 +5806,29 @@ export declare interface PreferenceOptimizationDataStats {
5805
5806
  userOutputTokenDistribution?: DatasetDistribution;
5806
5807
  }
5807
5808
 
5808
- /** A pre-tuned model for continuous tuning. */
5809
+ /** Hyperparameters for Preference Optimization. This data type is not supported in Gemini API. */
5810
+ export declare interface PreferenceOptimizationHyperParameters {
5811
+ /** Optional. Adapter size for preference optimization. */
5812
+ adapterSize?: AdapterSize;
5813
+ /** Optional. Weight for KL Divergence regularization. */
5814
+ beta?: number;
5815
+ /** Optional. Number of complete passes the model makes over the entire training dataset during training. */
5816
+ epochCount?: string;
5817
+ /** Optional. Multiplier for adjusting the default learning rate. */
5818
+ learningRateMultiplier?: number;
5819
+ }
5820
+
5821
+ /** Preference optimization tuning spec for tuning. */
5822
+ export declare interface PreferenceOptimizationSpec {
5823
+ /** Optional. Hyperparameters for Preference Optimization. */
5824
+ hyperParameters?: PreferenceOptimizationHyperParameters;
5825
+ /** Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. */
5826
+ trainingDatasetUri?: string;
5827
+ /** Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. */
5828
+ validationDatasetUri?: string;
5829
+ }
5830
+
5831
+ /** A pre-tuned model for continuous tuning. This data type is not supported in Gemini API. */
5809
5832
  export declare interface PreTunedModel {
5810
5833
  /** Output only. The name of the base model this PreTunedModel was tuned from. */
5811
5834
  baseModel?: string;
@@ -5829,7 +5852,7 @@ export declare interface ProductImage {
5829
5852
  productImage?: Image_2;
5830
5853
  }
5831
5854
 
5832
- /** A RagChunk includes the content of a chunk of a RagFile, and associated metadata. */
5855
+ /** A RagChunk includes the content of a chunk of a RagFile, and associated metadata. This data type is not supported in Gemini API. */
5833
5856
  export declare interface RagChunk {
5834
5857
  /** If populated, represents where the chunk starts and ends in the document. */
5835
5858
  pageSpan?: RagChunkPageSpan;
@@ -5837,7 +5860,7 @@ export declare interface RagChunk {
5837
5860
  text?: string;
5838
5861
  }
5839
5862
 
5840
- /** Represents where the chunk starts and ends in the document. */
5863
+ /** Represents where the chunk starts and ends in the document. This data type is not supported in Gemini API. */
5841
5864
  export declare interface RagChunkPageSpan {
5842
5865
  /** Page where chunk starts in the document. Inclusive. 1-indexed. */
5843
5866
  firstPage?: number;
@@ -5845,7 +5868,7 @@ export declare interface RagChunkPageSpan {
5845
5868
  lastPage?: number;
5846
5869
  }
5847
5870
 
5848
- /** Specifies the context retrieval config. */
5871
+ /** Specifies the context retrieval config. This data type is not supported in Gemini API. */
5849
5872
  export declare interface RagRetrievalConfig {
5850
5873
  /** Optional. Config for filters. */
5851
5874
  filter?: RagRetrievalConfigFilter;
@@ -5857,7 +5880,7 @@ export declare interface RagRetrievalConfig {
5857
5880
  topK?: number;
5858
5881
  }
5859
5882
 
5860
- /** Config for filters. */
5883
+ /** Config for filters. This data type is not supported in Gemini API. */
5861
5884
  export declare interface RagRetrievalConfigFilter {
5862
5885
  /** Optional. String for metadata filtering. */
5863
5886
  metadataFilter?: string;
@@ -5867,13 +5890,13 @@ export declare interface RagRetrievalConfigFilter {
5867
5890
  vectorSimilarityThreshold?: number;
5868
5891
  }
5869
5892
 
5870
- /** Config for Hybrid Search. */
5893
+ /** Config for Hybrid Search. This data type is not supported in Gemini API. */
5871
5894
  export declare interface RagRetrievalConfigHybridSearch {
5872
5895
  /** Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. */
5873
5896
  alpha?: number;
5874
5897
  }
5875
5898
 
5876
- /** Config for ranking and reranking. */
5899
+ /** Config for ranking and reranking. This data type is not supported in Gemini API. */
5877
5900
  export declare interface RagRetrievalConfigRanking {
5878
5901
  /** Optional. Config for LlmRanker. */
5879
5902
  llmRanker?: RagRetrievalConfigRankingLlmRanker;
@@ -5881,13 +5904,13 @@ export declare interface RagRetrievalConfigRanking {
5881
5904
  rankService?: RagRetrievalConfigRankingRankService;
5882
5905
  }
5883
5906
 
5884
- /** Config for LlmRanker. */
5907
+ /** Config for LlmRanker. This data type is not supported in Gemini API. */
5885
5908
  export declare interface RagRetrievalConfigRankingLlmRanker {
5886
5909
  /** Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). */
5887
5910
  modelName?: string;
5888
5911
  }
5889
5912
 
5890
- /** Config for Rank Service. */
5913
+ /** Config for Rank Service. This data type is not supported in Gemini API. */
5891
5914
  export declare interface RagRetrievalConfigRankingRankService {
5892
5915
  /** Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` */
5893
5916
  modelName?: string;
@@ -6037,7 +6060,7 @@ export declare class ReplayResponse {
6037
6060
  sdkResponseSegments?: Record<string, unknown>[];
6038
6061
  }
6039
6062
 
6040
- /** Defines a retrieval tool that model can call to access external knowledge. */
6063
+ /** Defines a retrieval tool that model can call to access external knowledge. This data type is not supported in Gemini API. */
6041
6064
  export declare interface Retrieval {
6042
6065
  /** Optional. Deprecated. This option is no longer supported. */
6043
6066
  disableAttribution?: boolean;
@@ -6088,25 +6111,24 @@ export declare interface SafetyRating {
6088
6111
  blocked?: boolean;
6089
6112
  /** Output only. Harm category. */
6090
6113
  category?: HarmCategory;
6091
- /** 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. */
6114
+ /** 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. */
6092
6115
  overwrittenThreshold?: HarmBlockThreshold;
6093
6116
  /** Output only. Harm probability levels in the content. */
6094
6117
  probability?: HarmProbability;
6095
- /** Output only. Harm probability score. */
6118
+ /** Output only. Harm probability score. This field is not supported in Gemini API. */
6096
6119
  probabilityScore?: number;
6097
- /** Output only. Harm severity levels in the content. */
6120
+ /** Output only. Harm severity levels in the content. This field is not supported in Gemini API. */
6098
6121
  severity?: HarmSeverity;
6099
- /** Output only. Harm severity score. */
6122
+ /** Output only. Harm severity score. This field is not supported in Gemini API. */
6100
6123
  severityScore?: number;
6101
6124
  }
6102
6125
 
6103
6126
  /** Safety settings. */
6104
6127
  export declare interface SafetySetting {
6105
- /** Determines if the harm block method uses probability or probability
6106
- and severity scores. */
6107
- method?: HarmBlockMethod;
6108
6128
  /** Required. Harm category. */
6109
6129
  category?: HarmCategory;
6130
+ /** 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. */
6131
+ method?: HarmBlockMethod;
6110
6132
  /** Required. The harm block threshold. */
6111
6133
  threshold?: HarmBlockThreshold;
6112
6134
  }
@@ -6520,28 +6542,22 @@ export declare interface SlidingWindow {
6520
6542
  targetTokens?: string;
6521
6543
  }
6522
6544
 
6523
- /** The configuration for the speaker to use. */
6545
+ /** The configuration for a single speaker in a multi speaker setup. This data type is not supported in Vertex AI. */
6524
6546
  export declare interface SpeakerVoiceConfig {
6525
- /** The name of the speaker to use. Should be the same as in the
6526
- prompt. */
6547
+ /** Required. The name of the speaker to use. Should be the same as in the prompt. */
6527
6548
  speaker?: string;
6528
- /** The configuration for the voice to use. */
6549
+ /** Required. The configuration for the voice to use. */
6529
6550
  voiceConfig?: VoiceConfig;
6530
6551
  }
6531
6552
 
6532
- /** The speech generation configuration. */
6553
+ /** The speech generation config. */
6533
6554
  export declare interface SpeechConfig {
6534
- /** The configuration for the speaker to use.
6535
- */
6555
+ /** Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. */
6556
+ languageCode?: string;
6557
+ /** The configuration for the speaker to use. */
6536
6558
  voiceConfig?: VoiceConfig;
6537
- /** The configuration for the multi-speaker setup.
6538
- It is mutually exclusive with the voice_config field.
6539
- */
6559
+ /** 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. */
6540
6560
  multiSpeakerVoiceConfig?: MultiSpeakerVoiceConfig;
6541
- /** Language code (ISO 639. e.g. en-US) for the speech synthesization.
6542
- Only available for Live API.
6543
- */
6544
- languageCode?: string;
6545
6561
  }
6546
6562
 
6547
6563
  export declare type SpeechConfigUnion = SpeechConfig | string;
@@ -6623,7 +6639,7 @@ export declare enum SubjectReferenceType {
6623
6639
  SUBJECT_TYPE_PRODUCT = "SUBJECT_TYPE_PRODUCT"
6624
6640
  }
6625
6641
 
6626
- /** Hyperparameters for SFT. */
6642
+ /** Hyperparameters for SFT. This data type is not supported in Gemini API. */
6627
6643
  export declare interface SupervisedHyperParameters {
6628
6644
  /** Optional. Adapter size for tuning. */
6629
6645
  adapterSize?: AdapterSize;
@@ -6637,7 +6653,7 @@ export declare interface SupervisedHyperParameters {
6637
6653
  learningRateMultiplier?: number;
6638
6654
  }
6639
6655
 
6640
- /** Dataset distribution for Supervised Tuning. */
6656
+ /** Dataset distribution for Supervised Tuning. This data type is not supported in Gemini API. */
6641
6657
  export declare interface SupervisedTuningDatasetDistribution {
6642
6658
  /** Output only. Sum of a given population of values that are billable. */
6643
6659
  billableSum?: string;
@@ -6659,7 +6675,7 @@ export declare interface SupervisedTuningDatasetDistribution {
6659
6675
  sum?: string;
6660
6676
  }
6661
6677
 
6662
- /** Dataset bucket used to create a histogram for the distribution given a population of values. */
6678
+ /** Dataset bucket used to create a histogram for the distribution given a population of values. This data type is not supported in Gemini API. */
6663
6679
  export declare interface SupervisedTuningDatasetDistributionDatasetBucket {
6664
6680
  /** Output only. Number of values in the bucket. */
6665
6681
  count?: number;
@@ -6669,7 +6685,7 @@ export declare interface SupervisedTuningDatasetDistributionDatasetBucket {
6669
6685
  right?: number;
6670
6686
  }
6671
6687
 
6672
- /** Tuning data statistics for Supervised Tuning. */
6688
+ /** Tuning data statistics for Supervised Tuning. This data type is not supported in Gemini API. */
6673
6689
  export declare interface SupervisedTuningDataStats {
6674
6690
  /** Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. */
6675
6691
  droppedExampleReasons?: string[];
@@ -6697,7 +6713,7 @@ export declare interface SupervisedTuningDataStats {
6697
6713
  userOutputTokenDistribution?: SupervisedTuningDatasetDistribution;
6698
6714
  }
6699
6715
 
6700
- /** Tuning Spec for Supervised Tuning for first party models. */
6716
+ /** Supervised tuning spec for tuning. */
6701
6717
  export declare interface SupervisedTuningSpec {
6702
6718
  /** 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. */
6703
6719
  exportLastCheckpointOnly?: boolean;
@@ -6851,30 +6867,28 @@ export declare interface TokensInfo {
6851
6867
  export declare interface Tool {
6852
6868
  /** List of function declarations that the tool supports. */
6853
6869
  functionDeclarations?: FunctionDeclaration[];
6854
- /** 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. */
6870
+ /** 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. */
6855
6871
  retrieval?: Retrieval;
6856
- /** Optional. Google Search tool type. Specialized retrieval tool
6857
- that is powered by Google Search. */
6858
- googleSearch?: GoogleSearch;
6859
6872
  /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
6860
6873
  googleSearchRetrieval?: GoogleSearchRetrieval;
6861
- /** Optional. Enterprise web search tool type. Specialized retrieval
6862
- tool that is powered by Vertex AI Search and Sec4 compliance. */
6863
- enterpriseWebSearch?: EnterpriseWebSearch;
6864
6874
  /** Optional. Google Maps tool type. Specialized retrieval tool
6865
6875
  that is powered by Google Maps. */
6866
6876
  googleMaps?: GoogleMaps;
6867
- /** Optional. Tool to support URL context retrieval. */
6868
- urlContext?: UrlContext;
6869
6877
  /** Optional. Tool to support the model interacting directly with the
6870
6878
  computer. If enabled, it automatically populates computer-use specific
6871
6879
  Function Declarations. */
6872
6880
  computerUse?: ComputerUse;
6873
6881
  /** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
6874
6882
  codeExecution?: ToolCodeExecution;
6883
+ /** Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. This field is not supported in Gemini API. */
6884
+ enterpriseWebSearch?: EnterpriseWebSearch;
6885
+ /** Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
6886
+ googleSearch?: GoogleSearch;
6887
+ /** Optional. Tool to support URL context retrieval. */
6888
+ urlContext?: UrlContext;
6875
6889
  }
6876
6890
 
6877
- /** 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. */
6891
+ /** 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. */
6878
6892
  export declare interface ToolCodeExecution {
6879
6893
  }
6880
6894
 
@@ -6892,7 +6906,7 @@ export declare type ToolListUnion = ToolUnion[];
6892
6906
 
6893
6907
  export declare type ToolUnion = Tool | CallableTool;
6894
6908
 
6895
- /** Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. */
6909
+ /** 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. */
6896
6910
  export declare enum TrafficType {
6897
6911
  /**
6898
6912
  * Unspecified request traffic type.
@@ -6974,7 +6988,7 @@ export declare interface TuningDataset {
6974
6988
  examples?: TuningExample[];
6975
6989
  }
6976
6990
 
6977
- /** The tuning data statistic values for TuningJob. */
6991
+ /** The tuning data statistic values for TuningJob. This data type is not supported in Gemini API. */
6978
6992
  export declare interface TuningDataStats {
6979
6993
  /** Output only. Statistics for distillation. */
6980
6994
  distillationDataStats?: DistillationDataStats;
@@ -6984,7 +6998,7 @@ export declare interface TuningDataStats {
6984
6998
  supervisedTuningDataStats?: SupervisedTuningDataStats;
6985
6999
  }
6986
7000
 
6987
- /** A single example for tuning. */
7001
+ /** A single example for tuning. This data type is not supported in Vertex AI. */
6988
7002
  export declare interface TuningExample {
6989
7003
  /** Required. The expected model output. */
6990
7004
  output?: string;
@@ -7020,6 +7034,8 @@ export declare interface TuningJob {
7020
7034
  preTunedModel?: PreTunedModel;
7021
7035
  /** Tuning Spec for Supervised Fine Tuning. */
7022
7036
  supervisedTuningSpec?: SupervisedTuningSpec;
7037
+ /** Tuning Spec for Preference Optimization. */
7038
+ preferenceOptimizationSpec?: PreferenceOptimizationSpec;
7023
7039
  /** Output only. The tuning data statistics associated with this TuningJob. */
7024
7040
  tuningDataStats?: TuningDataStats;
7025
7041
  /** 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. */
@@ -7044,7 +7060,19 @@ export declare interface TuningJob {
7044
7060
  veoTuningSpec?: VeoTuningSpec;
7045
7061
  }
7046
7062
 
7047
- /** Tuning mode. */
7063
+ /** Enum representing the tuning method. */
7064
+ export declare enum TuningMethod {
7065
+ /**
7066
+ * Supervised fine tuning.
7067
+ */
7068
+ SUPERVISED_FINE_TUNING = "SUPERVISED_FINE_TUNING",
7069
+ /**
7070
+ * Preference optimization tuning.
7071
+ */
7072
+ PREFERENCE_TUNING = "PREFERENCE_TUNING"
7073
+ }
7074
+
7075
+ /** Tuning mode. This enum is not supported in Gemini API. */
7048
7076
  export declare enum TuningMode {
7049
7077
  /**
7050
7078
  * Tuning mode is unspecified.
@@ -7125,7 +7153,7 @@ declare class Tunings extends BaseModule {
7125
7153
  private tuneMldevInternal;
7126
7154
  }
7127
7155
 
7128
- /** Optional. The tuning task. Either I2V or T2V. */
7156
+ /** The tuning task. Either I2V or T2V. This enum is not supported in Gemini API. */
7129
7157
  export declare enum TuningTask {
7130
7158
  /**
7131
7159
  * Default value. This value is unused.
@@ -7144,7 +7172,7 @@ export declare enum TuningTask {
7144
7172
  export declare interface TuningValidationDataset {
7145
7173
  /** GCS URI of the file containing validation dataset in JSONL format. */
7146
7174
  gcsUri?: string;
7147
- /** 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'. */
7175
+ /** 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'. */
7148
7176
  vertexDatasetResource?: string;
7149
7177
  }
7150
7178
 
@@ -7184,7 +7212,7 @@ export declare enum TurnCoverage {
7184
7212
  TURN_INCLUDES_ALL_INPUT = "TURN_INCLUDES_ALL_INPUT"
7185
7213
  }
7186
7214
 
7187
- /** Optional. The type of the data. */
7215
+ /** The type of the data. */
7188
7216
  export declare enum Type {
7189
7217
  /**
7190
7218
  * Not specified, should not be used.
@@ -7237,23 +7265,23 @@ declare namespace types {
7237
7265
  Language,
7238
7266
  FunctionResponseScheduling,
7239
7267
  Type,
7240
- HarmCategory,
7241
- HarmBlockMethod,
7242
- HarmBlockThreshold,
7243
7268
  Mode,
7244
7269
  AuthType,
7245
7270
  ApiSpec,
7246
- UrlRetrievalStatus,
7271
+ HarmCategory,
7272
+ HarmBlockMethod,
7273
+ HarmBlockThreshold,
7247
7274
  FinishReason,
7248
7275
  HarmProbability,
7249
7276
  HarmSeverity,
7277
+ UrlRetrievalStatus,
7250
7278
  BlockedReason,
7251
7279
  TrafficType,
7252
7280
  Modality,
7253
7281
  MediaResolution,
7254
- JobState,
7255
7282
  TuningMode,
7256
7283
  AdapterSize,
7284
+ JobState,
7257
7285
  TuningTask,
7258
7286
  FeatureSelectionPreference,
7259
7287
  Behavior,
@@ -7271,6 +7299,7 @@ declare namespace types {
7271
7299
  VideoGenerationReferenceType,
7272
7300
  VideoGenerationMaskMode,
7273
7301
  VideoCompressionQuality,
7302
+ TuningMethod,
7274
7303
  FileState,
7275
7304
  FileSource,
7276
7305
  TurnCompleteReason,
@@ -7282,28 +7311,24 @@ declare namespace types {
7282
7311
  Scale,
7283
7312
  MusicGenerationMode,
7284
7313
  LiveMusicPlaybackControl,
7285
- VideoMetadata,
7286
- Blob_2 as Blob,
7287
- FileData,
7288
7314
  FunctionCall,
7289
7315
  CodeExecutionResult,
7290
7316
  ExecutableCode,
7317
+ FileData,
7291
7318
  FunctionResponseBlob,
7292
7319
  FunctionResponseFileData,
7293
7320
  FunctionResponsePart,
7294
7321
  FunctionResponse,
7322
+ Blob_2 as Blob,
7323
+ VideoMetadata,
7295
7324
  Part,
7296
7325
  Content,
7297
7326
  HttpOptions,
7298
7327
  Schema,
7299
7328
  ModelSelectionConfig,
7300
- SafetySetting,
7301
7329
  FunctionDeclaration,
7302
- Interval,
7303
- GoogleSearch,
7304
7330
  DynamicRetrievalConfig,
7305
7331
  GoogleSearchRetrieval,
7306
- EnterpriseWebSearch,
7307
7332
  ApiKeyConfig,
7308
7333
  AuthConfigGoogleServiceAccountConfig,
7309
7334
  AuthConfigHttpBasicAuthConfig,
@@ -7311,7 +7336,6 @@ declare namespace types {
7311
7336
  AuthConfigOidcConfig,
7312
7337
  AuthConfig,
7313
7338
  GoogleMaps,
7314
- UrlContext,
7315
7339
  ComputerUse,
7316
7340
  ApiAuthApiKeyConfig,
7317
7341
  ApiAuth,
@@ -7330,22 +7354,22 @@ declare namespace types {
7330
7354
  VertexRagStore,
7331
7355
  Retrieval,
7332
7356
  ToolCodeExecution,
7357
+ EnterpriseWebSearch,
7358
+ Interval,
7359
+ GoogleSearch,
7360
+ UrlContext,
7333
7361
  Tool,
7334
7362
  FunctionCallingConfig,
7335
7363
  LatLng,
7336
7364
  RetrievalConfig,
7337
7365
  ToolConfig,
7338
- PrebuiltVoiceConfig,
7339
- VoiceConfig,
7340
- SpeakerVoiceConfig,
7341
- MultiSpeakerVoiceConfig,
7342
- SpeechConfig,
7343
7366
  AutomaticFunctionCallingConfig,
7344
7367
  ThinkingConfig,
7345
7368
  ImageConfig,
7346
7369
  GenerationConfigRoutingConfigAutoRoutingMode,
7347
7370
  GenerationConfigRoutingConfigManualRoutingMode,
7348
7371
  GenerationConfigRoutingConfig,
7372
+ SafetySetting,
7349
7373
  GenerateContentConfig,
7350
7374
  GenerateContentParameters,
7351
7375
  HttpResponse,
@@ -7353,8 +7377,6 @@ declare namespace types {
7353
7377
  GoogleTypeDate,
7354
7378
  Citation,
7355
7379
  CitationMetadata,
7356
- UrlMetadata,
7357
- UrlContextMetadata,
7358
7380
  GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution,
7359
7381
  GroundingChunkMapsPlaceAnswerSourcesReviewSnippet,
7360
7382
  GroundingChunkMapsPlaceAnswerSources,
@@ -7374,6 +7396,8 @@ declare namespace types {
7374
7396
  LogprobsResultTopCandidates,
7375
7397
  LogprobsResult,
7376
7398
  SafetyRating,
7399
+ UrlMetadata,
7400
+ UrlContextMetadata,
7377
7401
  Candidate,
7378
7402
  GenerateContentResponsePromptFeedback,
7379
7403
  ModalityTokenCount,
@@ -7426,6 +7450,11 @@ declare namespace types {
7426
7450
  DeleteModelConfig,
7427
7451
  DeleteModelParameters,
7428
7452
  DeleteModelResponse,
7453
+ PrebuiltVoiceConfig,
7454
+ VoiceConfig,
7455
+ SpeakerVoiceConfig,
7456
+ MultiSpeakerVoiceConfig,
7457
+ SpeechConfig,
7429
7458
  GenerationConfig,
7430
7459
  CountTokensConfig,
7431
7460
  CountTokensParameters,
@@ -7448,10 +7477,12 @@ declare namespace types {
7448
7477
  GetTuningJobParameters,
7449
7478
  TunedModelCheckpoint,
7450
7479
  TunedModel,
7451
- GoogleRpcStatus,
7452
- PreTunedModel,
7453
7480
  SupervisedHyperParameters,
7454
7481
  SupervisedTuningSpec,
7482
+ PreferenceOptimizationHyperParameters,
7483
+ PreferenceOptimizationSpec,
7484
+ GoogleRpcStatus,
7485
+ PreTunedModel,
7455
7486
  DatasetDistributionDistributionBucket,
7456
7487
  DatasetDistribution,
7457
7488
  DatasetStats,
@@ -7737,6 +7768,10 @@ export declare interface UpscaleImageConfig {
7737
7768
  abortSignal?: AbortSignal;
7738
7769
  /** Cloud Storage URI used to store the generated images. */
7739
7770
  outputGcsUri?: string;
7771
+ /** Filter level for safety filtering. */
7772
+ safetyFilterLevel?: SafetyFilterLevel;
7773
+ /** Allows generation of people by the model. */
7774
+ personGeneration?: PersonGeneration;
7740
7775
  /** Whether to include a reason for filtered-out images in the
7741
7776
  response. */
7742
7777
  includeRaiReason?: boolean;
@@ -7777,19 +7812,19 @@ export declare class UpscaleImageResponse {
7777
7812
  generatedImages?: GeneratedImage[];
7778
7813
  }
7779
7814
 
7780
- /** Tool to support URL context retrieval. */
7815
+ /** Tool to support URL context. */
7781
7816
  export declare interface UrlContext {
7782
7817
  }
7783
7818
 
7784
7819
  /** Metadata related to url context retrieval tool. */
7785
7820
  export declare interface UrlContextMetadata {
7786
- /** List of url context. */
7821
+ /** Output only. List of url context. */
7787
7822
  urlMetadata?: UrlMetadata[];
7788
7823
  }
7789
7824
 
7790
- /** Context for a single url retrieval. */
7825
+ /** Context of the a single url retrieval. */
7791
7826
  export declare interface UrlMetadata {
7792
- /** The URL retrieved by the tool. */
7827
+ /** Retrieved url by the tool. */
7793
7828
  retrievedUrl?: string;
7794
7829
  /** Status of the url retrieval. */
7795
7830
  urlRetrievalStatus?: UrlRetrievalStatus;
@@ -7798,7 +7833,7 @@ export declare interface UrlMetadata {
7798
7833
  /** Status of the url retrieval. */
7799
7834
  export declare enum UrlRetrievalStatus {
7800
7835
  /**
7801
- * Default value. This value is unused
7836
+ * Default value. This value is unused.
7802
7837
  */
7803
7838
  URL_RETRIEVAL_STATUS_UNSPECIFIED = "URL_RETRIEVAL_STATUS_UNSPECIFIED",
7804
7839
  /**
@@ -7810,11 +7845,11 @@ export declare enum UrlRetrievalStatus {
7810
7845
  */
7811
7846
  URL_RETRIEVAL_STATUS_ERROR = "URL_RETRIEVAL_STATUS_ERROR",
7812
7847
  /**
7813
- * Url retrieval is failed because the content is behind paywall.
7848
+ * Url retrieval is failed because the content is behind paywall. This enum value is not supported in Vertex AI.
7814
7849
  */
7815
7850
  URL_RETRIEVAL_STATUS_PAYWALL = "URL_RETRIEVAL_STATUS_PAYWALL",
7816
7851
  /**
7817
- * Url retrieval is failed because the content is unsafe.
7852
+ * Url retrieval is failed because the content is unsafe. This enum value is not supported in Vertex AI.
7818
7853
  */
7819
7854
  URL_RETRIEVAL_STATUS_UNSAFE = "URL_RETRIEVAL_STATUS_UNSAFE"
7820
7855
  }
@@ -7846,7 +7881,7 @@ export declare interface UsageMetadata {
7846
7881
  trafficType?: TrafficType;
7847
7882
  }
7848
7883
 
7849
- /** Hyperparameters for Veo. */
7884
+ /** Hyperparameters for Veo. This data type is not supported in Gemini API. */
7850
7885
  export declare interface VeoHyperParameters {
7851
7886
  /** Optional. Number of complete passes the model makes over the entire training dataset during training. */
7852
7887
  epochCount?: string;
@@ -7856,7 +7891,7 @@ export declare interface VeoHyperParameters {
7856
7891
  tuningTask?: TuningTask;
7857
7892
  }
7858
7893
 
7859
- /** Tuning Spec for Veo Model Tuning. */
7894
+ /** Tuning Spec for Veo Model Tuning. This data type is not supported in Gemini API. */
7860
7895
  export declare interface VeoTuningSpec {
7861
7896
  /** Optional. Hyperparameters for Veo. */
7862
7897
  hyperParameters?: VeoHyperParameters;
@@ -7866,7 +7901,7 @@ export declare interface VeoTuningSpec {
7866
7901
  validationDatasetUri?: string;
7867
7902
  }
7868
7903
 
7869
- /** Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder */
7904
+ /** Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder. This data type is not supported in Gemini API. */
7870
7905
  export declare interface VertexAISearch {
7871
7906
  /** Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. */
7872
7907
  dataStoreSpecs?: VertexAISearchDataStoreSpec[];
@@ -7880,7 +7915,7 @@ export declare interface VertexAISearch {
7880
7915
  maxResults?: number;
7881
7916
  }
7882
7917
 
7883
- /** Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec */
7918
+ /** Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec. This data type is not supported in Gemini API. */
7884
7919
  export declare interface VertexAISearchDataStoreSpec {
7885
7920
  /** Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
7886
7921
  dataStore?: string;
@@ -7888,7 +7923,7 @@ export declare interface VertexAISearchDataStoreSpec {
7888
7923
  filter?: string;
7889
7924
  }
7890
7925
 
7891
- /** Retrieve from Vertex RAG Store for grounding. */
7926
+ /** Retrieve from Vertex RAG Store for grounding. This data type is not supported in Gemini API. */
7892
7927
  export declare interface VertexRagStore {
7893
7928
  /** Optional. Deprecated. Please use rag_resources instead. */
7894
7929
  ragCorpora?: string[];
@@ -7904,7 +7939,7 @@ export declare interface VertexRagStore {
7904
7939
  vectorDistanceThreshold?: number;
7905
7940
  }
7906
7941
 
7907
- /** The definition of the Rag resource. */
7942
+ /** The definition of the Rag resource. This data type is not supported in Gemini API. */
7908
7943
  export declare interface VertexRagStoreRagResource {
7909
7944
  /** Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
7910
7945
  ragCorpus?: string;
@@ -7998,21 +8033,19 @@ export declare enum VideoGenerationReferenceType {
7998
8033
  STYLE = "STYLE"
7999
8034
  }
8000
8035
 
8001
- /** Describes how the video in the Part should be used by the model. */
8036
+ /** Metadata describes the input video content. */
8002
8037
  export declare interface VideoMetadata {
8003
- /** The frame rate of the video sent to the model. If not specified, the
8004
- default value will be 1.0. The fps range is (0.0, 24.0]. */
8005
- fps?: number;
8006
8038
  /** Optional. The end offset of the video. */
8007
8039
  endOffset?: string;
8040
+ /** 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]. */
8041
+ fps?: number;
8008
8042
  /** Optional. The start offset of the video. */
8009
8043
  startOffset?: string;
8010
8044
  }
8011
8045
 
8012
8046
  /** The configuration for the voice to use. */
8013
8047
  export declare interface VoiceConfig {
8014
- /** The configuration for the speaker to use.
8015
- */
8048
+ /** The configuration for the prebuilt voice to use. */
8016
8049
  prebuiltVoiceConfig?: PrebuiltVoiceConfig;
8017
8050
  }
8018
8051