@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.
@@ -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;
@@ -3448,7 +3451,7 @@ export declare interface GoogleMaps {
3448
3451
  enableWidget?: boolean;
3449
3452
  }
3450
3453
 
3451
- /** 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). */
3454
+ /** 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. */
3452
3455
  export declare interface GoogleRpcStatus {
3453
3456
  /** The status code, which should be an enum value of google.rpc.Code. */
3454
3457
  code?: number;
@@ -3458,14 +3461,12 @@ export declare interface GoogleRpcStatus {
3458
3461
  message?: string;
3459
3462
  }
3460
3463
 
3461
- /** Tool to support Google Search in Model. Powered by Google. */
3464
+ /** GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
3462
3465
  export declare interface GoogleSearch {
3463
- /** Optional. Filter search results to a specific time range.
3464
- If customers set a start time, they must set an end time (and vice versa).
3465
- */
3466
- timeRangeFilter?: Interval;
3467
- /** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. */
3466
+ /** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. This field is not supported in Gemini API. */
3468
3467
  excludeDomains?: string[];
3468
+ /** Optional. Filter search results to a specific time range. If customers set a start time, they must set an end time (and vice versa). This field is not supported in Vertex AI. */
3469
+ timeRangeFilter?: Interval;
3469
3470
  }
3470
3471
 
3471
3472
  /** Tool to retrieve public web data for grounding, powered by Google. */
@@ -3474,7 +3475,7 @@ export declare interface GoogleSearchRetrieval {
3474
3475
  dynamicRetrievalConfig?: DynamicRetrievalConfig;
3475
3476
  }
3476
3477
 
