@google/genai 1.46.0 → 1.47.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.
@@ -1372,7 +1372,7 @@ declare interface CreateTuningJobConfig {
1372
1372
  preTunedModelCheckpointId?: string;
1373
1373
  /** Adapter size for tuning. */
1374
1374
  adapterSize?: AdapterSize;
1375
- /** Tuning mode for SFT tuning. */
1375
+ /** Tuning mode for tuning. */
1376
1376
  tuningMode?: TuningMode;
1377
1377
  /** Custom base model for tuning. This is only supported for OSS models in Vertex. */
1378
1378
  customBaseModel?: string;
@@ -1673,7 +1673,7 @@ declare interface DistillationDataStats {
1673
1673
  trainingDatasetStats?: DatasetStats;
1674
1674
  }
1675
1675
 
1676
- /** Hyperparameters for Distillation. This data type is not supported in Gemini API. */
1676
+ /** Hyperparameters for distillation. */
1677
1677
  declare interface DistillationHyperParameters {
1678
1678
  /** Optional. Adapter size for distillation. */
1679
1679
  adapterSize?: AdapterSize;
@@ -1681,6 +1681,21 @@ declare interface DistillationHyperParameters {
1681
1681
  epochCount?: string;
1682
1682
  /** Optional. Multiplier for adjusting the default learning rate. */
1683
1683
  learningRateMultiplier?: number;
1684
+ /** The batch size hyperparameter for tuning.
1685
+ This is only supported for OSS models in Vertex. */
1686
+ batchSize?: number;
1687
+ /** The learning rate for tuning. OSS models only. */
1688
+ learningRate?: number;
1689
+ }
1690
+
1691
+ /** Spec for creating a distilled dataset in Vertex Dataset. This data type is not supported in Gemini API. */
1692
+ declare interface DistillationSamplingSpec {
1693
+ /** Optional. The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). */
1694
+ baseTeacherModel?: string;
1695
+ /** Optional. The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. */
1696
+ tunedTeacherModelSource?: string;
1697
+ /** Optional. Cloud Storage path to file containing validation dataset for distillation. The dataset must be formatted as a JSONL file. */
1698
+ validationDatasetUri?: string;
1684
1699
  }
1685
1700
 
1686
1701
  /** Distillation tuning spec for tuning. */
@@ -1701,20 +1716,21 @@ declare interface DistillationSpec {
1701
1716
  tunedTeacherModelSource?: string;
1702
1717
  /** Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. */
1703
1718
  validationDatasetUri?: string;
1719
+ /** Tuning mode for tuning. */
1720
+ tuningMode?: TuningMode;
1704
1721
  }
1705
1722
 
1706
1723
  /** A Document is a collection of Chunks. */
1707
1724
  declare interface Document_2 {
1708
- /** The resource name of the Document.
1709
- Example: fileSearchStores/file-search-store-foo/documents/documents-bar */
1725
+ /** Immutable. Identifier. The `Document` resource name. The ID (name excluding the "fileSearchStores/*/documents/" prefix) can contain up to 40 characters that are lowercase alphanumeric or dashes (-). The ID cannot start or end with a dash. If the name is empty on create, a unique name will be derived from `display_name` along with a 12 character random suffix. Example: `fileSearchStores/{file_search_store_id}/documents/my-awesome-doc-123a456b789c` */
1710
1726
  name?: string;
1711
- /** The human-readable display name for the Document. */
1727
+ /** Optional. The human-readable display name for the `Document`. The display name must be no more than 512 characters in length, including spaces. Example: "Semantic Retriever Documentation". */
1712
1728
  displayName?: string;
1713
- /** The current state of the Document. */
1729
+ /** Output only. Current state of the `Document`. */
1714
1730
  state?: DocumentState;
1715
- /** The size of the Document in bytes. */
1731
+ /** Output only. The size of raw bytes ingested into the Document. */
1716
1732
  sizeBytes?: string;
1717
- /** The MIME type of the Document. */
1733
+ /** Output only. The mime type of the Document. */
1718
1734
  mimeType?: string;
1719
1735
  /** Output only. The Timestamp of when the `Document` was created. */
1720
1736
  createTime?: string;
@@ -1724,11 +1740,23 @@ declare interface Document_2 {
1724
1740
  updateTime?: string;
1725
1741
  }
1726
1742
 
1727
- /** State for the lifecycle of a Document. */
1743
+ /** Output only. Current state of the `Document`. This enum is not supported in Vertex AI. */
1728
1744
  declare enum DocumentState {
1745
+ /**
1746
+ * The default value. This value is used if the state is omitted.
1747
+ */
1729
1748
  STATE_UNSPECIFIED = "STATE_UNSPECIFIED",
1749
+ /**
1750
+ * Some `Chunks` of the `Document` are being processed (embedding and vector storage).
1751
+ */
1730
1752
  STATE_PENDING = "STATE_PENDING",
1753
+ /**
1754
+ * All `Chunks` of the `Document` is processed and available for querying.
1755
+ */
1731
1756
  STATE_ACTIVE = "STATE_ACTIVE",
1757
+ /**
1758
+ * Some `Chunks` of the `Document` failed processing.
1759
+ */
1732
1760
  STATE_FAILED = "STATE_FAILED"
1733
1761
  }
1734
1762
 
@@ -2070,7 +2098,7 @@ declare interface EvaluateDatasetRun {
2070
2098
  evaluateDatasetResponse?: EvaluateDatasetResponse;
2071
2099
  /** Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`. */
2072
2100
  evaluationRun?: string;
2073
- /** Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`. */
2101
+ /** Output only. Deprecated: The updated architecture uses evaluation_run instead. */
2074
2102
  operationName?: string;
2075
2103
  }
2076
2104
 
@@ -2203,14 +2231,13 @@ declare interface FileData {
2203
2231
  mimeType?: string;
2204
2232
  }
2205
2233
 
2206
- /** Tool to retrieve knowledge from the File Search Stores. */
2234
+ /** The FileSearch tool that retrieves knowledge from Semantic Retrieval corpora. Files are imported to Semantic Retrieval corpora using the ImportFile API. This data type is not supported in Vertex AI. */
2207
2235
  declare interface FileSearch {
2208
- /** The names of the file_search_stores to retrieve from.
2209
- Example: `fileSearchStores/my-file-search-store-123` */
2236
+ /** Required. The names of the file_search_stores to retrieve from. Example: `fileSearchStores/my-file-search-store-123` */
2210
2237
  fileSearchStoreNames?: string[];
2211
- /** The number of file search retrieval chunks to retrieve. */
2238
+ /** Optional. The number of semantic retrieval chunks to retrieve. */
2212
2239
  topK?: number;
2213
- /** Metadata filter to apply to the file search retrieval documents. See https://google.aip.dev/160 for the syntax of the filter expression. */
2240
+ /** Optional. Metadata filter to apply to the semantic retrieval documents and chunks. */
2214
2241
  metadataFilter?: string;
2215
2242
  }
2216
2243
 
@@ -2703,6 +2730,8 @@ declare interface GenerateContentConfig {
2703
2730
  service. If supplied, safety_settings must not be supplied.
2704
2731
  */
2705
2732
  modelArmorConfig?: ModelArmorConfig;
2733
+ /** The service tier to use for the request. For example, SERVICE_TIER_FLEX. */
2734
+ serviceTier?: ServiceTier;
2706
2735
  }
2707
2736
 
2708
2737
  /** Config for models.generate_content parameters. */
@@ -2739,6 +2768,8 @@ declare class GenerateContentResponse {
2739
2768
  responseId?: string;
2740
2769
  /** Usage metadata about the response(s). */
2741
2770
  usageMetadata?: GenerateContentResponseUsageMetadata;
2771
+ /** Output only. The current model status of this model. This field is not supported in Vertex AI. */
2772
+ modelStatus?: ModelStatus;
2742
2773
  /**
2743
2774
  * Returns the concatenation of all text parts from the first candidate in the response.
2744
2775
  *
@@ -3068,6 +3099,8 @@ declare interface GenerateVideosConfig {
3068
3099
  mask?: VideoGenerationMask;
3069
3100
  /** Compression quality of the generated videos. */
3070
3101
  compressionQuality?: VideoCompressionQuality;
3102
+ /** User specified labels to track billing usage. */
3103
+ labels?: Record<string, string>;
3071
3104
  }
3072
3105
 
3073
3106
  /** A video generation operation. */
@@ -3084,7 +3117,6 @@ declare class GenerateVideosOperation implements Operation<GenerateVideosRespons
3084
3117
  response?: GenerateVideosResponse;
3085
3118
  /**
3086
3119
  * Instantiates an Operation of the same type as the one being called with the fields set from the API response.
3087
- * @internal
3088
3120
  */
3089
3121
  _fromAPIResponse({ apiResponse, _isVertexAI, }: OperationFromAPIResponseParameters): Operation<GenerateVideosResponse>;
3090
3122
  /** The full HTTP response. */
@@ -3404,9 +3436,9 @@ declare interface GoogleRpcStatus {
3404
3436
  message?: string;
3405
3437
  }
3406
3438
 
3407
- /** Tool to support web search. */
3439
+ /** GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
3408
3440
  declare interface GoogleSearch {
3409
- /** Different types of search that can be enabled on the GoogleSearch tool. */
3441
+ /** Optional. The set of search types to enable. If not set, web search is enabled by default. */
3410
3442
  searchTypes?: SearchTypes;
3411
3443
  /** Optional. Sites with confidence level chosen & above this value will be blocked from the search results. This field is not supported in Gemini API. */
3412
3444
  blockingConfidence?: PhishBlockThreshold;
@@ -3438,9 +3470,7 @@ declare interface GoogleTypeDate {
3438
3470
  is enabled, the model returns a `GroundingChunk` that contains a reference to
3439
3471
  the source of the information. */
3440
3472
  declare interface GroundingChunk {
3441
- /** A grounding chunk from an image search result. See the `Image`
3442
- message for details.
3443
- */
3473
+ /** A grounding chunk from an image search result. See the `Image` message for details. */
3444
3474
  image?: GroundingChunkImage;
3445
3475
  /** A `Maps` chunk is a piece of evidence that comes from Google Maps.
3446
3476
 
@@ -3448,17 +3478,25 @@ declare interface GroundingChunk {
3448
3478
  reviews. This is used to provide the user with rich, location-based
3449
3479
  information. */
3450
3480
  maps?: GroundingChunkMaps;
3451
- /** A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details. This field is not supported in Gemini API. */
3481
+ /** A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details */
3452
3482
  retrievedContext?: GroundingChunkRetrievedContext;
3453
3483
  /** A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. */
3454
3484
  web?: GroundingChunkWeb;
3455
3485
  }
3456
3486
 
3457
- /** A piece of evidence that comes from an image search result.
3487
+ /** User provided metadata about the GroundingFact. This data type is not supported in Vertex AI. */
3488
+ declare interface GroundingChunkCustomMetadata {
3489
+ /** The key of the metadata. */
3490
+ key?: string;
3491
+ /** Optional. The numeric value of the metadata. The expected range for this value depends on the specific `key` used. */
3492
+ numericValue?: number;
3493
+ /** Optional. A list of string values for the metadata. */
3494
+ stringListValue?: GroundingChunkStringList;
3495
+ /** Optional. The string value of the metadata. */
3496
+ stringValue?: string;
3497
+ }
3458
3498
 
3459
- It contains the URI of the image search result and the URI of the image.
3460
- This is used to provide the user with a link to the source of the
3461
- information. */
3499
+ /** An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. */
3462
3500
  declare interface GroundingChunkImage {
3463
3501
  /** The URI of the image search result page. */
3464
3502
  sourceUri?: string;
@@ -3490,6 +3528,8 @@ declare interface GroundingChunkMaps {
3490
3528
  title?: string;
3491
3529
  /** The URI of the place. */
3492
3530
  uri?: string;
3531
+ /** Output only. Route information. */
3532
+ route?: GroundingChunkMapsRoute;
3493
3533
  }
3494
3534
 
3495
3535
  /** The sources that were used to generate the place answer.
@@ -3533,11 +3573,21 @@ declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
3533
3573
  title?: string;
3534
3574
  }
3535
3575
 
3536
- /** Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. This data type is not supported in Gemini API. */
3576
+ /** Route information from Google Maps. This data type is not supported in Gemini API. */
3577
+ declare interface GroundingChunkMapsRoute {
3578
+ /** The total distance of the route, in meters. */
3579
+ distanceMeters?: number;
3580
+ /** The total duration of the route. */
3581
+ duration?: string;
3582
+ /** An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm */
3583
+ encodedPolyline?: string;
3584
+ }
3585
+
3586
+ /** Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. */
3537
3587
  declare interface GroundingChunkRetrievedContext {
3538
- /** Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. */
3588
+ /** Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. This field is not supported in Gemini API. */
3539
3589
  documentName?: string;
3540
- /** Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. */
3590
+ /** Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. This field is not supported in Gemini API. */
3541
3591
  ragChunk?: RagChunk;
3542
3592
  /** The content of the retrieved data source. */
3543
3593
  text?: string;
@@ -3545,6 +3595,16 @@ declare interface GroundingChunkRetrievedContext {
3545
3595
  title?: string;
3546
3596
  /** The URI of the retrieved data source. */
3547
3597
  uri?: string;
3598
+ /** Optional. User-provided metadata about the retrieved context. This field is not supported in Vertex AI. */
3599
+ customMetadata?: GroundingChunkCustomMetadata[];
3600
+ /** Optional. Name of the `FileSearchStore` containing the document. Example: `fileSearchStores/123`. This field is not supported in Vertex AI. */
3601
+ fileSearchStore?: string;
3602
+ }
3603
+
3604
+ /** A list of string values. This data type is not supported in Vertex AI. */
3605
+ declare interface GroundingChunkStringList {
3606
+ /** The string values of the list. */
3607
+ values?: string[];
3548
3608
  }
3549
3609
 
3550
3610
  /** A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. */
@@ -3559,10 +3619,7 @@ declare interface GroundingChunkWeb {
3559
3619
 
3560
3620
  /** Information for various kinds of grounding. */
3561
3621
  declare interface GroundingMetadata {
3562
- /** Optional. The image search queries that were used to generate the
3563
- content. This field is populated only when the grounding source is Google
3564
- Search with the Image Search search_type enabled.
3565
- */
3622
+ /** Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. */
3566
3623
  imageSearchQueries?: string[];
3567
3624
  /** A list of supporting references retrieved from the grounding
3568
3625
  source. This field is populated when the grounding source is Google
@@ -3578,7 +3635,7 @@ declare interface GroundingMetadata {
3578
3635
  searchEntryPoint?: SearchEntryPoint;
3579
3636
  /** Web search queries for the following-up web search. */
3580
3637
  webSearchQueries?: string[];
3581
- /** Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. This field is not supported in Gemini API. */
3638
+ /** Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. */
3582
3639
  googleMapsWidgetContextToken?: string;
3583
3640
  /** Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. This field is not supported in Gemini API. */
3584
3641
  retrievalQueries?: string[];
@@ -3608,6 +3665,8 @@ declare interface GroundingSupport {
3608
3665
  groundingChunkIndices?: number[];
3609
3666
  /** Segment of the content this support belongs to. */
3610
3667
  segment?: Segment;
3668
+ /** Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. */
3669
+ renderedParts?: number[];
3611
3670
  }
3612
3671
 
3613
3672
  /** The method for blocking content. If not specified, the default behavior is to use the probability score. This enum is not supported in Gemini API. */
@@ -3889,11 +3948,7 @@ declare interface ImageConfig {
3889
3948
  /** Controls the generation of people. Supported values are:
3890
3949
  ALLOW_ALL, ALLOW_ADULT, ALLOW_NONE. */
3891
3950
  personGeneration?: string;
3892
- /** Controls whether prominent people (celebrities)
3893
- generation is allowed. If used with personGeneration, personGeneration
3894
- enum would take precedence. For instance, if ALLOW_NONE is set, all person
3895
- generation would be blocked. If this field is unspecified, the default
3896
- behavior is to allow prominent people. */
3951
+ /** Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. This field is not supported in Gemini API. */
3897
3952
  prominentPeople?: ProminentPeople;
3898
3953
  /** MIME type of the generated image. This field is not
3899
3954
  supported in Gemini API. */
@@ -3901,7 +3956,7 @@ declare interface ImageConfig {
3901
3956
  /** Compression quality of the generated image (for
3902
3957
  ``image/jpeg`` only). This field is not supported in Gemini API. */
3903
3958
  outputCompressionQuality?: number;
3904
- /** Optional. The image output format for generated images. */
3959
+ /** Optional. The image output format for generated images. This field is not supported in Gemini API. */
3905
3960
  imageOutputOptions?: ImageConfigImageOutputOptions;
3906
3961
  }
3907
3962
 
@@ -3984,7 +4039,6 @@ declare class ImportFileOperation implements Operation<ImportFileResponse> {
3984
4039
  response?: ImportFileResponse;
3985
4040
  /**
3986
4041
  * Instantiates an Operation of the same type as the one being called with the fields set from the API response.
3987
- * @internal
3988
4042
  */
3989
4043
  _fromAPIResponse({ apiResponse, _isVertexAI, }: OperationFromAPIResponseParameters): Operation<ImportFileResponse>;
3990
4044
  /** The full HTTP response. */
@@ -4013,12 +4067,12 @@ declare class ImportFileResponse {
4013
4067
 
4014
4068
  /** Config for `inlined_embedding_responses` parameter. */
4015
4069
  declare class InlinedEmbedContentResponse {
4016
- /** The response to the request.
4017
- */
4070
+ /** Output only. The response to the request. */
4018
4071
  response?: SingleEmbedContentResponse;
4019
- /** The error encountered while processing the request.
4020
- */
4072
+ /** Output only. The error encountered while processing the request. */
4021
4073
  error?: JobError;
4074
+ /** Output only. The metadata associated with the request. */
4075
+ metadata?: Record<string, unknown>;
4022
4076
  }
4023
4077
 
4024
4078
  /** Config for inlined request. */
@@ -4282,6 +4336,7 @@ declare interface ListFileSearchStoresParameters {
4282
4336
  declare class ListFileSearchStoresResponse {
4283
4337
  /** Used to retain the full HTTP response. */
4284
4338
  sdkHttpResponse?: HttpResponse;
4339
+ /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no more pages. */
4285
4340
  nextPageToken?: string;
4286
4341
  /** The returned file search stores. */
4287
4342
  fileSearchStores?: FileSearchStore[];
@@ -4968,6 +5023,8 @@ declare interface LogprobsResult {
4968
5023
  chosenCandidates?: LogprobsResultCandidate[];
4969
5024
  /** A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. */
4970
5025
  topCandidates?: LogprobsResultTopCandidates[];
5026
+ /** Sum of log probabilities for all tokens. This field is not supported in Vertex AI. */
5027
+ logProbabilitySum?: number;
4971
5028
  }
4972
5029
 
4973
5030
  /** A single token and its associated log probability. */
@@ -5183,6 +5240,52 @@ declare interface ModelSelectionConfig {
5183
5240
  featureSelectionPreference?: FeatureSelectionPreference;
5184
5241
  }
5185
5242
 
5243
+ /** The stage of the underlying model. This enum is not supported in Vertex AI. */
5244
+ declare enum ModelStage {
5245
+ /**
5246
+ * Unspecified model stage.
5247
+ */
5248
+ MODEL_STAGE_UNSPECIFIED = "MODEL_STAGE_UNSPECIFIED",
5249
+ /**
5250
+ * The underlying model is subject to lots of tunings.
5251
+ */
5252
+ UNSTABLE_EXPERIMENTAL = "UNSTABLE_EXPERIMENTAL",
5253
+ /**
5254
+ * Models in this stage are for experimental purposes only.
5255
+ */
5256
+ EXPERIMENTAL = "EXPERIMENTAL",
5257
+ /**
5258
+ * Models in this stage are more mature than experimental models.
5259
+ */
5260
+ PREVIEW = "PREVIEW",
5261
+ /**
5262
+ * Models in this stage are considered stable and ready for production use.
5263
+ */
5264
+ STABLE = "STABLE",
5265
+ /**
5266
+ * If the model is on this stage, it means that this model is on the path to deprecation in near future. Only existing customers can use this model.
5267
+ */
5268
+ LEGACY = "LEGACY",
5269
+ /**
5270
+ * Models in this stage are deprecated. These models cannot be used.
5271
+ */
5272
+ DEPRECATED = "DEPRECATED",
5273
+ /**
5274
+ * Models in this stage are retired. These models cannot be used.
5275
+ */
5276
+ RETIRED = "RETIRED"
5277
+ }
5278
+
5279
+ /** The status of the underlying model. This is used to indicate the stage of the underlying model and the retirement time if applicable. This data type is not supported in Vertex AI. */
5280
+ declare interface ModelStatus {
5281
+ /** A message explaining the model status. */
5282
+ message?: string;
5283
+ /** The stage of the underlying model. */
5284
+ modelStage?: ModelStage;
5285
+ /** The time at which the model will be retired. */
5286
+ retirementTime?: string;
5287
+ }
5288
+
5186
5289
  /**
5187
5290
  * Moves values from source paths to destination paths.
5188
5291
  *
@@ -5281,7 +5384,6 @@ declare interface Operation<T> {
5281
5384
  response?: T;
5282
5385
  /**
5283
5386
  * Instantiates an Operation of the same type as the one being called with the fields set from the API response.
5284
- * @internal
5285
5387
  */
5286
5388
  _fromAPIResponse({ apiResponse, _isVertexAI, }: OperationFromAPIResponseParameters): Operation<T>;
5287
5389
  }
@@ -5392,6 +5494,8 @@ declare interface Part {
5392
5494
  toolCall?: ToolCall;
5393
5495
  /** The output from a server-side ToolCall execution. This field is populated by the client with the results of executing the corresponding ToolCall. */
5394
5496
  toolResponse?: ToolResponse;
5497
+ /** Custom metadata associated with the Part. Agents using genai.Part as content representation may need to keep track of the additional information. For example it can be name of a file/source from which the Part originates or a way to multiplex multiple Part streams. This field is not supported in Vertex AI. */
5498
+ partMetadata?: Record<string, unknown>;
5395
5499
  }
5396
5500
 
5397
5501
  /** Partial argument value of the function call. This data type is not supported in Gemini API. */
@@ -5594,7 +5698,7 @@ declare interface ProductImage {
5594
5698
  productImage?: Image_2;
5595
5699
  }
5596
5700
 
5597
- /** Enum for controlling whether the model can generate images of prominent people (celebrities). */
5701
+ /** Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. This enum is not supported in Gemini API. */
5598
5702
  declare enum ProminentPeople {
5599
5703
  /**
5600
5704
  * Unspecified value. The model will proceed with the default behavior, which is to allow generation of prominent people.
@@ -5859,12 +5963,14 @@ declare class ReplayResponse {
5859
5963
  sdkResponseSegments?: Record<string, unknown>[];
5860
5964
  }
5861
5965
 
5862
- /** ReplicatedVoiceConfig is used to configure replicated voice. */
5966
+ /** The configuration for the replicated voice to use. */
5863
5967
  declare interface ReplicatedVoiceConfig {
5864
- /** The mime type of the replicated voice.
5968
+ /** The mimetype of the voice sample. The only currently supported
5969
+ value is `audio/wav`. This represents 16-bit signed little-endian wav
5970
+ data, with a 24kHz sampling rate.
5865
5971
  */
5866
5972
  mimeType?: string;
5867
- /** The sample audio of the replicated voice.
5973
+ /** The sample of the custom voice.
5868
5974
 
5869
5975
  * @remarks Encoded as base64 string. */
5870
5976
  voiceSampleAudio?: string;
@@ -6032,7 +6138,7 @@ declare interface Schema {
6032
6138
  anyOf?: Schema[];
6033
6139
  /** Optional. Default value to use if the field is not specified. */
6034
6140
  default?: unknown;
6035
- /** Optional. Description of the schema. */
6141
+ /** Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. */
6036
6142
  description?: string;
6037
6143
  /** Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` */
6038
6144
  enum?: string[];
@@ -6092,12 +6198,11 @@ declare interface SearchEntryPoint {
6092
6198
  sdkBlob?: string;
6093
6199
  }
6094
6200
 
6095
- /** Tool to support computer use. */
6201
+ /** Different types of search that can be enabled on the GoogleSearch tool. */
6096
6202
  declare interface SearchTypes {
6097
- /** Setting this field enables web search. Only text results are
6098
- returned. */
6203
+ /** Optional. Setting this field enables web search. Only text results are returned. */
6099
6204
  webSearch?: WebSearch;
6100
- /** Setting this field enables image search. Image bytes are returned. */
6205
+ /** Optional. Setting this field enables image search. Image bytes are returned. */
6101
6206
  imageSearch?: ImageSearch;
6102
6207
  }
6103
6208
 
@@ -6210,6 +6315,26 @@ declare interface SendMessageParameters {
6210
6315
  config?: GenerateContentConfig;
6211
6316
  }
6212
6317
 
6318
+ /** Pricing and performance service tier. */
6319
+ declare enum ServiceTier {
6320
+ /**
6321
+ * Default service tier, which is standard.
6322
+ */
6323
+ SERVICE_TIER_UNSPECIFIED = "SERVICE_TIER_UNSPECIFIED",
6324
+ /**
6325
+ * Flex service tier.
6326
+ */
6327
+ SERVICE_TIER_FLEX = "SERVICE_TIER_FLEX",
6328
+ /**
6329
+ * Standard service tier.
6330
+ */
6331
+ SERVICE_TIER_STANDARD = "SERVICE_TIER_STANDARD",
6332
+ /**
6333
+ * Priority service tier.
6334
+ */
6335
+ SERVICE_TIER_PRIORITY = "SERVICE_TIER_PRIORITY"
6336
+ }
6337
+
6213
6338
  /** Configuration of session resumption mechanism.
6214
6339
 
6215
6340
  Included in `LiveConnectConfig.session_resumption`. If included server
@@ -6254,8 +6379,9 @@ declare interface SpeakerVoiceConfig {
6254
6379
  voiceConfig?: VoiceConfig;
6255
6380
  }
6256
6381
 
6382
+ /** Config for speech generation and transcription. */
6257
6383
  declare interface SpeechConfig {
6258
- /** Configuration for the voice of the response. */
6384
+ /** The configuration in case of single-voice output. */
6259
6385
  voiceConfig?: VoiceConfig;
6260
6386
  /** Optional. The language code (ISO 639-1) for the speech synthesis. */
6261
6387
  languageCode?: string;
@@ -6494,6 +6620,10 @@ declare enum ThinkingLevel {
6494
6620
  * Unspecified thinking level.
6495
6621
  */
6496
6622
  THINKING_LEVEL_UNSPECIFIED = "THINKING_LEVEL_UNSPECIFIED",
6623
+ /**
6624
+ * MINIMAL thinking level.
6625
+ */
6626
+ MINIMAL = "MINIMAL",
6497
6627
  /**
6498
6628
  * Low thinking level.
6499
6629
  */
@@ -6505,11 +6635,7 @@ declare enum ThinkingLevel {
6505
6635
  /**
6506
6636
  * High thinking level.
6507
6637
  */
6508
- HIGH = "HIGH",
6509
- /**
6510
- * MINIMAL thinking level.
6511
- */
6512
- MINIMAL = "MINIMAL"
6638
+ HIGH = "HIGH"
6513
6639
  }
6514
6640
 
6515
6641
  /** Tokens info with a list of tokens and the corresponding list of token ids. */
@@ -6531,9 +6657,9 @@ declare interface Tool {
6531
6657
  computer. If enabled, it automatically populates computer-use specific
6532
6658
  Function Declarations. */
6533
6659
  computerUse?: ComputerUse;
6534
- /** Optional. Tool to retrieve knowledge from the File Search Stores. */
6660
+ /** Optional. FileSearch tool type. Tool to retrieve knowledge from Semantic Retrieval corpora. This field is not supported in Vertex AI. */
6535
6661
  fileSearch?: FileSearch;
6536
- /** Enables the model to execute Google Search as part of generation. */
6662
+ /** Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
6537
6663
  googleSearch?: GoogleSearch;
6538
6664
  /** Optional. Tool that allows grounding the model's response with
6539
6665
  geospatial context related to the user's query. */
@@ -6666,11 +6792,9 @@ declare enum TrafficType {
6666
6792
 
6667
6793
  /** Audio transcription in Server Conent. */
6668
6794
  declare interface Transcription {
6669
- /** Transcription text.
6670
- */
6795
+ /** Optional. Transcription text. */
6671
6796
  text?: string;
6672
- /** The bool indicates the end of the transcription.
6673
- */
6797
+ /** Optional. The bool indicates the end of the transcription. */
6674
6798
  finished?: boolean;
6675
6799
  }
6676
6800
 
@@ -6808,6 +6932,18 @@ declare interface TuningJob {
6808
6932
  tuningJobState?: TuningJobState;
6809
6933
  /** Tuning Spec for Veo Tuning. */
6810
6934
  veoTuningSpec?: VeoTuningSpec;
6935
+ /** Optional. Spec for creating a distillation dataset. */
6936
+ distillationSamplingSpec?: DistillationSamplingSpec;
6937
+ /** Output only. Tuning Job metadata. */
6938
+ tuningJobMetadata?: TuningJobMetadata;
6939
+ }
6940
+
6941
+ /** Tuning job metadata. This data type is not supported in Gemini API. */
6942
+ declare interface TuningJobMetadata {
6943
+ /** Output only. The number of epochs that have been completed. */
6944
+ completedEpochCount?: string;
6945
+ /** Output only. The number of steps that have been completed. Set for Multi-Step RL. */
6946
+ completedStepCount?: string;
6811
6947
  }
6812
6948
 
6813
6949
  /** Output only. The detail state of the tuning job (while the overall `JobState` is running). This enum is not supported in Gemini API. */
@@ -6944,7 +7080,11 @@ declare enum TurnCoverage {
6944
7080
  /**
6945
7081
  * The users turn includes all realtime input since the last turn, including inactivity (e.g. silence on the audio stream).
6946
7082
  */
6947
- TURN_INCLUDES_ALL_INPUT = "TURN_INCLUDES_ALL_INPUT"
7083
+ TURN_INCLUDES_ALL_INPUT = "TURN_INCLUDES_ALL_INPUT",
7084
+ /**
7085
+ * Includes audio activity and all video since the last turn. With automatic activity detection, audio activity means speech and excludes silence.
7086
+ */
7087
+ TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO = "TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO"
6948
7088
  }
6949
7089
 
6950
7090
  /** Data type of the schema field. */
@@ -7000,15 +7140,17 @@ declare namespace types {
7000
7140
  Outcome,
7001
7141
  FunctionResponseScheduling,
7002
7142
  Type,
7003
- PhishBlockThreshold,
7143
+ Environment,
7004
7144
  AuthType,
7005
7145
  HttpElementLocation,
7006
7146
  ApiSpec,
7147
+ PhishBlockThreshold,
7007
7148
  Behavior,
7008
7149
  DynamicRetrievalConfigMode,
7009
7150
  FunctionCallingConfigMode,
7010
7151
  ThinkingLevel,
7011
7152
  PersonGeneration,
7153
+ ProminentPeople,
7012
7154
  HarmCategory,
7013
7155
  HarmBlockMethod,
7014
7156
  HarmBlockThreshold,
@@ -7019,6 +7161,7 @@ declare namespace types {
7019
7161
  BlockedReason,
7020
7162
  TrafficType,
7021
7163
  Modality,
7164
+ ModelStage,
7022
7165
  MediaResolution,
7023
7166
  TuningMode,
7024
7167
  AdapterSize,
@@ -7027,12 +7170,12 @@ declare namespace types {
7027
7170
  AggregationMetric,
7028
7171
  PairwiseChoice,
7029
7172
  TuningTask,
7173
+ DocumentState,
7030
7174
  PartMediaResolutionLevel,
7031
7175
  ToolType,
7032
7176
  ResourceScope,
7177
+ ServiceTier,
7033
7178
  FeatureSelectionPreference,
7034
- Environment,
7035
- ProminentPeople,
7036
7179
  EmbeddingApiType,
7037
7180
  SafetyFilterLevel,
7038
7181
  ImagePromptLanguage,
@@ -7045,7 +7188,6 @@ declare namespace types {
7045
7188
  VideoGenerationMaskMode,
7046
7189
  VideoCompressionQuality,
7047
7190
  TuningMethod,
7048
- DocumentState,
7049
7191
  FileState,
7050
7192
  FileSource,
7051
7193
  TurnCompleteReason,
@@ -7080,12 +7222,6 @@ declare namespace types {
7080
7222
  Schema,
7081
7223
  ModelSelectionConfig,
7082
7224
  ComputerUse,
7083
- FileSearch,
7084
- WebSearch,
7085
- ImageSearch,
7086
- SearchTypes,
7087
- Interval,
7088
- GoogleSearch,
7089
7225
  ApiKeyConfig,
7090
7226
  AuthConfigGoogleServiceAccountConfig,
7091
7227
  AuthConfigHttpBasicAuthConfig,
@@ -7109,6 +7245,12 @@ declare namespace types {
7109
7245
  RagRetrievalConfig,
7110
7246
  VertexRagStore,
7111
7247
  Retrieval,
7248
+ FileSearch,
7249
+ WebSearch,
7250
+ ImageSearch,
7251
+ SearchTypes,
7252
+ Interval,
7253
+ GoogleSearch,
7112
7254
  ToolCodeExecution,
7113
7255
  EnterpriseWebSearch,
7114
7256
  FunctionDeclaration,
@@ -7145,13 +7287,16 @@ declare namespace types {
7145
7287
  GoogleTypeDate,
7146
7288
  Citation,
7147
7289
  CitationMetadata,
7148
- GroundingChunkImage,
7149
7290
  GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution,
7150
7291
  GroundingChunkMapsPlaceAnswerSourcesReviewSnippet,
7151
7292
  GroundingChunkMapsPlaceAnswerSources,
7293
+ GroundingChunkMapsRoute,
7152
7294
  GroundingChunkMaps,
7295
+ GroundingChunkImage,
7153
7296
  RagChunkPageSpan,
7154
7297
  RagChunk,
7298
+ GroundingChunkStringList,
7299
+ GroundingChunkCustomMetadata,
7155
7300
  GroundingChunkRetrievedContext,
7156
7301
  GroundingChunkWeb,
7157
7302
  GroundingChunk,
@@ -7171,6 +7316,7 @@ declare namespace types {
7171
7316
  GenerateContentResponsePromptFeedback,
7172
7317
  ModalityTokenCount,
7173
7318
  GenerateContentResponseUsageMetadata,
7319
+ ModelStatus,
7174
7320
  GenerateContentResponse,
7175
7321
  ReferenceImage,
7176
7322
  EditImageParameters,
@@ -7281,6 +7427,8 @@ declare namespace types {
7281
7427
  FullFineTuningSpec,
7282
7428
  VeoHyperParameters,
7283
7429
  VeoTuningSpec,
7430
+ DistillationSamplingSpec,
7431
+ TuningJobMetadata,
7284
7432
  TuningJob,
7285
7433
  ListTuningJobsConfig,
7286
7434
  ListTuningJobsParameters,
@@ -7623,7 +7771,6 @@ declare class UploadToFileSearchStoreOperation implements Operation<UploadToFile
7623
7771
  response?: UploadToFileSearchStoreResponse;
7624
7772
  /**
7625
7773
  * Instantiates an Operation of the same type as the one being called with the fields set from the API response.
7626
- * @internal
7627
7774
  */
7628
7775
  _fromAPIResponse({ apiResponse, _isVertexAI, }: OperationFromAPIResponseParameters): Operation<UploadToFileSearchStoreResponse>;
7629
7776
  /** The full HTTP response. */
@@ -8001,16 +8148,17 @@ declare enum VoiceActivityType {
8001
8148
  ACTIVITY_END = "ACTIVITY_END"
8002
8149
  }
8003
8150
 
8151
+ /** The configuration for the voice to use. */
8004
8152
  declare interface VoiceConfig {
8005
- /** If true, the model will use a replicated voice for the response. */
8153
+ /** The configuration for a replicated voice, which is a clone of a
8154
+ user's voice that can be used for speech synthesis. If this is unset, a
8155
+ default voice is used. */
8006
8156
  replicatedVoiceConfig?: ReplicatedVoiceConfig;
8007
8157
  /** The configuration for a prebuilt voice. */
8008
8158
  prebuiltVoiceConfig?: PrebuiltVoiceConfig;
8009
8159
  }
8010
8160
 
8011
- /** Standard web search for grounding and related configurations.
8012
-
8013
- Only text results are returned. */
8161
+ /** Standard web search for grounding and related configurations. Only text results are returned. */
8014
8162
  declare interface WebSearch {
8015
8163
  }
8016
8164