@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/web/web.d.ts CHANGED
@@ -32,7 +32,7 @@ export declare enum ActivityHandling {
32
32
  export declare interface ActivityStart {
33
33
  }
34
34
 
35
- /** Optional. Adapter size for tuning. */
35
+ /** Adapter size for tuning. This enum is not supported in Gemini API. */
36
36
  export declare enum AdapterSize {
37
37
  /**
38
38
  * Adapter size is unspecified.
@@ -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;
@@ -3441,7 +3444,7 @@ export declare interface GoogleMaps {
3441
3444
  enableWidget?: boolean;
3442
3445
  }
3443
3446
 
3444
- /** 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). */
3447
+ /** 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. */
3445
3448
  export declare interface GoogleRpcStatus {
3446
3449
  /** The status code, which should be an enum value of google.rpc.Code. */
3447
3450
  code?: number;
@@ -3451,14 +3454,12 @@ export declare interface GoogleRpcStatus {
3451
3454
  message?: string;
3452
3455
  }
3453
3456
 
3454
- /** Tool to support Google Search in Model. Powered by Google. */
3457
+ /** GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
3455
3458
  export declare interface GoogleSearch {
3456
- /** Optional. Filter search results to a specific time range.
3457
- If customers set a start time, they must set an end time (and vice versa).
3458
- */
3459
- timeRangeFilter?: Interval;
3460
- /** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. */
3459
+ /** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. This field is not supported in Gemini API. */
3461
3460
  excludeDomains?: string[];
3461
+ /** Optional. Filter search results to a specific time range. If customers set a start time, they must set an end time (and vice versa). This field is not supported in Vertex AI. */
3462
+ timeRangeFilter?: Interval;
3462
3463
  }
3463
3464
 
3464
3465
  /** Tool to retrieve public web data for grounding, powered by Google. */
@@ -3467,7 +3468,7 @@ export declare interface GoogleSearchRetrieval {
3467
3468
  dynamicRetrievalConfig?: DynamicRetrievalConfig;
3468
3469
  }
3469
3470
 
3470
- /** 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 */
3471
+ /** 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. */
3471
3472
  export declare interface GoogleTypeDate {
3472
3473
  /** 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. */
3473
3474
  day?: number;
@@ -3479,15 +3480,15 @@ export declare interface GoogleTypeDate {
3479
3480
 
3480
3481
  /** Grounding chunk. */
3481
3482
  export declare interface GroundingChunk {
3482
- /** Grounding chunk from Google Maps. */
3483
+ /** Grounding chunk from Google Maps. This field is not supported in Gemini API. */
3483
3484
  maps?: GroundingChunkMaps;
3484
- /** Grounding chunk from context retrieved by the retrieval tools. */
3485
+ /** Grounding chunk from context retrieved by the retrieval tools. This field is not supported in Gemini API. */
3485
3486
  retrievedContext?: GroundingChunkRetrievedContext;
3486
3487
  /** Grounding chunk from the web. */
3487
3488
  web?: GroundingChunkWeb;
3488
3489
  }
3489
3490
 
3490
- /** Chunk from Google Maps. */
3491
+ /** Chunk from Google Maps. This data type is not supported in Gemini API. */
3491
3492
  export declare interface GroundingChunkMaps {
3492
3493
  /** 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. */
3493
3494
  placeAnswerSources?: GroundingChunkMapsPlaceAnswerSources;
@@ -3501,7 +3502,7 @@ export declare interface GroundingChunkMaps {
3501
3502
  uri?: string;
3502
3503
  }
3503
3504
 
3504
- /** Sources used to generate the place answer. */
3505
+ /** Sources used to generate the place answer. This data type is not supported in Gemini API. */
3505
3506
  export declare interface GroundingChunkMapsPlaceAnswerSources {
3506
3507
  /** A link where users can flag a problem with the generated answer. */
3507
3508
  flagContentUri?: string;
@@ -3509,7 +3510,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSources {
3509
3510
  reviewSnippets?: GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
3510
3511
  }
3511
3512
 
3512
- /** Author attribution for a photo or review. */
3513
+ /** Author attribution for a photo or review. This data type is not supported in Gemini API. */
3513
3514
  export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
3514
3515
  /** Name of the author of the Photo or Review. */
3515
3516
  displayName?: string;
@@ -3519,7 +3520,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
3519
3520
  uri?: string;
3520
3521
  }
3521
3522
 
3522
- /** Encapsulates a review snippet. */
3523
+ /** Encapsulates a review snippet. This data type is not supported in Gemini API. */
3523
3524
  export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
3524
3525
  /** This review's author. */
3525
3526
  authorAttribution?: GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution;
@@ -3537,7 +3538,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
3537
3538
  title?: string;
3538
3539
  }
3539
3540
 
3540
- /** Chunk from context retrieved by the retrieval tools. */
3541
+ /** Chunk from context retrieved by the retrieval tools. This data type is not supported in Gemini API. */
3541
3542
  export declare interface GroundingChunkRetrievedContext {
3542
3543
  /** Output only. The full document name for the referenced Vertex AI Search document. */
3543
3544
  documentName?: string;
@@ -3553,7 +3554,7 @@ export declare interface GroundingChunkRetrievedContext {
3553
3554
 
3554
3555
  /** Chunk from the web. */
3555
3556
  export declare interface GroundingChunkWeb {
3556
- /** Domain of the (original) URI. */
3557
+ /** Domain of the (original) URI. This field is not supported in Gemini API. */
3557
3558
  domain?: string;
3558
3559
  /** Title of the chunk. */
3559
3560
  title?: string;
@@ -3563,7 +3564,7 @@ export declare interface GroundingChunkWeb {
3563
3564
 
3564
3565
  /** Metadata returned to client when grounding is enabled. */
3565
3566
  export declare interface GroundingMetadata {
3566
- /** 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. */
3567
+ /** 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. */
3567
3568
  googleMapsWidgetContextToken?: string;
3568
3569
  /** List of supporting references retrieved from specified grounding source. */
3569
3570
  groundingChunks?: GroundingChunk[];
@@ -3571,17 +3572,17 @@ export declare interface GroundingMetadata {
3571
3572
  groundingSupports?: GroundingSupport[];
3572
3573
  /** Optional. Output only. Retrieval metadata. */
3573
3574
  retrievalMetadata?: RetrievalMetadata;
3574
- /** Optional. Queries executed by the retrieval tools. */
3575
+ /** Optional. Queries executed by the retrieval tools. This field is not supported in Gemini API. */
3575
3576
  retrievalQueries?: string[];
3576
3577
  /** Optional. Google search entry for the following-up web searches. */
3577
3578
  searchEntryPoint?: SearchEntryPoint;
3578
- /** Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. */
3579
+ /** 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. */
3579
3580
  sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
3580
3581
  /** Optional. Web search queries for the following-up web search. */
3581
3582
  webSearchQueries?: string[];
3582
3583
  }
3583
3584
 
3584
- /** Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. */
3585
+ /** 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. */
3585
3586
  export declare interface GroundingMetadataSourceFlaggingUri {
3586
3587
  /** A link where users can flag a problem with the source (place or review). */
3587
3588
  flagContentUri?: string;
@@ -3599,7 +3600,7 @@ export declare interface GroundingSupport {
3599
3600
  segment?: Segment;
3600
3601
  }
3601
3602
 
3602
- /** Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. */
3603
+ /** Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. This enum is not supported in Gemini API. */
3603
3604
  export declare enum HarmBlockMethod {
3604
3605
  /**
3605
3606
  * The harm block method is unspecified.
@@ -3615,7 +3616,7 @@ export declare enum HarmBlockMethod {
3615
3616
  PROBABILITY = "PROBABILITY"
3616
3617
  }
3617
3618
 
3618
- /** Required. The harm block threshold. */
3619
+ /** The harm block threshold. */
3619
3620
  export declare enum HarmBlockThreshold {
3620
3621
  /**
3621
3622
  * Unspecified harm block threshold.
@@ -3643,7 +3644,7 @@ export declare enum HarmBlockThreshold {
3643
3644
  OFF = "OFF"
3644
3645
  }
3645
3646
 
3646
- /** Required. Harm category. */
3647
+ /** Harm category. */
3647
3648
  export declare enum HarmCategory {
3648
3649
  /**
3649
3650
  * The harm category is unspecified.
@@ -3670,23 +3671,23 @@ export declare enum HarmCategory {
3670
3671
  */
3671
3672
  HARM_CATEGORY_CIVIC_INTEGRITY = "HARM_CATEGORY_CIVIC_INTEGRITY",
3672
3673
  /**
3673
- * The harm category is image hate.
3674
+ * The harm category is image hate. This enum value is not supported in Gemini API.
3674
3675
  */
3675
3676
  HARM_CATEGORY_IMAGE_HATE = "HARM_CATEGORY_IMAGE_HATE",
3676
3677
  /**
3677
- * The harm category is image dangerous content.
3678
+ * The harm category is image dangerous content. This enum value is not supported in Gemini API.
3678
3679
  */
3679
3680
  HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT = "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT",
3680
3681
  /**
3681
- * The harm category is image harassment.
3682
+ * The harm category is image harassment. This enum value is not supported in Gemini API.
3682
3683
  */
3683
3684
  HARM_CATEGORY_IMAGE_HARASSMENT = "HARM_CATEGORY_IMAGE_HARASSMENT",
3684
3685
  /**
3685
- * The harm category is image sexually explicit content.
3686
+ * The harm category is image sexually explicit content. This enum value is not supported in Gemini API.
3686
3687
  */
3687
3688
  HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT = "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT",
3688
3689
  /**
3689
- * The harm category is for jailbreak prompts.
3690
+ * The harm category is for jailbreak prompts. This enum value is not supported in Gemini API.
3690
3691
  */
3691
3692
  HARM_CATEGORY_JAILBREAK = "HARM_CATEGORY_JAILBREAK"
3692
3693
  }
@@ -3715,7 +3716,7 @@ export declare enum HarmProbability {
3715
3716
  HIGH = "HIGH"
3716
3717
  }
3717
3718
 
3718
- /** Output only. Harm severity levels in the content. */
3719
+ /** Output only. Harm severity levels in the content. This enum is not supported in Gemini API. */
3719
3720
  export declare enum HarmSeverity {
3720
3721
  /**
3721
3722
  * Harm severity unspecified.
@@ -3798,7 +3799,7 @@ declare interface HttpRequest {
3798
3799
  /**
3799
3800
  * Optional set of customizable configuration for HTTP requests.
3800
3801
  */
3801
- httpOptions?: HttpOptions;
3802
+ httpOptions?: types.HttpOptions;
3802
3803
  /**
3803
3804
  * Optional abort signal which can be used to cancel the request.
3804
3805
  */
@@ -3909,17 +3910,12 @@ export declare class InlinedResponse {
3909
3910
  error?: JobError;
3910
3911
  }
3911
3912
 
3912
- /** Represents a time interval, encoded as a start time (inclusive) and an end time (exclusive).
3913
-
3914
- The start time must be less than or equal to the end time.
3915
- When the start equals the end time, the interval is an empty interval.
3916
- (matches no time)
3917
- When both start and end are unspecified, the interval matches any time. */
3913
+ /** Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. */
3918
3914
  export declare interface Interval {
3919
- /** The start time of the interval. */
3920
- startTime?: string;
3921
- /** The end time of the interval. */
3915
+ /** Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. */
3922
3916
  endTime?: string;
3917
+ /** Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. */
3918
+ startTime?: string;
3923
3919
  }
3924
3920
 
3925
3921
  /** Job error. */
@@ -3984,7 +3980,7 @@ export declare enum JobState {
3984
3980
  JOB_STATE_PARTIALLY_SUCCEEDED = "JOB_STATE_PARTIALLY_SUCCEEDED"
3985
3981
  }
3986
3982
 
3987
- /** Required. Programming language of the `code`. */
3983
+ /** Programming language of the `code`. */
3988
3984
  export declare enum Language {
3989
3985
  /**
3990
3986
  * Unspecified language. This value should not be used.
@@ -5493,9 +5489,9 @@ export declare interface ModelSelectionConfig {
5493
5489
  featureSelectionPreference?: FeatureSelectionPreference;
5494
5490
  }
5495
5491
 
5496
- /** The configuration for the multi-speaker setup. */
5492
+ /** The configuration for the multi-speaker setup. This data type is not supported in Vertex AI. */
5497
5493
  export declare interface MultiSpeakerVoiceConfig {
5498
- /** The configuration for the speaker to use. */
5494
+ /** Required. All the enabled speaker voices. */
5499
5495
  speakerVoiceConfigs?: SpeakerVoiceConfig[];
5500
5496
  }
5501
5497
 
@@ -5578,7 +5574,7 @@ export declare class Operations extends BaseModule {
5578
5574
  private fetchPredictVideosOperationInternal;
5579
5575
  }
5580
5576
 
5581
- /** Required. Outcome of the code execution. */
5577
+ /** Outcome of the code execution. */
5582
5578
  export declare enum Outcome {
5583
5579
  /**
5584
5580
  * Unspecified status. This value should not be used.
@@ -5603,10 +5599,13 @@ export declare enum PagedItem {
5603
5599
  PAGED_ITEM_MODELS = "models",
5604
5600
  PAGED_ITEM_TUNING_JOBS = "tuningJobs",
5605
5601
  PAGED_ITEM_FILES = "files",
5606
- PAGED_ITEM_CACHED_CONTENTS = "cachedContents"
5602
+ PAGED_ITEM_CACHED_CONTENTS = "cachedContents",
5603
+ PAGED_ITEM_RAG_STORES = "ragStores",
5604
+ PAGED_ITEM_DOCUMENTS = "documents"
5607
5605
  }
5608
5606
 
5609
5607
  declare interface PagedItemConfig {
5608
+ parent?: string;
5610
5609
  config?: {
5611
5610
  pageToken?: string;
5612
5611
  pageSize?: number;
@@ -5621,6 +5620,8 @@ declare interface PagedItemResponse<T> {
5621
5620
  tuningJobs?: T[];
5622
5621
  files?: T[];
5623
5622
  cachedContents?: T[];
5623
+ ragStores?: T[];
5624
+ documents?: T[];
5624
5625
  }
5625
5626
 
5626
5627
  /**
@@ -5729,17 +5730,6 @@ export declare class Pager<T> implements AsyncIterable<T> {
5729
5730
  of content being conveyed. Using multiple fields within the same `Part`
5730
5731
  instance is considered invalid. */
5731
5732
  export declare interface Part {
5732
- /** Metadata for a given video. */
5733
- videoMetadata?: VideoMetadata;
5734
- /** Indicates if the part is thought from the model. */
5735
- thought?: boolean;
5736
- /** Optional. Inlined bytes data. */
5737
- inlineData?: Blob_2;
5738
- /** Optional. URI based data. */
5739
- fileData?: FileData;
5740
- /** An opaque signature for the thought so it can be reused in subsequent requests.
5741
- * @remarks Encoded as base64 string. */
5742
- thoughtSignature?: string;
5743
5733
  /** A predicted [FunctionCall] returned from the model that contains a string
5744
5734
  representing the [FunctionDeclaration.name] and a structured JSON object
5745
5735
  containing the parameters and their values. */
@@ -5748,15 +5738,26 @@ export declare interface Part {
5748
5738
  codeExecutionResult?: CodeExecutionResult;
5749
5739
  /** Optional. Code generated by the model that is meant to be executed. */
5750
5740
  executableCode?: ExecutableCode;
5741
+ /** Optional. URI based data. */
5742
+ fileData?: FileData;
5751
5743
  /** Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. */
5752
5744
  functionResponse?: FunctionResponse;
5745
+ /** Optional. Inlined bytes data. */
5746
+ inlineData?: Blob_2;
5753
5747
  /** Optional. Text part (can be code). */
5754
5748
  text?: string;
5749
+ /** Optional. Indicates if the part is thought from the model. */
5750
+ thought?: boolean;
5751
+ /** Optional. An opaque signature for the thought so it can be reused in subsequent requests.
5752
+ * @remarks Encoded as base64 string. */
5753
+ thoughtSignature?: string;
5754
+ /** Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. */
5755
+ videoMetadata?: VideoMetadata;
5755
5756
  }
5756
5757
 
5757
5758
  export declare type PartListUnion = PartUnion[] | PartUnion;
5758
5759
 
5759
- /** Tuning spec for Partner models. */
5760
+ /** Tuning spec for Partner models. This data type is not supported in Gemini API. */
5760
5761
  export declare interface PartnerModelTuningSpec {
5761
5762
  /** Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model. */
5762
5763
  hyperParameters?: Record<string, unknown>;
@@ -5786,11 +5787,11 @@ export declare enum PersonGeneration {
5786
5787
 
5787
5788
  /** The configuration for the prebuilt speaker to use. */
5788
5789
  export declare interface PrebuiltVoiceConfig {
5789
- /** The name of the prebuilt voice to use. */
5790
+ /** The name of the preset voice to use. */
5790
5791
  voiceName?: string;
5791
5792
  }
5792
5793
 
5793
- /** Statistics computed for datasets used for preference optimization. */
5794
+ /** Statistics computed for datasets used for preference optimization. This data type is not supported in Gemini API. */
5794
5795
  export declare interface PreferenceOptimizationDataStats {
5795
5796
  /** Output only. Dataset distributions for scores variance per example. */
5796
5797
  scoreVariancePerExampleDistribution?: DatasetDistribution;
@@ -5810,7 +5811,29 @@ export declare interface PreferenceOptimizationDataStats {
5810
5811
  userOutputTokenDistribution?: DatasetDistribution;
5811
5812
  }
5812
5813
 
5813
- /** A pre-tuned model for continuous tuning. */
5814
+ /** Hyperparameters for Preference Optimization. This data type is not supported in Gemini API. */
5815
+ export declare interface PreferenceOptimizationHyperParameters {
5816
+ /** Optional. Adapter size for preference optimization. */
5817
+ adapterSize?: AdapterSize;
5818
+ /** Optional. Weight for KL Divergence regularization. */
5819
+ beta?: number;
5820
+ /** Optional. Number of complete passes the model makes over the entire training dataset during training. */
5821
+ epochCount?: string;
5822
+ /** Optional. Multiplier for adjusting the default learning rate. */
5823
+ learningRateMultiplier?: number;
5824
+ }
5825
+
5826
+ /** Preference optimization tuning spec for tuning. */
5827
+ export declare interface PreferenceOptimizationSpec {
5828
+ /** Optional. Hyperparameters for Preference Optimization. */
5829
+ hyperParameters?: PreferenceOptimizationHyperParameters;
5830
+ /** Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. */
5831
+ trainingDatasetUri?: string;
5832
+ /** Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. */
5833
+ validationDatasetUri?: string;
5834
+ }
5835
+
5836
+ /** A pre-tuned model for continuous tuning. This data type is not supported in Gemini API. */
5814
5837
  export declare interface PreTunedModel {
5815
5838
  /** Output only. The name of the base model this PreTunedModel was tuned from. */
5816
5839
  baseModel?: string;
@@ -5834,7 +5857,7 @@ export declare interface ProductImage {
5834
5857
  productImage?: Image_2;
5835
5858
  }
5836
5859
 
5837
- /** A RagChunk includes the content of a chunk of a RagFile, and associated metadata. */
5860
+ /** A RagChunk includes the content of a chunk of a RagFile, and associated metadata. This data type is not supported in Gemini API. */
5838
5861
  export declare interface RagChunk {
5839
5862
  /** If populated, represents where the chunk starts and ends in the document. */
5840
5863
  pageSpan?: RagChunkPageSpan;
@@ -5842,7 +5865,7 @@ export declare interface RagChunk {
5842
5865
  text?: string;
5843
5866
  }
5844
5867
 
5845
- /** Represents where the chunk starts and ends in the document. */
5868
+ /** Represents where the chunk starts and ends in the document. This data type is not supported in Gemini API. */
5846
5869
  export declare interface RagChunkPageSpan {
5847
5870
  /** Page where chunk starts in the document. Inclusive. 1-indexed. */
5848
5871
  firstPage?: number;
@@ -5850,7 +5873,7 @@ export declare interface RagChunkPageSpan {
5850
5873
  lastPage?: number;
5851
5874
  }
5852
5875
 
5853
- /** Specifies the context retrieval config. */
5876
+ /** Specifies the context retrieval config. This data type is not supported in Gemini API. */
5854
5877
  export declare interface RagRetrievalConfig {
5855
5878
  /** Optional. Config for filters. */
5856
5879
  filter?: RagRetrievalConfigFilter;
@@ -5862,7 +5885,7 @@ export declare interface RagRetrievalConfig {
5862
5885
  topK?: number;
5863
5886
  }
5864
5887
 
5865
- /** Config for filters. */
5888
+ /** Config for filters. This data type is not supported in Gemini API. */
5866
5889
  export declare interface RagRetrievalConfigFilter {
5867
5890
  /** Optional. String for metadata filtering. */
5868
5891
  metadataFilter?: string;
@@ -5872,13 +5895,13 @@ export declare interface RagRetrievalConfigFilter {
5872
5895
  vectorSimilarityThreshold?: number;
5873
5896
  }
5874
5897
 
5875
- /** Config for Hybrid Search. */
5898
+ /** Config for Hybrid Search. This data type is not supported in Gemini API. */
5876
5899
  export declare interface RagRetrievalConfigHybridSearch {
5877
5900
  /** 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. */
5878
5901
  alpha?: number;
5879
5902
  }
5880
5903
 
5881
- /** Config for ranking and reranking. */
5904
+ /** Config for ranking and reranking. This data type is not supported in Gemini API. */
5882
5905
  export declare interface RagRetrievalConfigRanking {
5883
5906
  /** Optional. Config for LlmRanker. */
5884
5907
  llmRanker?: RagRetrievalConfigRankingLlmRanker;
@@ -5886,13 +5909,13 @@ export declare interface RagRetrievalConfigRanking {
5886
5909
  rankService?: RagRetrievalConfigRankingRankService;
5887
5910
  }
5888
5911
 
5889
- /** Config for LlmRanker. */
5912
+ /** Config for LlmRanker. This data type is not supported in Gemini API. */
5890
5913
  export declare interface RagRetrievalConfigRankingLlmRanker {
5891
5914
  /** Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). */
5892
5915
  modelName?: string;
5893
5916
  }
5894
5917
 
5895
- /** Config for Rank Service. */
5918
+ /** Config for Rank Service. This data type is not supported in Gemini API. */
5896
5919
  export declare interface RagRetrievalConfigRankingRankService {
5897
5920
  /** Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` */
5898
5921
  modelName?: string;
@@ -6042,7 +6065,7 @@ export declare class ReplayResponse {
6042
6065
  sdkResponseSegments?: Record<string, unknown>[];
6043
6066
  }
6044
6067
 
6045
- /** Defines a retrieval tool that model can call to access external knowledge. */
6068
+ /** Defines a retrieval tool that model can call to access external knowledge. This data type is not supported in Gemini API. */
6046
6069
  export declare interface Retrieval {
6047
6070
  /** Optional. Deprecated. This option is no longer supported. */
6048
6071
  disableAttribution?: boolean;
@@ -6093,25 +6116,24 @@ export declare interface SafetyRating {
6093
6116
  blocked?: boolean;
6094
6117
  /** Output only. Harm category. */
6095
6118
  category?: HarmCategory;
6096
- /** Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. */
6119
+ /** Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. This field is not supported in Gemini API. */
6097
6120
  overwrittenThreshold?: HarmBlockThreshold;
6098
6121
  /** Output only. Harm probability levels in the content. */
6099
6122
  probability?: HarmProbability;
6100
- /** Output only. Harm probability score. */
6123
+ /** Output only. Harm probability score. This field is not supported in Gemini API. */
6101
6124
  probabilityScore?: number;
6102
- /** Output only. Harm severity levels in the content. */
6125
+ /** Output only. Harm severity levels in the content. This field is not supported in Gemini API. */
6103
6126
  severity?: HarmSeverity;
6104
- /** Output only. Harm severity score. */
6127
+ /** Output only. Harm severity score. This field is not supported in Gemini API. */
6105
6128
  severityScore?: number;
6106
6129
  }
6107
6130
 
6108
6131
  /** Safety settings. */
6109
6132
  export declare interface SafetySetting {
6110
- /** Determines if the harm block method uses probability or probability
6111
- and severity scores. */
6112
- method?: HarmBlockMethod;
6113
6133
  /** Required. Harm category. */
6114
6134
  category?: HarmCategory;
6135
+ /** Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. This field is not supported in Gemini API. */
6136
+ method?: HarmBlockMethod;
6115
6137
  /** Required. The harm block threshold. */
6116
6138
  threshold?: HarmBlockThreshold;
6117
6139
  }
@@ -6525,28 +6547,22 @@ export declare interface SlidingWindow {
6525
6547
  targetTokens?: string;
6526
6548
  }
6527
6549
 
6528
- /** The configuration for the speaker to use. */
6550
+ /** The configuration for a single speaker in a multi speaker setup. This data type is not supported in Vertex AI. */
6529
6551
  export declare interface SpeakerVoiceConfig {
6530
- /** The name of the speaker to use. Should be the same as in the
6531
- prompt. */
6552
+ /** Required. The name of the speaker to use. Should be the same as in the prompt. */
6532
6553
  speaker?: string;
6533
- /** The configuration for the voice to use. */
6554
+ /** Required. The configuration for the voice to use. */
6534
6555
  voiceConfig?: VoiceConfig;
6535
6556
  }
6536
6557
 
6537
- /** The speech generation configuration. */
6558
+ /** The speech generation config. */
6538
6559
  export declare interface SpeechConfig {
6539
- /** The configuration for the speaker to use.
6540
- */
6560
+ /** Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. */
6561
+ languageCode?: string;
6562
+ /** The configuration for the speaker to use. */
6541
6563
  voiceConfig?: VoiceConfig;
6542
- /** The configuration for the multi-speaker setup.
6543
- It is mutually exclusive with the voice_config field.
6544
- */
6564
+ /** Optional. The configuration for the multi-speaker setup. It is mutually exclusive with the voice_config field. This field is not supported in Vertex AI. */
6545
6565
  multiSpeakerVoiceConfig?: MultiSpeakerVoiceConfig;
6546
- /** Language code (ISO 639. e.g. en-US) for the speech synthesization.
6547
- Only available for Live API.
6548
- */
6549
- languageCode?: string;
6550
6566
  }
6551
6567
 
6552
6568
  export declare type SpeechConfigUnion = SpeechConfig | string;
@@ -6628,7 +6644,7 @@ export declare enum SubjectReferenceType {
6628
6644
  SUBJECT_TYPE_PRODUCT = "SUBJECT_TYPE_PRODUCT"
6629
6645
  }
6630
6646
 
6631
- /** Hyperparameters for SFT. */
6647
+ /** Hyperparameters for SFT. This data type is not supported in Gemini API. */
6632
6648
  export declare interface SupervisedHyperParameters {
6633
6649
  /** Optional. Adapter size for tuning. */
6634
6650
  adapterSize?: AdapterSize;
@@ -6642,7 +6658,7 @@ export declare interface SupervisedHyperParameters {
6642
6658
  learningRateMultiplier?: number;
6643
6659
  }
6644
6660
 
6645
- /** Dataset distribution for Supervised Tuning. */
6661
+ /** Dataset distribution for Supervised Tuning. This data type is not supported in Gemini API. */
6646
6662
  export declare interface SupervisedTuningDatasetDistribution {
6647
6663
  /** Output only. Sum of a given population of values that are billable. */
6648
6664
  billableSum?: string;
@@ -6664,7 +6680,7 @@ export declare interface SupervisedTuningDatasetDistribution {
6664
6680
  sum?: string;
6665
6681
  }
6666
6682
 
6667
- /** Dataset bucket used to create a histogram for the distribution given a population of values. */
6683
+ /** Dataset bucket used to create a histogram for the distribution given a population of values. This data type is not supported in Gemini API. */
6668
6684
  export declare interface SupervisedTuningDatasetDistributionDatasetBucket {
6669
6685
  /** Output only. Number of values in the bucket. */
6670
6686
  count?: number;
@@ -6674,7 +6690,7 @@ export declare interface SupervisedTuningDatasetDistributionDatasetBucket {
6674
6690
  right?: number;
6675
6691
  }
6676
6692
 
6677
- /** Tuning data statistics for Supervised Tuning. */
6693
+ /** Tuning data statistics for Supervised Tuning. This data type is not supported in Gemini API. */
6678
6694
  export declare interface SupervisedTuningDataStats {
6679
6695
  /** Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. */
6680
6696
  droppedExampleReasons?: string[];
@@ -6702,7 +6718,7 @@ export declare interface SupervisedTuningDataStats {
6702
6718
  userOutputTokenDistribution?: SupervisedTuningDatasetDistribution;
6703
6719
  }
6704
6720
 
6705
- /** Tuning Spec for Supervised Tuning for first party models. */
6721
+ /** Supervised tuning spec for tuning. */
6706
6722
  export declare interface SupervisedTuningSpec {
6707
6723
  /** Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false. */
6708
6724
  exportLastCheckpointOnly?: boolean;
@@ -6856,30 +6872,28 @@ export declare interface TokensInfo {
6856
6872
  export declare interface Tool {
6857
6873
  /** List of function declarations that the tool supports. */
6858
6874
  functionDeclarations?: FunctionDeclaration[];
6859
- /** 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. */
6875
+ /** Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. This field is not supported in Gemini API. */
6860
6876
  retrieval?: Retrieval;
6861
- /** Optional. Google Search tool type. Specialized retrieval tool
6862
- that is powered by Google Search. */
6863
- googleSearch?: GoogleSearch;
6864
6877
  /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
6865
6878
  googleSearchRetrieval?: GoogleSearchRetrieval;
6866
- /** Optional. Enterprise web search tool type. Specialized retrieval
6867
- tool that is powered by Vertex AI Search and Sec4 compliance. */
6868
- enterpriseWebSearch?: EnterpriseWebSearch;
6869
6879
  /** Optional. Google Maps tool type. Specialized retrieval tool
6870
6880
  that is powered by Google Maps. */
6871
6881
  googleMaps?: GoogleMaps;
6872
- /** Optional. Tool to support URL context retrieval. */
6873
- urlContext?: UrlContext;
6874
6882
  /** Optional. Tool to support the model interacting directly with the
6875
6883
  computer. If enabled, it automatically populates computer-use specific
6876
6884
  Function Declarations. */
6877
6885
  computerUse?: ComputerUse;
6878
6886
  /** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
6879
6887
  codeExecution?: ToolCodeExecution;
6888
+ /** Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. This field is not supported in Gemini API. */
6889
+ enterpriseWebSearch?: EnterpriseWebSearch;
6890
+ /** Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
6891
+ googleSearch?: GoogleSearch;
6892
+ /** Optional. Tool to support URL context retrieval. */
6893
+ urlContext?: UrlContext;
6880
6894
  }
6881
6895
 
6882
- /** 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. */
6896
+ /** Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. This data type is not supported in Gemini API. */
6883
6897
  export declare interface ToolCodeExecution {
6884
6898
  }
6885
6899
 
@@ -6897,7 +6911,7 @@ export declare type ToolListUnion = ToolUnion[];
6897
6911
 
6898
6912
  export declare type ToolUnion = Tool | CallableTool;
6899
6913
 
6900
- /** Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. */
6914
+ /** Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. This enum is not supported in Gemini API. */
6901
6915
  export declare enum TrafficType {
6902
6916
  /**
6903
6917
  * Unspecified request traffic type.
@@ -6979,7 +6993,7 @@ export declare interface TuningDataset {
6979
6993
  examples?: TuningExample[];
6980
6994
  }
6981
6995
 
6982
- /** The tuning data statistic values for TuningJob. */
6996
+ /** The tuning data statistic values for TuningJob. This data type is not supported in Gemini API. */
6983
6997
  export declare interface TuningDataStats {
6984
6998
  /** Output only. Statistics for distillation. */
6985
6999
  distillationDataStats?: DistillationDataStats;
@@ -6989,7 +7003,7 @@ export declare interface TuningDataStats {
6989
7003
  supervisedTuningDataStats?: SupervisedTuningDataStats;
6990
7004
  }
6991
7005
 
6992
- /** A single example for tuning. */
7006
+ /** A single example for tuning. This data type is not supported in Vertex AI. */
6993
7007
  export declare interface TuningExample {
6994
7008
  /** Required. The expected model output. */
6995
7009
  output?: string;
@@ -7025,6 +7039,8 @@ export declare interface TuningJob {
7025
7039
  preTunedModel?: PreTunedModel;
7026
7040
  /** Tuning Spec for Supervised Fine Tuning. */
7027
7041
  supervisedTuningSpec?: SupervisedTuningSpec;
7042
+ /** Tuning Spec for Preference Optimization. */
7043
+ preferenceOptimizationSpec?: PreferenceOptimizationSpec;
7028
7044
  /** Output only. The tuning data statistics associated with this TuningJob. */
7029
7045
  tuningDataStats?: TuningDataStats;
7030
7046
  /** Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key. */
@@ -7049,7 +7065,19 @@ export declare interface TuningJob {
7049
7065
  veoTuningSpec?: VeoTuningSpec;
7050
7066
  }
7051
7067
 
7052
- /** Tuning mode. */
7068
+ /** Enum representing the tuning method. */
7069
+ export declare enum TuningMethod {
7070
+ /**
7071
+ * Supervised fine tuning.
7072
+ */
7073
+ SUPERVISED_FINE_TUNING = "SUPERVISED_FINE_TUNING",
7074
+ /**
7075
+ * Preference optimization tuning.
7076
+ */
7077
+ PREFERENCE_TUNING = "PREFERENCE_TUNING"
7078
+ }
7079
+
7080
+ /** Tuning mode. This enum is not supported in Gemini API. */
7053
7081
  export declare enum TuningMode {
7054
7082
  /**
7055
7083
  * Tuning mode is unspecified.
@@ -7130,7 +7158,7 @@ declare class Tunings extends BaseModule {
7130
7158
  private tuneMldevInternal;
7131
7159
  }
7132
7160
 
7133
- /** Optional. The tuning task. Either I2V or T2V. */
7161
+ /** The tuning task. Either I2V or T2V. This enum is not supported in Gemini API. */
7134
7162
  export declare enum TuningTask {
7135
7163
  /**
7136
7164
  * Default value. This value is unused.
@@ -7149,7 +7177,7 @@ export declare enum TuningTask {
7149
7177
  export declare interface TuningValidationDataset {
7150
7178
  /** GCS URI of the file containing validation dataset in JSONL format. */
7151
7179
  gcsUri?: string;
7152
- /** 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'. */
7180
+ /** 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'. */
7153
7181
  vertexDatasetResource?: string;
7154
7182
  }
7155
7183
 
@@ -7189,7 +7217,7 @@ export declare enum TurnCoverage {
7189
7217
  TURN_INCLUDES_ALL_INPUT = "TURN_INCLUDES_ALL_INPUT"
7190
7218
  }
7191
7219
 
7192
- /** Optional. The type of the data. */
7220
+ /** The type of the data. */
7193
7221
  export declare enum Type {
7194
7222
  /**
7195
7223
  * Not specified, should not be used.
@@ -7242,23 +7270,23 @@ declare namespace types {
7242
7270
  Language,
7243
7271
  FunctionResponseScheduling,
7244
7272
  Type,
7245
- HarmCategory,
7246
- HarmBlockMethod,
7247
- HarmBlockThreshold,
7248
7273
  Mode,
7249
7274
  AuthType,
7250
7275
  ApiSpec,
7251
- UrlRetrievalStatus,
7276
+ HarmCategory,
7277
+ HarmBlockMethod,
7278
+ HarmBlockThreshold,
7252
7279
  FinishReason,
7253
7280
  HarmProbability,
7254
7281
  HarmSeverity,
7282
+ UrlRetrievalStatus,
7255
7283
  BlockedReason,
7256
7284
  TrafficType,
7257
7285
  Modality,
7258
7286
  MediaResolution,
7259
- JobState,
7260
7287
  TuningMode,
7261
7288
  AdapterSize,
7289
+ JobState,
7262
7290
  TuningTask,
7263
7291
  FeatureSelectionPreference,
7264
7292
  Behavior,
@@ -7276,6 +7304,7 @@ declare namespace types {
7276
7304
  VideoGenerationReferenceType,
7277
7305
  VideoGenerationMaskMode,
7278
7306
  VideoCompressionQuality,
7307
+ TuningMethod,
7279
7308
  FileState,
7280
7309
  FileSource,
7281
7310
  TurnCompleteReason,
@@ -7287,28 +7316,24 @@ declare namespace types {
7287
7316
  Scale,
7288
7317
  MusicGenerationMode,
7289
7318
  LiveMusicPlaybackControl,
7290
- VideoMetadata,
7291
- Blob_2 as Blob,
7292
- FileData,
7293
7319
  FunctionCall,
7294
7320
  CodeExecutionResult,
7295
7321
  ExecutableCode,
7322
+ FileData,
7296
7323
  FunctionResponseBlob,
7297
7324
  FunctionResponseFileData,
7298
7325
  FunctionResponsePart,
7299
7326
  FunctionResponse,
7327
+ Blob_2 as Blob,
7328
+ VideoMetadata,
7300
7329
  Part,
7301
7330
  Content,
7302
7331
  HttpOptions,
7303
7332
  Schema,
7304
7333
  ModelSelectionConfig,
7305
- SafetySetting,
7306
7334
  FunctionDeclaration,
7307
- Interval,
7308
- GoogleSearch,
7309
7335
  DynamicRetrievalConfig,
7310
7336
  GoogleSearchRetrieval,
7311
- EnterpriseWebSearch,
7312
7337
  ApiKeyConfig,
7313
7338
  AuthConfigGoogleServiceAccountConfig,
7314
7339
  AuthConfigHttpBasicAuthConfig,
@@ -7316,7 +7341,6 @@ declare namespace types {
7316
7341
  AuthConfigOidcConfig,
7317
7342
  AuthConfig,
7318
7343
  GoogleMaps,
7319
- UrlContext,
7320
7344
  ComputerUse,
7321
7345
  ApiAuthApiKeyConfig,
7322
7346
  ApiAuth,
@@ -7335,22 +7359,22 @@ declare namespace types {
7335
7359
  VertexRagStore,
7336
7360
  Retrieval,
7337
7361
  ToolCodeExecution,
7362
+ EnterpriseWebSearch,
7363
+ Interval,
7364
+ GoogleSearch,
7365
+ UrlContext,
7338
7366
  Tool,
7339
7367
  FunctionCallingConfig,
7340
7368
  LatLng,
7341
7369
  RetrievalConfig,
7342
7370
  ToolConfig,
7343
- PrebuiltVoiceConfig,
7344
- VoiceConfig,
7345
- SpeakerVoiceConfig,
7346
- MultiSpeakerVoiceConfig,
7347
- SpeechConfig,
7348
7371
  AutomaticFunctionCallingConfig,
7349
7372
  ThinkingConfig,
7350
7373
  ImageConfig,
7351
7374
  GenerationConfigRoutingConfigAutoRoutingMode,
7352
7375
  GenerationConfigRoutingConfigManualRoutingMode,
7353
7376
  GenerationConfigRoutingConfig,
7377
+ SafetySetting,
7354
7378
  GenerateContentConfig,
7355
7379
  GenerateContentParameters,
7356
7380
  HttpResponse,
@@ -7358,8 +7382,6 @@ declare namespace types {
7358
7382
  GoogleTypeDate,
7359
7383
  Citation,
7360
7384
  CitationMetadata,
7361
- UrlMetadata,
7362
- UrlContextMetadata,
7363
7385
  GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution,
7364
7386
  GroundingChunkMapsPlaceAnswerSourcesReviewSnippet,
7365
7387
  GroundingChunkMapsPlaceAnswerSources,
@@ -7379,6 +7401,8 @@ declare namespace types {
7379
7401
  LogprobsResultTopCandidates,
7380
7402
  LogprobsResult,
7381
7403
  SafetyRating,
7404
+ UrlMetadata,
7405
+ UrlContextMetadata,
7382
7406
  Candidate,
7383
7407
  GenerateContentResponsePromptFeedback,
7384
7408
  ModalityTokenCount,
@@ -7431,6 +7455,11 @@ declare namespace types {
7431
7455
  DeleteModelConfig,
7432
7456
  DeleteModelParameters,
7433
7457
  DeleteModelResponse,
7458
+ PrebuiltVoiceConfig,
7459
+ VoiceConfig,
7460
+ SpeakerVoiceConfig,
7461
+ MultiSpeakerVoiceConfig,
7462
+ SpeechConfig,
7434
7463
  GenerationConfig,
7435
7464
  CountTokensConfig,
7436
7465
  CountTokensParameters,
@@ -7453,10 +7482,12 @@ declare namespace types {
7453
7482
  GetTuningJobParameters,
7454
7483
  TunedModelCheckpoint,
7455
7484
  TunedModel,
7456
- GoogleRpcStatus,
7457
- PreTunedModel,
7458
7485
  SupervisedHyperParameters,
7459
7486
  SupervisedTuningSpec,
7487
+ PreferenceOptimizationHyperParameters,
7488
+ PreferenceOptimizationSpec,
7489
+ GoogleRpcStatus,
7490
+ PreTunedModel,
7460
7491
  DatasetDistributionDistributionBucket,
7461
7492
  DatasetDistribution,
7462
7493
  DatasetStats,
@@ -7742,6 +7773,10 @@ export declare interface UpscaleImageConfig {
7742
7773
  abortSignal?: AbortSignal;
7743
7774
  /** Cloud Storage URI used to store the generated images. */
7744
7775
  outputGcsUri?: string;
7776
+ /** Filter level for safety filtering. */
7777
+ safetyFilterLevel?: SafetyFilterLevel;
7778
+ /** Allows generation of people by the model. */
7779
+ personGeneration?: PersonGeneration;
7745
7780
  /** Whether to include a reason for filtered-out images in the
7746
7781
  response. */
7747
7782
  includeRaiReason?: boolean;
@@ -7782,19 +7817,19 @@ export declare class UpscaleImageResponse {
7782
7817
  generatedImages?: GeneratedImage[];
7783
7818
  }
7784
7819
 
7785
- /** Tool to support URL context retrieval. */
7820
+ /** Tool to support URL context. */
7786
7821
  export declare interface UrlContext {
7787
7822
  }
7788
7823
 
7789
7824
  /** Metadata related to url context retrieval tool. */
7790
7825
  export declare interface UrlContextMetadata {
7791
- /** List of url context. */
7826
+ /** Output only. List of url context. */
7792
7827
  urlMetadata?: UrlMetadata[];
7793
7828
  }
7794
7829
 
7795
- /** Context for a single url retrieval. */
7830
+ /** Context of the a single url retrieval. */
7796
7831
  export declare interface UrlMetadata {
7797
- /** The URL retrieved by the tool. */
7832
+ /** Retrieved url by the tool. */
7798
7833
  retrievedUrl?: string;
7799
7834
  /** Status of the url retrieval. */
7800
7835
  urlRetrievalStatus?: UrlRetrievalStatus;
@@ -7803,7 +7838,7 @@ export declare interface UrlMetadata {
7803
7838
  /** Status of the url retrieval. */
7804
7839
  export declare enum UrlRetrievalStatus {
7805
7840
  /**
7806
- * Default value. This value is unused
7841
+ * Default value. This value is unused.
7807
7842
  */
7808
7843
  URL_RETRIEVAL_STATUS_UNSPECIFIED = "URL_RETRIEVAL_STATUS_UNSPECIFIED",
7809
7844
  /**
@@ -7815,11 +7850,11 @@ export declare enum UrlRetrievalStatus {
7815
7850
  */
7816
7851
  URL_RETRIEVAL_STATUS_ERROR = "URL_RETRIEVAL_STATUS_ERROR",
7817
7852
  /**
7818
- * Url retrieval is failed because the content is behind paywall.
7853
+ * Url retrieval is failed because the content is behind paywall. This enum value is not supported in Vertex AI.
7819
7854
  */
7820
7855
  URL_RETRIEVAL_STATUS_PAYWALL = "URL_RETRIEVAL_STATUS_PAYWALL",
7821
7856
  /**
7822
- * Url retrieval is failed because the content is unsafe.
7857
+ * Url retrieval is failed because the content is unsafe. This enum value is not supported in Vertex AI.
7823
7858
  */
7824
7859
  URL_RETRIEVAL_STATUS_UNSAFE = "URL_RETRIEVAL_STATUS_UNSAFE"
7825
7860
  }
@@ -7851,7 +7886,7 @@ export declare interface UsageMetadata {
7851
7886
  trafficType?: TrafficType;
7852
7887
  }
7853
7888
 
7854
- /** Hyperparameters for Veo. */
7889
+ /** Hyperparameters for Veo. This data type is not supported in Gemini API. */
7855
7890
  export declare interface VeoHyperParameters {
7856
7891
  /** Optional. Number of complete passes the model makes over the entire training dataset during training. */
7857
7892
  epochCount?: string;
@@ -7861,7 +7896,7 @@ export declare interface VeoHyperParameters {
7861
7896
  tuningTask?: TuningTask;
7862
7897
  }
7863
7898
 
7864
- /** Tuning Spec for Veo Model Tuning. */
7899
+ /** Tuning Spec for Veo Model Tuning. This data type is not supported in Gemini API. */
7865
7900
  export declare interface VeoTuningSpec {
7866
7901
  /** Optional. Hyperparameters for Veo. */
7867
7902
  hyperParameters?: VeoHyperParameters;
@@ -7871,7 +7906,7 @@ export declare interface VeoTuningSpec {
7871
7906
  validationDatasetUri?: string;
7872
7907
  }
7873
7908
 
7874
- /** Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder */
7909
+ /** 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. */
7875
7910
  export declare interface VertexAISearch {
7876
7911
  /** 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. */
7877
7912
  dataStoreSpecs?: VertexAISearchDataStoreSpec[];
@@ -7885,7 +7920,7 @@ export declare interface VertexAISearch {
7885
7920
  maxResults?: number;
7886
7921
  }
7887
7922
 
7888
- /** 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 */
7923
+ /** 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. */
7889
7924
  export declare interface VertexAISearchDataStoreSpec {
7890
7925
  /** Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
7891
7926
  dataStore?: string;
@@ -7893,7 +7928,7 @@ export declare interface VertexAISearchDataStoreSpec {
7893
7928
  filter?: string;
7894
7929
  }
7895
7930
 
7896
- /** Retrieve from Vertex RAG Store for grounding. */
7931
+ /** Retrieve from Vertex RAG Store for grounding. This data type is not supported in Gemini API. */
7897
7932
  export declare interface VertexRagStore {
7898
7933
  /** Optional. Deprecated. Please use rag_resources instead. */
7899
7934
  ragCorpora?: string[];
@@ -7909,7 +7944,7 @@ export declare interface VertexRagStore {
7909
7944
  vectorDistanceThreshold?: number;
7910
7945
  }
7911
7946
 
7912
- /** The definition of the Rag resource. */
7947
+ /** The definition of the Rag resource. This data type is not supported in Gemini API. */
7913
7948
  export declare interface VertexRagStoreRagResource {
7914
7949
  /** Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
7915
7950
  ragCorpus?: string;
@@ -8003,21 +8038,19 @@ export declare enum VideoGenerationReferenceType {
8003
8038
  STYLE = "STYLE"
8004
8039
  }
8005
8040
 
8006
- /** Describes how the video in the Part should be used by the model. */
8041
+ /** Metadata describes the input video content. */
8007
8042
  export declare interface VideoMetadata {
8008
- /** The frame rate of the video sent to the model. If not specified, the
8009
- default value will be 1.0. The fps range is (0.0, 24.0]. */
8010
- fps?: number;
8011
8043
  /** Optional. The end offset of the video. */
8012
8044
  endOffset?: string;
8045
+ /** Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. */
8046
+ fps?: number;
8013
8047
  /** Optional. The start offset of the video. */
8014
8048
  startOffset?: string;
8015
8049
  }
8016
8050
 
8017
8051
  /** The configuration for the voice to use. */
8018
8052
  export declare interface VoiceConfig {
8019
- /** The configuration for the speaker to use.
8020
- */
8053
+ /** The configuration for the prebuilt voice to use. */
8021
8054
  prebuiltVoiceConfig?: PrebuiltVoiceConfig;
8022
8055
  }
8023
8056