@google/genai 1.43.0 → 1.45.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/genai.d.ts CHANGED
@@ -66,6 +66,80 @@ export declare enum AdapterSize {
66
66
  ADAPTER_SIZE_THIRTY_TWO = "ADAPTER_SIZE_THIRTY_TWO"
67
67
  }
68
68
 
69
+ /** Aggregation metric. This enum is not supported in Gemini API. */
70
+ export declare enum AggregationMetric {
71
+ /**
72
+ * Unspecified aggregation metric.
73
+ */
74
+ AGGREGATION_METRIC_UNSPECIFIED = "AGGREGATION_METRIC_UNSPECIFIED",
75
+ /**
76
+ * Average aggregation metric. Not supported for Pairwise metric.
77
+ */
78
+ AVERAGE = "AVERAGE",
79
+ /**
80
+ * Mode aggregation metric.
81
+ */
82
+ MODE = "MODE",
83
+ /**
84
+ * Standard deviation aggregation metric. Not supported for pairwise metric.
85
+ */
86
+ STANDARD_DEVIATION = "STANDARD_DEVIATION",
87
+ /**
88
+ * Variance aggregation metric. Not supported for pairwise metric.
89
+ */
90
+ VARIANCE = "VARIANCE",
91
+ /**
92
+ * Minimum aggregation metric. Not supported for pairwise metric.
93
+ */
94
+ MINIMUM = "MINIMUM",
95
+ /**
96
+ * Maximum aggregation metric. Not supported for pairwise metric.
97
+ */
98
+ MAXIMUM = "MAXIMUM",
99
+ /**
100
+ * Median aggregation metric. Not supported for pairwise metric.
101
+ */
102
+ MEDIAN = "MEDIAN",
103
+ /**
104
+ * 90th percentile aggregation metric. Not supported for pairwise metric.
105
+ */
106
+ PERCENTILE_P90 = "PERCENTILE_P90",
107
+ /**
108
+ * 95th percentile aggregation metric. Not supported for pairwise metric.
109
+ */
110
+ PERCENTILE_P95 = "PERCENTILE_P95",
111
+ /**
112
+ * 99th percentile aggregation metric. Not supported for pairwise metric.
113
+ */
114
+ PERCENTILE_P99 = "PERCENTILE_P99"
115
+ }
116
+
117
+ /** The aggregation result for the entire dataset and all metrics. This data type is not supported in Gemini API. */
118
+ export declare interface AggregationOutput {
119
+ /** One AggregationResult per metric. */
120
+ aggregationResults?: AggregationResult[];
121
+ /** The dataset used for evaluation & aggregation. */
122
+ dataset?: EvaluationDataset;
123
+ }
124
+
125
+ /** The aggregation result for a single metric. This data type is not supported in Gemini API. */
126
+ export declare interface AggregationResult {
127
+ /** Aggregation metric. */
128
+ aggregationMetric?: AggregationMetric;
129
+ /** Results for bleu metric. */
130
+ bleuMetricValue?: BleuMetricValue;
131
+ /** Result for code execution metric. */
132
+ customCodeExecutionResult?: CustomCodeExecutionResult;
133
+ /** Results for exact match metric. */
134
+ exactMatchMetricValue?: ExactMatchMetricValue;
135
+ /** Result for pairwise metric. */
136
+ pairwiseMetricResult?: PairwiseMetricResult;
137
+ /** Result for pointwise metric. */
138
+ pointwiseMetricResult?: PointwiseMetricResult;
139
+ /** Results for rouge metric. */
140
+ rougeMetricValue?: RougeMetricValue;
141
+ }
142
+
69
143
  /**
70
144
  * The configuration for allowed tools.
71
145
  */
