@google/genai 1.43.0 → 1.44.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 +643 -221
- package/dist/index.cjs +482 -343
- package/dist/index.mjs +482 -344
- package/dist/index.mjs.map +1 -1
- package/dist/node/index.cjs +483 -344
- package/dist/node/index.mjs +483 -345
- package/dist/node/index.mjs.map +1 -1
- package/dist/node/node.d.ts +643 -221
- package/dist/tokenizer/node.cjs +171 -67
- package/dist/tokenizer/node.d.ts +96 -83
- package/dist/tokenizer/node.mjs +171 -67
- package/dist/tokenizer/node.mjs.map +1 -1
- package/dist/web/index.mjs +482 -344
- package/dist/web/index.mjs.map +1 -1
- package/dist/web/web.d.ts +643 -221
- package/package.json +5 -1
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;
|
|
@@ -440,8 +517,10 @@ declare interface Auth {
|
|
|
440
517
|
addAuthHeaders(headers: Headers, url?: string): Promise<void>;
|
|
441
518
|
}
|
|
442
519
|
|
|
443
|
-
/**
|
|
520
|
+
/** The authentication config to access the API. */
|
|
444
521
|
export declare interface AuthConfig {
|
|
522
|
+
/** The authentication config to access the API. Only API key is supported. This field is not supported in Gemini API. */
|
|
523
|
+
apiKey?: string;
|
|
445
524
|
/** Config for API key auth. */
|
|
446
525
|
apiKeyConfig?: ApiKeyConfig;
|
|
447
526
|
/** Type of auth scheme. */
|
|
@@ -1057,12 +1136,24 @@ export declare enum Behavior {
|
|
|
1057
1136
|
NON_BLOCKING = "NON_BLOCKING"
|
|
1058
1137
|
}
|
|
1059
1138
|
|
|
1060
|
-
/**
|
|
1139
|
+
/** The BigQuery location for the input content. This data type is not supported in Gemini API. */
|
|
1140
|
+
export declare interface BigQuerySource {
|
|
1141
|
+
/** Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. */
|
|
1142
|
+
inputUri?: string;
|
|
1143
|
+
}
|
|
1144
|
+
|
|
1145
|
+
/** Bleu metric value for an instance. This data type is not supported in Gemini API. */
|
|
1146
|
+
export declare interface BleuMetricValue {
|
|
1147
|
+
/** Output only. Bleu score. */
|
|
1148
|
+
score?: number;
|
|
1149
|
+
}
|
|
1150
|
+
|
|
1151
|
+
/** A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. */
|
|
1061
1152
|
declare interface Blob_2 {
|
|
1062
|
-
/** Required.
|
|
1153
|
+
/** Required. The raw bytes of the data.
|
|
1063
1154
|
* @remarks Encoded as base64 string. */
|
|
1064
1155
|
data?: string;
|
|
1065
|
-
/** Optional.
|
|
1156
|
+
/** 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
1157
|
displayName?: string;
|
|
1067
1158
|
/** Required. The IANA standard MIME type of the source data. */
|
|
1068
1159
|
mimeType?: string;
|
|
@@ -1335,15 +1426,15 @@ export declare interface Candidate {
|
|
|
1335
1426
|
contains the sources used to ground the generated content.
|
|
1336
1427
|
*/
|
|
1337
1428
|
groundingMetadata?: GroundingMetadata;
|
|
1338
|
-
/** Output only.
|
|
1429
|
+
/** 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
1430
|
avgLogprobs?: number;
|
|
1340
|
-
/** Output only.
|
|
1431
|
+
/** 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
1432
|
index?: number;
|
|
1342
|
-
/** Output only.
|
|
1433
|
+
/** 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
1434
|
logprobsResult?: LogprobsResult;
|
|
1344
|
-
/** Output only.
|
|
1435
|
+
/** Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. */
|
|
1345
1436
|
safetyRatings?: SafetyRating[];
|
|
1346
|
-
/** Output only. Metadata
|
|
1437
|
+
/** Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */
|
|
1347
1438
|
urlContextMetadata?: UrlContextMetadata;
|
|
1348
1439
|
}
|
|
1349
1440
|
|
|
@@ -1485,19 +1576,19 @@ export declare interface ChunkingConfig {
|
|
|
1485
1576
|
whiteSpaceConfig?: WhiteSpaceConfig;
|
|
1486
1577
|
}
|
|
1487
1578
|
|
|
1488
|
-
/**
|
|
1579
|
+
/** A citation for a piece of generatedcontent. This data type is not supported in Gemini API. */
|
|
1489
1580
|
export declare interface Citation {
|
|
1490
|
-
/** Output only.
|
|
1581
|
+
/** Output only. The end index of the citation in the content. */
|
|
1491
1582
|
endIndex?: number;
|
|
1492
|
-
/** Output only.
|
|
1583
|
+
/** Output only. The license of the source of the citation. */
|
|
1493
1584
|
license?: string;
|
|
1494
|
-
/** Output only.
|
|
1585
|
+
/** Output only. The publication date of the source of the citation. */
|
|
1495
1586
|
publicationDate?: GoogleTypeDate;
|
|
1496
|
-
/** Output only.
|
|
1587
|
+
/** Output only. The start index of the citation in the content. */
|
|
1497
1588
|
startIndex?: number;
|
|
1498
|
-
/** Output only.
|
|
1589
|
+
/** Output only. The title of the source of the citation. */
|
|
1499
1590
|
title?: string;
|
|
1500
|
-
/** Output only.
|
|
1591
|
+
/** Output only. The URI of the source of the citation. */
|
|
1501
1592
|
uri?: string;
|
|
1502
1593
|
}
|
|
1503
1594
|
|
|
@@ -1609,6 +1700,10 @@ declare interface CodeExecutionCallContent {
|
|
|
1609
1700
|
*/
|
|
1610
1701
|
arguments: CodeExecutionCallArguments;
|
|
1611
1702
|
type: 'code_execution_call';
|
|
1703
|
+
/**
|
|
1704
|
+
* A signature hash for backend validation.
|
|
1705
|
+
*/
|
|
1706
|
+
signature?: string;
|
|
1612
1707
|
}
|
|
1613
1708
|
|
|
1614
1709
|
/** Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. */
|
|
@@ -1717,7 +1812,7 @@ export declare interface Content {
|
|
|
1717
1812
|
/** List of parts that constitute a single message. Each part may have
|
|
1718
1813
|
a different IANA MIME type. */
|
|
1719
1814
|
parts?: Part[];
|
|
1720
|
-
/** Optional. The producer of the content. Must be either 'user' or 'model'.
|
|
1815
|
+
/** Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. */
|
|
1721
1816
|
role?: string;
|
|
1722
1817
|
}
|
|
1723
1818
|
|
|
@@ -1801,6 +1896,10 @@ declare namespace ContentDelta {
|
|
|
1801
1896
|
};
|
|
1802
1897
|
name: string;
|
|
1803
1898
|
type: 'function_call';
|
|
1899
|
+
/**
|
|
1900
|
+
* A signature hash for backend validation.
|
|
1901
|
+
*/
|
|
1902
|
+
signature?: string;
|
|
1804
1903
|
}
|
|
1805
1904
|
interface FunctionResultDelta {
|
|
1806
1905
|
/**
|
|
@@ -1814,6 +1913,10 @@ declare namespace ContentDelta {
|
|
|
1814
1913
|
type: 'function_result';
|
|
1815
1914
|
is_error?: boolean;
|
|
1816
1915
|
name?: string;
|
|
1916
|
+
/**
|
|
1917
|
+
* A signature hash for backend validation.
|
|
1918
|
+
*/
|
|
1919
|
+
signature?: string;
|
|
1817
1920
|
}
|
|
1818
1921
|
namespace FunctionResultDelta {
|
|
1819
1922
|
interface Items {
|
|
@@ -1830,6 +1933,10 @@ declare namespace ContentDelta {
|
|
|
1830
1933
|
*/
|
|
1831
1934
|
arguments: InteractionsAPI.CodeExecutionCallArguments;
|
|
1832
1935
|
type: 'code_execution_call';
|
|
1936
|
+
/**
|
|
1937
|
+
* A signature hash for backend validation.
|
|
1938
|
+
*/
|
|
1939
|
+
signature?: string;
|
|
1833
1940
|
}
|
|
1834
1941
|
interface CodeExecutionResultDelta {
|
|
1835
1942
|
/**
|
|
@@ -1839,6 +1946,9 @@ declare namespace ContentDelta {
|
|
|
1839
1946
|
result: string;
|
|
1840
1947
|
type: 'code_execution_result';
|
|
1841
1948
|
is_error?: boolean;
|
|
1949
|
+
/**
|
|
1950
|
+
* A signature hash for backend validation.
|
|
1951
|
+
*/
|
|
1842
1952
|
signature?: string;
|
|
1843
1953
|
}
|
|
1844
1954
|
interface URLContextCallDelta {
|
|
@@ -1851,6 +1961,10 @@ declare namespace ContentDelta {
|
|
|
1851
1961
|
*/
|
|
1852
1962
|
arguments: InteractionsAPI.URLContextCallArguments;
|
|
1853
1963
|
type: 'url_context_call';
|
|
1964
|
+
/**
|
|
1965
|
+
* A signature hash for backend validation.
|
|
1966
|
+
*/
|
|
1967
|
+
signature?: string;
|
|
1854
1968
|
}
|
|
1855
1969
|
interface URLContextResultDelta {
|
|
1856
1970
|
/**
|
|
@@ -1860,6 +1974,9 @@ declare namespace ContentDelta {
|
|
|
1860
1974
|
result: Array<InteractionsAPI.URLContextResult>;
|
|
1861
1975
|
type: 'url_context_result';
|
|
1862
1976
|
is_error?: boolean;
|
|
1977
|
+
/**
|
|
1978
|
+
* A signature hash for backend validation.
|
|
1979
|
+
*/
|
|
1863
1980
|
signature?: string;
|
|
1864
1981
|
}
|
|
1865
1982
|
interface GoogleSearchCallDelta {
|
|
@@ -1872,6 +1989,10 @@ declare namespace ContentDelta {
|
|
|
1872
1989
|
*/
|
|
1873
1990
|
arguments: InteractionsAPI.GoogleSearchCallArguments;
|
|
1874
1991
|
type: 'google_search_call';
|
|
1992
|
+
/**
|
|
1993
|
+
* A signature hash for backend validation.
|
|
1994
|
+
*/
|
|
1995
|
+
signature?: string;
|
|
1875
1996
|
}
|
|
1876
1997
|
interface GoogleSearchResultDelta {
|
|
1877
1998
|
/**
|
|
@@ -1881,6 +2002,9 @@ declare namespace ContentDelta {
|
|
|
1881
2002
|
result: Array<InteractionsAPI.GoogleSearchResult>;
|
|
1882
2003
|
type: 'google_search_result';
|
|
1883
2004
|
is_error?: boolean;
|
|
2005
|
+
/**
|
|
2006
|
+
* A signature hash for backend validation.
|
|
2007
|
+
*/
|
|
1884
2008
|
signature?: string;
|
|
1885
2009
|
}
|
|
1886
2010
|
interface MCPServerToolCallDelta {
|
|
@@ -1894,6 +2018,10 @@ declare namespace ContentDelta {
|
|
|
1894
2018
|
name: string;
|
|
1895
2019
|
server_name: string;
|
|
1896
2020
|
type: 'mcp_server_tool_call';
|
|
2021
|
+
/**
|
|
2022
|
+
* A signature hash for backend validation.
|
|
2023
|
+
*/
|
|
2024
|
+
signature?: string;
|
|
1897
2025
|
}
|
|
1898
2026
|
interface MCPServerToolResultDelta {
|
|
1899
2027
|
/**
|
|
@@ -1907,6 +2035,10 @@ declare namespace ContentDelta {
|
|
|
1907
2035
|
type: 'mcp_server_tool_result';
|
|
1908
2036
|
name?: string;
|
|
1909
2037
|
server_name?: string;
|
|
2038
|
+
/**
|
|
2039
|
+
* A signature hash for backend validation.
|
|
2040
|
+
*/
|
|
2041
|
+
signature?: string;
|
|
1910
2042
|
}
|
|
1911
2043
|
namespace MCPServerToolResultDelta {
|
|
1912
2044
|
interface Items {
|
|
@@ -1919,6 +2051,10 @@ declare namespace ContentDelta {
|
|
|
1919
2051
|
*/
|
|
1920
2052
|
id: string;
|
|
1921
2053
|
type: 'file_search_call';
|
|
2054
|
+
/**
|
|
2055
|
+
* A signature hash for backend validation.
|
|
2056
|
+
*/
|
|
2057
|
+
signature?: string;
|
|
1922
2058
|
}
|
|
1923
2059
|
interface FileSearchResultDelta {
|
|
1924
2060
|
type: 'file_search_result';
|
|
@@ -2501,6 +2637,12 @@ export declare interface CreateTuningJobParametersPrivate {
|
|
|
2501
2637
|
*/
|
|
2502
2638
|
export declare function createUserContent(partOrString: PartListUnion | string): Content;
|
|
2503
2639
|
|
|
2640
|
+
/** Result for custom code execution metric. This data type is not supported in Gemini API. */
|
|
2641
|
+
export declare interface CustomCodeExecutionResult {
|
|
2642
|
+
/** Output only. Custom code execution score. */
|
|
2643
|
+
score?: number;
|
|
2644
|
+
}
|
|
2645
|
+
|
|
2504
2646
|
/** User provided metadata stored as key-value pairs. This data type is not supported in Vertex AI. */
|
|
2505
2647
|
export declare interface CustomMetadata {
|
|
2506
2648
|
/** Required. The key of the metadata to store. */
|
|
@@ -2513,6 +2655,12 @@ export declare interface CustomMetadata {
|
|
|
2513
2655
|
stringValue?: string;
|
|
2514
2656
|
}
|
|
2515
2657
|
|
|
2658
|
+
/** Spec for custom output. This data type is not supported in Gemini API. */
|
|
2659
|
+
export declare interface CustomOutput {
|
|
2660
|
+
/** Output only. List of raw output strings. */
|
|
2661
|
+
rawOutputs?: RawOutput;
|
|
2662
|
+
}
|
|
2663
|
+
|
|
2516
2664
|
/** Distribution computed over a tuning dataset. This data type is not supported in Gemini API. */
|
|
2517
2665
|
export declare interface DatasetDistribution {
|
|
2518
2666
|
/** Output only. Defines the histogram bucket. */
|
|
@@ -2545,6 +2693,10 @@ export declare interface DatasetDistributionDistributionBucket {
|
|
|
2545
2693
|
|
|
2546
2694
|
/** Statistics computed over a tuning dataset. This data type is not supported in Gemini API. */
|
|
2547
2695
|
export declare interface DatasetStats {
|
|
2696
|
+
/** Output only. A partial sample of the indices (starting from 1) of the dropped examples. */
|
|
2697
|
+
droppedExampleIndices?: string[];
|
|
2698
|
+
/** Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. */
|
|
2699
|
+
droppedExampleReasons?: string[];
|
|
2548
2700
|
/** Output only. Number of billable characters in the tuning dataset. */
|
|
2549
2701
|
totalBillableCharacterCount?: string;
|
|
2550
2702
|
/** Output only. Number of tuning characters in the tuning dataset. */
|
|
@@ -2740,7 +2892,7 @@ export declare interface DeleteResourceJob {
|
|
|
2740
2892
|
error?: JobError;
|
|
2741
2893
|
}
|
|
2742
2894
|
|
|
2743
|
-
/** Statistics
|
|
2895
|
+
/** 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
2896
|
export declare interface DistillationDataStats {
|
|
2745
2897
|
/** Output only. Statistics computed for the training dataset. */
|
|
2746
2898
|
trainingDatasetStats?: DatasetStats;
|
|
@@ -3132,9 +3284,9 @@ export declare interface EmbeddingsBatchJobSource {
|
|
|
3132
3284
|
inlinedRequests?: EmbedContentBatch;
|
|
3133
3285
|
}
|
|
3134
3286
|
|
|
3135
|
-
/** Represents a customer-managed encryption key
|
|
3287
|
+
/** 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
3288
|
export declare interface EncryptionSpec {
|
|
3137
|
-
/** Required.
|
|
3289
|
+
/** 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
3290
|
kmsKeyName?: string;
|
|
3139
3291
|
}
|
|
3140
3292
|
|
|
@@ -3164,10 +3316,10 @@ export declare enum EndSensitivity {
|
|
|
3164
3316
|
|
|
3165
3317
|
/** Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. This data type is not supported in Gemini API. */
|
|
3166
3318
|
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
3319
|
/** Optional. Sites with confidence level chosen & above this value will be blocked from the search results. */
|
|
3170
3320
|
blockingConfidence?: PhishBlockThreshold;
|
|
3321
|
+
/** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. */
|
|
3322
|
+
excludeDomains?: string[];
|
|
3171
3323
|
}
|
|
3172
3324
|
|
|
3173
3325
|
/** An entity representing the segmented area. */
|
|
@@ -3236,6 +3388,42 @@ declare namespace Errors {
|
|
|
3236
3388
|
}
|
|
3237
3389
|
}
|
|
3238
3390
|
|
|
3391
|
+
/** The results from an evaluation run performed by the EvaluationService. This data type is not supported in Gemini API. */
|
|
3392
|
+
export declare class EvaluateDatasetResponse {
|
|
3393
|
+
/** Output only. Aggregation statistics derived from results of EvaluationService. */
|
|
3394
|
+
aggregationOutput?: AggregationOutput;
|
|
3395
|
+
/** Output only. Output info for EvaluationService. */
|
|
3396
|
+
outputInfo?: OutputInfo;
|
|
3397
|
+
}
|
|
3398
|
+
|
|
3399
|
+
/** Evaluate Dataset Run Result for Tuning Job. This data type is not supported in Gemini API. */
|
|
3400
|
+
export declare interface EvaluateDatasetRun {
|
|
3401
|
+
/** Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints. */
|
|
3402
|
+
checkpointId?: string;
|
|
3403
|
+
/** Output only. The error of the evaluation run if any. */
|
|
3404
|
+
error?: GoogleRpcStatus;
|
|
3405
|
+
/** Output only. Results for EvaluationService. */
|
|
3406
|
+
evaluateDatasetResponse?: EvaluateDatasetResponse;
|
|
3407
|
+
/** Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`. */
|
|
3408
|
+
evaluationRun?: string;
|
|
3409
|
+
/** Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`. */
|
|
3410
|
+
operationName?: string;
|
|
3411
|
+
}
|
|
3412
|
+
|
|
3413
|
+
/** The dataset used for evaluation. This data type is not supported in Gemini API. */
|
|
3414
|
+
export declare interface EvaluationDataset {
|
|
3415
|
+
/** BigQuery source holds the dataset. */
|
|
3416
|
+
bigquerySource?: BigQuerySource;
|
|
3417
|
+
/** Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported. */
|
|
3418
|
+
gcsSource?: GcsSource;
|
|
3419
|
+
}
|
|
3420
|
+
|
|
3421
|
+
/** Exact match metric value for an instance. This data type is not supported in Gemini API. */
|
|
3422
|
+
export declare interface ExactMatchMetricValue {
|
|
3423
|
+
/** Output only. Exact match score. */
|
|
3424
|
+
score?: number;
|
|
3425
|
+
}
|
|
3426
|
+
|
|
3239
3427
|
/** 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
3428
|
export declare interface ExecutableCode {
|
|
3241
3429
|
/** Required. The code to be executed. */
|
|
@@ -3346,11 +3534,11 @@ declare interface File_2 {
|
|
|
3346
3534
|
}
|
|
3347
3535
|
export { File_2 as File }
|
|
3348
3536
|
|
|
3349
|
-
/** URI
|
|
3537
|
+
/** 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
3538
|
export declare interface FileData {
|
|
3351
|
-
/** Optional.
|
|
3539
|
+
/** 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
3540
|
displayName?: string;
|
|
3353
|
-
/** Required. URI. */
|
|
3541
|
+
/** Required. The URI of the file in Google Cloud Storage. */
|
|
3354
3542
|
fileUri?: string;
|
|
3355
3543
|
/** Required. The IANA standard MIME type of the source data. */
|
|
3356
3544
|
mimeType?: string;
|
|
@@ -3496,6 +3684,10 @@ declare interface FileSearchCallContent {
|
|
|
3496
3684
|
*/
|
|
3497
3685
|
id: string;
|
|
3498
3686
|
type: 'file_search_call';
|
|
3687
|
+
/**
|
|
3688
|
+
* A signature hash for backend validation.
|
|
3689
|
+
*/
|
|
3690
|
+
signature?: string;
|
|
3499
3691
|
}
|
|
3500
3692
|
|
|
3501
3693
|
/**
|
|
@@ -3511,6 +3703,10 @@ declare interface FileSearchResultContent {
|
|
|
3511
3703
|
* The results of the File Search.
|
|
3512
3704
|
*/
|
|
3513
3705
|
result?: Array<FileSearchResultContent.Result>;
|
|
3706
|
+
/**
|
|
3707
|
+
* A signature hash for backend validation.
|
|
3708
|
+
*/
|
|
3709
|
+
signature?: string;
|
|
3514
3710
|
}
|
|
3515
3711
|
|
|
3516
3712
|
declare namespace FileSearchResultContent {
|
|
@@ -3769,6 +3965,16 @@ export declare enum FinishReason {
|
|
|
3769
3965
|
IMAGE_OTHER = "IMAGE_OTHER"
|
|
3770
3966
|
}
|
|
3771
3967
|
|
|
3968
|
+
/** Tuning Spec for Full Fine Tuning. This data type is not supported in Gemini API. */
|
|
3969
|
+
export declare interface FullFineTuningSpec {
|
|
3970
|
+
/** Optional. Hyperparameters for Full Fine Tuning. */
|
|
3971
|
+
hyperParameters?: SupervisedHyperParameters;
|
|
3972
|
+
/** 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. */
|
|
3973
|
+
trainingDatasetUri?: string;
|
|
3974
|
+
/** 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. */
|
|
3975
|
+
validationDatasetUri?: string;
|
|
3976
|
+
}
|
|
3977
|
+
|
|
3772
3978
|
/**
|
|
3773
3979
|
* A tool that can be used by the model.
|
|
3774
3980
|
*/
|
|
@@ -3822,6 +4028,10 @@ declare interface FunctionCallContent {
|
|
|
3822
4028
|
*/
|
|
3823
4029
|
name: string;
|
|
3824
4030
|
type: 'function_call';
|
|
4031
|
+
/**
|
|
4032
|
+
* A signature hash for backend validation.
|
|
4033
|
+
*/
|
|
4034
|
+
signature?: string;
|
|
3825
4035
|
}
|
|
3826
4036
|
|
|
3827
4037
|
/** Function calling config. */
|
|
@@ -3862,7 +4072,7 @@ export declare enum FunctionCallingConfigMode {
|
|
|
3862
4072
|
export declare interface FunctionDeclaration {
|
|
3863
4073
|
/** Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. */
|
|
3864
4074
|
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. */
|
|
4075
|
+
/** 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
4076
|
name?: string;
|
|
3867
4077
|
/** 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
4078
|
parameters?: Schema;
|
|
@@ -3976,6 +4186,10 @@ declare interface FunctionResultContent {
|
|
|
3976
4186
|
* The name of the tool that was called.
|
|
3977
4187
|
*/
|
|
3978
4188
|
name?: string;
|
|
4189
|
+
/**
|
|
4190
|
+
* A signature hash for backend validation.
|
|
4191
|
+
*/
|
|
4192
|
+
signature?: string;
|
|
3979
4193
|
}
|
|
3980
4194
|
|
|
3981
4195
|
declare namespace FunctionResultContent {
|
|
@@ -3984,6 +4198,12 @@ declare namespace FunctionResultContent {
|
|
|
3984
4198
|
}
|
|
3985
4199
|
}
|
|
3986
4200
|
|
|
4201
|
+
/** The Google Cloud Storage location for the input content. This data type is not supported in Gemini API. */
|
|
4202
|
+
export declare interface GcsSource {
|
|
4203
|
+
/** 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. */
|
|
4204
|
+
uris?: string[];
|
|
4205
|
+
}
|
|
4206
|
+
|
|
3987
4207
|
/**
|
|
3988
4208
|
* @license
|
|
3989
4209
|
* Copyright 2025 Google LLC
|
|
@@ -4619,45 +4839,45 @@ export declare interface GenerationConfig {
|
|
|
4619
4839
|
`response_schema` that accepts [JSON Schema](https://json-schema.org/).
|
|
4620
4840
|
*/
|
|
4621
4841
|
responseJsonSchema?: unknown;
|
|
4622
|
-
/** Optional. If enabled, audio
|
|
4842
|
+
/** 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
4843
|
audioTimestamp?: boolean;
|
|
4624
|
-
/** Optional.
|
|
4844
|
+
/** 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
4845
|
candidateCount?: number;
|
|
4626
|
-
/** Optional. If enabled, the model will detect emotions and adapt its responses accordingly. This field is not supported in Gemini API. */
|
|
4846
|
+
/** 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
4847
|
enableAffectiveDialog?: boolean;
|
|
4628
|
-
/** Optional.
|
|
4848
|
+
/** 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
4849
|
frequencyPenalty?: number;
|
|
4630
|
-
/** Optional.
|
|
4850
|
+
/** 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
4851
|
logprobs?: number;
|
|
4632
|
-
/** Optional. The maximum number of
|
|
4852
|
+
/** 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
4853
|
maxOutputTokens?: number;
|
|
4634
|
-
/** Optional.
|
|
4854
|
+
/** 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
4855
|
mediaResolution?: MediaResolution;
|
|
4636
|
-
/** Optional.
|
|
4856
|
+
/** 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
4857
|
presencePenalty?: number;
|
|
4638
|
-
/** Optional. If true,
|
|
4858
|
+
/** 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
4859
|
responseLogprobs?: boolean;
|
|
4640
|
-
/** Optional.
|
|
4860
|
+
/** 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
4861
|
responseMimeType?: string;
|
|
4642
|
-
/** Optional. The modalities of the response. */
|
|
4862
|
+
/** 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
4863
|
responseModalities?: Modality[];
|
|
4644
|
-
/** Optional.
|
|
4864
|
+
/** 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
4865
|
responseSchema?: Schema;
|
|
4646
4866
|
/** Optional. Routing configuration. This field is not supported in Gemini API. */
|
|
4647
4867
|
routingConfig?: GenerationConfigRoutingConfig;
|
|
4648
|
-
/** Optional.
|
|
4868
|
+
/** 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
4869
|
seed?: number;
|
|
4650
4870
|
/** Optional. The speech generation config. */
|
|
4651
4871
|
speechConfig?: SpeechConfig;
|
|
4652
|
-
/** Optional.
|
|
4872
|
+
/** 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
4873
|
stopSequences?: string[];
|
|
4654
|
-
/** Optional. Controls the randomness of
|
|
4874
|
+
/** 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
4875
|
temperature?: number;
|
|
4656
|
-
/** Optional.
|
|
4876
|
+
/** Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. */
|
|
4657
4877
|
thinkingConfig?: ThinkingConfig;
|
|
4658
|
-
/** Optional.
|
|
4878
|
+
/** 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
4879
|
topK?: number;
|
|
4660
|
-
/** Optional.
|
|
4880
|
+
/** 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
4881
|
topP?: number;
|
|
4662
4882
|
/** Optional. Enables enhanced civic answers. It may not be available for all models. This field is not supported in Vertex AI. */
|
|
4663
4883
|
enableEnhancedCivicAnswers?: boolean;
|
|
@@ -4709,23 +4929,23 @@ declare interface GenerationConfig_2 {
|
|
|
4709
4929
|
top_p?: number;
|
|
4710
4930
|
}
|
|
4711
4931
|
|
|
4712
|
-
/** The configuration for routing the request to a specific model. This data type is not supported in Gemini API. */
|
|
4932
|
+
/** 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
4933
|
export declare interface GenerationConfigRoutingConfig {
|
|
4714
|
-
/**
|
|
4934
|
+
/** In this mode, the model is selected automatically based on the content of the request. */
|
|
4715
4935
|
autoMode?: GenerationConfigRoutingConfigAutoRoutingMode;
|
|
4716
|
-
/**
|
|
4936
|
+
/** In this mode, the model is specified manually. */
|
|
4717
4937
|
manualMode?: GenerationConfigRoutingConfigManualRoutingMode;
|
|
4718
4938
|
}
|
|
4719
4939
|
|
|
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. */
|
|
4940
|
+
/** 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
4941
|
export declare interface GenerationConfigRoutingConfigAutoRoutingMode {
|
|
4722
4942
|
/** The model routing preference. */
|
|
4723
4943
|
modelRoutingPreference?: 'UNKNOWN' | 'PRIORITIZE_QUALITY' | 'BALANCED' | 'PRIORITIZE_COST';
|
|
4724
4944
|
}
|
|
4725
4945
|
|
|
4726
|
-
/** When manual routing is
|
|
4946
|
+
/** 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
4947
|
export declare interface GenerationConfigRoutingConfigManualRoutingMode {
|
|
4728
|
-
/** The model
|
|
4948
|
+
/** The name of the model to use. Only public LLM models are accepted. */
|
|
4729
4949
|
modelName?: string;
|
|
4730
4950
|
}
|
|
4731
4951
|
|
|
@@ -5022,11 +5242,11 @@ export declare interface GoogleGenAIOptions {
|
|
|
5022
5242
|
httpOptions?: HttpOptions;
|
|
5023
5243
|
}
|
|
5024
5244
|
|
|
5025
|
-
/** Tool to retrieve
|
|
5245
|
+
/** Tool to retrieve knowledge from Google Maps. */
|
|
5026
5246
|
export declare interface GoogleMaps {
|
|
5027
5247
|
/** The authentication config to access the API. Only API key is supported. This field is not supported in Gemini API. */
|
|
5028
5248
|
authConfig?: AuthConfig;
|
|
5029
|
-
/** Optional.
|
|
5249
|
+
/** 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
5250
|
enableWidget?: boolean;
|
|
5031
5251
|
}
|
|
5032
5252
|
|
|
@@ -5044,10 +5264,10 @@ export declare interface GoogleRpcStatus {
|
|
|
5044
5264
|
export declare interface GoogleSearch {
|
|
5045
5265
|
/** Different types of search that can be enabled on the GoogleSearch tool. */
|
|
5046
5266
|
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
5267
|
/** 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
5268
|
blockingConfidence?: PhishBlockThreshold;
|
|
5269
|
+
/** 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. */
|
|
5270
|
+
excludeDomains?: string[];
|
|
5051
5271
|
/** 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
5272
|
timeRangeFilter?: Interval;
|
|
5053
5273
|
}
|
|
@@ -5079,6 +5299,10 @@ declare interface GoogleSearchCallContent {
|
|
|
5079
5299
|
* The type of search grounding enabled.
|
|
5080
5300
|
*/
|
|
5081
5301
|
search_type?: 'web_search' | 'image_search';
|
|
5302
|
+
/**
|
|
5303
|
+
* A signature hash for backend validation.
|
|
5304
|
+
*/
|
|
5305
|
+
signature?: string;
|
|
5082
5306
|
}
|
|
5083
5307
|
|
|
5084
5308
|
/**
|
|
@@ -5117,7 +5341,7 @@ declare interface GoogleSearchResultContent {
|
|
|
5117
5341
|
*/
|
|
5118
5342
|
is_error?: boolean;
|
|
5119
5343
|
/**
|
|
5120
|
-
*
|
|
5344
|
+
* A signature hash for backend validation.
|
|
5121
5345
|
*/
|
|
5122
5346
|
signature?: string;
|
|
5123
5347
|
}
|
|
@@ -5148,11 +5372,15 @@ export declare interface GroundingChunk {
|
|
|
5148
5372
|
message for details.
|
|
5149
5373
|
*/
|
|
5150
5374
|
image?: GroundingChunkImage;
|
|
5151
|
-
/**
|
|
5375
|
+
/** A `Maps` chunk is a piece of evidence that comes from Google Maps.
|
|
5376
|
+
|
|
5377
|
+
It contains information about a place, such as its name, address, and
|
|
5378
|
+
reviews. This is used to provide the user with rich, location-based
|
|
5379
|
+
information. */
|
|
5152
5380
|
maps?: GroundingChunkMaps;
|
|
5153
|
-
/**
|
|
5381
|
+
/** 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
5382
|
retrievedContext?: GroundingChunkRetrievedContext;
|
|
5155
|
-
/**
|
|
5383
|
+
/** A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. */
|
|
5156
5384
|
web?: GroundingChunkWeb;
|
|
5157
5385
|
}
|
|
5158
5386
|
|
|
@@ -5172,29 +5400,42 @@ export declare interface GroundingChunkImage {
|
|
|
5172
5400
|
domain?: string;
|
|
5173
5401
|
}
|
|
5174
5402
|
|
|
5175
|
-
/**
|
|
5403
|
+
/** A `Maps` chunk is a piece of evidence that comes from Google Maps.
|
|
5404
|
+
|
|
5405
|
+
It contains information about a place, such as its name, address, and reviews.
|
|
5406
|
+
This is used to provide the user with rich, location-based information. */
|
|
5176
5407
|
export declare interface GroundingChunkMaps {
|
|
5177
|
-
/**
|
|
5408
|
+
/** The sources that were used to generate the place answer.
|
|
5409
|
+
|
|
5410
|
+
This includes review snippets and photos that were used to generate the
|
|
5411
|
+
answer, as well as URIs to flag content. */
|
|
5178
5412
|
placeAnswerSources?: GroundingChunkMapsPlaceAnswerSources;
|
|
5179
|
-
/** This Place's resource name, in `places/{place_id}` format.
|
|
5413
|
+
/** This Place's resource name, in `places/{place_id}` format.
|
|
5414
|
+
|
|
5415
|
+
This can be used to look up the place in the Google Maps API. */
|
|
5180
5416
|
placeId?: string;
|
|
5181
|
-
/**
|
|
5417
|
+
/** The text of the place answer. */
|
|
5182
5418
|
text?: string;
|
|
5183
|
-
/**
|
|
5419
|
+
/** The title of the place. */
|
|
5184
5420
|
title?: string;
|
|
5185
|
-
/** URI
|
|
5421
|
+
/** The URI of the place. */
|
|
5186
5422
|
uri?: string;
|
|
5187
5423
|
}
|
|
5188
5424
|
|
|
5189
|
-
/**
|
|
5425
|
+
/** The sources that were used to generate the place answer.
|
|
5426
|
+
|
|
5427
|
+
This includes review snippets and photos that were used to generate the
|
|
5428
|
+
answer, as well as URIs to flag content. */
|
|
5190
5429
|
export declare interface GroundingChunkMapsPlaceAnswerSources {
|
|
5430
|
+
/** Snippets of reviews that were used to generate the answer. */
|
|
5431
|
+
reviewSnippet?: GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
|
|
5191
5432
|
/** A link where users can flag a problem with the generated answer. */
|
|
5192
5433
|
flagContentUri?: string;
|
|
5193
|
-
/** Snippets of reviews that
|
|
5434
|
+
/** Snippets of reviews that were used to generate the answer. */
|
|
5194
5435
|
reviewSnippets?: GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
|
|
5195
5436
|
}
|
|
5196
5437
|
|
|
5197
|
-
/** Author attribution for a photo or review.
|
|
5438
|
+
/** Author attribution for a photo or review. */
|
|
5198
5439
|
export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
|
|
5199
5440
|
/** Name of the author of the Photo or Review. */
|
|
5200
5441
|
displayName?: string;
|
|
@@ -5204,7 +5445,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
|
|
|
5204
5445
|
uri?: string;
|
|
5205
5446
|
}
|
|
5206
5447
|
|
|
5207
|
-
/** Encapsulates a review snippet.
|
|
5448
|
+
/** Encapsulates a review snippet. */
|
|
5208
5449
|
export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
|
|
5209
5450
|
/** This review's author. */
|
|
5210
5451
|
authorAttribution?: GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution;
|
|
@@ -5222,30 +5463,31 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
|
|
|
5222
5463
|
title?: string;
|
|
5223
5464
|
}
|
|
5224
5465
|
|
|
5225
|
-
/**
|
|
5466
|
+
/** 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
5467
|
export declare interface GroundingChunkRetrievedContext {
|
|
5227
|
-
/** Output only. The full
|
|
5468
|
+
/** 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
5469
|
documentName?: string;
|
|
5229
|
-
/** Additional context for
|
|
5470
|
+
/** Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. */
|
|
5230
5471
|
ragChunk?: RagChunk;
|
|
5231
|
-
/**
|
|
5472
|
+
/** The content of the retrieved data source. */
|
|
5232
5473
|
text?: string;
|
|
5233
|
-
/**
|
|
5474
|
+
/** The title of the retrieved data source. */
|
|
5234
5475
|
title?: string;
|
|
5235
|
-
/** URI
|
|
5476
|
+
/** The URI of the retrieved data source. */
|
|
5236
5477
|
uri?: string;
|
|
5237
5478
|
}
|
|
5238
5479
|
|
|
5239
|
-
/**
|
|
5480
|
+
/** 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
5481
|
export declare interface GroundingChunkWeb {
|
|
5241
|
-
/**
|
|
5482
|
+
/** 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
5483
|
domain?: string;
|
|
5243
|
-
/**
|
|
5484
|
+
/** The title of the web page that contains the evidence. */
|
|
5244
5485
|
title?: string;
|
|
5245
|
-
/** URI
|
|
5486
|
+
/** The URI of the web page that contains the evidence. */
|
|
5246
5487
|
uri?: string;
|
|
5247
5488
|
}
|
|
5248
5489
|
|
|
5490
|
+
/** Information for various kinds of grounding. */
|
|
5249
5491
|
export declare interface GroundingMetadata {
|
|
5250
5492
|
/** Optional. The image search queries that were used to generate the
|
|
5251
5493
|
content. This field is populated only when the grounding source is Google
|
|
@@ -5257,41 +5499,48 @@ export declare interface GroundingMetadata {
|
|
|
5257
5499
|
Search, Vertex AI Search, or Google Maps.
|
|
5258
5500
|
*/
|
|
5259
5501
|
groundingChunks?: GroundingChunk[];
|
|
5260
|
-
/**
|
|
5261
|
-
googleMapsWidgetContextToken?: string;
|
|
5262
|
-
/** Optional. List of grounding support. */
|
|
5502
|
+
/** List of grounding support. */
|
|
5263
5503
|
groundingSupports?: GroundingSupport[];
|
|
5264
|
-
/**
|
|
5504
|
+
/** Metadata related to retrieval in the grounding flow. */
|
|
5265
5505
|
retrievalMetadata?: RetrievalMetadata;
|
|
5266
|
-
/** Optional.
|
|
5267
|
-
|
|
5268
|
-
/** Optional. Google search entry for the following-up web searches. */
|
|
5506
|
+
/** Optional. Google search entry for the following-up web
|
|
5507
|
+
searches. */
|
|
5269
5508
|
searchEntryPoint?: SearchEntryPoint;
|
|
5270
|
-
/**
|
|
5271
|
-
sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
|
|
5272
|
-
/** Optional. Web search queries for the following-up web search. */
|
|
5509
|
+
/** Web search queries for the following-up web search. */
|
|
5273
5510
|
webSearchQueries?: string[];
|
|
5511
|
+
/** 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. */
|
|
5512
|
+
googleMapsWidgetContextToken?: string;
|
|
5513
|
+
/** 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. */
|
|
5514
|
+
retrievalQueries?: string[];
|
|
5515
|
+
/** 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. */
|
|
5516
|
+
sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
|
|
5274
5517
|
}
|
|
5275
5518
|
|
|
5276
|
-
/**
|
|
5519
|
+
/** 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
5520
|
export declare interface GroundingMetadataSourceFlaggingUri {
|
|
5278
|
-
/**
|
|
5521
|
+
/** The URI that can be used to flag the content. */
|
|
5279
5522
|
flagContentUri?: string;
|
|
5280
|
-
/**
|
|
5523
|
+
/** The ID of the place or review. */
|
|
5281
5524
|
sourceId?: string;
|
|
5282
5525
|
}
|
|
5283
5526
|
|
|
5284
5527
|
/** Grounding support. */
|
|
5285
5528
|
export declare interface GroundingSupport {
|
|
5286
|
-
/** Confidence score of the support references.
|
|
5529
|
+
/** Confidence score of the support references.
|
|
5530
|
+
|
|
5531
|
+
Ranges from 0 to 1. 1 is the most confident. This list must have the
|
|
5532
|
+
same size as the grounding_chunk_indices. */
|
|
5287
5533
|
confidenceScores?: number[];
|
|
5288
|
-
/** A list of indices (into 'grounding_chunk') specifying the
|
|
5534
|
+
/** A list of indices (into 'grounding_chunk') specifying the
|
|
5535
|
+
citations associated with the claim. For instance [1,3,4] means that
|
|
5536
|
+
grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the
|
|
5537
|
+
retrieved content attributed to the claim. */
|
|
5289
5538
|
groundingChunkIndices?: number[];
|
|
5290
5539
|
/** Segment of the content this support belongs to. */
|
|
5291
5540
|
segment?: Segment;
|
|
5292
5541
|
}
|
|
5293
5542
|
|
|
5294
|
-
/**
|
|
5543
|
+
/** 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
5544
|
export declare enum HarmBlockMethod {
|
|
5296
5545
|
/**
|
|
5297
5546
|
* The harm block method is unspecified.
|
|
@@ -5307,54 +5556,54 @@ export declare enum HarmBlockMethod {
|
|
|
5307
5556
|
PROBABILITY = "PROBABILITY"
|
|
5308
5557
|
}
|
|
5309
5558
|
|
|
5310
|
-
/** The harm
|
|
5559
|
+
/** The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. */
|
|
5311
5560
|
export declare enum HarmBlockThreshold {
|
|
5312
5561
|
/**
|
|
5313
|
-
*
|
|
5562
|
+
* The harm block threshold is unspecified.
|
|
5314
5563
|
*/
|
|
5315
5564
|
HARM_BLOCK_THRESHOLD_UNSPECIFIED = "HARM_BLOCK_THRESHOLD_UNSPECIFIED",
|
|
5316
5565
|
/**
|
|
5317
|
-
* Block
|
|
5566
|
+
* Block content with a low harm probability or higher.
|
|
5318
5567
|
*/
|
|
5319
5568
|
BLOCK_LOW_AND_ABOVE = "BLOCK_LOW_AND_ABOVE",
|
|
5320
5569
|
/**
|
|
5321
|
-
* Block medium
|
|
5570
|
+
* Block content with a medium harm probability or higher.
|
|
5322
5571
|
*/
|
|
5323
5572
|
BLOCK_MEDIUM_AND_ABOVE = "BLOCK_MEDIUM_AND_ABOVE",
|
|
5324
5573
|
/**
|
|
5325
|
-
* Block
|
|
5574
|
+
* Block content with a high harm probability.
|
|
5326
5575
|
*/
|
|
5327
5576
|
BLOCK_ONLY_HIGH = "BLOCK_ONLY_HIGH",
|
|
5328
5577
|
/**
|
|
5329
|
-
*
|
|
5578
|
+
* Do not block any content, regardless of its harm probability.
|
|
5330
5579
|
*/
|
|
5331
5580
|
BLOCK_NONE = "BLOCK_NONE",
|
|
5332
5581
|
/**
|
|
5333
|
-
* Turn off the safety filter.
|
|
5582
|
+
* Turn off the safety filter entirely.
|
|
5334
5583
|
*/
|
|
5335
5584
|
OFF = "OFF"
|
|
5336
5585
|
}
|
|
5337
5586
|
|
|
5338
|
-
/**
|
|
5587
|
+
/** The harm category to be blocked. */
|
|
5339
5588
|
export declare enum HarmCategory {
|
|
5340
5589
|
/**
|
|
5341
|
-
*
|
|
5590
|
+
* Default value. This value is unused.
|
|
5342
5591
|
*/
|
|
5343
5592
|
HARM_CATEGORY_UNSPECIFIED = "HARM_CATEGORY_UNSPECIFIED",
|
|
5344
5593
|
/**
|
|
5345
|
-
*
|
|
5594
|
+
* Abusive, threatening, or content intended to bully, torment, or ridicule.
|
|
5346
5595
|
*/
|
|
5347
5596
|
HARM_CATEGORY_HARASSMENT = "HARM_CATEGORY_HARASSMENT",
|
|
5348
5597
|
/**
|
|
5349
|
-
*
|
|
5598
|
+
* Content that promotes violence or incites hatred against individuals or groups based on certain attributes.
|
|
5350
5599
|
*/
|
|
5351
5600
|
HARM_CATEGORY_HATE_SPEECH = "HARM_CATEGORY_HATE_SPEECH",
|
|
5352
5601
|
/**
|
|
5353
|
-
*
|
|
5602
|
+
* Content that contains sexually explicit material.
|
|
5354
5603
|
*/
|
|
5355
5604
|
HARM_CATEGORY_SEXUALLY_EXPLICIT = "HARM_CATEGORY_SEXUALLY_EXPLICIT",
|
|
5356
5605
|
/**
|
|
5357
|
-
*
|
|
5606
|
+
* Content that promotes, facilitates, or enables dangerous activities.
|
|
5358
5607
|
*/
|
|
5359
5608
|
HARM_CATEGORY_DANGEROUS_CONTENT = "HARM_CATEGORY_DANGEROUS_CONTENT",
|
|
5360
5609
|
/**
|
|
@@ -5362,71 +5611,71 @@ export declare enum HarmCategory {
|
|
|
5362
5611
|
*/
|
|
5363
5612
|
HARM_CATEGORY_CIVIC_INTEGRITY = "HARM_CATEGORY_CIVIC_INTEGRITY",
|
|
5364
5613
|
/**
|
|
5365
|
-
*
|
|
5614
|
+
* Images that contain hate speech. This enum value is not supported in Gemini API.
|
|
5366
5615
|
*/
|
|
5367
5616
|
HARM_CATEGORY_IMAGE_HATE = "HARM_CATEGORY_IMAGE_HATE",
|
|
5368
5617
|
/**
|
|
5369
|
-
*
|
|
5618
|
+
* Images that contain dangerous content. This enum value is not supported in Gemini API.
|
|
5370
5619
|
*/
|
|
5371
5620
|
HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT = "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT",
|
|
5372
5621
|
/**
|
|
5373
|
-
*
|
|
5622
|
+
* Images that contain harassment. This enum value is not supported in Gemini API.
|
|
5374
5623
|
*/
|
|
5375
5624
|
HARM_CATEGORY_IMAGE_HARASSMENT = "HARM_CATEGORY_IMAGE_HARASSMENT",
|
|
5376
5625
|
/**
|
|
5377
|
-
*
|
|
5626
|
+
* Images that contain sexually explicit content. This enum value is not supported in Gemini API.
|
|
5378
5627
|
*/
|
|
5379
5628
|
HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT = "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT",
|
|
5380
5629
|
/**
|
|
5381
|
-
*
|
|
5630
|
+
* Prompts designed to bypass safety filters. This enum value is not supported in Gemini API.
|
|
5382
5631
|
*/
|
|
5383
5632
|
HARM_CATEGORY_JAILBREAK = "HARM_CATEGORY_JAILBREAK"
|
|
5384
5633
|
}
|
|
5385
5634
|
|
|
5386
|
-
/** Output only.
|
|
5635
|
+
/** Output only. The probability of harm for this category. */
|
|
5387
5636
|
export declare enum HarmProbability {
|
|
5388
5637
|
/**
|
|
5389
|
-
*
|
|
5638
|
+
* The harm probability is unspecified.
|
|
5390
5639
|
*/
|
|
5391
5640
|
HARM_PROBABILITY_UNSPECIFIED = "HARM_PROBABILITY_UNSPECIFIED",
|
|
5392
5641
|
/**
|
|
5393
|
-
*
|
|
5642
|
+
* The harm probability is negligible.
|
|
5394
5643
|
*/
|
|
5395
5644
|
NEGLIGIBLE = "NEGLIGIBLE",
|
|
5396
5645
|
/**
|
|
5397
|
-
*
|
|
5646
|
+
* The harm probability is low.
|
|
5398
5647
|
*/
|
|
5399
5648
|
LOW = "LOW",
|
|
5400
5649
|
/**
|
|
5401
|
-
*
|
|
5650
|
+
* The harm probability is medium.
|
|
5402
5651
|
*/
|
|
5403
5652
|
MEDIUM = "MEDIUM",
|
|
5404
5653
|
/**
|
|
5405
|
-
*
|
|
5654
|
+
* The harm probability is high.
|
|
5406
5655
|
*/
|
|
5407
5656
|
HIGH = "HIGH"
|
|
5408
5657
|
}
|
|
5409
5658
|
|
|
5410
|
-
/** Output only.
|
|
5659
|
+
/** Output only. The severity of harm for this category. This enum is not supported in Gemini API. */
|
|
5411
5660
|
export declare enum HarmSeverity {
|
|
5412
5661
|
/**
|
|
5413
|
-
*
|
|
5662
|
+
* The harm severity is unspecified.
|
|
5414
5663
|
*/
|
|
5415
5664
|
HARM_SEVERITY_UNSPECIFIED = "HARM_SEVERITY_UNSPECIFIED",
|
|
5416
5665
|
/**
|
|
5417
|
-
*
|
|
5666
|
+
* The harm severity is negligible.
|
|
5418
5667
|
*/
|
|
5419
5668
|
HARM_SEVERITY_NEGLIGIBLE = "HARM_SEVERITY_NEGLIGIBLE",
|
|
5420
5669
|
/**
|
|
5421
|
-
*
|
|
5670
|
+
* The harm severity is low.
|
|
5422
5671
|
*/
|
|
5423
5672
|
HARM_SEVERITY_LOW = "HARM_SEVERITY_LOW",
|
|
5424
5673
|
/**
|
|
5425
|
-
*
|
|
5674
|
+
* The harm severity is medium.
|
|
5426
5675
|
*/
|
|
5427
5676
|
HARM_SEVERITY_MEDIUM = "HARM_SEVERITY_MEDIUM",
|
|
5428
5677
|
/**
|
|
5429
|
-
*
|
|
5678
|
+
* The harm severity is high.
|
|
5430
5679
|
*/
|
|
5431
5680
|
HARM_SEVERITY_HIGH = "HARM_SEVERITY_HIGH"
|
|
5432
5681
|
}
|
|
@@ -5594,6 +5843,8 @@ export declare interface ImageConfig {
|
|
|
5594
5843
|
/** Compression quality of the generated image (for
|
|
5595
5844
|
``image/jpeg`` only). This field is not supported in Gemini API. */
|
|
5596
5845
|
outputCompressionQuality?: number;
|
|
5846
|
+
/** Optional. The image output format for generated images. */
|
|
5847
|
+
imageOutputOptions?: ImageConfigImageOutputOptions;
|
|
5597
5848
|
}
|
|
5598
5849
|
|
|
5599
5850
|
/**
|
|
@@ -5604,6 +5855,14 @@ declare interface ImageConfig_2 {
|
|
|
5604
5855
|
image_size?: '1K' | '2K' | '4K' | '512';
|
|
5605
5856
|
}
|
|
5606
5857
|
|
|
5858
|
+
/** The image output format for generated images. This data type is not supported in Gemini API. */
|
|
5859
|
+
export declare interface ImageConfigImageOutputOptions {
|
|
5860
|
+
/** Optional. The compression quality of the output image. */
|
|
5861
|
+
compressionQuality?: number;
|
|
5862
|
+
/** Optional. The image format that the output should be saved as. */
|
|
5863
|
+
mimeType?: string;
|
|
5864
|
+
}
|
|
5865
|
+
|
|
5607
5866
|
/**
|
|
5608
5867
|
* An image content block.
|
|
5609
5868
|
*/
|
|
@@ -6321,9 +6580,9 @@ export declare interface ListTuningJobsParameters {
|
|
|
6321
6580
|
export declare class ListTuningJobsResponse {
|
|
6322
6581
|
/** Used to retain the full HTTP response. */
|
|
6323
6582
|
sdkHttpResponse?: HttpResponse;
|
|
6324
|
-
/** A token to retrieve the next page of results. Pass
|
|
6583
|
+
/** 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
6584
|
nextPageToken?: string;
|
|
6326
|
-
/**
|
|
6585
|
+
/** The tuning jobs that match the request. */
|
|
6327
6586
|
tuningJobs?: TuningJob[];
|
|
6328
6587
|
}
|
|
6329
6588
|
|
|
@@ -7109,27 +7368,27 @@ declare type Logger = {
|
|
|
7109
7368
|
|
|
7110
7369
|
declare type LogLevel = 'off' | 'error' | 'warn' | 'info' | 'debug';
|
|
7111
7370
|
|
|
7112
|
-
/**
|
|
7371
|
+
/** 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
7372
|
export declare interface LogprobsResult {
|
|
7114
|
-
/**
|
|
7373
|
+
/** 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
7374
|
chosenCandidates?: LogprobsResultCandidate[];
|
|
7116
|
-
/**
|
|
7375
|
+
/** 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
7376
|
topCandidates?: LogprobsResultTopCandidates[];
|
|
7118
7377
|
}
|
|
7119
7378
|
|
|
7120
|
-
/**
|
|
7379
|
+
/** A single token and its associated log probability. */
|
|
7121
7380
|
export declare interface LogprobsResultCandidate {
|
|
7122
|
-
/** The
|
|
7381
|
+
/** 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
7382
|
logProbability?: number;
|
|
7124
|
-
/** The
|
|
7383
|
+
/** The token's string representation. */
|
|
7125
7384
|
token?: string;
|
|
7126
|
-
/** The
|
|
7385
|
+
/** 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
7386
|
tokenId?: number;
|
|
7128
7387
|
}
|
|
7129
7388
|
|
|
7130
|
-
/**
|
|
7389
|
+
/** 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
7390
|
export declare interface LogprobsResultTopCandidates {
|
|
7132
|
-
/**
|
|
7391
|
+
/** The list of candidate tokens, sorted by log probability in descending order. */
|
|
7133
7392
|
candidates?: LogprobsResultCandidate[];
|
|
7134
7393
|
}
|
|
7135
7394
|
|
|
@@ -7208,6 +7467,10 @@ declare interface MCPServerToolCallContent {
|
|
|
7208
7467
|
*/
|
|
7209
7468
|
server_name: string;
|
|
7210
7469
|
type: 'mcp_server_tool_call';
|
|
7470
|
+
/**
|
|
7471
|
+
* A signature hash for backend validation.
|
|
7472
|
+
*/
|
|
7473
|
+
signature?: string;
|
|
7211
7474
|
}
|
|
7212
7475
|
|
|
7213
7476
|
/**
|
|
@@ -7231,6 +7494,10 @@ declare interface MCPServerToolResultContent {
|
|
|
7231
7494
|
* The name of the used MCP server.
|
|
7232
7495
|
*/
|
|
7233
7496
|
server_name?: string;
|
|
7497
|
+
/**
|
|
7498
|
+
* A signature hash for backend validation.
|
|
7499
|
+
*/
|
|
7500
|
+
signature?: string;
|
|
7234
7501
|
}
|
|
7235
7502
|
|
|
7236
7503
|
declare namespace MCPServerToolResultContent {
|
|
@@ -7331,7 +7598,7 @@ export declare enum Modality {
|
|
|
7331
7598
|
export declare interface ModalityTokenCount {
|
|
7332
7599
|
/** The modality associated with this token count. */
|
|
7333
7600
|
modality?: MediaModality;
|
|
7334
|
-
/**
|
|
7601
|
+
/** The number of tokens counted for this modality. */
|
|
7335
7602
|
tokenCount?: number;
|
|
7336
7603
|
}
|
|
7337
7604
|
|
|
@@ -7393,13 +7660,13 @@ export declare interface Model {
|
|
|
7393
7660
|
/**
|
|
7394
7661
|
* The model that will complete your prompt.\n\nSee [models](https://ai.google.dev/gemini-api/docs/models) for additional details.
|
|
7395
7662
|
*/
|
|
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 & {});
|
|
7663
|
+
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
7664
|
|
|
7398
|
-
/** Configuration for Model Armor
|
|
7665
|
+
/** 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
7666
|
export declare interface ModelArmorConfig {
|
|
7400
|
-
/** Optional. The name of the Model Armor template to use for prompt
|
|
7667
|
+
/** 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
7668
|
promptTemplateName?: string;
|
|
7402
|
-
/** Optional. The name of the Model Armor template to use for response
|
|
7669
|
+
/** 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
7670
|
responseTemplateName?: string;
|
|
7404
7671
|
}
|
|
7405
7672
|
|
|
@@ -7946,6 +8213,12 @@ export declare enum Outcome {
|
|
|
7946
8213
|
OUTCOME_DEADLINE_EXCEEDED = "OUTCOME_DEADLINE_EXCEEDED"
|
|
7947
8214
|
}
|
|
7948
8215
|
|
|
8216
|
+
/** Describes the info for output of EvaluationService. This data type is not supported in Gemini API. */
|
|
8217
|
+
export declare interface OutputInfo {
|
|
8218
|
+
/** Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. */
|
|
8219
|
+
gcsOutputDirectory?: string;
|
|
8220
|
+
}
|
|
8221
|
+
|
|
7949
8222
|
/**
|
|
7950
8223
|
* Some environments overload the global fetch function, and Parameters<T> only gets the last signature.
|
|
7951
8224
|
*/
|
|
@@ -8093,6 +8366,36 @@ export declare class Pager<T> implements AsyncIterable<T> {
|
|
|
8093
8366
|
hasNextPage(): boolean;
|
|
8094
8367
|
}
|
|
8095
8368
|
|
|
8369
|
+
/** Output only. Pairwise metric choice. This enum is not supported in Gemini API. */
|
|
8370
|
+
export declare enum PairwiseChoice {
|
|
8371
|
+
/**
|
|
8372
|
+
* Unspecified prediction choice.
|
|
8373
|
+
*/
|
|
8374
|
+
PAIRWISE_CHOICE_UNSPECIFIED = "PAIRWISE_CHOICE_UNSPECIFIED",
|
|
8375
|
+
/**
|
|
8376
|
+
* Baseline prediction wins
|
|
8377
|
+
*/
|
|
8378
|
+
BASELINE = "BASELINE",
|
|
8379
|
+
/**
|
|
8380
|
+
* Candidate prediction wins
|
|
8381
|
+
*/
|
|
8382
|
+
CANDIDATE = "CANDIDATE",
|
|
8383
|
+
/**
|
|
8384
|
+
* Winner cannot be determined
|
|
8385
|
+
*/
|
|
8386
|
+
TIE = "TIE"
|
|
8387
|
+
}
|
|
8388
|
+
|
|
8389
|
+
/** Spec for pairwise metric result. This data type is not supported in Gemini API. */
|
|
8390
|
+
export declare interface PairwiseMetricResult {
|
|
8391
|
+
/** Output only. Spec for custom output. */
|
|
8392
|
+
customOutput?: CustomOutput;
|
|
8393
|
+
/** Output only. Explanation for pairwise metric score. */
|
|
8394
|
+
explanation?: string;
|
|
8395
|
+
/** Output only. Pairwise metric choice. */
|
|
8396
|
+
pairwiseChoice?: PairwiseChoice;
|
|
8397
|
+
}
|
|
8398
|
+
|
|
8096
8399
|
/** A datatype containing media content.
|
|
8097
8400
|
|
|
8098
8401
|
Exactly one field within a Part should be set, representing the specific type
|
|
@@ -8102,21 +8405,21 @@ export declare interface Part {
|
|
|
8102
8405
|
/** Media resolution for the input media.
|
|
8103
8406
|
*/
|
|
8104
8407
|
mediaResolution?: PartMediaResolution;
|
|
8105
|
-
/** Optional.
|
|
8408
|
+
/** Optional. The result of executing the ExecutableCode. */
|
|
8106
8409
|
codeExecutionResult?: CodeExecutionResult;
|
|
8107
|
-
/** Optional. Code generated by the model that is
|
|
8410
|
+
/** Optional. Code generated by the model that is intended to be executed. */
|
|
8108
8411
|
executableCode?: ExecutableCode;
|
|
8109
|
-
/** Optional. URI
|
|
8412
|
+
/** Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. */
|
|
8110
8413
|
fileData?: FileData;
|
|
8111
|
-
/** Optional. A predicted
|
|
8414
|
+
/** 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
8415
|
functionCall?: FunctionCall;
|
|
8113
|
-
/** Optional. The result
|
|
8416
|
+
/** 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
8417
|
functionResponse?: FunctionResponse;
|
|
8115
|
-
/** Optional.
|
|
8418
|
+
/** Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. */
|
|
8116
8419
|
inlineData?: Blob_2;
|
|
8117
|
-
/** Optional.
|
|
8420
|
+
/** 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
8421
|
text?: string;
|
|
8119
|
-
/** Optional. Indicates
|
|
8422
|
+
/** Optional. Indicates whether the `part` represents the model's thought process or reasoning. */
|
|
8120
8423
|
thought?: boolean;
|
|
8121
8424
|
/** Optional. An opaque signature for the thought so it can be reused in subsequent requests.
|
|
8122
8425
|
* @remarks Encoded as base64 string. */
|
|
@@ -8127,16 +8430,16 @@ export declare interface Part {
|
|
|
8127
8430
|
|
|
8128
8431
|
/** Partial argument value of the function call. This data type is not supported in Gemini API. */
|
|
8129
8432
|
export declare interface PartialArg {
|
|
8433
|
+
/** Optional. Represents a boolean value. */
|
|
8434
|
+
boolValue?: boolean;
|
|
8435
|
+
/** Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". */
|
|
8436
|
+
jsonPath?: string;
|
|
8130
8437
|
/** Optional. Represents a null value. */
|
|
8131
8438
|
nullValue?: 'NULL_VALUE';
|
|
8132
8439
|
/** Optional. Represents a double value. */
|
|
8133
8440
|
numberValue?: number;
|
|
8134
8441
|
/** Optional. Represents a string value. */
|
|
8135
8442
|
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
8443
|
/** 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
8444
|
willContinue?: boolean;
|
|
8142
8445
|
}
|
|
@@ -8240,14 +8543,28 @@ export declare enum PhishBlockThreshold {
|
|
|
8240
8543
|
BLOCK_ONLY_EXTREMELY_HIGH = "BLOCK_ONLY_EXTREMELY_HIGH"
|
|
8241
8544
|
}
|
|
8242
8545
|
|
|
8243
|
-
/**
|
|
8546
|
+
/** Spec for pointwise metric result. This data type is not supported in Gemini API. */
|
|
8547
|
+
export declare interface PointwiseMetricResult {
|
|
8548
|
+
/** Output only. Spec for custom output. */
|
|
8549
|
+
customOutput?: CustomOutput;
|
|
8550
|
+
/** Output only. Explanation for pointwise metric score. */
|
|
8551
|
+
explanation?: string;
|
|
8552
|
+
/** Output only. Pointwise metric score. */
|
|
8553
|
+
score?: number;
|
|
8554
|
+
}
|
|
8555
|
+
|
|
8556
|
+
/** Configuration for a prebuilt voice. */
|
|
8244
8557
|
export declare interface PrebuiltVoiceConfig {
|
|
8245
|
-
/** The name of the
|
|
8558
|
+
/** The name of the prebuilt voice to use. */
|
|
8246
8559
|
voiceName?: string;
|
|
8247
8560
|
}
|
|
8248
8561
|
|
|
8249
8562
|
/** Statistics computed for datasets used for preference optimization. This data type is not supported in Gemini API. */
|
|
8250
8563
|
export declare interface PreferenceOptimizationDataStats {
|
|
8564
|
+
/** Output only. A partial sample of the indices (starting from 1) of the dropped examples. */
|
|
8565
|
+
droppedExampleIndices?: string[];
|
|
8566
|
+
/** Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. */
|
|
8567
|
+
droppedExampleReasons?: string[];
|
|
8251
8568
|
/** Output only. Dataset distributions for scores variance per example. */
|
|
8252
8569
|
scoreVariancePerExampleDistribution?: DatasetDistribution;
|
|
8253
8570
|
/** Output only. Dataset distributions for scores. */
|
|
@@ -8404,6 +8721,12 @@ export declare interface RagRetrievalConfigRankingRankService {
|
|
|
8404
8721
|
declare class RateLimitError extends APIError<429, Headers> {
|
|
8405
8722
|
}
|
|
8406
8723
|
|
|
8724
|
+
/** Raw output. This data type is not supported in Gemini API. */
|
|
8725
|
+
export declare interface RawOutput {
|
|
8726
|
+
/** Output only. Raw output string. */
|
|
8727
|
+
rawOutput?: string[];
|
|
8728
|
+
}
|
|
8729
|
+
|
|
8407
8730
|
/** A raw reference image.
|
|
8408
8731
|
|
|
8409
8732
|
A raw reference image represents the base image to edit, provided by the user.
|
|
@@ -8705,12 +9028,23 @@ export declare interface RetrievalConfig {
|
|
|
8705
9028
|
languageCode?: string;
|
|
8706
9029
|
}
|
|
8707
9030
|
|
|
8708
|
-
/** Metadata
|
|
9031
|
+
/** Metadata returned to client when grounding is enabled. */
|
|
8709
9032
|
export declare interface RetrievalMetadata {
|
|
8710
|
-
/** Optional. Score indicating how likely information from
|
|
9033
|
+
/** Optional. Score indicating how likely information from google
|
|
9034
|
+
search could help answer the prompt. The score is in the range [0, 1],
|
|
9035
|
+
where 0 is the least likely and 1 is the most likely. This score is only
|
|
9036
|
+
populated when google search grounding and dynamic retrieval is enabled.
|
|
9037
|
+
It will be compared to the threshold to determine whether to trigger
|
|
9038
|
+
Google search. */
|
|
8711
9039
|
googleSearchDynamicRetrievalScore?: number;
|
|
8712
9040
|
}
|
|
8713
9041
|
|
|
9042
|
+
/** Rouge metric value for an instance. This data type is not supported in Gemini API. */
|
|
9043
|
+
export declare interface RougeMetricValue {
|
|
9044
|
+
/** Output only. Rouge score. */
|
|
9045
|
+
score?: number;
|
|
9046
|
+
}
|
|
9047
|
+
|
|
8714
9048
|
/** Safety attributes of a GeneratedImage or the user-provided prompt. */
|
|
8715
9049
|
export declare interface SafetyAttributes {
|
|
8716
9050
|
/** List of RAI categories. */
|
|
@@ -8729,31 +9063,31 @@ export declare enum SafetyFilterLevel {
|
|
|
8729
9063
|
BLOCK_NONE = "BLOCK_NONE"
|
|
8730
9064
|
}
|
|
8731
9065
|
|
|
8732
|
-
/**
|
|
9066
|
+
/** A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. */
|
|
8733
9067
|
export declare interface SafetyRating {
|
|
8734
|
-
/** Output only. Indicates whether the content was
|
|
9068
|
+
/** Output only. Indicates whether the content was blocked because of this rating. */
|
|
8735
9069
|
blocked?: boolean;
|
|
8736
|
-
/** Output only.
|
|
9070
|
+
/** Output only. The harm category of this rating. */
|
|
8737
9071
|
category?: HarmCategory;
|
|
8738
9072
|
/** 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
9073
|
overwrittenThreshold?: HarmBlockThreshold;
|
|
8740
|
-
/** Output only.
|
|
9074
|
+
/** Output only. The probability of harm for this category. */
|
|
8741
9075
|
probability?: HarmProbability;
|
|
8742
|
-
/** Output only.
|
|
9076
|
+
/** Output only. The probability score of harm for this category. This field is not supported in Gemini API. */
|
|
8743
9077
|
probabilityScore?: number;
|
|
8744
|
-
/** Output only.
|
|
9078
|
+
/** Output only. The severity of harm for this category. This field is not supported in Gemini API. */
|
|
8745
9079
|
severity?: HarmSeverity;
|
|
8746
|
-
/** Output only.
|
|
9080
|
+
/** Output only. The severity score of harm for this category. This field is not supported in Gemini API. */
|
|
8747
9081
|
severityScore?: number;
|
|
8748
9082
|
}
|
|
8749
9083
|
|
|
8750
|
-
/**
|
|
9084
|
+
/** A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. */
|
|
8751
9085
|
export declare interface SafetySetting {
|
|
8752
|
-
/** Required.
|
|
9086
|
+
/** Required. The harm category to be blocked. */
|
|
8753
9087
|
category?: HarmCategory;
|
|
8754
|
-
/** Optional.
|
|
9088
|
+
/** 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
9089
|
method?: HarmBlockMethod;
|
|
8756
|
-
/** Required. The harm
|
|
9090
|
+
/** Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. */
|
|
8757
9091
|
threshold?: HarmBlockThreshold;
|
|
8758
9092
|
}
|
|
8759
9093
|
|
|
@@ -8819,49 +9153,49 @@ export declare enum Scale {
|
|
|
8819
9153
|
object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may
|
|
8820
9154
|
be added in the future as needed. */
|
|
8821
9155
|
export declare interface Schema {
|
|
8822
|
-
/** Optional. The
|
|
9156
|
+
/** Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. */
|
|
8823
9157
|
anyOf?: Schema[];
|
|
8824
|
-
/** Optional. Default value
|
|
9158
|
+
/** Optional. Default value to use if the field is not specified. */
|
|
8825
9159
|
default?: unknown;
|
|
8826
|
-
/** Optional.
|
|
9160
|
+
/** Optional. Description of the schema. */
|
|
8827
9161
|
description?: string;
|
|
8828
|
-
/** Optional. Possible values of the
|
|
9162
|
+
/** 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
9163
|
enum?: string[];
|
|
8830
|
-
/** Optional. Example of
|
|
9164
|
+
/** Optional. Example of an instance of this schema. */
|
|
8831
9165
|
example?: unknown;
|
|
8832
|
-
/** Optional. The format of the data.
|
|
9166
|
+
/** 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
9167
|
format?: string;
|
|
8834
|
-
/** Optional.
|
|
9168
|
+
/** Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. */
|
|
8835
9169
|
items?: Schema;
|
|
8836
|
-
/** Optional.
|
|
9170
|
+
/** Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. */
|
|
8837
9171
|
maxItems?: string;
|
|
8838
|
-
/** Optional.
|
|
9172
|
+
/** Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. */
|
|
8839
9173
|
maxLength?: string;
|
|
8840
|
-
/** Optional.
|
|
9174
|
+
/** Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. */
|
|
8841
9175
|
maxProperties?: string;
|
|
8842
|
-
/** Optional.
|
|
9176
|
+
/** Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. */
|
|
8843
9177
|
maximum?: number;
|
|
8844
|
-
/** Optional.
|
|
9178
|
+
/** Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. */
|
|
8845
9179
|
minItems?: string;
|
|
8846
|
-
/** Optional.
|
|
9180
|
+
/** Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. */
|
|
8847
9181
|
minLength?: string;
|
|
8848
|
-
/** Optional.
|
|
9182
|
+
/** Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. */
|
|
8849
9183
|
minProperties?: string;
|
|
8850
|
-
/** Optional.
|
|
9184
|
+
/** Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. */
|
|
8851
9185
|
minimum?: number;
|
|
8852
|
-
/** Optional. Indicates if the value
|
|
9186
|
+
/** Optional. Indicates if the value of this field can be null. */
|
|
8853
9187
|
nullable?: boolean;
|
|
8854
|
-
/** Optional.
|
|
9188
|
+
/** Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. */
|
|
8855
9189
|
pattern?: string;
|
|
8856
|
-
/** Optional.
|
|
9190
|
+
/** Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. */
|
|
8857
9191
|
properties?: Record<string, Schema>;
|
|
8858
|
-
/** Optional.
|
|
9192
|
+
/** 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
9193
|
propertyOrdering?: string[];
|
|
8860
|
-
/** Optional.
|
|
9194
|
+
/** Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. */
|
|
8861
9195
|
required?: string[];
|
|
8862
|
-
/** Optional.
|
|
9196
|
+
/** Optional. Title for the schema. */
|
|
8863
9197
|
title?: string;
|
|
8864
|
-
/** Optional.
|
|
9198
|
+
/** Optional. Data type of the schema field. */
|
|
8865
9199
|
type?: Type;
|
|
8866
9200
|
}
|
|
8867
9201
|
|
|
@@ -8873,11 +9207,12 @@ export declare interface ScribbleImage {
|
|
|
8873
9207
|
image?: Image_2;
|
|
8874
9208
|
}
|
|
8875
9209
|
|
|
8876
|
-
/**
|
|
9210
|
+
/** The entry point used to search for grounding sources. */
|
|
8877
9211
|
export declare interface SearchEntryPoint {
|
|
8878
|
-
/** Optional. Web content snippet that can be embedded in a web page
|
|
9212
|
+
/** Optional. Web content snippet that can be embedded in a web page
|
|
9213
|
+
or an app webview. */
|
|
8879
9214
|
renderedContent?: string;
|
|
8880
|
-
/** Optional.
|
|
9215
|
+
/** Optional. JSON representing array of tuples.
|
|
8881
9216
|
* @remarks Encoded as base64 string. */
|
|
8882
9217
|
sdkBlob?: string;
|
|
8883
9218
|
}
|
|
@@ -8891,15 +9226,21 @@ export declare interface SearchTypes {
|
|
|
8891
9226
|
imageSearch?: ImageSearch;
|
|
8892
9227
|
}
|
|
8893
9228
|
|
|
8894
|
-
/** Segment of the content. */
|
|
9229
|
+
/** Segment of the content this support belongs to. */
|
|
8895
9230
|
export declare interface Segment {
|
|
8896
|
-
/** Output only.
|
|
9231
|
+
/** Output only. Start index in the given Part, measured in bytes.
|
|
9232
|
+
|
|
9233
|
+
Offset from the start of the Part, inclusive, starting at zero. */
|
|
9234
|
+
startIndex?: number;
|
|
9235
|
+
/** Output only. End index in the given Part, measured in bytes.
|
|
9236
|
+
|
|
9237
|
+
Offset from the start of the Part, exclusive, starting at zero. */
|
|
8897
9238
|
endIndex?: number;
|
|
8898
|
-
/** Output only. The index of a Part object within its parent
|
|
9239
|
+
/** Output only. The index of a Part object within its parent
|
|
9240
|
+
Content object. */
|
|
8899
9241
|
partIndex?: number;
|
|
8900
|
-
/** Output only.
|
|
8901
|
-
|
|
8902
|
-
/** Output only. The text corresponding to the segment from the response. */
|
|
9242
|
+
/** Output only. The text corresponding to the segment from the
|
|
9243
|
+
response. */
|
|
8903
9244
|
text?: string;
|
|
8904
9245
|
}
|
|
8905
9246
|
|
|
@@ -9175,7 +9516,7 @@ export declare interface SlidingWindow {
|
|
|
9175
9516
|
targetTokens?: string;
|
|
9176
9517
|
}
|
|
9177
9518
|
|
|
9178
|
-
/** Configuration for a single speaker in a multi
|
|
9519
|
+
/** Configuration for a single speaker in a multi-speaker setup. */
|
|
9179
9520
|
export declare interface SpeakerVoiceConfig {
|
|
9180
9521
|
/** Required. The name of the speaker. This should be the same as the speaker name used in the prompt. */
|
|
9181
9522
|
speaker?: string;
|
|
@@ -9186,7 +9527,7 @@ export declare interface SpeakerVoiceConfig {
|
|
|
9186
9527
|
export declare interface SpeechConfig {
|
|
9187
9528
|
/** Configuration for the voice of the response. */
|
|
9188
9529
|
voiceConfig?: VoiceConfig;
|
|
9189
|
-
/** Optional.
|
|
9530
|
+
/** Optional. The language code (ISO 639-1) for the speech synthesis. */
|
|
9190
9531
|
languageCode?: string;
|
|
9191
9532
|
/** The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. */
|
|
9192
9533
|
multiSpeakerVoiceConfig?: MultiSpeakerVoiceConfig;
|
|
@@ -9628,16 +9969,19 @@ export declare interface Tool {
|
|
|
9628
9969
|
fileSearch?: FileSearch;
|
|
9629
9970
|
/** Enables the model to execute Google Search as part of generation. */
|
|
9630
9971
|
googleSearch?: GoogleSearch;
|
|
9972
|
+
/** Optional. Tool that allows grounding the model's response with
|
|
9973
|
+
geospatial context related to the user's query. */
|
|
9974
|
+
googleMaps?: GoogleMaps;
|
|
9631
9975
|
/** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
|
|
9632
9976
|
codeExecution?: ToolCodeExecution;
|
|
9633
9977
|
/** 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
9978
|
enterpriseWebSearch?: EnterpriseWebSearch;
|
|
9635
9979
|
/** 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
9980
|
functionDeclarations?: FunctionDeclaration[];
|
|
9637
|
-
/** Optional. GoogleMaps tool type. Tool to support Google Maps in Model. */
|
|
9638
|
-
googleMaps?: GoogleMaps;
|
|
9639
9981
|
/** Optional. Specialized retrieval tool that is powered by Google Search. */
|
|
9640
9982
|
googleSearchRetrieval?: GoogleSearchRetrieval;
|
|
9983
|
+
/** 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. */
|
|
9984
|
+
parallelAiSearch?: ToolParallelAiSearch;
|
|
9641
9985
|
/** Optional. Tool to support URL context retrieval. */
|
|
9642
9986
|
urlContext?: UrlContext;
|
|
9643
9987
|
/** Optional. MCP Servers to connect to. This field is not supported in Vertex AI. */
|
|
@@ -9759,6 +10103,14 @@ export declare interface ToolConfig {
|
|
|
9759
10103
|
|
|
9760
10104
|
export declare type ToolListUnion = ToolUnion[];
|
|
9761
10105
|
|
|
10106
|
+
/** ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. This data type is not supported in Gemini API. */
|
|
10107
|
+
export declare interface ToolParallelAiSearch {
|
|
10108
|
+
/** 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. */
|
|
10109
|
+
apiKey?: string;
|
|
10110
|
+
/** 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 } } */
|
|
10111
|
+
customConfigs?: Record<string, unknown>;
|
|
10112
|
+
}
|
|
10113
|
+
|
|
9762
10114
|
export declare type ToolUnion = Tool | CallableTool;
|
|
9763
10115
|
|
|
9764
10116
|
/** Output only. The traffic type for this request. This enum is not supported in Gemini API. */
|
|
@@ -9771,6 +10123,14 @@ export declare enum TrafficType {
|
|
|
9771
10123
|
* The request was processed using Pay-As-You-Go quota.
|
|
9772
10124
|
*/
|
|
9773
10125
|
ON_DEMAND = "ON_DEMAND",
|
|
10126
|
+
/**
|
|
10127
|
+
* Type for Priority Pay-As-You-Go traffic.
|
|
10128
|
+
*/
|
|
10129
|
+
ON_DEMAND_PRIORITY = "ON_DEMAND_PRIORITY",
|
|
10130
|
+
/**
|
|
10131
|
+
* Type for Flex traffic.
|
|
10132
|
+
*/
|
|
10133
|
+
ON_DEMAND_FLEX = "ON_DEMAND_FLEX",
|
|
9774
10134
|
/**
|
|
9775
10135
|
* Type for Provisioned Throughput traffic.
|
|
9776
10136
|
*/
|
|
@@ -9845,7 +10205,7 @@ export declare interface TuningDataset {
|
|
|
9845
10205
|
|
|
9846
10206
|
/** The tuning data statistic values for TuningJob. This data type is not supported in Gemini API. */
|
|
9847
10207
|
export declare interface TuningDataStats {
|
|
9848
|
-
/** Output only. Statistics for distillation. */
|
|
10208
|
+
/** Output only. Statistics for distillation prompt dataset. These statistics do not include the responses sampled from the teacher model. */
|
|
9849
10209
|
distillationDataStats?: DistillationDataStats;
|
|
9850
10210
|
/** Output only. Statistics for preference optimization. */
|
|
9851
10211
|
preferenceOptimizationDataStats?: PreferenceOptimizationDataStats;
|
|
@@ -9901,8 +10261,12 @@ export declare interface TuningJob {
|
|
|
9901
10261
|
partnerModelTuningSpec?: PartnerModelTuningSpec;
|
|
9902
10262
|
/** 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
10263
|
customBaseModel?: string;
|
|
10264
|
+
/** Output only. Evaluation runs for the Tuning Job. */
|
|
10265
|
+
evaluateDatasetRuns?: EvaluateDatasetRun[];
|
|
9904
10266
|
/** Output only. The Experiment associated with this TuningJob. */
|
|
9905
10267
|
experiment?: string;
|
|
10268
|
+
/** Tuning Spec for Full Fine Tuning. */
|
|
10269
|
+
fullFineTuningSpec?: FullFineTuningSpec;
|
|
9906
10270
|
/** 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
10271
|
labels?: Record<string, string>;
|
|
9908
10272
|
/** 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 +10277,40 @@ export declare interface TuningJob {
|
|
|
9913
10277
|
serviceAccount?: string;
|
|
9914
10278
|
/** 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
10279
|
tunedModelDisplayName?: string;
|
|
10280
|
+
/** Output only. The detail state of the tuning job (while the overall `JobState` is running). */
|
|
10281
|
+
tuningJobState?: TuningJobState;
|
|
9916
10282
|
/** Tuning Spec for Veo Tuning. */
|
|
9917
10283
|
veoTuningSpec?: VeoTuningSpec;
|
|
9918
10284
|
}
|
|
9919
10285
|
|
|
10286
|
+
/** Output only. The detail state of the tuning job (while the overall `JobState` is running). This enum is not supported in Gemini API. */
|
|
10287
|
+
export declare enum TuningJobState {
|
|
10288
|
+
/**
|
|
10289
|
+
* Default tuning job state.
|
|
10290
|
+
*/
|
|
10291
|
+
TUNING_JOB_STATE_UNSPECIFIED = "TUNING_JOB_STATE_UNSPECIFIED",
|
|
10292
|
+
/**
|
|
10293
|
+
* Tuning job is waiting for job quota.
|
|
10294
|
+
*/
|
|
10295
|
+
TUNING_JOB_STATE_WAITING_FOR_QUOTA = "TUNING_JOB_STATE_WAITING_FOR_QUOTA",
|
|
10296
|
+
/**
|
|
10297
|
+
* Tuning job is validating the dataset.
|
|
10298
|
+
*/
|
|
10299
|
+
TUNING_JOB_STATE_PROCESSING_DATASET = "TUNING_JOB_STATE_PROCESSING_DATASET",
|
|
10300
|
+
/**
|
|
10301
|
+
* Tuning job is waiting for hardware capacity.
|
|
10302
|
+
*/
|
|
10303
|
+
TUNING_JOB_STATE_WAITING_FOR_CAPACITY = "TUNING_JOB_STATE_WAITING_FOR_CAPACITY",
|
|
10304
|
+
/**
|
|
10305
|
+
* Tuning job is running.
|
|
10306
|
+
*/
|
|
10307
|
+
TUNING_JOB_STATE_TUNING = "TUNING_JOB_STATE_TUNING",
|
|
10308
|
+
/**
|
|
10309
|
+
* Tuning job is doing some post processing steps.
|
|
10310
|
+
*/
|
|
10311
|
+
TUNING_JOB_STATE_POST_PROCESSING = "TUNING_JOB_STATE_POST_PROCESSING"
|
|
10312
|
+
}
|
|
10313
|
+
|
|
9920
10314
|
/** Enum representing the tuning method. */
|
|
9921
10315
|
export declare enum TuningMethod {
|
|
9922
10316
|
/**
|
|
@@ -10094,7 +10488,7 @@ export declare enum TurnCoverage {
|
|
|
10094
10488
|
TURN_INCLUDES_ALL_INPUT = "TURN_INCLUDES_ALL_INPUT"
|
|
10095
10489
|
}
|
|
10096
10490
|
|
|
10097
|
-
/**
|
|
10491
|
+
/** Data type of the schema field. */
|
|
10098
10492
|
export declare enum Type {
|
|
10099
10493
|
/**
|
|
10100
10494
|
* Not specified, should not be used.
|
|
@@ -10148,13 +10542,14 @@ declare namespace types {
|
|
|
10148
10542
|
FunctionResponseScheduling,
|
|
10149
10543
|
Type,
|
|
10150
10544
|
PhishBlockThreshold,
|
|
10151
|
-
ApiSpec,
|
|
10152
10545
|
AuthType,
|
|
10153
10546
|
HttpElementLocation,
|
|
10547
|
+
ApiSpec,
|
|
10154
10548
|
Behavior,
|
|
10155
10549
|
DynamicRetrievalConfigMode,
|
|
10156
10550
|
FunctionCallingConfigMode,
|
|
10157
10551
|
ThinkingLevel,
|
|
10552
|
+
PersonGeneration,
|
|
10158
10553
|
HarmCategory,
|
|
10159
10554
|
HarmBlockMethod,
|
|
10160
10555
|
HarmBlockThreshold,
|
|
@@ -10169,6 +10564,9 @@ declare namespace types {
|
|
|
10169
10564
|
TuningMode,
|
|
10170
10565
|
AdapterSize,
|
|
10171
10566
|
JobState,
|
|
10567
|
+
TuningJobState,
|
|
10568
|
+
AggregationMetric,
|
|
10569
|
+
PairwiseChoice,
|
|
10172
10570
|
TuningTask,
|
|
10173
10571
|
PartMediaResolutionLevel,
|
|
10174
10572
|
ResourceScope,
|
|
@@ -10177,7 +10575,6 @@ declare namespace types {
|
|
|
10177
10575
|
ProminentPeople,
|
|
10178
10576
|
EmbeddingApiType,
|
|
10179
10577
|
SafetyFilterLevel,
|
|
10180
|
-
PersonGeneration,
|
|
10181
10578
|
ImagePromptLanguage,
|
|
10182
10579
|
MaskReferenceMode,
|
|
10183
10580
|
ControlReferenceType,
|
|
@@ -10227,14 +10624,15 @@ declare namespace types {
|
|
|
10227
10624
|
SearchTypes,
|
|
10228
10625
|
Interval,
|
|
10229
10626
|
GoogleSearch,
|
|
10230
|
-
ApiAuthApiKeyConfig,
|
|
10231
|
-
ApiAuth,
|
|
10232
10627
|
ApiKeyConfig,
|
|
10233
10628
|
AuthConfigGoogleServiceAccountConfig,
|
|
10234
10629
|
AuthConfigHttpBasicAuthConfig,
|
|
10235
10630
|
AuthConfigOauthConfig,
|
|
10236
10631
|
AuthConfigOidcConfig,
|
|
10237
10632
|
AuthConfig,
|
|
10633
|
+
GoogleMaps,
|
|
10634
|
+
ApiAuthApiKeyConfig,
|
|
10635
|
+
ApiAuth,
|
|
10238
10636
|
ExternalApiElasticSearchParams,
|
|
10239
10637
|
ExternalApiSimpleSearchParams,
|
|
10240
10638
|
ExternalApi,
|
|
@@ -10252,9 +10650,9 @@ declare namespace types {
|
|
|
10252
10650
|
ToolCodeExecution,
|
|
10253
10651
|
EnterpriseWebSearch,
|
|
10254
10652
|
FunctionDeclaration,
|
|
10255
|
-
GoogleMaps,
|
|
10256
10653
|
DynamicRetrievalConfig,
|
|
10257
10654
|
GoogleSearchRetrieval,
|
|
10655
|
+
ToolParallelAiSearch,
|
|
10258
10656
|
UrlContext,
|
|
10259
10657
|
StreamableHttpTransport,
|
|
10260
10658
|
McpServer,
|
|
@@ -10271,6 +10669,7 @@ declare namespace types {
|
|
|
10271
10669
|
SpeechConfig,
|
|
10272
10670
|
AutomaticFunctionCallingConfig,
|
|
10273
10671
|
ThinkingConfig,
|
|
10672
|
+
ImageConfigImageOutputOptions,
|
|
10274
10673
|
ImageConfig,
|
|
10275
10674
|
GenerationConfigRoutingConfigAutoRoutingMode,
|
|
10276
10675
|
GenerationConfigRoutingConfigManualRoutingMode,
|
|
@@ -10401,6 +10800,23 @@ declare namespace types {
|
|
|
10401
10800
|
TuningDataStats,
|
|
10402
10801
|
EncryptionSpec,
|
|
10403
10802
|
PartnerModelTuningSpec,
|
|
10803
|
+
BleuMetricValue,
|
|
10804
|
+
CustomCodeExecutionResult,
|
|
10805
|
+
ExactMatchMetricValue,
|
|
10806
|
+
RawOutput,
|
|
10807
|
+
CustomOutput,
|
|
10808
|
+
PairwiseMetricResult,
|
|
10809
|
+
PointwiseMetricResult,
|
|
10810
|
+
RougeMetricValue,
|
|
10811
|
+
AggregationResult,
|
|
10812
|
+
BigQuerySource,
|
|
10813
|
+
GcsSource,
|
|
10814
|
+
EvaluationDataset,
|
|
10815
|
+
AggregationOutput,
|
|
10816
|
+
OutputInfo,
|
|
10817
|
+
EvaluateDatasetResponse,
|
|
10818
|
+
EvaluateDatasetRun,
|
|
10819
|
+
FullFineTuningSpec,
|
|
10404
10820
|
VeoHyperParameters,
|
|
10405
10821
|
VeoTuningSpec,
|
|
10406
10822
|
TuningJob,
|
|
@@ -10904,11 +11320,15 @@ declare interface URLContextCallContent {
|
|
|
10904
11320
|
*/
|
|
10905
11321
|
arguments: URLContextCallArguments;
|
|
10906
11322
|
type: 'url_context_call';
|
|
11323
|
+
/**
|
|
11324
|
+
* A signature hash for backend validation.
|
|
11325
|
+
*/
|
|
11326
|
+
signature?: string;
|
|
10907
11327
|
}
|
|
10908
11328
|
|
|
10909
|
-
/** Metadata
|
|
11329
|
+
/** Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */
|
|
10910
11330
|
export declare interface UrlContextMetadata {
|
|
10911
|
-
/** Output only.
|
|
11331
|
+
/** Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. */
|
|
10912
11332
|
urlMetadata?: UrlMetadata[];
|
|
10913
11333
|
}
|
|
10914
11334
|
|
|
@@ -10944,31 +11364,31 @@ declare interface URLContextResultContent {
|
|
|
10944
11364
|
*/
|
|
10945
11365
|
is_error?: boolean;
|
|
10946
11366
|
/**
|
|
10947
|
-
*
|
|
11367
|
+
* A signature hash for backend validation.
|
|
10948
11368
|
*/
|
|
10949
11369
|
signature?: string;
|
|
10950
11370
|
}
|
|
10951
11371
|
|
|
10952
|
-
/**
|
|
11372
|
+
/** The metadata for a single URL retrieval. */
|
|
10953
11373
|
export declare interface UrlMetadata {
|
|
10954
|
-
/**
|
|
11374
|
+
/** The URL retrieved by the tool. */
|
|
10955
11375
|
retrievedUrl?: string;
|
|
10956
|
-
/**
|
|
11376
|
+
/** The status of the URL retrieval. */
|
|
10957
11377
|
urlRetrievalStatus?: UrlRetrievalStatus;
|
|
10958
11378
|
}
|
|
10959
11379
|
|
|
10960
|
-
/**
|
|
11380
|
+
/** The status of the URL retrieval. */
|
|
10961
11381
|
export declare enum UrlRetrievalStatus {
|
|
10962
11382
|
/**
|
|
10963
11383
|
* Default value. This value is unused.
|
|
10964
11384
|
*/
|
|
10965
11385
|
URL_RETRIEVAL_STATUS_UNSPECIFIED = "URL_RETRIEVAL_STATUS_UNSPECIFIED",
|
|
10966
11386
|
/**
|
|
10967
|
-
*
|
|
11387
|
+
* The URL was retrieved successfully.
|
|
10968
11388
|
*/
|
|
10969
11389
|
URL_RETRIEVAL_STATUS_SUCCESS = "URL_RETRIEVAL_STATUS_SUCCESS",
|
|
10970
11390
|
/**
|
|
10971
|
-
*
|
|
11391
|
+
* The URL retrieval failed.
|
|
10972
11392
|
*/
|
|
10973
11393
|
URL_RETRIEVAL_STATUS_ERROR = "URL_RETRIEVAL_STATUS_ERROR",
|
|
10974
11394
|
/**
|
|
@@ -11134,6 +11554,8 @@ export declare interface VeoHyperParameters {
|
|
|
11134
11554
|
learningRateMultiplier?: number;
|
|
11135
11555
|
/** Optional. The tuning task. Either I2V or T2V. */
|
|
11136
11556
|
tuningTask?: TuningTask;
|
|
11557
|
+
/** 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. */
|
|
11558
|
+
veoDataMixtureRatio?: number;
|
|
11137
11559
|
}
|
|
11138
11560
|
|
|
11139
11561
|
/** Tuning Spec for Veo Model Tuning. This data type is not supported in Gemini API. */
|
|
@@ -11301,11 +11723,11 @@ export declare enum VideoGenerationReferenceType {
|
|
|
11301
11723
|
STYLE = "STYLE"
|
|
11302
11724
|
}
|
|
11303
11725
|
|
|
11304
|
-
/**
|
|
11726
|
+
/** Provides metadata for a video, including the start and end offsets for clipping and the frame rate. */
|
|
11305
11727
|
export declare interface VideoMetadata {
|
|
11306
11728
|
/** Optional. The end offset of the video. */
|
|
11307
11729
|
endOffset?: string;
|
|
11308
|
-
/** Optional. The frame rate of the video sent to the model. If not specified, the default value
|
|
11730
|
+
/** 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
11731
|
fps?: number;
|
|
11310
11732
|
/** Optional. The start offset of the video. */
|
|
11311
11733
|
startOffset?: string;
|
|
@@ -11341,7 +11763,7 @@ export declare enum VoiceActivityType {
|
|
|
11341
11763
|
export declare interface VoiceConfig {
|
|
11342
11764
|
/** If true, the model will use a replicated voice for the response. */
|
|
11343
11765
|
replicatedVoiceConfig?: ReplicatedVoiceConfig;
|
|
11344
|
-
/** The configuration for
|
|
11766
|
+
/** The configuration for a prebuilt voice. */
|
|
11345
11767
|
prebuiltVoiceConfig?: PrebuiltVoiceConfig;
|
|
11346
11768
|
}
|
|
11347
11769
|
|