3477
- /** 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 */
3478
+ /** 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. */
3478
3479
  export declare interface GoogleTypeDate {
3479
3480
  /** 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. */
3480
3481
  day?: number;
@@ -3486,15 +3487,15 @@ export declare interface GoogleTypeDate {
3486
3487
 
3487
3488
  /** Grounding chunk. */
3488
3489
  export declare interface GroundingChunk {
3489
- /** Grounding chunk from Google Maps. */
3490
+ /** Grounding chunk from Google Maps. This field is not supported in Gemini API. */
3490
3491
  maps?: GroundingChunkMaps;
3491
- /** Grounding chunk from context retrieved by the retrieval tools. */
3492
+ /** Grounding chunk from context retrieved by the retrieval tools. This field is not supported in Gemini API. */
3492
3493
  retrievedContext?: GroundingChunkRetrievedContext;
3493
3494
  /** Grounding chunk from the web. */
3494
3495
  web?: GroundingChunkWeb;
3495
3496
  }
3496
3497
 
3497
- /** Chunk from Google Maps. */
3498
+ /** Chunk from Google Maps. This data type is not supported in Gemini API. */
3498
3499
  export declare interface GroundingChunkMaps {
3499
3500
  /** 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. */
3500
3501
  placeAnswerSources?: GroundingChunkMapsPlaceAnswerSources;
@@ -3508,7 +3509,7 @@ export declare interface GroundingChunkMaps {
3508
3509
  uri?: string;
3509
3510
  }
3510
3511
 
3511
- /** Sources used to generate the place answer. */
3512
+ /** Sources used to generate the place answer. This data type is not supported in Gemini API. */
3512
3513
  export declare interface GroundingChunkMapsPlaceAnswerSources {
3513
3514
  /** A link where users can flag a problem with the generated answer. */
3514
3515
  flagContentUri?: string;
@@ -3516,7 +3517,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSources {
3516
3517
  reviewSnippets?: GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
3517
3518
  }
3518
3519
 
3519
- /** Author attribution for a photo or review. */
3520
+ /** Author attribution for a photo or review. This data type is not supported in Gemini API. */
3520
3521
  export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
3521
3522
  /** Name of the author of the Photo or Review. */
3522
3523
  displayName?: string;
@@ -3526,7 +3527,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
3526
3527
  uri?: string;
3527
3528
  }
3528
3529
 
3529
- /** Encapsulates a review snippet. */
3530
+ /** Encapsulates a review snippet. This data type is not supported in Gemini API. */
3530
3531
  export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
3531
3532
  /** This review's author. */
3532
3533
  authorAttribution?: GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution;
@@ -3544,7 +3545,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
3544
3545
  title?: string;
3545
3546
  }
3546
3547
 
3547
- /** Chunk from context retrieved by the retrieval tools. */
3548
+ /** Chunk from context retrieved by the retrieval tools. This data type is not supported in Gemini API. */
3548
3549
  export declare interface GroundingChunkRetrievedContext {
3549
3550
  /** Output only. The full document name for the referenced Vertex AI Search document. */
3550
3551
  documentName?: string;
@@ -3560,7 +3561,7 @@ export declare interface GroundingChunkRetrievedContext {
3560
3561
 
3561
3562
  /** Chunk from the web. */
3562
3563
  export declare interface GroundingChunkWeb {
3563
- /** Domain of the (original) URI. */
3564
+ /** Domain of the (original) URI. This field is not supported in Gemini API. */
3564
3565
  domain?: string;
3565
3566
  /** Title of the chunk. */
3566
3567
  title?: string;
@@ -3570,7 +3571,7 @@ export declare interface GroundingChunkWeb {
3570
3571
 
3571
3572
  /** Metadata returned to client when grounding is enabled. */
3572
3573
  export declare interface GroundingMetadata {
3573
- /** 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. */
3574
+ /** 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. */
3574
3575
  googleMapsWidgetContextToken?: string;
3575
3576
  /** List of supporting references retrieved from specified grounding source. */
3576
3577
  groundingChunks?: GroundingChunk[];
@@ -3578,17 +3579,17 @@ export declare interface GroundingMetadata {
3578
3579
  groundingSupports?: GroundingSupport[];
3579
3580
  /** Optional. Output only. Retrieval metadata. */
3580
3581
  retrievalMetadata?: RetrievalMetadata;
3581
- /** Optional. Queries executed by the retrieval tools. */
3582
+ /** Optional. Queries executed by the retrieval tools. This field is not supported in Gemini API. */
3582
3583
  retrievalQueries?: string[];
3583
3584
  /** Optional. Google search entry for the following-up web searches. */
3584
3585
  searchEntryPoint?: SearchEntryPoint;
3585
- /** Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. */
3586
+ /** 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. */
3586
3587
  sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
3587
3588
  /** Optional. Web search queries for the following-up web search. */
3588
3589
  webSearchQueries?: string[];
3589
3590
  }
3590
3591
 
3591
- /** Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. */
3592
+ /** 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. */
3592
3593
  export declare interface GroundingMetadataSourceFlaggingUri {
3593
3594
  /** A link where users can flag a problem with the source (place or review). */
3594
3595
  flagContentUri?: string;
@@ -3606,7 +3607,7 @@ export declare interface GroundingSupport {
3606
3607
  segment?: Segment;
3607
3608
  }
3608
3609
 
3609
- /** Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. */
3610
+ /** Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. This enum is not supported in Gemini API. */
3610
3611
  export declare enum HarmBlockMethod {
3611
3612
  /**
3612
3613
  * The harm block method is unspecified.
@@ -3622,7 +3623,7 @@ export declare enum HarmBlockMethod {
3622
3623
  PROBABILITY = "PROBABILITY"
3623
3624
  }
3624
3625
 
3625
- /** Required. The harm block threshold. */
3626
+ /** The harm block threshold. */
3626
3627
  export declare enum HarmBlockThreshold {
3627
3628
  /**
3628
3629
  * Unspecified harm block threshold.
@@ -3650,7 +3651,7 @@ export declare enum HarmBlockThreshold {
3650
3651
  OFF = "OFF"
3651
3652
  }
3652
3653
 
3653
- /** Required. Harm category. */
3654
+ /** Harm category. */
3654
3655
  export declare enum HarmCategory {
3655
3656
  /**
3656
3657
  * The harm category is unspecified.
@@ -3677,23 +3678,23 @@ export declare enum HarmCategory {
3677
3678
  */
3678
3679
  HARM_CATEGORY_CIVIC_INTEGRITY = "HARM_CATEGORY_CIVIC_INTEGRITY",
3679
3680
  /**
3680
- * The harm category is image hate.
3681
+ * The harm category is image hate. This enum value is not supported in Gemini API.
3681
3682
  */
3682
3683
  HARM_CATEGORY_IMAGE_HATE = "HARM_CATEGORY_IMAGE_HATE",
3683
3684
  /**
3684
- * The harm category is image dangerous content.
3685
+ * The harm category is image dangerous content. This enum value is not supported in Gemini API.
3685
3686
  */
3686
3687
  HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT = "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT",
3687
3688
  /**
3688
- * The harm category is image harassment.
3689
+ * The harm category is image harassment. This enum value is not supported in Gemini API.
3689
3690
  */
3690
3691
  HARM_CATEGORY_IMAGE_HARASSMENT = "HARM_CATEGORY_IMAGE_HARASSMENT",
3691
3692
  /**
3692
- * The harm category is image sexually explicit content.
3693
+ * The harm category is image sexually explicit content. This enum value is not supported in Gemini API.
3693
3694
  */
3694
3695
  HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT = "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT",
3695
3696
  /**
3696
- * The harm category is for jailbreak prompts.
3697
+ * The harm category is for jailbreak prompts. This enum value is not supported in Gemini API.
3697
3698
  */
3698
3699
  HARM_CATEGORY_JAILBREAK = "HARM_CATEGORY_JAILBREAK"
3699
3700
  }
@@ -3722,7 +3723,7 @@ export declare enum HarmProbability {
3722
3723
  HIGH = "HIGH"
3723
3724
  }
3724
3725
 
3725
- /** Output only. Harm severity levels in the content. */
3726
+ /** Output only. Harm severity levels in the content. This enum is not supported in Gemini API. */
3726
3727
  export declare enum HarmSeverity {
3727
3728
  /**
3728
3729
  * Harm severity unspecified.
@@ -3805,7 +3806,7 @@ declare interface HttpRequest {
3805
3806
  /**
3806
3807
  * Optional set of customizable configuration for HTTP requests.
3807
3808
  */
3808
- httpOptions?: HttpOptions;
3809
+ httpOptions?: types.HttpOptions;
3809
3810
  /**
3810
3811
  * Optional abort signal which can be used to cancel the request.
3811
3812
  */
@@ -3916,17 +3917,12 @@ export declare class InlinedResponse {
3916
3917
  error?: JobError;
3917
3918
  }
3918
3919
 
3919
- /** Represents a time interval, encoded as a start time (inclusive) and an end time (exclusive).
3920
-
3921
- The start time must be less than or equal to the end time.
3922
- When the start equals the end time, the interval is an empty interval.
3923
- (matches no time)
3924
- When both start and end are unspecified, the interval matches any time. */
3920
+ /** Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. */
3925
3921
  export declare interface Interval {
3926
- /** The start time of the interval. */
3927
- startTime?: string;
3928
- /** The end time of the interval. */
3922
+ /** Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. */
3929
3923
  endTime?: string;
3924
+ /** Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. */
3925
+ startTime?: string;
3930
3926
  }
3931
3927
 
3932
3928
  /** Job error. */
@@ -3991,7 +3987,7 @@ export declare enum JobState {
3991
3987
  JOB_STATE_PARTIALLY_SUCCEEDED = "JOB_STATE_PARTIALLY_SUCCEEDED"
3992
3988
  }
3993
3989
 
3994
- /** Required. Programming language of the `code`. */
3990
+ /** Programming language of the `code`. */
3995
3991
  export declare enum Language {
3996
3992
  /**
3997
3993
  * Unspecified language. This value should not be used.
@@ -5500,9 +5496,9 @@ export declare interface ModelSelectionConfig {
5500
5496
  featureSelectionPreference?: FeatureSelectionPreference;
5501
5497
  }
5502
5498
 
5503
- /** The configuration for the multi-speaker setup. */
5499
+ /** The configuration for the multi-speaker setup. This data type is not supported in Vertex AI. */
5504
5500
  export declare interface MultiSpeakerVoiceConfig {
5505
- /** The configuration for the speaker to use. */
5501
+ /** Required. All the enabled speaker voices. */
5506
5502
  speakerVoiceConfigs?: SpeakerVoiceConfig[];
5507
5503
  }
5508
5504
 
@@ -5585,7 +5581,7 @@ export declare class Operations extends BaseModule {
5585
5581
  private fetchPredictVideosOperationInternal;
5586
5582
  }
5587
5583
 
5588
- /** Required. Outcome of the code execution. */
5584
+ /** Outcome of the code execution. */
5589
5585
  export declare enum Outcome {
5590
5586
  /**
5591
5587
  * Unspecified status. This value should not be used.
@@ -5610,10 +5606,13 @@ export declare enum PagedItem {
5610
5606
  PAGED_ITEM_MODELS = "models",
5611
5607
  PAGED_ITEM_TUNING_JOBS = "tuningJobs",
5612
5608
  PAGED_ITEM_FILES = "files",
5613
- PAGED_ITEM_CACHED_CONTENTS = "cachedContents"
5609
+ PAGED_ITEM_CACHED_CONTENTS = "cachedContents",
5610
+ PAGED_ITEM_RAG_STORES = "ragStores",
5611
+ PAGED_ITEM_DOCUMENTS = "documents"
5614
5612
  }
5615
5613
 
5616
5614
  declare interface PagedItemConfig {
5615
+ parent?: string;
5617
5616
  config?: {
5618
5617
  pageToken?: string;
5619
5618
  pageSize?: number;
@@ -5628,6 +5627,8 @@ declare interface PagedItemResponse<T> {
5628
5627
  tuningJobs?: T[];
5629
5628
  files?: T[];
5630
5629
  cachedContents?: T[];
5630
+ ragStores?: T[];
5631
+ documents?: T[];
5631
5632
  }
5632
5633
 
5633
5634
  /**
@@ -5736,17 +5737,6 @@ export declare class Pager<T> implements AsyncIterable<T> {
5736
5737
  of content being conveyed. Using multiple fields within the same `Part`
5737
5738
  instance is considered invalid. */
5738
5739
  export declare interface Part {
5739
- /** Metadata for a given video. */
5740
- videoMetadata?: VideoMetadata;
5741
- /** Indicates if the part is thought from the model. */
5742
- thought?: boolean;
5743
- /** Optional. Inlined bytes data. */
5744
- inlineData?: Blob_2;
5745
- /** Optional. URI based data. */
5746
- fileData?: FileData;
5747
- /** An opaque signature for the thought so it can be reused in subsequent requests.
5748
- * @remarks Encoded as base64 string. */
5749
- thoughtSignature?: string;
5750
5740
  /** A predicted [FunctionCall] returned from the model that contains a string
5751
5741
  representing the [FunctionDeclaration.name] and a structured JSON object
5752
5742
  containing the parameters and their values. */
@@ -5755,15 +5745,26 @@ export declare interface Part {
5755
5745
  codeExecutionResult?: CodeExecutionResult;
5756
5746
  /** Optional. Code generated by the model that is meant to be executed. */
5757
5747
  executableCode?: ExecutableCode;
5748
+ /** Optional. URI based data. */
5749
+ fileData?: FileData;
5758
5750
  /** Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. */
5759
5751
  functionResponse?: FunctionResponse;
5752
+ /** Optional. Inlined bytes data. */
5753
+ inlineData?: Blob_2;
5760
5754
  /** Optional. Text part (can be code). */
5761
5755
  text?: string;
5756
+ /** Optional. Indicates if the part is thought from the model. */
5757
+ thought?: boolean;
5758
+ /** Optional. An opaque signature for the thought so it can be reused in subsequent requests.
5759
+ * @remarks Encoded as base64 string. */
5760
+ thoughtSignature?: string;
5761
+ /** Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. */
5762
+ videoMetadata?: VideoMetadata;
5762
5763
  }
5763
5764
 
5764
5765
  export declare type PartListUnion = PartUnion[] | PartUnion;
5765
5766
 
5766
- /** Tuning spec for Partner models. */
5767
+ /** Tuning spec for Partner models. This data type is not supported in Gemini API. */
5767
5768
  export declare interface PartnerModelTuningSpec {
5768
5769
  /** Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model. */
5769
5770
  hyperParameters?: Record<string, unknown>;
@@ -5793,11 +5794,11 @@ export declare enum PersonGeneration {
5793
5794
 
5794
5795
  /** The configuration for the prebuilt speaker to use. */
5795
5796
  export declare interface PrebuiltVoiceConfig {
5796
- /** The name of the prebuilt voice to use. */
5797
+ /** The name of the preset voice to use. */
5797
5798
  voiceName?: string;
5798
5799
  }
5799
5800
 
5800
- /** Statistics computed for datasets used for preference optimization. */
5801
+ /** Statistics computed for datasets used for preference optimization. This data type is not supported in Gemini API. */
5801
5802
  export declare interface PreferenceOptimizationDataStats {
5802
5803
  /** Output only. Dataset distributions for scores variance per example. */
5803
5804
  scoreVariancePerExampleDistribution?: DatasetDistribution;
@@ -5817,7 +5818,29 @@ export declare interface PreferenceOptimizationDataStats {
5817
5818
  userOutputTokenDistribution?: DatasetDistribution;
5818
5819
  }
5819
5820
 
5820
- /** A pre-tuned model for continuous tuning. */
5821
+ /** Hyperparameters for Preference Optimization. This data type is not supported in Gemini API. */
5822
+ export declare interface PreferenceOptimizationHyperParameters {
5823
+ /** Optional. Adapter size for preference optimization. */
5824
+ adapterSize?: AdapterSize;
5825
+ /** Optional. Weight for KL Divergence regularization. */
5826
+ beta?: number;
5827
+ /** Optional. Number of complete passes the model makes over the entire training dataset during training. */
5828
+ epochCount?: string;
5829
+ /** Optional. Multiplier for adjusting the default learning rate. */
5830
+ learningRateMultiplier?: number;
5831
+ }
5832
+
5833
+ /** Preference optimization tuning spec for tuning. */
5834
+ export declare interface PreferenceOptimizationSpec {
5835
+ /** Optional. Hyperparameters for Preference Optimization. */
5836
+ hyperParameters?: PreferenceOptimizationHyperParameters;
5837
+ /** Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. */
5838
+ trainingDatasetUri?: string;
5839
+ /** Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. */
5840
+ validationDatasetUri?: string;
5841
+ }
5842
+
5843
+ /** A pre-tuned model for continuous tuning. This data type is not supported in Gemini API. */
5821
5844
  export declare interface PreTunedModel {
5822
5845
  /** Output only. The name of the base model this PreTunedModel was tuned from. */
5823
5846
  baseModel?: string;
@@ -5841,7 +5864,7 @@ export declare interface ProductImage {
5841
5864
  productImage?: Image_2;
5842
5865
  }
5843
5866
 
5844
- /** A RagChunk includes the content of a chunk of a RagFile, and associated metadata. */
5867
+ /** A RagChunk includes the content of a chunk of a RagFile, and associated metadata. This data type is not supported in Gemini API. */
5845
5868
  export declare interface RagChunk {
5846
5869
  /** If populated, represents where the chunk starts and ends in the document. */
5847
5870
  pageSpan?: RagChunkPageSpan;
@@ -5849,7 +5872,7 @@ export declare interface RagChunk {
5849
5872
  text?: string;
5850
5873
  }
5851
5874
 
5852
- /** Represents where the chunk starts and ends in the document. */
5875
+ /** Represents where the chunk starts and ends in the document. This data type is not supported in Gemini API. */
5853
5876
  export declare interface RagChunkPageSpan {
5854
5877
  /** Page where chunk starts in the document. Inclusive. 1-indexed. */
5855
5878
  firstPage?: number;
@@ -5857,7 +5880,7 @@ export declare interface RagChunkPageSpan {
5857
5880
  lastPage?: number;
5858
5881
  }
5859
5882
 
5860
- /** Specifies the context retrieval config. */
5883
+ /** Specifies the context retrieval config. This data type is not supported in Gemini API. */
5861
5884
  export declare interface RagRetrievalConfig {
5862
5885
  /** Optional. Config for filters. */
5863
5886
  filter?: RagRetrievalConfigFilter;
@@ -5869,7 +5892,7 @@ export declare interface RagRetrievalConfig {
5869
5892
  topK?: number;
5870
5893
  }
5871
5894
 
5872
- /** Config for filters. */
5895
+ /** Config for filters. This data type is not supported in Gemini API. */
5873
5896
  export declare interface RagRetrievalConfigFilter {
5874
5897
  /** Optional. String for metadata filtering. */
5875
5898
  metadataFilter?: string;
@@ -5879,13 +5902,13 @@ export declare interface RagRetrievalConfigFilter {
5879
5902
  vectorSimilarityThreshold?: number;
5880
5903
  }
5881
5904
 
5882
- /** Config for Hybrid Search. */
5905
+ /** Config for Hybrid Search. This data type is not supported in Gemini API. */
5883
5906
  export declare interface RagRetrievalConfigHybridSearch {
5884
5907
  /** 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. */
5885
5908
  alpha?: number;
5886
5909
  }
5887
5910
 
5888
- /** Config for ranking and reranking. */
5911
+ /** Config for ranking and reranking. This data type is not supported in Gemini API. */
5889
5912
  export declare interface RagRetrievalConfigRanking {
5890
5913
  /** Optional. Config for LlmRanker. */
5891
5914
  llmRanker?: RagRetrievalConfigRankingLlmRanker;
@@ -5893,13 +5916,13 @@ export declare interface RagRetrievalConfigRanking {
5893
5916
  rankService?: RagRetrievalConfigRankingRankService;
5894
5917
  }
5895
5918
 
5896
- /** Config for LlmRanker. */
5919
+ /** Config for LlmRanker. This data type is not supported in Gemini API. */
5897
5920
  export declare interface RagRetrievalConfigRankingLlmRanker {
5898
5921
  /** Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). */
5899
5922
  modelName?: string;
5900
5923
  }
5901
5924
 
5902
- /** Config for Rank Service. */
5925
+ /** Config for Rank Service. This data type is not supported in Gemini API. */
5903
5926
  export declare interface RagRetrievalConfigRankingRankService {
5904
5927
  /** Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` */
5905
5928
  modelName?: string;
@@ -6049,7 +6072,7 @@ export declare class ReplayResponse {
6049
6072
  sdkResponseSegments?: Record<string, unknown>[];
6050
6073
  }
6051
6074
 
6052
- /** Defines a retrieval tool that model can call to access external knowledge. */
6075
+ /** Defines a retrieval tool that model can call to access external knowledge. This data type is not supported in Gemini API. */
6053
6076
  export declare interface Retrieval {
6054
6077
  /** Optional. Deprecated. This option is no longer supported. */
6055
6078
  disableAttribution?: boolean;
@@ -6100,25 +6123,24 @@ export declare interface SafetyRating {
6100
6123
  blocked?: boolean;
6101
6124
  /** Output only. Harm category. */
6102
6125
  category?: HarmCategory;
6103
- /** Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. */
6126
+ /** Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. This field is not supported in Gemini API. */
6104
6127
  overwrittenThreshold?: HarmBlockThreshold;
6105
6128
  /** Output only. Harm probability levels in the content. */
6106
6129
  probability?: HarmProbability;
6107
- /** Output only. Harm probability score. */
6130
+ /** Output only. Harm probability score. This field is not supported in Gemini API. */
6108
6131
  probabilityScore?: number;
6109
- /** Output only. Harm severity levels in the content. */
6132
+ /** Output only. Harm severity levels in the content. This field is not supported in Gemini API. */
6110
6133
  severity?: HarmSeverity;
6111
- /** Output only. Harm severity score. */
6134
+ /** Output only. Harm severity score. This field is not supported in Gemini API. */
6112
6135
  severityScore?: number;
6113
6136
  }
6114
6137
 
6115
6138
  /** Safety settings. */
6116
6139
  export declare interface SafetySetting {
6117
- /** Determines if the harm block method uses probability or probability
6118
- and severity scores. */
6119
- method?: HarmBlockMethod;
6120
6140
  /** Required. Harm category. */
6121
6141
  category?: HarmCategory;
6142
+ /** Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. This field is not supported in Gemini API. */
6143
+ method?: HarmBlockMethod;
6122
6144
  /** Required. The harm block threshold. */
6123
6145
  threshold?: HarmBlockThreshold;
6124
6146
  }
@@ -6532,28 +6554,22 @@ export declare interface SlidingWindow {
6532
6554
  targetTokens?: string;
6533
6555
  }
6534
6556
 
6535
- /** The configuration for the speaker to use. */
6557
+ /** The configuration for a single speaker in a multi speaker setup. This data type is not supported in Vertex AI. */
6536
6558
  export declare interface SpeakerVoiceConfig {
6537
- /** The name of the speaker to use. Should be the same as in the
6538
- prompt. */
6559
+ /** Required. The name of the speaker to use. Should be the same as in the prompt. */
6539
6560
  speaker?: string;
6540
- /** The configuration for the voice to use. */
6561
+ /** Required. The configuration for the voice to use. */
6541
6562
  voiceConfig?: VoiceConfig;
6542
6563
  }
6543
6564
 
6544
- /** The speech generation configuration. */
6565
+ /** The speech generation config. */
6545
6566
  export declare interface SpeechConfig {
6546
- /** The configuration for the speaker to use.
6547
- */
6567
+ /** Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. */
6568
+ languageCode?: string;
6569
+ /** The configuration for the speaker to use. */
6548
6570
  voiceConfig?: VoiceConfig;
6549
- /** The configuration for the multi-speaker setup.
6550
- It is mutually exclusive with the voice_config field.
6551
- */
6571
+ /** Optional. The configuration for the multi-speaker setup. It is mutually exclusive with the voice_config field. This field is not supported in Vertex AI. */
6552
6572
  multiSpeakerVoiceConfig?: MultiSpeakerVoiceConfig;
6553
- /** Language code (ISO 639. e.g. en-US) for the speech synthesization.
6554
- Only available for Live API.
6555
- */
6556
- languageCode?: string;
6557
6573
  }
6558
6574
 
6559
6575
  export declare type SpeechConfigUnion = SpeechConfig | string;
@@ -6635,7 +6651,7 @@ export declare enum SubjectReferenceType {
6635
6651
  SUBJECT_TYPE_PRODUCT = "SUBJECT_TYPE_PRODUCT"
6636
6652
  }
6637
6653
 
6638
- /** Hyperparameters for SFT. */
6654
+ /** Hyperparameters for SFT. This data type is not supported in Gemini API. */
6639
6655
  export declare interface SupervisedHyperParameters {
6640
6656
  /** Optional. Adapter size for tuning. */
6641
6657
  adapterSize?: AdapterSize;
@@ -6649,7 +6665,7 @@ export declare interface SupervisedHyperParameters {
6649
6665
  learningRateMultiplier?: number;
6650
6666
  }
6651
6667
 
6652
- /** Dataset distribution for Supervised Tuning. */
6668
+ /** Dataset distribution for Supervised Tuning. This data type is not supported in Gemini API. */
6653
6669
  export declare interface SupervisedTuningDatasetDistribution {
6654
6670
  /** Output only. Sum of a given population of values that are billable. */
6655
6671
  billableSum?: string;
@@ -6671,7 +6687,7 @@ export declare interface SupervisedTuningDatasetDistribution {
6671
6687
  sum?: string;
6672
6688
  }
6673
6689
 
6674
- /** Dataset bucket used to create a histogram for the distribution given a population of values. */
6690
+ /** Dataset bucket used to create a histogram for the distribution given a population of values. This data type is not supported in Gemini API. */
6675
6691
  export declare interface SupervisedTuningDatasetDistributionDatasetBucket {
6676
6692
  /** Output only. Number of values in the bucket. */
6677
6693
  count?: number;
@@ -6681,7 +6697,7 @@ export declare interface SupervisedTuningDatasetDistributionDatasetBucket {
6681
6697
  right?: number;
6682
6698
  }
6683
6699
 
6684
- /** Tuning data statistics for Supervised Tuning. */
6700
+ /** Tuning data statistics for Supervised Tuning. This data type is not supported in Gemini API. */
6685
6701
  export declare interface SupervisedTuningDataStats {
6686
6702
  /** Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. */
6687
6703
  droppedExampleReasons?: string[];
@@ -6709,7 +6725,7 @@ export declare interface SupervisedTuningDataStats {
6709
6725
  userOutputTokenDistribution?: SupervisedTuningDatasetDistribution;
6710
6726
  }
6711
6727
 
6712
- /** Tuning Spec for Supervised Tuning for first party models. */
6728
+ /** Supervised tuning spec for tuning. */
6713
6729
  export declare interface SupervisedTuningSpec {
6714
6730
  /** Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false. */
6715
6731
  exportLastCheckpointOnly?: boolean;
@@ -6863,30 +6879,28 @@ export declare interface TokensInfo {
6863
6879
  export declare interface Tool {
6864
6880
  /** List of function declarations that the tool supports. */
6865
6881
  functionDeclarations?: FunctionDeclaration[];
6866
- /** 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. */
6882
+ /** Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. This field is not supported in Gemini API. */
6867
6883
  retrieval?: Retrieval;
6868
- /** Optional. Google Search tool type. Specialized retrieval tool
6869
- that is powered by Google Search. */
6870
- googleSearch?: GoogleSearch;
6871
6884
  /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
6872
6885
  googleSearchRetrieval?: GoogleSearchRetrieval;
6873
- /** Optional. Enterprise web search tool type. Specialized retrieval
6874
- tool that is powered by Vertex AI Search and Sec4 compliance. */
6875
- enterpriseWebSearch?: EnterpriseWebSearch;
6876
6886
  /** Optional. Google Maps tool type. Specialized retrieval tool
6877
6887
  that is powered by Google Maps. */
6878
6888
  googleMaps?: GoogleMaps;
6879
- /** Optional. Tool to support URL context retrieval. */
6880
- urlContext?: UrlContext;
6881
6889
  /** Optional. Tool to support the model interacting directly with the
6882
6890
  computer. If enabled, it automatically populates computer-use specific
6883
6891
  Function Declarations. */
6884
6892
  computerUse?: ComputerUse;
6885
6893
  /** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
6886
6894
  codeExecution?: ToolCodeExecution;
6895
+ /** Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. This field is not supported in Gemini API. */
6896
+ enterpriseWebSearch?: EnterpriseWebSearch;
6897
+ /** Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
6898
+ googleSearch?: GoogleSearch;
6899
+ /** Optional. Tool to support URL context retrieval. */
6900
+ urlContext?: UrlContext;
6887
6901
  }
6888
6902
 
6889
- /** 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. */
6903
+ /** Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. This data type is not supported in Gemini API. */
6890
6904
  export declare interface ToolCodeExecution {
6891
6905
  }
6892
6906
 
@@ -6904,7 +6918,7 @@ export declare type ToolListUnion = ToolUnion[];
6904
6918
 
6905
6919
  export declare type ToolUnion = Tool | CallableTool;
6906
6920
 
6907
- /** Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. */
6921
+ /** Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. This enum is not supported in Gemini API. */
6908
6922
  export declare enum TrafficType {
6909
6923
  /**
6910
6924
  * Unspecified request traffic type.
@@ -6986,7 +7000,7 @@ export declare interface TuningDataset {
6986
7000
  examples?: TuningExample[];
6987
7001
  }
6988
7002
 
6989
- /** The tuning data statistic values for TuningJob. */
7003
+ /** The tuning data statistic values for TuningJob. This data type is not supported in Gemini API. */
6990
7004
  export declare interface TuningDataStats {
6991
7005
  /** Output only. Statistics for distillation. */
6992
7006
  distillationDataStats?: DistillationDataStats;
@@ -6996,7 +7010,7 @@ export declare interface TuningDataStats {
6996
7010
  supervisedTuningDataStats?: SupervisedTuningDataStats;
6997
7011
  }
6998
7012
 
6999
- /** A single example for tuning. */
7013
+ /** A single example for tuning. This data type is not supported in Vertex AI. */
7000
7014
  export declare interface TuningExample {
7001
7015
  /** Required. The expected model output. */
7002
7016
  output?: string;
@@ -7032,6 +7046,8 @@ export declare interface TuningJob {
7032
7046
  preTunedModel?: PreTunedModel;
7033
7047
  /** Tuning Spec for Supervised Fine Tuning. */
7034
7048
  supervisedTuningSpec?: SupervisedTuningSpec;
7049
+ /** Tuning Spec for Preference Optimization. */
7050
+ preferenceOptimizationSpec?: PreferenceOptimizationSpec;
7035
7051
  /** Output only. The tuning data statistics associated with this TuningJob. */
7036
7052
  tuningDataStats?: TuningDataStats;
7037
7053
  /** Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key. */
@@ -7056,7 +7072,19 @@ export declare interface TuningJob {
7056
7072
  veoTuningSpec?: VeoTuningSpec;
7057
7073
  }
7058
7074
 
7059
- /** Tuning mode. */
7075
+ /** Enum representing the tuning method. */
7076
+ export declare enum TuningMethod {
7077
+ /**
7078
+ * Supervised fine tuning.
7079
+ */
7080
+ SUPERVISED_FINE_TUNING = "SUPERVISED_FINE_TUNING",
7081
+ /**
7082
+ * Preference optimization tuning.
7083
+ */
7084
+ PREFERENCE_TUNING = "PREFERENCE_TUNING"
7085
+ }
7086
+
7087
+ /** Tuning mode. This enum is not supported in Gemini API. */
7060
7088
  export declare enum TuningMode {
7061
7089
  /**
7062
7090
  * Tuning mode is unspecified.
@@ -7137,7 +7165,7 @@ declare class Tunings extends BaseModule {
7137
7165
  private tuneMldevInternal;
7138
7166
  }
7139
7167
 
7140
- /** Optional. The tuning task. Either I2V or T2V. */
7168
+ /** The tuning task. Either I2V or T2V. This enum is not supported in Gemini API. */
7141
7169
  export declare enum TuningTask {
7142
7170
  /**
7143
7171
  * Default value. This value is unused.
@@ -7156,7 +7184,7 @@ export declare enum TuningTask {
7156
7184
  export declare interface TuningValidationDataset {
7157
7185
  /** GCS URI of the file containing validation dataset in JSONL format. */
7158
7186
  gcsUri?: string;
7159
- /** 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'. */
7187
+ /** 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'. */
7160
7188
  vertexDatasetResource?: string;
7161
7189
  }
7162
7190
 
@@ -7196,7 +7224,7 @@ export declare enum TurnCoverage {
7196
7224
  TURN_INCLUDES_ALL_INPUT = "TURN_INCLUDES_ALL_INPUT"
7197
7225
  }
7198
7226
 
7199
- /** Optional. The type of the data. */
7227
+ /** The type of the data. */
7200
7228
  export declare enum Type {
7201
7229
  /**
7202
7230
  * Not specified, should not be used.
@@ -7249,23 +7277,23 @@ declare namespace types {
7249
7277
  Language,
7250
7278
  FunctionResponseScheduling,
7251
7279
  Type,
7252
- HarmCategory,
7253
- HarmBlockMethod,
7254
- HarmBlockThreshold,
7255
7280
  Mode,
7256
7281
  AuthType,
7257
7282
  ApiSpec,
7258
- UrlRetrievalStatus,
7283
+ HarmCategory,
7284
+ HarmBlockMethod,
7285
+ HarmBlockThreshold,
7259
7286
  FinishReason,
7260
7287
  HarmProbability,
7261
7288
  HarmSeverity,
7289
+ UrlRetrievalStatus,
7262
7290
  BlockedReason,
7263
7291
  TrafficType,
7264
7292
  Modality,
7265
7293
  MediaResolution,
7266
- JobState,
7267
7294
  TuningMode,
7268
7295
  AdapterSize,
7296
+ JobState,
7269
7297
  TuningTask,
7270
7298
  FeatureSelectionPreference,
7271
7299
  Behavior,
@@ -7283,6 +7311,7 @@ declare namespace types {
7283
7311
  VideoGenerationReferenceType,
7284
7312
  VideoGenerationMaskMode,
7285
7313
  VideoCompressionQuality,
7314
+ TuningMethod,
7286
7315
  FileState,
7287
7316
  FileSource,
7288
7317
  TurnCompleteReason,
@@ -7294,28 +7323,24 @@ declare namespace types {
7294
7323
  Scale,
7295
7324
  MusicGenerationMode,
7296
7325
  LiveMusicPlaybackControl,
7297
- VideoMetadata,
7298
- Blob_2 as Blob,
7299
- FileData,
7300
7326
  FunctionCall,
7301
7327
  CodeExecutionResult,
7302
7328
  ExecutableCode,
7329
+ FileData,
7303
7330
  FunctionResponseBlob,
7304
7331
  FunctionResponseFileData,
7305
7332
  FunctionResponsePart,
7306
7333
  FunctionResponse,
7334
+ Blob_2 as Blob,
7335
+ VideoMetadata,
7307
7336
  Part,
7308
7337
  Content,
7309
7338
  HttpOptions,
7310
7339
  Schema,
7311
7340
  ModelSelectionConfig,
7312
- SafetySetting,
7313
7341
  FunctionDeclaration,
7314
- Interval,
7315
- GoogleSearch,
7316
7342
  DynamicRetrievalConfig,
7317
7343
  GoogleSearchRetrieval,
7318
- EnterpriseWebSearch,
7319
7344
  ApiKeyConfig,
7320
7345
  AuthConfigGoogleServiceAccountConfig,
7321
7346
  AuthConfigHttpBasicAuthConfig,
@@ -7323,7 +7348,6 @@ declare namespace types {
7323
7348
  AuthConfigOidcConfig,
7324
7349
  AuthConfig,
7325
7350
  GoogleMaps,
7326
- UrlContext,
7327
7351
  ComputerUse,
7328
7352
  ApiAuthApiKeyConfig,
7329
7353
  ApiAuth,
@@ -7342,22 +7366,22 @@ declare namespace types {
7342
7366
  VertexRagStore,
7343
7367
  Retrieval,
7344
7368
  ToolCodeExecution,
7369
+ EnterpriseWebSearch,
7370
+ Interval,
7371
+ GoogleSearch,
7372
+ UrlContext,
7345
7373
  Tool,
7346
7374
  FunctionCallingConfig,
7347
7375
  LatLng,
7348
7376
  RetrievalConfig,
7349
7377
  ToolConfig,
7350
- PrebuiltVoiceConfig,
7351
- VoiceConfig,
7352
- SpeakerVoiceConfig,
7353
- MultiSpeakerVoiceConfig,
7354
- SpeechConfig,
7355
7378
  AutomaticFunctionCallingConfig,
7356
7379
  ThinkingConfig,
7357
7380
  ImageConfig,
7358
7381
  GenerationConfigRoutingConfigAutoRoutingMode,
7359
7382
  GenerationConfigRoutingConfigManualRoutingMode,
7360
7383
  GenerationConfigRoutingConfig,
7384
+ SafetySetting,
7361
7385
  GenerateContentConfig,
7362
7386
  GenerateContentParameters,
7363
7387
  HttpResponse,
@@ -7365,8 +7389,6 @@ declare namespace types {
7365
7389
  GoogleTypeDate,
7366
7390
  Citation,
7367
7391
  CitationMetadata,
7368
- UrlMetadata,
7369
- UrlContextMetadata,
7370
7392
  GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution,
7371
7393
  GroundingChunkMapsPlaceAnswerSourcesReviewSnippet,
7372
7394
  GroundingChunkMapsPlaceAnswerSources,
@@ -7386,6 +7408,8 @@ declare namespace types {
7386
7408
  LogprobsResultTopCandidates,
7387
7409
  LogprobsResult,
7388
7410
  SafetyRating,
7411
+ UrlMetadata,
7412
+ UrlContextMetadata,
7389
7413
  Candidate,
7390
7414
  GenerateContentResponsePromptFeedback,
7391
7415
  ModalityTokenCount,
@@ -7438,6 +7462,11 @@ declare namespace types {
7438
7462
  DeleteModelConfig,
7439
7463
  DeleteModelParameters,
7440
7464
  DeleteModelResponse,
7465
+ PrebuiltVoiceConfig,
7466
+ VoiceConfig,
7467
+ SpeakerVoiceConfig,
7468
+ MultiSpeakerVoiceConfig,
7469
+ SpeechConfig,
7441
7470
  GenerationConfig,
7442
7471
  CountTokensConfig,
7443
7472
  CountTokensParameters,
@@ -7460,10 +7489,12 @@ declare namespace types {
7460
7489
  GetTuningJobParameters,
7461
7490
  TunedModelCheckpoint,
7462
7491
  TunedModel,
7463
- GoogleRpcStatus,
7464
- PreTunedModel,
7465
7492
  SupervisedHyperParameters,
7466
7493
  SupervisedTuningSpec,
7494
+ PreferenceOptimizationHyperParameters,
7495
+ PreferenceOptimizationSpec,
7496
+ GoogleRpcStatus,
7497
+ PreTunedModel,
7467
7498
  DatasetDistributionDistributionBucket,
7468
7499
  DatasetDistribution,
7469
7500
  DatasetStats,
@@ -7749,6 +7780,10 @@ export declare interface UpscaleImageConfig {
7749
7780
  abortSignal?: AbortSignal;
7750
7781
  /** Cloud Storage URI used to store the generated images. */
7751
7782
  outputGcsUri?: string;
7783
+ /** Filter level for safety filtering. */
7784
+ safetyFilterLevel?: SafetyFilterLevel;
7785
+ /** Allows generation of people by the model. */
7786
+ personGeneration?: PersonGeneration;
7752
7787
  /** Whether to include a reason for filtered-out images in the
7753
7788
  response. */
7754
7789
  includeRaiReason?: boolean;
@@ -7789,19 +7824,19 @@ export declare class UpscaleImageResponse {
7789
7824
  generatedImages?: GeneratedImage[];
7790
7825
  }
7791
7826
 
7792
- /** Tool to support URL context retrieval. */
7827
+ /** Tool to support URL context. */
7793
7828
  export declare interface UrlContext {
7794
7829
  }
7795
7830
 
7796
7831
  /** Metadata related to url context retrieval tool. */
7797
7832
  export declare interface UrlContextMetadata {
7798
- /** List of url context. */
7833
+ /** Output only. List of url context. */
7799
7834
  urlMetadata?: UrlMetadata[];
7800
7835
  }
7801
7836
 
7802
- /** Context for a single url retrieval. */
7837
+ /** Context of the a single url retrieval. */
7803
7838
  export declare interface UrlMetadata {
7804
- /** The URL retrieved by the tool. */
7839
+ /** Retrieved url by the tool. */
7805
7840
  retrievedUrl?: string;
7806
7841
  /** Status of the url retrieval. */
7807
7842
  urlRetrievalStatus?: UrlRetrievalStatus;
@@ -7810,7 +7845,7 @@ export declare interface UrlMetadata {
7810
7845
  /** Status of the url retrieval. */
7811
7846
  export declare enum UrlRetrievalStatus {
7812
7847
  /**
7813
- * Default value. This value is unused
7848
+ * Default value. This value is unused.
7814
7849
  */
7815
7850
  URL_RETRIEVAL_STATUS_UNSPECIFIED = "URL_RETRIEVAL_STATUS_UNSPECIFIED",
7816
7851
  /**
@@ -7822,11 +7857,11 @@ export declare enum UrlRetrievalStatus {
7822
7857
  */
7823
7858
  URL_RETRIEVAL_STATUS_ERROR = "URL_RETRIEVAL_STATUS_ERROR",
7824
7859
  /**
7825
- * Url retrieval is failed because the content is behind paywall.
7860
+ * Url retrieval is failed because the content is behind paywall. This enum value is not supported in Vertex AI.
7826
7861
  */
7827
7862
  URL_RETRIEVAL_STATUS_PAYWALL = "URL_RETRIEVAL_STATUS_PAYWALL",
7828
7863
  /**
7829
- * Url retrieval is failed because the content is unsafe.
7864
+ * Url retrieval is failed because the content is unsafe. This enum value is not supported in Vertex AI.
7830
7865
  */
7831
7866
  URL_RETRIEVAL_STATUS_UNSAFE = "URL_RETRIEVAL_STATUS_UNSAFE"
7832
7867
  }
@@ -7858,7 +7893,7 @@ export declare interface UsageMetadata {
7858
7893
  trafficType?: TrafficType;
7859
7894
  }
7860
7895
 
7861
- /** Hyperparameters for Veo. */
7896
+ /** Hyperparameters for Veo. This data type is not supported in Gemini API. */
7862
7897
  export declare interface VeoHyperParameters {
7863
7898
  /** Optional. Number of complete passes the model makes over the entire training dataset during training. */
7864
7899
  epochCount?: string;
@@ -7868,7 +7903,7 @@ export declare interface VeoHyperParameters {
7868
7903
  tuningTask?: TuningTask;
7869
7904
  }
7870
7905
 
7871
- /** Tuning Spec for Veo Model Tuning. */
7906
+ /** Tuning Spec for Veo Model Tuning. This data type is not supported in Gemini API. */
7872
7907
  export declare interface VeoTuningSpec {
7873
7908
  /** Optional. Hyperparameters for Veo. */
7874
7909
  hyperParameters?: VeoHyperParameters;
@@ -7878,7 +7913,7 @@ export declare interface VeoTuningSpec {
7878
7913
  validationDatasetUri?: string;
7879
7914
  }
7880
7915
 
7881
- /** Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder */
7916
+ /** 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. */
7882
7917
  export declare interface VertexAISearch {
7883
7918
  /** 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. */
7884
7919
  dataStoreSpecs?: VertexAISearchDataStoreSpec[];
@@ -7892,7 +7927,7 @@ export declare interface VertexAISearch {
7892
7927
  maxResults?: number;
7893
7928
  }
7894
7929
 
7895
- /** 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 */
7930
+ /** 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. */
7896
7931
  export declare interface VertexAISearchDataStoreSpec {
7897
7932
  /** Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
7898
7933
  dataStore?: string;
@@ -7900,7 +7935,7 @@ export declare interface VertexAISearchDataStoreSpec {
7900
7935
  filter?: string;
7901
7936
  }
7902
7937
 
7903
- /** Retrieve from Vertex RAG Store for grounding. */
7938
+ /** Retrieve from Vertex RAG Store for grounding. This data type is not supported in Gemini API. */
7904
7939
  export declare interface VertexRagStore {
7905
7940
  /** Optional. Deprecated. Please use rag_resources instead. */
7906
7941
  ragCorpora?: string[];
@@ -7916,7 +7951,7 @@ export declare interface VertexRagStore {
7916
7951
  vectorDistanceThreshold?: number;
7917
7952
  }
7918
7953
 
7919
- /** The definition of the Rag resource. */
7954
+ /** The definition of the Rag resource. This data type is not supported in Gemini API. */
7920
7955
  export declare interface VertexRagStoreRagResource {
7921
7956
  /** Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` */
7922
7957
  ragCorpus?: string;
@@ -8010,21 +8045,19 @@ export declare enum VideoGenerationReferenceType {
8010
8045
  STYLE = "STYLE"
8011
8046
  }
8012
8047
 
8013
- /** Describes how the video in the Part should be used by the model. */
8048
+ /** Metadata describes the input video content. */
8014
8049
  export declare interface VideoMetadata {
8015
- /** The frame rate of the video sent to the model. If not specified, the
8016
- default value will be 1.0. The fps range is (0.0, 24.0]. */
8017
- fps?: number;
8018
8050
  /** Optional. The end offset of the video. */
8019
8051
  endOffset?: string;
8052
+ /** Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. */
8053
+ fps?: number;
8020
8054
  /** Optional. The start offset of the video. */
8021
8055
  startOffset?: string;
8022
8056
  }
8023
8057
 
8024
8058
  /** The configuration for the voice to use. */
8025
8059
  export declare interface VoiceConfig {
8026
- /** The configuration for the speaker to use.
8027
- */
8060
+ /** The configuration for the prebuilt voice to use. */
8028
8061
  prebuiltVoiceConfig?: PrebuiltVoiceConfig;
8029
8062
  }
8030
8063