@@ -118,6 +192,9 @@ export declare interface ApiAuthApiKeyConfig {
118
192
  /**
119
193
  * The ApiClient class is used to send requests to the Gemini API or Vertex AI
120
194
  * endpoints.
195
+ *
196
+ * WARNING: This is an internal API and may change without notice. Direct usage
197
+ * is not supported and may break your application.
121
198
  */
122
199
  declare class ApiClient implements GeminiNextGenAPIClientAdapter {
123
200
  readonly clientOptions: ApiClientInitOptions;
@@ -420,6 +497,9 @@ declare interface AudioContent {
420
497
 
421
498
  /** The audio transcription configuration in Setup. */
422
499
  export declare interface AudioTranscriptionConfig {
500
+ /** The language codes of the audio. BCP-47 language code. If not set, the transcription will be in the language detected by the model. If set, the server will use the language code specified in the model config as a hint for the language of the audio
501
+ */
502
+ languageCodes?: string[];
423
503
  }
424
504
 
425
505
  /**
@@ -440,8 +520,10 @@ declare interface Auth {
440
520
  addAuthHeaders(headers: Headers, url?: string): Promise<void>;
441
521
  }
442
522
 
443
- /** Auth configuration to run the extension. This data type is not supported in Gemini API. */
523
+ /** The authentication config to access the API. */
444
524
  export declare interface AuthConfig {
525
+ /** The authentication config to access the API. Only API key is supported. This field is not supported in Gemini API. */
526
+ apiKey?: string;
445
527
  /** Config for API key auth. */
446
528
  apiKeyConfig?: ApiKeyConfig;
447
529
  /** Type of auth scheme. */
@@ -571,11 +653,11 @@ declare interface BaseCreateAgentInteractionParams {
571
653
  */
572
654
  agent: (string & {}) | 'deep-research-pro-preview-12-2025';
573
655
  /**
574
- * Body param: The inputs for the interaction.
656
+ * Body param: The input for the interaction.
575
657
  */
576
- input: string | Array<Content_2> | Array<Turn> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent | ThoughtContent | FunctionCallContent | FunctionResultContent | CodeExecutionCallContent | CodeExecutionResultContent | URLContextCallContent | URLContextResultContent | GoogleSearchCallContent | GoogleSearchResultContent | MCPServerToolCallContent | MCPServerToolResultContent | FileSearchCallContent | FileSearchResultContent;
658
+ input: Array<Content_2> | string | Array<Turn> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent | ThoughtContent | FunctionCallContent | FunctionResultContent | CodeExecutionCallContent | CodeExecutionResultContent | URLContextCallContent | URLContextResultContent | GoogleSearchCallContent | GoogleSearchResultContent | MCPServerToolCallContent | MCPServerToolResultContent | FileSearchCallContent | FileSearchResultContent;
577
659
  /**
578
- * Body param: Configuration for the agent.
660
+ * Body param: Configuration parameters for the agent interaction.
579
661
  */
580
662
  agent_config?: DynamicAgentConfig | DeepResearchAgentConfig;
581
663
  /**
@@ -623,9 +705,9 @@ declare interface BaseCreateModelInteractionParams {
623
705
  */
624
706
  api_version?: string;
625
707
  /**
626
- * Body param: The inputs for the interaction.
708
+ * Body param: The input for the interaction.
627
709
  */
628
- input: string | Array<Content_2> | Array<Turn> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent | ThoughtContent | FunctionCallContent | FunctionResultContent | CodeExecutionCallContent | CodeExecutionResultContent | URLContextCallContent | URLContextResultContent | GoogleSearchCallContent | GoogleSearchResultContent | MCPServerToolCallContent | MCPServerToolResultContent | FileSearchCallContent | FileSearchResultContent;
710
+ input: Array<Content_2> | string | Array<Turn> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent | ThoughtContent | FunctionCallContent | FunctionResultContent | CodeExecutionCallContent | CodeExecutionResultContent | URLContextCallContent | URLContextResultContent | GoogleSearchCallContent | GoogleSearchResultContent | MCPServerToolCallContent | MCPServerToolResultContent | FileSearchCallContent | FileSearchResultContent;
629
711
  /**
630
712
  * Body param: The name of the `Model` used for generating the interaction.
631
713
  */
@@ -718,7 +800,7 @@ declare class BaseGeminiNextGenAPIClient {
718
800
  /**
719
801
  * Basic re-implementation of `qs.stringify` for primitive types.
720
802
  */
721
- protected stringifyQuery(query: Record<string, unknown>): string;
803
+ protected stringifyQuery(query: object | Record<string, unknown>): string;
722
804
  private getUserAgent;
723
805
  protected defaultIdempotencyKey(): string;
724
806
  protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
@@ -772,7 +854,7 @@ declare class BaseInteractions extends APIResource {
772
854
  * ```ts
773
855
  * const interaction = await client.interactions.create({
774
856
  * api_version: 'api_version',
775
- * input: 'string',
857
+ * input: [{ text: 'text', type: 'text' }],
776
858
  * model: 'gemini-2.5-flash',
777
859
  * });
778
860
  * ```
@@ -1057,12 +1139,24 @@ export declare enum Behavior {
1057
1139
  NON_BLOCKING = "NON_BLOCKING"
1058
1140
  }
1059
1141
 
1060
- /** Content blob. */
1142
+ /** The BigQuery location for the input content. This data type is not supported in Gemini API. */
1143
+ export declare interface BigQuerySource {
1144
+ /** Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. */
1145
+ inputUri?: string;
1146
+ }
1147
+
1148
+ /** Bleu metric value for an instance. This data type is not supported in Gemini API. */
1149
+ export declare interface BleuMetricValue {
1150
+ /** Output only. Bleu score. */
1151
+ score?: number;
1152
+ }
1153
+
1154
+ /** A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. */
1061
1155
  declare interface Blob_2 {
1062
- /** Required. Raw bytes.
1156
+ /** Required. The raw bytes of the data.
1063
1157
  * @remarks Encoded as base64 string. */
1064
1158
  data?: string;
1065
- /** 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. */
1159
+ /** Optional. The 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 used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. This field is not supported in Gemini API. */
1066
1160
  displayName?: string;
1067
1161
  /** Required. The IANA standard MIME type of the source data. */
1068
1162
  mimeType?: string;
@@ -1335,15 +1429,15 @@ export declare interface Candidate {
1335
1429
  contains the sources used to ground the generated content.
1336
1430
  */
1337
1431
  groundingMetadata?: GroundingMetadata;
1338
- /** Output only. Average log probability score of the candidate. */
1432
+ /** Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. */
1339
1433
  avgLogprobs?: number;
1340
- /** Output only. Index of the candidate. */
1434
+ /** Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. */
1341
1435
  index?: number;
1342
- /** Output only. Log-likelihood scores for the response tokens and top tokens */
1436
+ /** Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". */
1343
1437
  logprobsResult?: LogprobsResult;
1344
- /** Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */
1438
+ /** Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. */
1345
1439
  safetyRatings?: SafetyRating[];
1346
- /** Output only. Metadata related to url context retrieval tool. */
1440
+ /** Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */
1347
1441
  urlContextMetadata?: UrlContextMetadata;
1348
1442
  }
1349
1443
 
@@ -1485,19 +1579,19 @@ export declare interface ChunkingConfig {
1485
1579
  whiteSpaceConfig?: WhiteSpaceConfig;
1486
1580
  }
1487
1581
 
1488
- /** Source attributions for content. This data type is not supported in Gemini API. */
1582
+ /** A citation for a piece of generatedcontent. This data type is not supported in Gemini API. */
1489
1583
  export declare interface Citation {
1490
- /** Output only. End index into the content. */
1584
+ /** Output only. The end index of the citation in the content. */
1491
1585
  endIndex?: number;
1492
- /** Output only. License of the attribution. */
1586
+ /** Output only. The license of the source of the citation. */
1493
1587
  license?: string;
1494
- /** Output only. Publication date of the attribution. */
1588
+ /** Output only. The publication date of the source of the citation. */
1495
1589
  publicationDate?: GoogleTypeDate;
1496
- /** Output only. Start index into the content. */
1590
+ /** Output only. The start index of the citation in the content. */
1497
1591
  startIndex?: number;
1498
- /** Output only. Title of the attribution. */
1592
+ /** Output only. The title of the source of the citation. */
1499
1593
  title?: string;
1500
- /** Output only. Url reference of the attribution. */
1594
+ /** Output only. The URI of the source of the citation. */
1501
1595
  uri?: string;
1502
1596
  }
1503
1597
 
@@ -1717,7 +1811,7 @@ export declare interface Content {
1717
1811
  /** List of parts that constitute a single message. Each part may have
1718
1812
  a different IANA MIME type. */
1719
1813
  parts?: Part[];
1720
- /** 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. */
1814
+ /** Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. */
1721
1815
  role?: string;
1722
1816
  }
1723
1817
 
@@ -1780,7 +1874,7 @@ declare namespace ContentDelta {
1780
1874
  interface ThoughtSummaryDelta {
1781
1875
  type: 'thought_summary';
1782
1876
  /**
1783
- * A text content block.
1877
+ * A new summary item to be added to the thought.
1784
1878
  */
1785
1879
  content?: InteractionsAPI.TextContent | InteractionsAPI.ImageContent;
1786
1880
  }
@@ -1814,6 +1908,10 @@ declare namespace ContentDelta {
1814
1908
  type: 'function_result';
1815
1909
  is_error?: boolean;
1816
1910
  name?: string;
1911
+ /**
1912
+ * A signature hash for backend validation.
1913
+ */
1914
+ signature?: string;
1817
1915
  }
1818
1916
  namespace FunctionResultDelta {
1819
1917
  interface Items {
@@ -1839,6 +1937,9 @@ declare namespace ContentDelta {
1839
1937
  result: string;
1840
1938
  type: 'code_execution_result';
1841
1939
  is_error?: boolean;
1940
+ /**
1941
+ * A signature hash for backend validation.
1942
+ */
1842
1943
  signature?: string;
1843
1944
  }
1844
1945
  interface URLContextCallDelta {
@@ -1860,6 +1961,9 @@ declare namespace ContentDelta {
1860
1961
  result: Array<InteractionsAPI.URLContextResult>;
1861
1962
  type: 'url_context_result';
1862
1963
  is_error?: boolean;
1964
+ /**
1965
+ * A signature hash for backend validation.
1966
+ */
1863
1967
  signature?: string;
1864
1968
  }
1865
1969
  interface GoogleSearchCallDelta {
@@ -1881,6 +1985,9 @@ declare namespace ContentDelta {
1881
1985
  result: Array<InteractionsAPI.GoogleSearchResult>;
1882
1986
  type: 'google_search_result';
1883
1987
  is_error?: boolean;
1988
+ /**
1989
+ * A signature hash for backend validation.
1990
+ */
1884
1991
  signature?: string;
1885
1992
  }
1886
1993
  interface MCPServerToolCallDelta {
@@ -1907,6 +2014,10 @@ declare namespace ContentDelta {
1907
2014
  type: 'mcp_server_tool_result';
1908
2015
  name?: string;
1909
2016
  server_name?: string;
2017
+ /**
2018
+ * A signature hash for backend validation.
2019
+ */
2020
+ signature?: string;
1910
2021
  }
1911
2022
  namespace MCPServerToolResultDelta {
1912
2023
  interface Items {
@@ -1921,8 +2032,16 @@ declare namespace ContentDelta {
1921
2032
  type: 'file_search_call';
1922
2033
  }
1923
2034
  interface FileSearchResultDelta {
2035
+ /**
2036
+ * ID to match the ID from the function call block.
2037
+ */
2038
+ call_id: string;
1924
2039
  type: 'file_search_result';
1925
2040
  result?: Array<FileSearchResultDelta.Result>;
2041
+ /**
2042
+ * A signature hash for backend validation.
2043
+ */
2044
+ signature?: string;
1926
2045
  }
1927
2046
  namespace FileSearchResultDelta {
1928
2047
  /**
@@ -2501,6 +2620,12 @@ export declare interface CreateTuningJobParametersPrivate {
2501
2620
  */
2502
2621
  export declare function createUserContent(partOrString: PartListUnion | string): Content;
2503
2622
 
2623
+ /** Result for custom code execution metric. This data type is not supported in Gemini API. */
2624
+ export declare interface CustomCodeExecutionResult {
2625
+ /** Output only. Custom code execution score. */
2626
+ score?: number;
2627
+ }
2628
+
2504
2629
  /** User provided metadata stored as key-value pairs. This data type is not supported in Vertex AI. */
2505
2630
  export declare interface CustomMetadata {
2506
2631
  /** Required. The key of the metadata to store. */
@@ -2513,6 +2638,12 @@ export declare interface CustomMetadata {
2513
2638
  stringValue?: string;
2514
2639
  }
2515
2640
 
2641
+ /** Spec for custom output. This data type is not supported in Gemini API. */
2642
+ export declare interface CustomOutput {
2643
+ /** Output only. List of raw output strings. */
2644
+ rawOutputs?: RawOutput;
2645
+ }
2646
+
2516
2647
  /** Distribution computed over a tuning dataset. This data type is not supported in Gemini API. */
2517
2648
  export declare interface DatasetDistribution {
2518
2649
  /** Output only. Defines the histogram bucket. */
@@ -2545,6 +2676,10 @@ export declare interface DatasetDistributionDistributionBucket {
2545
2676
 
2546
2677
  /** Statistics computed over a tuning dataset. This data type is not supported in Gemini API. */
2547
2678
  export declare interface DatasetStats {
2679
+ /** Output only. A partial sample of the indices (starting from 1) of the dropped examples. */
2680
+ droppedExampleIndices?: string[];
2681
+ /** Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. */
2682
+ droppedExampleReasons?: string[];
2548
2683
  /** Output only. Number of billable characters in the tuning dataset. */
2549
2684
  totalBillableCharacterCount?: string;
2550
2685
  /** Output only. Number of tuning characters in the tuning dataset. */
@@ -2740,7 +2875,7 @@ export declare interface DeleteResourceJob {
2740
2875
  error?: JobError;
2741
2876
  }
2742
2877
 
2743
- /** Statistics computed for datasets used for distillation. This data type is not supported in Gemini API. */
2878
+ /** Statistics for distillation prompt dataset. These statistics do not include the responses sampled from the teacher model. This data type is not supported in Gemini API. */
2744
2879
  export declare interface DistillationDataStats {
2745
2880
  /** Output only. Statistics computed for the training dataset. */
2746
2881
  trainingDatasetStats?: DatasetStats;
@@ -3132,9 +3267,9 @@ export declare interface EmbeddingsBatchJobSource {
3132
3267
  inlinedRequests?: EmbedContentBatch;
3133
3268
  }
3134
3269
 
3135
- /** 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. */
3270
+ /** Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. This data type is not supported in Gemini API. */
3136
3271
  export declare interface EncryptionSpec {
3137
- /** 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. */
3272
+ /** Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. */
3138
3273
  kmsKeyName?: string;
3139
3274
  }
3140
3275
 
@@ -3164,10 +3299,10 @@ export declare enum EndSensitivity {
3164
3299
 
3165
3300
  /** Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. This data type is not supported in Gemini API. */
3166
3301
  export declare interface EnterpriseWebSearch {
3167
- /** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. */
3168
- excludeDomains?: string[];
3169
3302
  /** Optional. Sites with confidence level chosen & above this value will be blocked from the search results. */
3170
3303
  blockingConfidence?: PhishBlockThreshold;
3304
+ /** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. */
3305
+ excludeDomains?: string[];
3171
3306
  }
3172
3307
 
3173
3308
  /** An entity representing the segmented area. */
@@ -3236,6 +3371,42 @@ declare namespace Errors {
3236
3371
  }
3237
3372
  }
3238
3373
 
3374
+ /** The results from an evaluation run performed by the EvaluationService. This data type is not supported in Gemini API. */
3375
+ export declare class EvaluateDatasetResponse {
3376
+ /** Output only. Aggregation statistics derived from results of EvaluationService. */
3377
+ aggregationOutput?: AggregationOutput;
3378
+ /** Output only. Output info for EvaluationService. */
3379
+ outputInfo?: OutputInfo;
3380
+ }
3381
+
3382
+ /** Evaluate Dataset Run Result for Tuning Job. This data type is not supported in Gemini API. */
3383
+ export declare interface EvaluateDatasetRun {
3384
+ /** Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints. */
3385
+ checkpointId?: string;
3386
+ /** Output only. The error of the evaluation run if any. */
3387
+ error?: GoogleRpcStatus;
3388
+ /** Output only. Results for EvaluationService. */
3389
+ evaluateDatasetResponse?: EvaluateDatasetResponse;
3390
+ /** Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`. */
3391
+ evaluationRun?: string;
3392
+ /** Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`. */
3393
+ operationName?: string;
3394
+ }
3395
+
3396
+ /** The dataset used for evaluation. This data type is not supported in Gemini API. */
3397
+ export declare interface EvaluationDataset {
3398
+ /** BigQuery source holds the dataset. */
3399
+ bigquerySource?: BigQuerySource;
3400
+ /** Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported. */
3401
+ gcsSource?: GcsSource;
3402
+ }
3403
+
3404
+ /** Exact match metric value for an instance. This data type is not supported in Gemini API. */
3405
+ export declare interface ExactMatchMetricValue {
3406
+ /** Output only. Exact match score. */
3407
+ score?: number;
3408
+ }
3409
+
3239
3410
  /** Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. */
3240
3411
  export declare interface ExecutableCode {
3241
3412
  /** Required. The code to be executed. */
@@ -3346,11 +3517,11 @@ declare interface File_2 {
3346
3517
  }
3347
3518
  export { File_2 as File }
3348
3519
 
3349
- /** URI based data. */
3520
+ /** URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. */
3350
3521
  export declare interface FileData {
3351
- /** 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. */
3522
+ /** Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. This field is not supported in Gemini API. */
3352
3523
  displayName?: string;
3353
- /** Required. URI. */
3524
+ /** Required. The URI of the file in Google Cloud Storage. */
3354
3525
  fileUri?: string;
3355
3526
  /** Required. The IANA standard MIME type of the source data. */
3356
3527
  mimeType?: string;
@@ -3511,6 +3682,10 @@ declare interface FileSearchResultContent {
3511
3682
  * The results of the File Search.
3512
3683
  */
3513
3684
  result?: Array<FileSearchResultContent.Result>;
3685
+ /**
3686
+ * A signature hash for backend validation.
3687
+ */
3688
+ signature?: string;
3514
3689
  }
3515
3690
 
3516
3691
  declare namespace FileSearchResultContent {
@@ -3769,6 +3944,16 @@ export declare enum FinishReason {
3769
3944
  IMAGE_OTHER = "IMAGE_OTHER"
3770
3945
  }
3771
3946
 
3947
+ /** Tuning Spec for Full Fine Tuning. This data type is not supported in Gemini API. */
3948
+ export declare interface FullFineTuningSpec {
3949
+ /** Optional. Hyperparameters for Full Fine Tuning. */
3950
+ hyperParameters?: SupervisedHyperParameters;
3951
+ /** Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. */
3952
+ trainingDatasetUri?: string;
3953
+ /** Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. */
3954
+ validationDatasetUri?: string;
3955
+ }
3956
+
3772
3957
  /**
3773
3958
  * A tool that can be used by the model.
3774
3959
  */
@@ -3862,7 +4047,7 @@ export declare enum FunctionCallingConfigMode {
3862
4047
  export declare interface FunctionDeclaration {
3863
4048
  /** Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. */
3864
4049
  description?: string;
3865
- /** Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. */
4050
+ /** Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. */
3866
4051
  name?: string;
3867
4052
  /** Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 */
3868
4053
  parameters?: Schema;
@@ -3966,7 +4151,7 @@ declare interface FunctionResultContent {
3966
4151
  /**
3967
4152
  * The result of the tool call.
3968
4153
  */
3969
- result: FunctionResultContent.Items | unknown | string;
4154
+ result: unknown | Array<TextContent | ImageContent> | string;
3970
4155
  type: 'function_result';
3971
4156
  /**
3972
4157
  * Whether the tool call resulted in an error.
@@ -3976,12 +4161,16 @@ declare interface FunctionResultContent {
3976
4161
  * The name of the tool that was called.
3977
4162
  */
3978
4163
  name?: string;
4164
+ /**
4165
+ * A signature hash for backend validation.
4166
+ */
4167
+ signature?: string;
3979
4168
  }
3980
4169
 
3981
- declare namespace FunctionResultContent {
3982
- interface Items {
3983
- items?: Array<InteractionsAPI.TextContent | InteractionsAPI.ImageContent>;
3984
- }
4170
+ /** The Google Cloud Storage location for the input content. This data type is not supported in Gemini API. */
4171
+ export declare interface GcsSource {
4172
+ /** Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards. */
4173
+ uris?: string[];
3985
4174
  }
3986
4175
 
3987
4176
  /**
@@ -4096,7 +4285,6 @@ export declare interface GenerateContentConfig {
4096
4285
  - `application/json`: JSON response in the candidates.
4097
4286
  The model needs to be prompted to output the appropriate response type,
4098
4287
  otherwise the behavior is undefined.
4099
- This is a preview feature.
4100
4288
  */
4101
4289
  responseMimeType?: string;
4102
4290
  /** The `Schema` object allows the definition of input and output data types.
@@ -4619,45 +4807,45 @@ export declare interface GenerationConfig {
4619
4807
  `response_schema` that accepts [JSON Schema](https://json-schema.org/).
4620
4808
  */
4621
4809
  responseJsonSchema?: unknown;
4622
- /** Optional. If enabled, audio timestamp will be included in the request to the model. This field is not supported in Gemini API. */
4810
+ /** Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. This field is not supported in Gemini API. */
4623
4811
  audioTimestamp?: boolean;
4624
- /** Optional. Number of candidates to generate. */
4812
+ /** Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. */
4625
4813
  candidateCount?: number;
4626
- /** Optional. If enabled, the model will detect emotions and adapt its responses accordingly. This field is not supported in Gemini API. */
4814
+ /** Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. This field is not supported in Gemini API. */
4627
4815
  enableAffectiveDialog?: boolean;
4628
- /** Optional. Frequency penalties. */
4816
+ /** Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. */
4629
4817
  frequencyPenalty?: number;
4630
- /** Optional. Logit probabilities. */
4818
+ /** Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. */
4631
4819
  logprobs?: number;
4632
- /** Optional. The maximum number of output tokens to generate per message. */
4820
+ /** Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. */
4633
4821
  maxOutputTokens?: number;
4634
- /** Optional. If specified, the media resolution specified will be used. */
4822
+ /** Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. */
4635
4823
  mediaResolution?: MediaResolution;
4636
- /** Optional. Positive penalties. */
4824
+ /** Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. */
4637
4825
  presencePenalty?: number;
4638
- /** Optional. If true, export the logprobs results in response. */
4826
+ /** Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. */
4639
4827
  responseLogprobs?: boolean;
4640
- /** Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. */
4828
+ /** Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. */
4641
4829
  responseMimeType?: string;
4642
- /** Optional. The modalities of the response. */
4830
+ /** Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. */
4643
4831
  responseModalities?: Modality[];
4644
- /** 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. */
4832
+ /** Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. */
4645
4833
  responseSchema?: Schema;
4646
4834
  /** Optional. Routing configuration. This field is not supported in Gemini API. */
4647
4835
  routingConfig?: GenerationConfigRoutingConfig;
4648
- /** Optional. Seed. */
4836
+ /** Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. */
4649
4837
  seed?: number;
4650
4838
  /** Optional. The speech generation config. */
4651
4839
  speechConfig?: SpeechConfig;
4652
- /** Optional. Stop sequences. */
4840
+ /** Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. */
4653
4841
  stopSequences?: string[];
4654
- /** Optional. Controls the randomness of predictions. */
4842
+ /** Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. */
4655
4843
  temperature?: number;
4656
- /** Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. */
4844
+ /** Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. */
4657
4845
  thinkingConfig?: ThinkingConfig;
4658
- /** Optional. If specified, top-k sampling will be used. */
4846
+ /** Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. */
4659
4847
  topK?: number;
4660
- /** Optional. If specified, nucleus sampling will be used. */
4848
+ /** Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. */
4661
4849
  topP?: number;
4662
4850
  /** Optional. Enables enhanced civic answers. It may not be available for all models. This field is not supported in Vertex AI. */
4663
4851
  enableEnhancedCivicAnswers?: boolean;
@@ -4709,23 +4897,23 @@ declare interface GenerationConfig_2 {
4709
4897
  top_p?: number;
4710
4898
  }
4711
4899
 
4712
- /** The configuration for routing the request to a specific model. This data type is not supported in Gemini API. */
4900
+ /** The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. This data type is not supported in Gemini API. */
4713
4901
  export declare interface GenerationConfigRoutingConfig {
4714
- /** Automated routing. */
4902
+ /** In this mode, the model is selected automatically based on the content of the request. */
4715
4903
  autoMode?: GenerationConfigRoutingConfigAutoRoutingMode;
4716
- /** Manual routing. */
4904
+ /** In this mode, the model is specified manually. */
4717
4905
  manualMode?: GenerationConfigRoutingConfigManualRoutingMode;
4718
4906
  }
4719
4907
 
4720
- /** 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. */
4908
+ /** The configuration for automated routing. 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. */
4721
4909
  export declare interface GenerationConfigRoutingConfigAutoRoutingMode {
4722
4910
  /** The model routing preference. */
4723
4911
  modelRoutingPreference?: 'UNKNOWN' | 'PRIORITIZE_QUALITY' | 'BALANCED' | 'PRIORITIZE_COST';
4724
4912
  }
4725
4913
 
4726
- /** When manual routing is set, the specified model will be used directly. This data type is not supported in Gemini API. */
4914
+ /** The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. This data type is not supported in Gemini API. */
4727
4915
  export declare interface GenerationConfigRoutingConfigManualRoutingMode {
4728
- /** 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). */
4916
+ /** The name of the model to use. Only public LLM models are accepted. */
4729
4917
  modelName?: string;
4730
4918
  }
4731
4919
 
@@ -5022,11 +5210,11 @@ export declare interface GoogleGenAIOptions {
5022
5210
  httpOptions?: HttpOptions;
5023
5211
  }
5024
5212
 
5025
- /** Tool to retrieve public maps data for grounding, powered by Google. */
5213
+ /** Tool to retrieve knowledge from Google Maps. */
5026
5214
  export declare interface GoogleMaps {
5027
5215
  /** The authentication config to access the API. Only API key is supported. This field is not supported in Gemini API. */
5028
5216
  authConfig?: AuthConfig;
5029
- /** Optional. If true, include the widget context token in the response. */
5217
+ /** Optional. Whether to return a widget context token in the GroundingMetadata of the response. Developers can use the widget context token to render a Google Maps widget with geospatial context related to the places that the model references in the response. */
5030
5218
  enableWidget?: boolean;
5031
5219
  }
5032
5220
 
@@ -5044,10 +5232,10 @@ export declare interface GoogleRpcStatus {
5044
5232
  export declare interface GoogleSearch {
5045
5233
  /** Different types of search that can be enabled on the GoogleSearch tool. */
5046
5234
  searchTypes?: SearchTypes;
5047
- /** 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. */
5048
- excludeDomains?: string[];
5049
5235
  /** Optional. Sites with confidence level chosen & above this value will be blocked from the search results. This field is not supported in Gemini API. */
5050
5236
  blockingConfidence?: PhishBlockThreshold;
5237
+ /** 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. */
5238
+ excludeDomains?: string[];
5051
5239
  /** 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. */
5052
5240
  timeRangeFilter?: Interval;
5053
5241
  }
@@ -5117,7 +5305,7 @@ declare interface GoogleSearchResultContent {
5117
5305
  */
5118
5306
  is_error?: boolean;
5119
5307
  /**
5120
- * The signature of the Google Search result.
5308
+ * A signature hash for backend validation.
5121
5309
  */
5122
5310
  signature?: string;
5123
5311
  }
@@ -5148,11 +5336,15 @@ export declare interface GroundingChunk {
5148
5336
  message for details.
5149
5337
  */
5150
5338
  image?: GroundingChunkImage;
5151
- /** Grounding chunk from Google Maps. This field is not supported in Gemini API. */
5339
+ /** A `Maps` chunk is a piece of evidence that comes from Google Maps.
5340
+
5341
+ It contains information about a place, such as its name, address, and
5342
+ reviews. This is used to provide the user with rich, location-based
5343
+ information. */
5152
5344
  maps?: GroundingChunkMaps;
5153
- /** Grounding chunk from context retrieved by the retrieval tools. This field is not supported in Gemini API. */
5345
+ /** 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. */
5154
5346
  retrievedContext?: GroundingChunkRetrievedContext;
5155
- /** Grounding chunk from the web. */
5347
+ /** A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. */
5156
5348
  web?: GroundingChunkWeb;
5157
5349
  }
5158
5350
 
@@ -5172,29 +5364,42 @@ export declare interface GroundingChunkImage {
5172
5364
  domain?: string;
5173
5365
  }
5174
5366
 
5175
- /** Chunk from Google Maps. This data type is not supported in Gemini API. */
5367
+ /** A `Maps` chunk is a piece of evidence that comes from Google Maps.
5368
+
5369
+ It contains information about a place, such as its name, address, and reviews.
5370
+ This is used to provide the user with rich, location-based information. */
5176
5371
  export declare interface GroundingChunkMaps {
5177
- /** 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. */
5372
+ /** The sources that were used to generate the place answer.
5373
+
5374
+ This includes review snippets and photos that were used to generate the
5375
+ answer, as well as URIs to flag content. */
5178
5376
  placeAnswerSources?: GroundingChunkMapsPlaceAnswerSources;
5179
- /** This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. */
5377
+ /** This Place's resource name, in `places/{place_id}` format.
5378
+
5379
+ This can be used to look up the place in the Google Maps API. */
5180
5380
  placeId?: string;
5181
- /** Text of the place answer. */
5381
+ /** The text of the place answer. */
5182
5382
  text?: string;
5183
- /** Title of the place. */
5383
+ /** The title of the place. */
5184
5384
  title?: string;
5185
- /** URI reference of the place. */
5385
+ /** The URI of the place. */
5186
5386
  uri?: string;
5187
5387
  }
5188
5388
 
5189
- /** Sources used to generate the place answer. This data type is not supported in Gemini API. */
5389
+ /** The sources that were used to generate the place answer.
5390
+
5391
+ This includes review snippets and photos that were used to generate the
5392
+ answer, as well as URIs to flag content. */
5190
5393
  export declare interface GroundingChunkMapsPlaceAnswerSources {
5394
+ /** Snippets of reviews that were used to generate the answer. */
5395
+ reviewSnippet?: GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
5191
5396
  /** A link where users can flag a problem with the generated answer. */
5192
5397
  flagContentUri?: string;
5193
- /** Snippets of reviews that are used to generate the answer. */
5398
+ /** Snippets of reviews that were used to generate the answer. */
5194
5399
  reviewSnippets?: GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
5195
5400
  }
5196
5401
 
5197
- /** Author attribution for a photo or review. This data type is not supported in Gemini API. */
5402
+ /** Author attribution for a photo or review. */
5198
5403
  export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
5199
5404
  /** Name of the author of the Photo or Review. */
5200
5405
  displayName?: string;
@@ -5204,7 +5409,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
5204
5409
  uri?: string;
5205
5410
  }
5206
5411
 
5207
- /** Encapsulates a review snippet. This data type is not supported in Gemini API. */
5412
+ /** Encapsulates a review snippet. */
5208
5413
  export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
5209
5414
  /** This review's author. */
5210
5415
  authorAttribution?: GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution;
@@ -5222,30 +5427,31 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
5222
5427
  title?: string;
5223
5428
  }
5224
5429
 
5225
- /** Chunk from context retrieved by the retrieval tools. This data type is not supported in Gemini API. */
5430
+ /** 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. */
5226
5431
  export declare interface GroundingChunkRetrievedContext {
5227
- /** Output only. The full document name for the referenced Vertex AI Search document. */
5432
+ /** 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}`. */
5228
5433
  documentName?: string;
5229
- /** Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. */
5434
+ /** Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. */
5230
5435
  ragChunk?: RagChunk;
5231
- /** Text of the attribution. */
5436
+ /** The content of the retrieved data source. */
5232
5437
  text?: string;
5233
- /** Title of the attribution. */
5438
+ /** The title of the retrieved data source. */
5234
5439
  title?: string;
5235
- /** URI reference of the attribution. */
5440
+ /** The URI of the retrieved data source. */
5236
5441
  uri?: string;
5237
5442
  }
5238
5443
 
5239
- /** Chunk from the web. */
5444
+ /** 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. */
5240
5445
  export declare interface GroundingChunkWeb {
5241
- /** Domain of the (original) URI. This field is not supported in Gemini API. */
5446
+ /** The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. This field is not supported in Gemini API. */
5242
5447
  domain?: string;
5243
- /** Title of the chunk. */
5448
+ /** The title of the web page that contains the evidence. */
5244
5449
  title?: string;
5245
- /** URI reference of the chunk. */
5450
+ /** The URI of the web page that contains the evidence. */
5246
5451
  uri?: string;
5247
5452
  }
5248
5453
 
5454
+ /** Information for various kinds of grounding. */
5249
5455
  export declare interface GroundingMetadata {
5250
5456
  /** Optional. The image search queries that were used to generate the
5251
5457
  content. This field is populated only when the grounding source is Google
@@ -5257,41 +5463,48 @@ export declare interface GroundingMetadata {
5257
5463
  Search, Vertex AI Search, or Google Maps.
5258
5464
  */
5259
5465
  groundingChunks?: GroundingChunk[];
5260
- /** 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. */
5261
- googleMapsWidgetContextToken?: string;
5262
- /** Optional. List of grounding support. */
5466
+ /** List of grounding support. */
5263
5467
  groundingSupports?: GroundingSupport[];
5264
- /** Optional. Output only. Retrieval metadata. */
5468
+ /** Metadata related to retrieval in the grounding flow. */
5265
5469
  retrievalMetadata?: RetrievalMetadata;
5266
- /** Optional. Queries executed by the retrieval tools. This field is not supported in Gemini API. */
5267
- retrievalQueries?: string[];
5268
- /** Optional. Google search entry for the following-up web searches. */
5470
+ /** Optional. Google search entry for the following-up web
5471
+ searches. */
5269
5472
  searchEntryPoint?: SearchEntryPoint;
5270
- /** 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. */
5271
- sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
5272
- /** Optional. Web search queries for the following-up web search. */
5473
+ /** Web search queries for the following-up web search. */
5273
5474
  webSearchQueries?: string[];
5475
+ /** 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. */
5476
+ googleMapsWidgetContextToken?: string;
5477
+ /** 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. */
5478
+ retrievalQueries?: string[];
5479
+ /** Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. This field is not supported in Gemini API. */
5480
+ sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
5274
5481
  }
5275
5482
 
5276
- /** 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. */
5483
+ /** A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. This data type is not supported in Gemini API. */
5277
5484
  export declare interface GroundingMetadataSourceFlaggingUri {
5278
- /** A link where users can flag a problem with the source (place or review). */
5485
+ /** The URI that can be used to flag the content. */
5279
5486
  flagContentUri?: string;
5280
- /** Id of the place or review. */
5487
+ /** The ID of the place or review. */
5281
5488
  sourceId?: string;
5282
5489
  }
5283
5490
 
5284
5491
  /** Grounding support. */
5285
5492
  export declare interface GroundingSupport {
5286
- /** Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. */
5493
+ /** Confidence score of the support references.
5494
+
5495
+ Ranges from 0 to 1. 1 is the most confident. This list must have the
5496
+ same size as the grounding_chunk_indices. */
5287
5497
  confidenceScores?: number[];
5288
- /** A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. */
5498
+ /** A list of indices (into 'grounding_chunk') specifying the
5499
+ citations associated with the claim. For instance [1,3,4] means that
5500
+ grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the
5501
+ retrieved content attributed to the claim. */
5289
5502
  groundingChunkIndices?: number[];
5290
5503
  /** Segment of the content this support belongs to. */
5291
5504
  segment?: Segment;
5292
5505
  }
5293
5506
 
5294
- /** 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. */
5507
+ /** 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. */
5295
5508
  export declare enum HarmBlockMethod {
5296
5509
  /**
5297
5510
  * The harm block method is unspecified.
@@ -5307,54 +5520,54 @@ export declare enum HarmBlockMethod {
5307
5520
  PROBABILITY = "PROBABILITY"
5308
5521
  }
5309
5522
 
5310
- /** The harm block threshold. */
5523
+ /** The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. */
5311
5524
  export declare enum HarmBlockThreshold {
5312
5525
  /**
5313
- * Unspecified harm block threshold.
5526
+ * The harm block threshold is unspecified.
5314
5527
  */
5315
5528
  HARM_BLOCK_THRESHOLD_UNSPECIFIED = "HARM_BLOCK_THRESHOLD_UNSPECIFIED",
5316
5529
  /**
5317
- * Block low threshold and above (i.e. block more).
5530
+ * Block content with a low harm probability or higher.
5318
5531
  */
5319
5532
  BLOCK_LOW_AND_ABOVE = "BLOCK_LOW_AND_ABOVE",
5320
5533
  /**
5321
- * Block medium threshold and above.
5534
+ * Block content with a medium harm probability or higher.
5322
5535
  */
5323
5536
  BLOCK_MEDIUM_AND_ABOVE = "BLOCK_MEDIUM_AND_ABOVE",
5324
5537
  /**
5325
- * Block only high threshold (i.e. block less).
5538
+ * Block content with a high harm probability.
5326
5539
  */
5327
5540
  BLOCK_ONLY_HIGH = "BLOCK_ONLY_HIGH",
5328
5541
  /**
5329
- * Block none.
5542
+ * Do not block any content, regardless of its harm probability.
5330
5543
  */
5331
5544
  BLOCK_NONE = "BLOCK_NONE",
5332
5545
  /**
5333
- * Turn off the safety filter.
5546
+ * Turn off the safety filter entirely.
5334
5547
  */
5335
5548
  OFF = "OFF"
5336
5549
  }
5337
5550
 
5338
- /** Harm category. */
5551
+ /** The harm category to be blocked. */
5339
5552
  export declare enum HarmCategory {
5340
5553
  /**
5341
- * The harm category is unspecified.
5554
+ * Default value. This value is unused.
5342
5555
  */
5343
5556
  HARM_CATEGORY_UNSPECIFIED = "HARM_CATEGORY_UNSPECIFIED",
5344
5557
  /**
5345
- * The harm category is harassment.
5558
+ * Abusive, threatening, or content intended to bully, torment, or ridicule.
5346
5559
  */
5347
5560
  HARM_CATEGORY_HARASSMENT = "HARM_CATEGORY_HARASSMENT",
5348
5561
  /**
5349
- * The harm category is hate speech.
5562
+ * Content that promotes violence or incites hatred against individuals or groups based on certain attributes.
5350
5563
  */
5351
5564
  HARM_CATEGORY_HATE_SPEECH = "HARM_CATEGORY_HATE_SPEECH",
5352
5565
  /**
5353
- * The harm category is sexually explicit content.
5566
+ * Content that contains sexually explicit material.
5354
5567
  */
5355
5568
  HARM_CATEGORY_SEXUALLY_EXPLICIT = "HARM_CATEGORY_SEXUALLY_EXPLICIT",
5356
5569
  /**
5357
- * The harm category is dangerous content.
5570
+ * Content that promotes, facilitates, or enables dangerous activities.
5358
5571
  */
5359
5572
  HARM_CATEGORY_DANGEROUS_CONTENT = "HARM_CATEGORY_DANGEROUS_CONTENT",
5360
5573
  /**
@@ -5362,71 +5575,71 @@ export declare enum HarmCategory {
5362
5575
  */
5363
5576
  HARM_CATEGORY_CIVIC_INTEGRITY = "HARM_CATEGORY_CIVIC_INTEGRITY",
5364
5577
  /**
5365
- * The harm category is image hate. This enum value is not supported in Gemini API.
5578
+ * Images that contain hate speech. This enum value is not supported in Gemini API.
5366
5579
  */
5367
5580
  HARM_CATEGORY_IMAGE_HATE = "HARM_CATEGORY_IMAGE_HATE",
5368
5581
  /**
5369
- * The harm category is image dangerous content. This enum value is not supported in Gemini API.
5582
+ * Images that contain dangerous content. This enum value is not supported in Gemini API.
5370
5583
  */
5371
5584
  HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT = "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT",
5372
5585
  /**
5373
- * The harm category is image harassment. This enum value is not supported in Gemini API.
5586
+ * Images that contain harassment. This enum value is not supported in Gemini API.
5374
5587
  */
5375
5588
  HARM_CATEGORY_IMAGE_HARASSMENT = "HARM_CATEGORY_IMAGE_HARASSMENT",
5376
5589
  /**
5377
- * The harm category is image sexually explicit content. This enum value is not supported in Gemini API.
5590
+ * Images that contain sexually explicit content. This enum value is not supported in Gemini API.
5378
5591
  */
5379
5592
  HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT = "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT",
5380
5593
  /**
5381
- * The harm category is for jailbreak prompts. This enum value is not supported in Gemini API.
5594
+ * Prompts designed to bypass safety filters. This enum value is not supported in Gemini API.
5382
5595
  */
5383
5596
  HARM_CATEGORY_JAILBREAK = "HARM_CATEGORY_JAILBREAK"
5384
5597
  }
5385
5598
 
5386
- /** Output only. Harm probability levels in the content. */
5599
+ /** Output only. The probability of harm for this category. */
5387
5600
  export declare enum HarmProbability {
5388
5601
  /**
5389
- * Harm probability unspecified.
5602
+ * The harm probability is unspecified.
5390
5603
  */
5391
5604
  HARM_PROBABILITY_UNSPECIFIED = "HARM_PROBABILITY_UNSPECIFIED",
5392
5605
  /**
5393
- * Negligible level of harm.
5606
+ * The harm probability is negligible.
5394
5607
  */
5395
5608
  NEGLIGIBLE = "NEGLIGIBLE",
5396
5609
  /**
5397
- * Low level of harm.
5610
+ * The harm probability is low.
5398
5611
  */
5399
5612
  LOW = "LOW",
5400
5613
  /**
5401
- * Medium level of harm.
5614
+ * The harm probability is medium.
5402
5615
  */
5403
5616
  MEDIUM = "MEDIUM",
5404
5617
  /**
5405
- * High level of harm.
5618
+ * The harm probability is high.
5406
5619
  */
5407
5620
  HIGH = "HIGH"
5408
5621
  }
5409
5622
 
5410
- /** Output only. Harm severity levels in the content. This enum is not supported in Gemini API. */
5623
+ /** Output only. The severity of harm for this category. This enum is not supported in Gemini API. */
5411
5624
  export declare enum HarmSeverity {
5412
5625
  /**
5413
- * Harm severity unspecified.
5626
+ * The harm severity is unspecified.
5414
5627
  */
5415
5628
  HARM_SEVERITY_UNSPECIFIED = "HARM_SEVERITY_UNSPECIFIED",
5416
5629
  /**
5417
- * Negligible level of harm severity.
5630
+ * The harm severity is negligible.
5418
5631
  */
5419
5632
  HARM_SEVERITY_NEGLIGIBLE = "HARM_SEVERITY_NEGLIGIBLE",
5420
5633
  /**
5421
- * Low level of harm severity.
5634
+ * The harm severity is low.
5422
5635
  */
5423
5636
  HARM_SEVERITY_LOW = "HARM_SEVERITY_LOW",
5424
5637
  /**
5425
- * Medium level of harm severity.
5638
+ * The harm severity is medium.
5426
5639
  */
5427
5640
  HARM_SEVERITY_MEDIUM = "HARM_SEVERITY_MEDIUM",
5428
5641
  /**
5429
- * High level of harm severity.
5642
+ * The harm severity is high.
5430
5643
  */
5431
5644
  HARM_SEVERITY_HIGH = "HARM_SEVERITY_HIGH"
5432
5645
  }
@@ -5594,6 +5807,8 @@ export declare interface ImageConfig {
5594
5807
  /** Compression quality of the generated image (for
5595
5808
  ``image/jpeg`` only). This field is not supported in Gemini API. */
5596
5809
  outputCompressionQuality?: number;
5810
+ /** Optional. The image output format for generated images. */
5811
+ imageOutputOptions?: ImageConfigImageOutputOptions;
5597
5812
  }
5598
5813
 
5599
5814
  /**
@@ -5604,6 +5819,14 @@ declare interface ImageConfig_2 {
5604
5819
  image_size?: '1K' | '2K' | '4K' | '512';
5605
5820
  }
5606
5821
 
5822
+ /** The image output format for generated images. This data type is not supported in Gemini API. */
5823
+ export declare interface ImageConfigImageOutputOptions {
5824
+ /** Optional. The compression quality of the output image. */
5825
+ compressionQuality?: number;
5826
+ /** Optional. The image format that the output should be saved as. */
5827
+ mimeType?: string;
5828
+ }
5829
+
5607
5830
  /**
5608
5831
  * An image content block.
5609
5832
  */
@@ -5789,13 +6012,13 @@ declare interface Interaction {
5789
6012
  */
5790
6013
  agent?: (string & {}) | 'deep-research-pro-preview-12-2025';
5791
6014
  /**
5792
- * Configuration for the agent.
6015
+ * Configuration parameters for the agent interaction.
5793
6016
  */
5794
6017
  agent_config?: DynamicAgentConfig | DeepResearchAgentConfig;
5795
6018
  /**
5796
- * The inputs for the interaction.
6019
+ * The input for the interaction.
5797
6020
  */
5798
- input?: string | Array<Content_2> | Array<Turn> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent | ThoughtContent | FunctionCallContent | FunctionResultContent | CodeExecutionCallContent | CodeExecutionResultContent | URLContextCallContent | URLContextResultContent | GoogleSearchCallContent | GoogleSearchResultContent | MCPServerToolCallContent | MCPServerToolResultContent | FileSearchCallContent | FileSearchResultContent;
6021
+ input?: Array<Content_2> | string | Array<Turn> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent | ThoughtContent | FunctionCallContent | FunctionResultContent | CodeExecutionCallContent | CodeExecutionResultContent | URLContextCallContent | URLContextResultContent | GoogleSearchCallContent | GoogleSearchResultContent | MCPServerToolCallContent | MCPServerToolResultContent | FileSearchCallContent | FileSearchResultContent;
5799
6022
  /**
5800
6023
  * The name of the `Model` used for generating the interaction.
5801
6024
  */
@@ -6321,9 +6544,9 @@ export declare interface ListTuningJobsParameters {
6321
6544
  export declare class ListTuningJobsResponse {
6322
6545
  /** Used to retain the full HTTP response. */
6323
6546
  sdkHttpResponse?: HttpResponse;
6324
- /** A token to retrieve the next page of results. Pass to ListTuningJobsRequest.page_token to obtain that page. */
6547
+ /** A token to retrieve the next page of results. Pass this token in a subsequent [GenAiTuningService.ListTuningJobs] call to retrieve the next page of results. */
6325
6548
  nextPageToken?: string;
6326
- /** List of TuningJobs in the requested page. */
6549
+ /** The tuning jobs that match the request. */
6327
6550
  tuningJobs?: TuningJob[];
6328
6551
  }
6329
6552
 
@@ -7109,27 +7332,27 @@ declare type Logger = {
7109
7332
 
7110
7333
  declare type LogLevel = 'off' | 'error' | 'warn' | 'info' | 'debug';
7111
7334
 
7112
- /** Logprobs Result */
7335
+ /** The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. */
7113
7336
  export declare interface LogprobsResult {
7114
- /** Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. */
7337
+ /** A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. */
7115
7338
  chosenCandidates?: LogprobsResultCandidate[];
7116
- /** Length = total number of decoding steps. */
7339
+ /** 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. */
7117
7340
  topCandidates?: LogprobsResultTopCandidates[];
7118
7341
  }
7119
7342
 
7120
- /** Candidate for the logprobs token and score. */
7343
+ /** A single token and its associated log probability. */
7121
7344
  export declare interface LogprobsResultCandidate {
7122
- /** The candidate's log probability. */
7345
+ /** The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. */
7123
7346
  logProbability?: number;
7124
- /** The candidate's token string value. */
7347
+ /** The token's string representation. */
7125
7348
  token?: string;
7126
- /** The candidate's token id value. */
7349
+ /** The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. */
7127
7350
  tokenId?: number;
7128
7351
  }
7129
7352
 
7130
- /** Candidates with top log probabilities at each decoding step. */
7353
+ /** A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. */
7131
7354
  export declare interface LogprobsResultTopCandidates {
7132
- /** Sorted by log probability in descending order. */
7355
+ /** The list of candidate tokens, sorted by log probability in descending order. */
7133
7356
  candidates?: LogprobsResultCandidate[];
7134
7357
  }
7135
7358
 
@@ -7219,9 +7442,9 @@ declare interface MCPServerToolResultContent {
7219
7442
  */
7220
7443
  call_id: string;
7221
7444
  /**
7222
- * The result of the tool call.
7445
+ * The output from the MCP server call. Can be simple text or rich content.
7223
7446
  */
7224
- result: MCPServerToolResultContent.Items | unknown | string;
7447
+ result: unknown | Array<TextContent | ImageContent> | string;
7225
7448
  type: 'mcp_server_tool_result';
7226
7449
  /**
7227
7450
  * Name of the tool which is called for this specific tool call.
@@ -7231,12 +7454,10 @@ declare interface MCPServerToolResultContent {
7231
7454
  * The name of the used MCP server.
7232
7455
  */
7233
7456
  server_name?: string;
7234
- }
7235
-
7236
- declare namespace MCPServerToolResultContent {
7237
- interface Items {
7238
- items?: Array<InteractionsAPI.TextContent | InteractionsAPI.ImageContent>;
7239
- }
7457
+ /**
7458
+ * A signature hash for backend validation.
7459
+ */
7460
+ signature?: string;
7240
7461
  }
7241
7462
 
7242
7463
  /**
@@ -7331,7 +7552,7 @@ export declare enum Modality {
7331
7552
  export declare interface ModalityTokenCount {
7332
7553
  /** The modality associated with this token count. */
7333
7554
  modality?: MediaModality;
7334
- /** Number of tokens. */
7555
+ /** The number of tokens counted for this modality. */
7335
7556
  tokenCount?: number;
7336
7557
  }
7337
7558
 
@@ -7393,13 +7614,13 @@ export declare interface Model {
7393
7614
  /**
7394
7615
  * The model that will complete your prompt.\n\nSee [models](https://ai.google.dev/gemini-api/docs/models) for additional details.
7395
7616
  */
7396
- declare type Model_2 = 'gemini-2.5-flash' | 'gemini-2.5-flash-image' | 'gemini-2.5-flash-lite' | 'gemini-2.5-flash-lite-preview-09-2025' | 'gemini-2.5-flash-native-audio-preview-12-2025' | 'gemini-2.5-flash-preview-09-2025' | 'gemini-2.5-flash-preview-tts' | 'gemini-2.5-pro' | 'gemini-2.5-pro-preview-tts' | 'gemini-3-flash-preview' | 'gemini-3-pro-image-preview' | 'gemini-3-pro-preview' | 'gemini-3.1-pro-preview' | (string & {});
7617
+ declare type Model_2 = 'gemini-2.5-flash' | 'gemini-2.5-flash-image' | 'gemini-2.5-flash-lite' | 'gemini-2.5-flash-lite-preview-09-2025' | 'gemini-2.5-flash-native-audio-preview-12-2025' | 'gemini-2.5-flash-preview-09-2025' | 'gemini-2.5-flash-preview-tts' | 'gemini-2.5-pro' | 'gemini-2.5-pro-preview-tts' | 'gemini-3-flash-preview' | 'gemini-3-pro-image-preview' | 'gemini-3-pro-preview' | 'gemini-3.1-pro-preview' | 'gemini-3.1-flash-image-preview' | (string & {});
7397
7618
 
7398
- /** Configuration for Model Armor integrations of prompt and responses. This data type is not supported in Gemini API. */
7619
+ /** Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. This data type is not supported in Gemini API. */
7399
7620
  export declare interface ModelArmorConfig {
7400
- /** Optional. The name of the Model Armor template to use for prompt sanitization. */
7621
+ /** Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. */
7401
7622
  promptTemplateName?: string;
7402
- /** Optional. The name of the Model Armor template to use for response sanitization. */
7623
+ /** Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. */
7403
7624
  responseTemplateName?: string;
7404
7625
  }
7405
7626
 
@@ -7946,6 +8167,12 @@ export declare enum Outcome {
7946
8167
  OUTCOME_DEADLINE_EXCEEDED = "OUTCOME_DEADLINE_EXCEEDED"
7947
8168
  }
7948
8169
 
8170
+ /** Describes the info for output of EvaluationService. This data type is not supported in Gemini API. */
8171
+ export declare interface OutputInfo {
8172
+ /** Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. */
8173
+ gcsOutputDirectory?: string;
8174
+ }
8175
+
7949
8176
  /**
7950
8177
  * Some environments overload the global fetch function, and Parameters<T> only gets the last signature.
7951
8178
  */
@@ -8093,6 +8320,36 @@ export declare class Pager<T> implements AsyncIterable<T> {
8093
8320
  hasNextPage(): boolean;
8094
8321
  }
8095
8322
 
8323
+ /** Output only. Pairwise metric choice. This enum is not supported in Gemini API. */
8324
+ export declare enum PairwiseChoice {
8325
+ /**
8326
+ * Unspecified prediction choice.
8327
+ */
8328
+ PAIRWISE_CHOICE_UNSPECIFIED = "PAIRWISE_CHOICE_UNSPECIFIED",
8329
+ /**
8330
+ * Baseline prediction wins
8331
+ */
8332
+ BASELINE = "BASELINE",
8333
+ /**
8334
+ * Candidate prediction wins
8335
+ */
8336
+ CANDIDATE = "CANDIDATE",
8337
+ /**
8338
+ * Winner cannot be determined
8339
+ */
8340
+ TIE = "TIE"
8341
+ }
8342
+
8343
+ /** Spec for pairwise metric result. This data type is not supported in Gemini API. */
8344
+ export declare interface PairwiseMetricResult {
8345
+ /** Output only. Spec for custom output. */
8346
+ customOutput?: CustomOutput;
8347
+ /** Output only. Explanation for pairwise metric score. */
8348
+ explanation?: string;
8349
+ /** Output only. Pairwise metric choice. */
8350
+ pairwiseChoice?: PairwiseChoice;
8351
+ }
8352
+
8096
8353
  /** A datatype containing media content.
8097
8354
 
8098
8355
  Exactly one field within a Part should be set, representing the specific type
@@ -8102,21 +8359,21 @@ export declare interface Part {
8102
8359
  /** Media resolution for the input media.
8103
8360
  */
8104
8361
  mediaResolution?: PartMediaResolution;
8105
- /** Optional. Result of executing the [ExecutableCode]. */
8362
+ /** Optional. The result of executing the ExecutableCode. */
8106
8363
  codeExecutionResult?: CodeExecutionResult;
8107
- /** Optional. Code generated by the model that is meant to be executed. */
8364
+ /** Optional. Code generated by the model that is intended to be executed. */
8108
8365
  executableCode?: ExecutableCode;
8109
- /** Optional. URI based data. */
8366
+ /** Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. */
8110
8367
  fileData?: FileData;
8111
- /** Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. */
8368
+ /** Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. */
8112
8369
  functionCall?: FunctionCall;
8113
- /** 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. */
8370
+ /** Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. */
8114
8371
  functionResponse?: FunctionResponse;
8115
- /** Optional. Inlined bytes data. */
8372
+ /** Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. */
8116
8373
  inlineData?: Blob_2;
8117
- /** Optional. Text part (can be code). */
8374
+ /** Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. */
8118
8375
  text?: string;
8119
- /** Optional. Indicates if the part is thought from the model. */
8376
+ /** Optional. Indicates whether the `part` represents the model's thought process or reasoning. */
8120
8377
  thought?: boolean;
8121
8378
  /** Optional. An opaque signature for the thought so it can be reused in subsequent requests.
8122
8379
  * @remarks Encoded as base64 string. */
@@ -8127,16 +8384,16 @@ export declare interface Part {
8127
8384
 
8128
8385
  /** Partial argument value of the function call. This data type is not supported in Gemini API. */
8129
8386
  export declare interface PartialArg {
8387
+ /** Optional. Represents a boolean value. */
8388
+ boolValue?: boolean;
8389
+ /** Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". */
8390
+ jsonPath?: string;
8130
8391
  /** Optional. Represents a null value. */
8131
8392
  nullValue?: 'NULL_VALUE';
8132
8393
  /** Optional. Represents a double value. */
8133
8394
  numberValue?: number;
8134
8395
  /** Optional. Represents a string value. */
8135
8396
  stringValue?: string;
8136
- /** Optional. Represents a boolean value. */
8137
- boolValue?: boolean;
8138
- /** Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". */
8139
- jsonPath?: string;
8140
8397
  /** Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. */
8141
8398
  willContinue?: boolean;
8142
8399
  }
@@ -8240,14 +8497,28 @@ export declare enum PhishBlockThreshold {
8240
8497
  BLOCK_ONLY_EXTREMELY_HIGH = "BLOCK_ONLY_EXTREMELY_HIGH"
8241
8498
  }
8242
8499
 
8243
- /** The configuration for the prebuilt speaker to use. */
8500
+ /** Spec for pointwise metric result. This data type is not supported in Gemini API. */
8501
+ export declare interface PointwiseMetricResult {
8502
+ /** Output only. Spec for custom output. */
8503
+ customOutput?: CustomOutput;
8504
+ /** Output only. Explanation for pointwise metric score. */
8505
+ explanation?: string;
8506
+ /** Output only. Pointwise metric score. */
8507
+ score?: number;
8508
+ }
8509
+
8510
+ /** Configuration for a prebuilt voice. */
8244
8511
  export declare interface PrebuiltVoiceConfig {
8245
- /** The name of the preset voice to use. */
8512
+ /** The name of the prebuilt voice to use. */
8246
8513
  voiceName?: string;
8247
8514
  }
8248
8515
 
8249
8516
  /** Statistics computed for datasets used for preference optimization. This data type is not supported in Gemini API. */
8250
8517
  export declare interface PreferenceOptimizationDataStats {
8518
+ /** Output only. A partial sample of the indices (starting from 1) of the dropped examples. */
8519
+ droppedExampleIndices?: string[];
8520
+ /** Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. */
8521
+ droppedExampleReasons?: string[];
8251
8522
  /** Output only. Dataset distributions for scores variance per example. */
8252
8523
  scoreVariancePerExampleDistribution?: DatasetDistribution;
8253
8524
  /** Output only. Dataset distributions for scores. */
@@ -8404,6 +8675,12 @@ export declare interface RagRetrievalConfigRankingRankService {
8404
8675
  declare class RateLimitError extends APIError<429, Headers> {
8405
8676
  }
8406
8677
 
8678
+ /** Raw output. This data type is not supported in Gemini API. */
8679
+ export declare interface RawOutput {
8680
+ /** Output only. Raw output string. */
8681
+ rawOutput?: string[];
8682
+ }
8683
+
8407
8684
  /** A raw reference image.
8408
8685
 
8409
8686
  A raw reference image represents the base image to edit, provided by the user.
@@ -8705,12 +8982,23 @@ export declare interface RetrievalConfig {
8705
8982
  languageCode?: string;
8706
8983
  }
8707
8984
 
8708
- /** Metadata related to retrieval in the grounding flow. */
8985
+ /** Metadata returned to client when grounding is enabled. */
8709
8986
  export declare interface RetrievalMetadata {
8710
- /** Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. */
8987
+ /** Optional. Score indicating how likely information from google
8988
+ search could help answer the prompt. The score is in the range [0, 1],
8989
+ where 0 is the least likely and 1 is the most likely. This score is only
8990
+ populated when google search grounding and dynamic retrieval is enabled.
8991
+ It will be compared to the threshold to determine whether to trigger
8992
+ Google search. */
8711
8993
  googleSearchDynamicRetrievalScore?: number;
8712
8994
  }
8713
8995
 
8996
+ /** Rouge metric value for an instance. This data type is not supported in Gemini API. */
8997
+ export declare interface RougeMetricValue {
8998
+ /** Output only. Rouge score. */
8999
+ score?: number;
9000
+ }
9001
+
8714
9002
  /** Safety attributes of a GeneratedImage or the user-provided prompt. */
8715
9003
  export declare interface SafetyAttributes {
8716
9004
  /** List of RAI categories. */
@@ -8729,31 +9017,31 @@ export declare enum SafetyFilterLevel {
8729
9017
  BLOCK_NONE = "BLOCK_NONE"
8730
9018
  }
8731
9019
 
8732
- /** Safety rating corresponding to the generated content. */
9020
+ /** A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. */
8733
9021
  export declare interface SafetyRating {
8734
- /** Output only. Indicates whether the content was filtered out because of this rating. */
9022
+ /** Output only. Indicates whether the content was blocked because of this rating. */
8735
9023
  blocked?: boolean;
8736
- /** Output only. Harm category. */
9024
+ /** Output only. The harm category of this rating. */
8737
9025
  category?: HarmCategory;
8738
9026
  /** 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. */
8739
9027
  overwrittenThreshold?: HarmBlockThreshold;
8740
- /** Output only. Harm probability levels in the content. */
9028
+ /** Output only. The probability of harm for this category. */
8741
9029
  probability?: HarmProbability;
8742
- /** Output only. Harm probability score. This field is not supported in Gemini API. */
9030
+ /** Output only. The probability score of harm for this category. This field is not supported in Gemini API. */
8743
9031
  probabilityScore?: number;
8744
- /** Output only. Harm severity levels in the content. This field is not supported in Gemini API. */
9032
+ /** Output only. The severity of harm for this category. This field is not supported in Gemini API. */
8745
9033
  severity?: HarmSeverity;
8746
- /** Output only. Harm severity score. This field is not supported in Gemini API. */
9034
+ /** Output only. The severity score of harm for this category. This field is not supported in Gemini API. */
8747
9035
  severityScore?: number;
8748
9036
  }
8749
9037
 
8750
- /** Safety settings. */
9038
+ /** A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. */
8751
9039
  export declare interface SafetySetting {
8752
- /** Required. Harm category. */
9040
+ /** Required. The harm category to be blocked. */
8753
9041
  category?: HarmCategory;
8754
- /** 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. */
9042
+ /** Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. This field is not supported in Gemini API. */
8755
9043
  method?: HarmBlockMethod;
8756
- /** Required. The harm block threshold. */
9044
+ /** Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. */
8757
9045
  threshold?: HarmBlockThreshold;
8758
9046
  }
8759
9047
 
@@ -8819,49 +9107,49 @@ export declare enum Scale {
8819
9107
  object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may
8820
9108
  be added in the future as needed. */
8821
9109
  export declare interface Schema {
8822
- /** Optional. The value should be validated against any (one or more) of the subschemas in the list. */
9110
+ /** Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. */
8823
9111
  anyOf?: Schema[];
8824
- /** Optional. Default value of the data. */
9112
+ /** Optional. Default value to use if the field is not specified. */
8825
9113
  default?: unknown;
8826
- /** Optional. The description of the data. */
9114
+ /** Optional. Description of the schema. */
8827
9115
  description?: string;
8828
- /** Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} */
9116
+ /** 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"]}` */
8829
9117
  enum?: string[];
8830
- /** Optional. Example of the object. Will only populated when the object is the root. */
9118
+ /** Optional. Example of an instance of this schema. */
8831
9119
  example?: unknown;
8832
- /** Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc */
9120
+ /** Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. */
8833
9121
  format?: string;
8834
- /** Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. */
9122
+ /** Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. */
8835
9123
  items?: Schema;
8836
- /** Optional. Maximum number of the elements for Type.ARRAY. */
9124
+ /** Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. */
8837
9125
  maxItems?: string;
8838
- /** Optional. Maximum length of the Type.STRING */
9126
+ /** Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. */
8839
9127
  maxLength?: string;
8840
- /** Optional. Maximum number of the properties for Type.OBJECT. */
9128
+ /** Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. */
8841
9129
  maxProperties?: string;
8842
- /** Optional. Maximum value of the Type.INTEGER and Type.NUMBER */
9130
+ /** Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. */
8843
9131
  maximum?: number;
8844
- /** Optional. Minimum number of the elements for Type.ARRAY. */
9132
+ /** Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. */
8845
9133
  minItems?: string;
8846
- /** Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING */
9134
+ /** Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. */
8847
9135
  minLength?: string;
8848
- /** Optional. Minimum number of the properties for Type.OBJECT. */
9136
+ /** Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. */
8849
9137
  minProperties?: string;
8850
- /** Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER */
9138
+ /** Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. */
8851
9139
  minimum?: number;
8852
- /** Optional. Indicates if the value may be null. */
9140
+ /** Optional. Indicates if the value of this field can be null. */
8853
9141
  nullable?: boolean;
8854
- /** Optional. Pattern of the Type.STRING to restrict a string to a regular expression. */
9142
+ /** Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. */
8855
9143
  pattern?: string;
8856
- /** Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. */
9144
+ /** Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. */
8857
9145
  properties?: Record<string, Schema>;
8858
- /** Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. */
9146
+ /** Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. */
8859
9147
  propertyOrdering?: string[];
8860
- /** Optional. Required properties of Type.OBJECT. */
9148
+ /** Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. */
8861
9149
  required?: string[];
8862
- /** Optional. The title of the Schema. */
9150
+ /** Optional. Title for the schema. */
8863
9151
  title?: string;
8864
- /** Optional. The type of the data. */
9152
+ /** Optional. Data type of the schema field. */
8865
9153
  type?: Type;
8866
9154
  }
8867
9155
 
@@ -8873,11 +9161,12 @@ export declare interface ScribbleImage {
8873
9161
  image?: Image_2;
8874
9162
  }
8875
9163
 
8876
- /** Google search entry point. */
9164
+ /** The entry point used to search for grounding sources. */
8877
9165
  export declare interface SearchEntryPoint {
8878
- /** Optional. Web content snippet that can be embedded in a web page or an app webview. */
9166
+ /** Optional. Web content snippet that can be embedded in a web page
9167
+ or an app webview. */
8879
9168
  renderedContent?: string;
8880
- /** Optional. Base64 encoded JSON representing array of tuple.
9169
+ /** Optional. JSON representing array of tuples.
8881
9170
  * @remarks Encoded as base64 string. */
8882
9171
  sdkBlob?: string;
8883
9172
  }
@@ -8891,15 +9180,21 @@ export declare interface SearchTypes {
8891
9180
  imageSearch?: ImageSearch;
8892
9181
  }
8893
9182
 
8894
- /** Segment of the content. */
9183
+ /** Segment of the content this support belongs to. */
8895
9184
  export declare interface Segment {
8896
- /** Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. */
9185
+ /** Output only. Start index in the given Part, measured in bytes.
9186
+
9187
+ Offset from the start of the Part, inclusive, starting at zero. */
9188
+ startIndex?: number;
9189
+ /** Output only. End index in the given Part, measured in bytes.
9190
+
9191
+ Offset from the start of the Part, exclusive, starting at zero. */
8897
9192
  endIndex?: number;
8898
- /** Output only. The index of a Part object within its parent Content object. */
9193
+ /** Output only. The index of a Part object within its parent
9194
+ Content object. */
8899
9195
  partIndex?: number;
8900
- /** Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. */
8901
- startIndex?: number;
8902
- /** Output only. The text corresponding to the segment from the response. */
9196
+ /** Output only. The text corresponding to the segment from the
9197
+ response. */
8903
9198
  text?: string;
8904
9199
  }
8905
9200
 
@@ -9175,7 +9470,7 @@ export declare interface SlidingWindow {
9175
9470
  targetTokens?: string;
9176
9471
  }
9177
9472
 
9178
- /** Configuration for a single speaker in a multi speaker setup. */
9473
+ /** Configuration for a single speaker in a multi-speaker setup. */
9179
9474
  export declare interface SpeakerVoiceConfig {
9180
9475
  /** Required. The name of the speaker. This should be the same as the speaker name used in the prompt. */
9181
9476
  speaker?: string;
@@ -9186,7 +9481,7 @@ export declare interface SpeakerVoiceConfig {
9186
9481
  export declare interface SpeechConfig {
9187
9482
  /** Configuration for the voice of the response. */
9188
9483
  voiceConfig?: VoiceConfig;
9189
- /** Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. */
9484
+ /** Optional. The language code (ISO 639-1) for the speech synthesis. */
9190
9485
  languageCode?: string;
9191
9486
  /** The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. */
9192
9487
  multiSpeakerVoiceConfig?: MultiSpeakerVoiceConfig;
@@ -9628,16 +9923,19 @@ export declare interface Tool {
9628
9923
  fileSearch?: FileSearch;
9629
9924
  /** Enables the model to execute Google Search as part of generation. */
9630
9925
  googleSearch?: GoogleSearch;
9926
+ /** Optional. Tool that allows grounding the model's response with
9927
+ geospatial context related to the user's query. */
9928
+ googleMaps?: GoogleMaps;
9631
9929
  /** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
9632
9930
  codeExecution?: ToolCodeExecution;
9633
9931
  /** Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. This field is not supported in Gemini API. */
9634
9932
  enterpriseWebSearch?: EnterpriseWebSearch;
9635
9933
  /** Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. */
9636
9934
  functionDeclarations?: FunctionDeclaration[];
9637
- /** Optional. GoogleMaps tool type. Tool to support Google Maps in Model. */
9638
- googleMaps?: GoogleMaps;
9639
9935
  /** Optional. Specialized retrieval tool that is powered by Google Search. */
9640
9936
  googleSearchRetrieval?: GoogleSearchRetrieval;
9937
+ /** Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation. This field is not supported in Gemini API. */
9938
+ parallelAiSearch?: ToolParallelAiSearch;
9641
9939
  /** Optional. Tool to support URL context retrieval. */
9642
9940
  urlContext?: UrlContext;
9643
9941
  /** Optional. MCP Servers to connect to. This field is not supported in Vertex AI. */
@@ -9647,19 +9945,9 @@ export declare interface Tool {
9647
9945
  /**
9648
9946
  * A tool that can be used by the model.
9649
9947
  */
9650
- declare type Tool_2 = Function_2 | Tool_2.GoogleSearch | Tool_2.CodeExecution | Tool_2.URLContext | Tool_2.ComputerUse | Tool_2.MCPServer | Tool_2.FileSearch;
9948
+ declare type Tool_2 = Function_2 | Tool_2.CodeExecution | Tool_2.URLContext | Tool_2.ComputerUse | Tool_2.MCPServer | Tool_2.GoogleSearch | Tool_2.FileSearch;
9651
9949
 
9652
9950
  declare namespace Tool_2 {
9653
- /**
9654
- * A tool that can be used by the model to search Google.
9655
- */
9656
- interface GoogleSearch {
9657
- type: 'google_search';
9658
- /**
9659
- * The types of search grounding to enable.
9660
- */
9661
- search_types?: Array<'web_search' | 'image_search'>;
9662
- }
9663
9951
  /**
9664
9952
  * A tool that can be used by the model to execute code.
9665
9953
  */
@@ -9711,6 +9999,16 @@ declare namespace Tool_2 {
9711
9999
  */
9712
10000
  url?: string;
9713
10001
  }
10002
+ /**
10003
+ * A tool that can be used by the model to search Google.
10004
+ */
10005
+ interface GoogleSearch {
10006
+ type: 'google_search';
10007
+ /**
10008
+ * The types of search grounding to enable.
10009
+ */
10010
+ search_types?: Array<'web_search' | 'image_search'>;
10011
+ }
9714
10012
  /**
9715
10013
  * A tool that can be used by the model to search files.
9716
10014
  */
@@ -9759,6 +10057,14 @@ export declare interface ToolConfig {
9759
10057
 
9760
10058
  export declare type ToolListUnion = ToolUnion[];
9761
10059
 
10060
+ /** ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. This data type is not supported in Gemini API. */
10061
+ export declare interface ToolParallelAiSearch {
10062
+ /** Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. */
10063
+ apiKey?: string;
10064
+ /** Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } */
10065
+ customConfigs?: Record<string, unknown>;
10066
+ }
10067
+
9762
10068
  export declare type ToolUnion = Tool | CallableTool;
9763
10069
 
9764
10070
  /** Output only. The traffic type for this request. This enum is not supported in Gemini API. */
@@ -9771,6 +10077,14 @@ export declare enum TrafficType {
9771
10077
  * The request was processed using Pay-As-You-Go quota.
9772
10078
  */
9773
10079
  ON_DEMAND = "ON_DEMAND",
10080
+ /**
10081
+ * Type for Priority Pay-As-You-Go traffic.
10082
+ */
10083
+ ON_DEMAND_PRIORITY = "ON_DEMAND_PRIORITY",
10084
+ /**
10085
+ * Type for Flex traffic.
10086
+ */
10087
+ ON_DEMAND_FLEX = "ON_DEMAND_FLEX",
9774
10088
  /**
9775
10089
  * Type for Provisioned Throughput traffic.
9776
10090
  */
@@ -9845,7 +10159,7 @@ export declare interface TuningDataset {
9845
10159
 
9846
10160
  /** The tuning data statistic values for TuningJob. This data type is not supported in Gemini API. */
9847
10161
  export declare interface TuningDataStats {
9848
- /** Output only. Statistics for distillation. */
10162
+ /** Output only. Statistics for distillation prompt dataset. These statistics do not include the responses sampled from the teacher model. */
9849
10163
  distillationDataStats?: DistillationDataStats;
9850
10164
  /** Output only. Statistics for preference optimization. */
9851
10165
  preferenceOptimizationDataStats?: PreferenceOptimizationDataStats;
@@ -9901,8 +10215,12 @@ export declare interface TuningJob {
9901
10215
  partnerModelTuningSpec?: PartnerModelTuningSpec;
9902
10216
  /** Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models. */
9903
10217
  customBaseModel?: string;
10218
+ /** Output only. Evaluation runs for the Tuning Job. */
10219
+ evaluateDatasetRuns?: EvaluateDatasetRun[];
9904
10220
  /** Output only. The Experiment associated with this TuningJob. */
9905
10221
  experiment?: string;
10222
+ /** Tuning Spec for Full Fine Tuning. */
10223
+ fullFineTuningSpec?: FullFineTuningSpec;
9906
10224
  /** 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. */
9907
10225
  labels?: Record<string, string>;
9908
10226
  /** Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models. */
@@ -9913,10 +10231,40 @@ export declare interface TuningJob {
9913
10231
  serviceAccount?: string;
9914
10232
  /** Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. */
9915
10233
  tunedModelDisplayName?: string;
10234
+ /** Output only. The detail state of the tuning job (while the overall `JobState` is running). */
10235
+ tuningJobState?: TuningJobState;
9916
10236
  /** Tuning Spec for Veo Tuning. */
9917
10237
  veoTuningSpec?: VeoTuningSpec;
9918
10238
  }
9919
10239
 
10240
+ /** Output only. The detail state of the tuning job (while the overall `JobState` is running). This enum is not supported in Gemini API. */
10241
+ export declare enum TuningJobState {
10242
+ /**
10243
+ * Default tuning job state.
10244
+ */
10245
+ TUNING_JOB_STATE_UNSPECIFIED = "TUNING_JOB_STATE_UNSPECIFIED",
10246
+ /**
10247
+ * Tuning job is waiting for job quota.
10248
+ */
10249
+ TUNING_JOB_STATE_WAITING_FOR_QUOTA = "TUNING_JOB_STATE_WAITING_FOR_QUOTA",
10250
+ /**
10251
+ * Tuning job is validating the dataset.
10252
+ */
10253
+ TUNING_JOB_STATE_PROCESSING_DATASET = "TUNING_JOB_STATE_PROCESSING_DATASET",
10254
+ /**
10255
+ * Tuning job is waiting for hardware capacity.
10256
+ */
10257
+ TUNING_JOB_STATE_WAITING_FOR_CAPACITY = "TUNING_JOB_STATE_WAITING_FOR_CAPACITY",
10258
+ /**
10259
+ * Tuning job is running.
10260
+ */
10261
+ TUNING_JOB_STATE_TUNING = "TUNING_JOB_STATE_TUNING",
10262
+ /**
10263
+ * Tuning job is doing some post processing steps.
10264
+ */
10265
+ TUNING_JOB_STATE_POST_PROCESSING = "TUNING_JOB_STATE_POST_PROCESSING"
10266
+ }
10267
+
9920
10268
  /** Enum representing the tuning method. */
9921
10269
  export declare enum TuningMethod {
9922
10270
  /**
@@ -10094,7 +10442,7 @@ export declare enum TurnCoverage {
10094
10442
  TURN_INCLUDES_ALL_INPUT = "TURN_INCLUDES_ALL_INPUT"
10095
10443
  }
10096
10444
 
10097
- /** The type of the data. */
10445
+ /** Data type of the schema field. */
10098
10446
  export declare enum Type {
10099
10447
  /**
10100
10448
  * Not specified, should not be used.
@@ -10148,13 +10496,14 @@ declare namespace types {
10148
10496
  FunctionResponseScheduling,
10149
10497
  Type,
10150
10498
  PhishBlockThreshold,
10151
- ApiSpec,
10152
10499
  AuthType,
10153
10500
  HttpElementLocation,
10501
+ ApiSpec,
10154
10502
  Behavior,
10155
10503
  DynamicRetrievalConfigMode,
10156
10504
  FunctionCallingConfigMode,
10157
10505
  ThinkingLevel,
10506
+ PersonGeneration,
10158
10507
  HarmCategory,
10159
10508
  HarmBlockMethod,
10160
10509
  HarmBlockThreshold,
@@ -10169,6 +10518,9 @@ declare namespace types {
10169
10518
  TuningMode,
10170
10519
  AdapterSize,
10171
10520
  JobState,
10521
+ TuningJobState,
10522
+ AggregationMetric,
10523
+ PairwiseChoice,
10172
10524
  TuningTask,
10173
10525
  PartMediaResolutionLevel,
10174
10526
  ResourceScope,
@@ -10177,7 +10529,6 @@ declare namespace types {
10177
10529
  ProminentPeople,
10178
10530
  EmbeddingApiType,
10179
10531
  SafetyFilterLevel,
10180
- PersonGeneration,
10181
10532
  ImagePromptLanguage,
10182
10533
  MaskReferenceMode,
10183
10534
  ControlReferenceType,
@@ -10227,14 +10578,15 @@ declare namespace types {
10227
10578
  SearchTypes,
10228
10579
  Interval,
10229
10580
  GoogleSearch,
10230
- ApiAuthApiKeyConfig,
10231
- ApiAuth,
10232
10581
  ApiKeyConfig,
10233
10582
  AuthConfigGoogleServiceAccountConfig,
10234
10583
  AuthConfigHttpBasicAuthConfig,
10235
10584
  AuthConfigOauthConfig,
10236
10585
  AuthConfigOidcConfig,
10237
10586
  AuthConfig,
10587
+ GoogleMaps,
10588
+ ApiAuthApiKeyConfig,
10589
+ ApiAuth,
10238
10590
  ExternalApiElasticSearchParams,
10239
10591
  ExternalApiSimpleSearchParams,
10240
10592
  ExternalApi,
@@ -10252,9 +10604,9 @@ declare namespace types {
10252
10604
  ToolCodeExecution,
10253
10605
  EnterpriseWebSearch,
10254
10606
  FunctionDeclaration,
10255
- GoogleMaps,
10256
10607
  DynamicRetrievalConfig,
10257
10608
  GoogleSearchRetrieval,
10609
+ ToolParallelAiSearch,
10258
10610
  UrlContext,
10259
10611
  StreamableHttpTransport,
10260
10612
  McpServer,
@@ -10271,6 +10623,7 @@ declare namespace types {
10271
10623
  SpeechConfig,
10272
10624
  AutomaticFunctionCallingConfig,
10273
10625
  ThinkingConfig,
10626
+ ImageConfigImageOutputOptions,
10274
10627
  ImageConfig,
10275
10628
  GenerationConfigRoutingConfigAutoRoutingMode,
10276
10629
  GenerationConfigRoutingConfigManualRoutingMode,
@@ -10401,6 +10754,23 @@ declare namespace types {
10401
10754
  TuningDataStats,
10402
10755
  EncryptionSpec,
10403
10756
  PartnerModelTuningSpec,
10757
+ BleuMetricValue,
10758
+ CustomCodeExecutionResult,
10759
+ ExactMatchMetricValue,
10760
+ RawOutput,
10761
+ CustomOutput,
10762
+ PairwiseMetricResult,
10763
+ PointwiseMetricResult,
10764
+ RougeMetricValue,
10765
+ AggregationResult,
10766
+ BigQuerySource,
10767
+ GcsSource,
10768
+ EvaluationDataset,
10769
+ AggregationOutput,
10770
+ OutputInfo,
10771
+ EvaluateDatasetResponse,
10772
+ EvaluateDatasetRun,
10773
+ FullFineTuningSpec,
10404
10774
  VeoHyperParameters,
10405
10775
  VeoTuningSpec,
10406
10776
  TuningJob,
@@ -10906,9 +11276,9 @@ declare interface URLContextCallContent {
10906
11276
  type: 'url_context_call';
10907
11277
  }
10908
11278
 
10909
- /** Metadata related to url context retrieval tool. */
11279
+ /** Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */
10910
11280
  export declare interface UrlContextMetadata {
10911
- /** Output only. List of url context. */
11281
+ /** Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. */
10912
11282
  urlMetadata?: UrlMetadata[];
10913
11283
  }
10914
11284
 
@@ -10944,31 +11314,31 @@ declare interface URLContextResultContent {
10944
11314
  */
10945
11315
  is_error?: boolean;
10946
11316
  /**
10947
- * The signature of the URL context result.
11317
+ * A signature hash for backend validation.
10948
11318
  */
10949
11319
  signature?: string;
10950
11320
  }
10951
11321
 
10952
- /** Context of the a single url retrieval. */
11322
+ /** The metadata for a single URL retrieval. */
10953
11323
  export declare interface UrlMetadata {
10954
- /** Retrieved url by the tool. */
11324
+ /** The URL retrieved by the tool. */
10955
11325
  retrievedUrl?: string;
10956
- /** Status of the url retrieval. */
11326
+ /** The status of the URL retrieval. */
10957
11327
  urlRetrievalStatus?: UrlRetrievalStatus;
10958
11328
  }
10959
11329
 
10960
- /** Status of the url retrieval. */
11330
+ /** The status of the URL retrieval. */
10961
11331
  export declare enum UrlRetrievalStatus {
10962
11332
  /**
10963
11333
  * Default value. This value is unused.
10964
11334
  */
10965
11335
  URL_RETRIEVAL_STATUS_UNSPECIFIED = "URL_RETRIEVAL_STATUS_UNSPECIFIED",
10966
11336
  /**
10967
- * Url retrieval is successful.
11337
+ * The URL was retrieved successfully.
10968
11338
  */
10969
11339
  URL_RETRIEVAL_STATUS_SUCCESS = "URL_RETRIEVAL_STATUS_SUCCESS",
10970
11340
  /**
10971
- * Url retrieval is failed due to error.
11341
+ * The URL retrieval failed.
10972
11342
  */
10973
11343
  URL_RETRIEVAL_STATUS_ERROR = "URL_RETRIEVAL_STATUS_ERROR",
10974
11344
  /**
@@ -11134,6 +11504,8 @@ export declare interface VeoHyperParameters {
11134
11504
  learningRateMultiplier?: number;
11135
11505
  /** Optional. The tuning task. Either I2V or T2V. */
11136
11506
  tuningTask?: TuningTask;
11507
+ /** Optional. The ratio of Google internal dataset to use in the training mixture, in range of `[0, 1)`. If `0.2`, it means 20% of Google internal dataset and 80% of user dataset will be used for training. If not set, the default value is 0.1. */
11508
+ veoDataMixtureRatio?: number;
11137
11509
  }
11138
11510
 
11139
11511
  /** Tuning Spec for Veo Model Tuning. This data type is not supported in Gemini API. */
@@ -11301,11 +11673,11 @@ export declare enum VideoGenerationReferenceType {
11301
11673
  STYLE = "STYLE"
11302
11674
  }
11303
11675
 
11304
- /** Metadata describes the input video content. */
11676
+ /** Provides metadata for a video, including the start and end offsets for clipping and the frame rate. */
11305
11677
  export declare interface VideoMetadata {
11306
11678
  /** Optional. The end offset of the video. */
11307
11679
  endOffset?: string;
11308
- /** 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]. */
11680
+ /** Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. */
11309
11681
  fps?: number;
11310
11682
  /** Optional. The start offset of the video. */
11311
11683
  startOffset?: string;
@@ -11341,7 +11713,7 @@ export declare enum VoiceActivityType {
11341
11713
  export declare interface VoiceConfig {
11342
11714
  /** If true, the model will use a replicated voice for the response. */
11343
11715
  replicatedVoiceConfig?: ReplicatedVoiceConfig;
11344
- /** The configuration for the prebuilt voice to use. */
11716
+ /** The configuration for a prebuilt voice. */
11345
11717
  prebuiltVoiceConfig?: PrebuiltVoiceConfig;
11346
11718
  }
11347
11719