@google/genai 1.43.0 → 1.45.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/genai.d.ts +629 -257
- package/dist/index.cjs +531 -364
- package/dist/index.mjs +531 -365
- package/dist/index.mjs.map +1 -1
- package/dist/node/index.cjs +532 -365
- package/dist/node/index.mjs +532 -366
- package/dist/node/index.mjs.map +1 -1
- package/dist/node/node.d.ts +629 -257
- 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/vertex_internal/index.cjs +2980 -0
- package/dist/vertex_internal/index.cjs.map +1 -0
- package/dist/vertex_internal/index.d.ts +7960 -0
- package/dist/vertex_internal/index.js +2951 -0
- package/dist/vertex_internal/index.js.map +1 -0
- package/dist/web/index.mjs +531 -365
- package/dist/web/index.mjs.map +1 -1
- package/dist/web/web.d.ts +629 -257
- package/package.json +13 -1
package/dist/web/web.d.ts
CHANGED
|
@@ -66,6 +66,80 @@ export declare enum AdapterSize {
|
|
|
66
66
|
ADAPTER_SIZE_THIRTY_TWO = "ADAPTER_SIZE_THIRTY_TWO"
|
|
67
67
|
}
|
|
68
68
|
|
|
69
|
+
/** Aggregation metric. This enum is not supported in Gemini API. */
|
|
70
|
+
export declare enum AggregationMetric {
|
|
71
|
+
/**
|
|
72
|
+
* Unspecified aggregation metric.
|
|
73
|
+
*/
|
|
74
|
+
AGGREGATION_METRIC_UNSPECIFIED = "AGGREGATION_METRIC_UNSPECIFIED",
|
|
75
|
+
/**
|
|
76
|
+
* Average aggregation metric. Not supported for Pairwise metric.
|
|
77
|
+
*/
|
|
78
|
+
AVERAGE = "AVERAGE",
|
|
79
|
+
/**
|
|
80
|
+
* Mode aggregation metric.
|
|
81
|
+
*/
|
|
82
|
+
MODE = "MODE",
|
|
83
|
+
/**
|
|
84
|
+
* Standard deviation aggregation metric. Not supported for pairwise metric.
|
|
85
|
+
*/
|
|
86
|
+
STANDARD_DEVIATION = "STANDARD_DEVIATION",
|
|
87
|
+
/**
|
|
88
|
+
* Variance aggregation metric. Not supported for pairwise metric.
|
|
89
|
+
*/
|
|
90
|
+
VARIANCE = "VARIANCE",
|
|
91
|
+
/**
|
|
92
|
+
* Minimum aggregation metric. Not supported for pairwise metric.
|
|
93
|
+
*/
|
|
94
|
+
MINIMUM = "MINIMUM",
|
|
95
|
+
/**
|
|
96
|
+
* Maximum aggregation metric. Not supported for pairwise metric.
|
|
97
|
+
*/
|
|
98
|
+
MAXIMUM = "MAXIMUM",
|
|
99
|
+
/**
|
|
100
|
+
* Median aggregation metric. Not supported for pairwise metric.
|
|
101
|
+
*/
|
|
102
|
+
MEDIAN = "MEDIAN",
|
|
103
|
+
/**
|
|
104
|
+
* 90th percentile aggregation metric. Not supported for pairwise metric.
|
|
105
|
+
*/
|
|
106
|
+
PERCENTILE_P90 = "PERCENTILE_P90",
|
|
107
|
+
/**
|
|
108
|
+
* 95th percentile aggregation metric. Not supported for pairwise metric.
|
|
109
|
+
*/
|
|
110
|
+
PERCENTILE_P95 = "PERCENTILE_P95",
|
|
111
|
+
/**
|
|
112
|
+
* 99th percentile aggregation metric. Not supported for pairwise metric.
|
|
113
|
+
*/
|
|
114
|
+
PERCENTILE_P99 = "PERCENTILE_P99"
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
/** The aggregation result for the entire dataset and all metrics. This data type is not supported in Gemini API. */
|
|
118
|
+
export declare interface AggregationOutput {
|
|
119
|
+
/** One AggregationResult per metric. */
|
|
120
|
+
aggregationResults?: AggregationResult[];
|
|
121
|
+
/** The dataset used for evaluation & aggregation. */
|
|
122
|
+
dataset?: EvaluationDataset;
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/** The aggregation result for a single metric. This data type is not supported in Gemini API. */
|
|
126
|
+
export declare interface AggregationResult {
|
|
127
|
+
/** Aggregation metric. */
|
|
128
|
+
aggregationMetric?: AggregationMetric;
|
|
129
|
+
/** Results for bleu metric. */
|
|
130
|
+
bleuMetricValue?: BleuMetricValue;
|
|
131
|
+
/** Result for code execution metric. */
|
|
132
|
+
customCodeExecutionResult?: CustomCodeExecutionResult;
|
|
133
|
+
/** Results for exact match metric. */
|
|
134
|
+
exactMatchMetricValue?: ExactMatchMetricValue;
|
|
135
|
+
/** Result for pairwise metric. */
|
|
136
|
+
pairwiseMetricResult?: PairwiseMetricResult;
|
|
137
|
+
/** Result for pointwise metric. */
|
|
138
|
+
pointwiseMetricResult?: PointwiseMetricResult;
|
|
139
|
+
/** Results for rouge metric. */
|
|
140
|
+
rougeMetricValue?: RougeMetricValue;
|
|
141
|
+
}
|
|
142
|
+
|
|
69
143
|
/**
|
|
70
144
|
* The configuration for allowed tools.
|
|
71
145
|
*/
|
|
@@ -118,6 +192,9 @@ export declare interface ApiAuthApiKeyConfig {
|
|
|
118
192
|
/**
|
|
119
193
|
* The ApiClient class is used to send requests to the Gemini API or Vertex AI
|
|
120
194
|
* endpoints.
|
|
195
|
+
*
|
|
196
|
+
* WARNING: This is an internal API and may change without notice. Direct usage
|
|
197
|
+
* is not supported and may break your application.
|
|
121
198
|
*/
|
|
122
199
|
declare class ApiClient implements GeminiNextGenAPIClientAdapter {
|
|
123
200
|
readonly clientOptions: ApiClientInitOptions;
|
|
@@ -420,6 +497,9 @@ declare interface AudioContent {
|
|
|
420
497
|
|
|
421
498
|
/** The audio transcription configuration in Setup. */
|
|
422
499
|
export declare interface AudioTranscriptionConfig {
|
|
500
|
+
/** The language codes of the audio. BCP-47 language code. If not set, the transcription will be in the language detected by the model. If set, the server will use the language code specified in the model config as a hint for the language of the audio
|
|
501
|
+
*/
|
|
502
|
+
languageCodes?: string[];
|
|
423
503
|
}
|
|
424
504
|
|
|
425
505
|
/**
|
|
@@ -440,8 +520,10 @@ declare interface Auth {
|
|
|
440
520
|
addAuthHeaders(headers: Headers, url?: string): Promise<void>;
|
|
441
521
|
}
|
|
442
522
|
|
|
443
|
-
/**
|
|
523
|
+
/** The authentication config to access the API. */
|
|
444
524
|
export declare interface AuthConfig {
|
|
525
|
+
/** The authentication config to access the API. Only API key is supported. This field is not supported in Gemini API. */
|
|
526
|
+
apiKey?: string;
|
|
445
527
|
/** Config for API key auth. */
|
|
446
528
|
apiKeyConfig?: ApiKeyConfig;
|
|
447
529
|
/** Type of auth scheme. */
|
|
@@ -571,11 +653,11 @@ declare interface BaseCreateAgentInteractionParams {
|
|
|
571
653
|
*/
|
|
572
654
|
agent: (string & {}) | 'deep-research-pro-preview-12-2025';
|
|
573
655
|
/**
|
|
574
|
-
* Body param: The
|
|
656
|
+
* Body param: The input for the interaction.
|
|
575
657
|
*/
|
|
576
|
-
input:
|
|
658
|
+
input: Array<Content_2> | string | Array<Turn> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent | ThoughtContent | FunctionCallContent | FunctionResultContent | CodeExecutionCallContent | CodeExecutionResultContent | URLContextCallContent | URLContextResultContent | GoogleSearchCallContent | GoogleSearchResultContent | MCPServerToolCallContent | MCPServerToolResultContent | FileSearchCallContent | FileSearchResultContent;
|
|
577
659
|
/**
|
|
578
|
-
* Body param: Configuration for the agent.
|
|
660
|
+
* Body param: Configuration parameters for the agent interaction.
|
|
579
661
|
*/
|
|
580
662
|
agent_config?: DynamicAgentConfig | DeepResearchAgentConfig;
|
|
581
663
|
/**
|
|
@@ -623,9 +705,9 @@ declare interface BaseCreateModelInteractionParams {
|
|
|
623
705
|
*/
|
|
624
706
|
api_version?: string;
|
|
625
707
|
/**
|
|
626
|
-
* Body param: The
|
|
708
|
+
* Body param: The input for the interaction.
|
|
627
709
|
*/
|
|
628
|
-
input:
|
|
710
|
+
input: Array<Content_2> | string | Array<Turn> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent | ThoughtContent | FunctionCallContent | FunctionResultContent | CodeExecutionCallContent | CodeExecutionResultContent | URLContextCallContent | URLContextResultContent | GoogleSearchCallContent | GoogleSearchResultContent | MCPServerToolCallContent | MCPServerToolResultContent | FileSearchCallContent | FileSearchResultContent;
|
|
629
711
|
/**
|
|
630
712
|
* Body param: The name of the `Model` used for generating the interaction.
|
|
631
713
|
*/
|
|
@@ -718,7 +800,7 @@ declare class BaseGeminiNextGenAPIClient {
|
|
|
718
800
|
/**
|
|
719
801
|
* Basic re-implementation of `qs.stringify` for primitive types.
|
|
720
802
|
*/
|
|
721
|
-
protected stringifyQuery(query: Record<string, unknown>): string;
|
|
803
|
+
protected stringifyQuery(query: object | Record<string, unknown>): string;
|
|
722
804
|
private getUserAgent;
|
|
723
805
|
protected defaultIdempotencyKey(): string;
|
|
724
806
|
protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
|
|
@@ -772,7 +854,7 @@ declare class BaseInteractions extends APIResource {
|
|
|
772
854
|
* ```ts
|
|
773
855
|
* const interaction = await client.interactions.create({
|
|
774
856
|
* api_version: 'api_version',
|
|
775
|
-
* input: '
|
|
857
|
+
* input: [{ text: 'text', type: 'text' }],
|
|
776
858
|
* model: 'gemini-2.5-flash',
|
|
777
859
|
* });
|
|
778
860
|
* ```
|
|
@@ -1057,12 +1139,24 @@ export declare enum Behavior {
|
|
|
1057
1139
|
NON_BLOCKING = "NON_BLOCKING"
|
|
1058
1140
|
}
|
|
1059
1141
|
|
|
1060
|
-
/**
|
|
1142
|
+
/** The BigQuery location for the input content. This data type is not supported in Gemini API. */
|
|
1143
|
+
export declare interface BigQuerySource {
|
|
1144
|
+
/** Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. */
|
|
1145
|
+
inputUri?: string;
|
|
1146
|
+
}
|
|
1147
|
+
|
|
1148
|
+
/** Bleu metric value for an instance. This data type is not supported in Gemini API. */
|
|
1149
|
+
export declare interface BleuMetricValue {
|
|
1150
|
+
/** Output only. Bleu score. */
|
|
1151
|
+
score?: number;
|
|
1152
|
+
}
|
|
1153
|
+
|
|
1154
|
+
/** A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. */
|
|
1061
1155
|
declare interface Blob_2 {
|
|
1062
|
-
/** Required.
|
|
1156
|
+
/** Required. The raw bytes of the data.
|
|
1063
1157
|
* @remarks Encoded as base64 string. */
|
|
1064
1158
|
data?: string;
|
|
1065
|
-
/** Optional.
|
|
1159
|
+
/** Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. This field is not supported in Gemini API. */
|
|
1066
1160
|
displayName?: string;
|
|
1067
1161
|
/** Required. The IANA standard MIME type of the source data. */
|
|
1068
1162
|
mimeType?: string;
|
|
@@ -1335,15 +1429,15 @@ export declare interface Candidate {
|
|
|
1335
1429
|
contains the sources used to ground the generated content.
|
|
1336
1430
|
*/
|
|
1337
1431
|
groundingMetadata?: GroundingMetadata;
|
|
1338
|
-
/** Output only.
|
|
1432
|
+
/** Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. */
|
|
1339
1433
|
avgLogprobs?: number;
|
|
1340
|
-
/** Output only.
|
|
1434
|
+
/** Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. */
|
|
1341
1435
|
index?: number;
|
|
1342
|
-
/** Output only.
|
|
1436
|
+
/** Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". */
|
|
1343
1437
|
logprobsResult?: LogprobsResult;
|
|
1344
|
-
/** Output only.
|
|
1438
|
+
/** Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. */
|
|
1345
1439
|
safetyRatings?: SafetyRating[];
|
|
1346
|
-
/** Output only. Metadata
|
|
1440
|
+
/** Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */
|
|
1347
1441
|
urlContextMetadata?: UrlContextMetadata;
|
|
1348
1442
|
}
|
|
1349
1443
|
|
|
@@ -1485,19 +1579,19 @@ export declare interface ChunkingConfig {
|
|
|
1485
1579
|
whiteSpaceConfig?: WhiteSpaceConfig;
|
|
1486
1580
|
}
|
|
1487
1581
|
|
|
1488
|
-
/**
|
|
1582
|
+
/** A citation for a piece of generatedcontent. This data type is not supported in Gemini API. */
|
|
1489
1583
|
export declare interface Citation {
|
|
1490
|
-
/** Output only.
|
|
1584
|
+
/** Output only. The end index of the citation in the content. */
|
|
1491
1585
|
endIndex?: number;
|
|
1492
|
-
/** Output only.
|
|
1586
|
+
/** Output only. The license of the source of the citation. */
|
|
1493
1587
|
license?: string;
|
|
1494
|
-
/** Output only.
|
|
1588
|
+
/** Output only. The publication date of the source of the citation. */
|
|
1495
1589
|
publicationDate?: GoogleTypeDate;
|
|
1496
|
-
/** Output only.
|
|
1590
|
+
/** Output only. The start index of the citation in the content. */
|
|
1497
1591
|
startIndex?: number;
|
|
1498
|
-
/** Output only.
|
|
1592
|
+
/** Output only. The title of the source of the citation. */
|
|
1499
1593
|
title?: string;
|
|
1500
|
-
/** Output only.
|
|
1594
|
+
/** Output only. The URI of the source of the citation. */
|
|
1501
1595
|
uri?: string;
|
|
1502
1596
|
}
|
|
1503
1597
|
|
|
@@ -1717,7 +1811,7 @@ export declare interface Content {
|
|
|
1717
1811
|
/** List of parts that constitute a single message. Each part may have
|
|
1718
1812
|
a different IANA MIME type. */
|
|
1719
1813
|
parts?: Part[];
|
|
1720
|
-
/** Optional. The producer of the content. Must be either 'user' or 'model'.
|
|
1814
|
+
/** Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. */
|
|
1721
1815
|
role?: string;
|
|
1722
1816
|
}
|
|
1723
1817
|
|
|
@@ -1780,7 +1874,7 @@ declare namespace ContentDelta {
|
|
|
1780
1874
|
interface ThoughtSummaryDelta {
|
|
1781
1875
|
type: 'thought_summary';
|
|
1782
1876
|
/**
|
|
1783
|
-
* A
|
|
1877
|
+
* A new summary item to be added to the thought.
|
|
1784
1878
|
*/
|
|
1785
1879
|
content?: InteractionsAPI.TextContent | InteractionsAPI.ImageContent;
|
|
1786
1880
|
}
|
|
@@ -1814,6 +1908,10 @@ declare namespace ContentDelta {
|
|
|
1814
1908
|
type: 'function_result';
|
|
1815
1909
|
is_error?: boolean;
|
|
1816
1910
|
name?: string;
|
|
1911
|
+
/**
|
|
1912
|
+
* A signature hash for backend validation.
|
|
1913
|
+
*/
|
|
1914
|
+
signature?: string;
|
|
1817
1915
|
}
|
|
1818
1916
|
namespace FunctionResultDelta {
|
|
1819
1917
|
interface Items {
|
|
@@ -1839,6 +1937,9 @@ declare namespace ContentDelta {
|
|
|
1839
1937
|
result: string;
|
|
1840
1938
|
type: 'code_execution_result';
|
|
1841
1939
|
is_error?: boolean;
|
|
1940
|
+
/**
|
|
1941
|
+
* A signature hash for backend validation.
|
|
1942
|
+
*/
|
|
1842
1943
|
signature?: string;
|
|
1843
1944
|
}
|
|
1844
1945
|
interface URLContextCallDelta {
|
|
@@ -1860,6 +1961,9 @@ declare namespace ContentDelta {
|
|
|
1860
1961
|
result: Array<InteractionsAPI.URLContextResult>;
|
|
1861
1962
|
type: 'url_context_result';
|
|
1862
1963
|
is_error?: boolean;
|
|
1964
|
+
/**
|
|
1965
|
+
* A signature hash for backend validation.
|
|
1966
|
+
*/
|
|
1863
1967
|
signature?: string;
|
|
1864
1968
|
}
|
|
1865
1969
|
interface GoogleSearchCallDelta {
|
|
@@ -1881,6 +1985,9 @@ declare namespace ContentDelta {
|
|
|
1881
1985
|
result: Array<InteractionsAPI.GoogleSearchResult>;
|
|
1882
1986
|
type: 'google_search_result';
|
|
1883
1987
|
is_error?: boolean;
|
|
1988
|
+
/**
|
|
1989
|
+
* A signature hash for backend validation.
|
|
1990
|
+
*/
|
|
1884
1991
|
signature?: string;
|
|
1885
1992
|
}
|
|
1886
1993
|
interface MCPServerToolCallDelta {
|
|
@@ -1907,6 +2014,10 @@ declare namespace ContentDelta {
|
|
|
1907
2014
|
type: 'mcp_server_tool_result';
|
|
1908
2015
|
name?: string;
|
|
1909
2016
|
server_name?: string;
|
|
2017
|
+
/**
|
|
2018
|
+
* A signature hash for backend validation.
|
|
2019
|
+
*/
|
|
2020
|
+
signature?: string;
|
|
1910
2021
|
}
|
|
1911
2022
|
namespace MCPServerToolResultDelta {
|
|
1912
2023
|
interface Items {
|
|
@@ -1921,8 +2032,16 @@ declare namespace ContentDelta {
|
|
|
1921
2032
|
type: 'file_search_call';
|
|
1922
2033
|
}
|
|
1923
2034
|
interface FileSearchResultDelta {
|
|
2035
|
+
/**
|
|
2036
|
+
* ID to match the ID from the function call block.
|
|
2037
|
+
*/
|
|
2038
|
+
call_id: string;
|
|
1924
2039
|
type: 'file_search_result';
|
|
1925
2040
|
result?: Array<FileSearchResultDelta.Result>;
|
|
2041
|
+
/**
|
|
2042
|
+
* A signature hash for backend validation.
|
|
2043
|
+
*/
|
|
2044
|
+
signature?: string;
|
|
1926
2045
|
}
|
|
1927
2046
|
namespace FileSearchResultDelta {
|
|
1928
2047
|
/**
|
|
@@ -2501,6 +2620,12 @@ export declare interface CreateTuningJobParametersPrivate {
|
|
|
2501
2620
|
*/
|
|
2502
2621
|
export declare function createUserContent(partOrString: PartListUnion | string): Content;
|
|
2503
2622
|
|
|
2623
|
+
/** Result for custom code execution metric. This data type is not supported in Gemini API. */
|
|
2624
|
+
export declare interface CustomCodeExecutionResult {
|
|
2625
|
+
/** Output only. Custom code execution score. */
|
|
2626
|
+
score?: number;
|
|
2627
|
+
}
|
|
2628
|
+
|
|
2504
2629
|
/** User provided metadata stored as key-value pairs. This data type is not supported in Vertex AI. */
|
|
2505
2630
|
export declare interface CustomMetadata {
|
|
2506
2631
|
/** Required. The key of the metadata to store. */
|
|
@@ -2513,6 +2638,12 @@ export declare interface CustomMetadata {
|
|
|
2513
2638
|
stringValue?: string;
|
|
2514
2639
|
}
|
|
2515
2640
|
|
|
2641
|
+
/** Spec for custom output. This data type is not supported in Gemini API. */
|
|
2642
|
+
export declare interface CustomOutput {
|
|
2643
|
+
/** Output only. List of raw output strings. */
|
|
2644
|
+
rawOutputs?: RawOutput;
|
|
2645
|
+
}
|
|
2646
|
+
|
|
2516
2647
|
/** Distribution computed over a tuning dataset. This data type is not supported in Gemini API. */
|
|
2517
2648
|
export declare interface DatasetDistribution {
|
|
2518
2649
|
/** Output only. Defines the histogram bucket. */
|
|
@@ -2545,6 +2676,10 @@ export declare interface DatasetDistributionDistributionBucket {
|
|
|
2545
2676
|
|
|
2546
2677
|
/** Statistics computed over a tuning dataset. This data type is not supported in Gemini API. */
|
|
2547
2678
|
export declare interface DatasetStats {
|
|
2679
|
+
/** Output only. A partial sample of the indices (starting from 1) of the dropped examples. */
|
|
2680
|
+
droppedExampleIndices?: string[];
|
|
2681
|
+
/** Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. */
|
|
2682
|
+
droppedExampleReasons?: string[];
|
|
2548
2683
|
/** Output only. Number of billable characters in the tuning dataset. */
|
|
2549
2684
|
totalBillableCharacterCount?: string;
|
|
2550
2685
|
/** Output only. Number of tuning characters in the tuning dataset. */
|
|
@@ -2740,7 +2875,7 @@ export declare interface DeleteResourceJob {
|
|
|
2740
2875
|
error?: JobError;
|
|
2741
2876
|
}
|
|
2742
2877
|
|
|
2743
|
-
/** Statistics
|
|
2878
|
+
/** Statistics for distillation prompt dataset. These statistics do not include the responses sampled from the teacher model. This data type is not supported in Gemini API. */
|
|
2744
2879
|
export declare interface DistillationDataStats {
|
|
2745
2880
|
/** Output only. Statistics computed for the training dataset. */
|
|
2746
2881
|
trainingDatasetStats?: DatasetStats;
|
|
@@ -3132,9 +3267,9 @@ export declare interface EmbeddingsBatchJobSource {
|
|
|
3132
3267
|
inlinedRequests?: EmbedContentBatch;
|
|
3133
3268
|
}
|
|
3134
3269
|
|
|
3135
|
-
/** Represents a customer-managed encryption key
|
|
3270
|
+
/** Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. This data type is not supported in Gemini API. */
|
|
3136
3271
|
export declare interface EncryptionSpec {
|
|
3137
|
-
/** Required.
|
|
3272
|
+
/** Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. */
|
|
3138
3273
|
kmsKeyName?: string;
|
|
3139
3274
|
}
|
|
3140
3275
|
|
|
@@ -3164,10 +3299,10 @@ export declare enum EndSensitivity {
|
|
|
3164
3299
|
|
|
3165
3300
|
/** Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. This data type is not supported in Gemini API. */
|
|
3166
3301
|
export declare interface EnterpriseWebSearch {
|
|
3167
|
-
/** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. */
|
|
3168
|
-
excludeDomains?: string[];
|
|
3169
3302
|
/** Optional. Sites with confidence level chosen & above this value will be blocked from the search results. */
|
|
3170
3303
|
blockingConfidence?: PhishBlockThreshold;
|
|
3304
|
+
/** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. */
|
|
3305
|
+
excludeDomains?: string[];
|
|
3171
3306
|
}
|
|
3172
3307
|
|
|
3173
3308
|
/** An entity representing the segmented area. */
|
|
@@ -3236,6 +3371,42 @@ declare namespace Errors {
|
|
|
3236
3371
|
}
|
|
3237
3372
|
}
|
|
3238
3373
|
|
|
3374
|
+
/** The results from an evaluation run performed by the EvaluationService. This data type is not supported in Gemini API. */
|
|
3375
|
+
export declare class EvaluateDatasetResponse {
|
|
3376
|
+
/** Output only. Aggregation statistics derived from results of EvaluationService. */
|
|
3377
|
+
aggregationOutput?: AggregationOutput;
|
|
3378
|
+
/** Output only. Output info for EvaluationService. */
|
|
3379
|
+
outputInfo?: OutputInfo;
|
|
3380
|
+
}
|
|
3381
|
+
|
|
3382
|
+
/** Evaluate Dataset Run Result for Tuning Job. This data type is not supported in Gemini API. */
|
|
3383
|
+
export declare interface EvaluateDatasetRun {
|
|
3384
|
+
/** Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints. */
|
|
3385
|
+
checkpointId?: string;
|
|
3386
|
+
/** Output only. The error of the evaluation run if any. */
|
|
3387
|
+
error?: GoogleRpcStatus;
|
|
3388
|
+
/** Output only. Results for EvaluationService. */
|
|
3389
|
+
evaluateDatasetResponse?: EvaluateDatasetResponse;
|
|
3390
|
+
/** Output only. The resource name of the evaluation run. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run_id}`. */
|
|
3391
|
+
evaluationRun?: string;
|
|
3392
|
+
/** Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`. */
|
|
3393
|
+
operationName?: string;
|
|
3394
|
+
}
|
|
3395
|
+
|
|
3396
|
+
/** The dataset used for evaluation. This data type is not supported in Gemini API. */
|
|
3397
|
+
export declare interface EvaluationDataset {
|
|
3398
|
+
/** BigQuery source holds the dataset. */
|
|
3399
|
+
bigquerySource?: BigQuerySource;
|
|
3400
|
+
/** Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported. */
|
|
3401
|
+
gcsSource?: GcsSource;
|
|
3402
|
+
}
|
|
3403
|
+
|
|
3404
|
+
/** Exact match metric value for an instance. This data type is not supported in Gemini API. */
|
|
3405
|
+
export declare interface ExactMatchMetricValue {
|
|
3406
|
+
/** Output only. Exact match score. */
|
|
3407
|
+
score?: number;
|
|
3408
|
+
}
|
|
3409
|
+
|
|
3239
3410
|
/** Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. */
|
|
3240
3411
|
export declare interface ExecutableCode {
|
|
3241
3412
|
/** Required. The code to be executed. */
|
|
@@ -3346,11 +3517,11 @@ declare interface File_2 {
|
|
|
3346
3517
|
}
|
|
3347
3518
|
export { File_2 as File }
|
|
3348
3519
|
|
|
3349
|
-
/** URI
|
|
3520
|
+
/** URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. */
|
|
3350
3521
|
export declare interface FileData {
|
|
3351
|
-
/** Optional.
|
|
3522
|
+
/** Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. This field is not supported in Gemini API. */
|
|
3352
3523
|
displayName?: string;
|
|
3353
|
-
/** Required. URI. */
|
|
3524
|
+
/** Required. The URI of the file in Google Cloud Storage. */
|
|
3354
3525
|
fileUri?: string;
|
|
3355
3526
|
/** Required. The IANA standard MIME type of the source data. */
|
|
3356
3527
|
mimeType?: string;
|
|
@@ -3511,6 +3682,10 @@ declare interface FileSearchResultContent {
|
|
|
3511
3682
|
* The results of the File Search.
|
|
3512
3683
|
*/
|
|
3513
3684
|
result?: Array<FileSearchResultContent.Result>;
|
|
3685
|
+
/**
|
|
3686
|
+
* A signature hash for backend validation.
|
|
3687
|
+
*/
|
|
3688
|
+
signature?: string;
|
|
3514
3689
|
}
|
|
3515
3690
|
|
|
3516
3691
|
declare namespace FileSearchResultContent {
|
|
@@ -3769,6 +3944,16 @@ export declare enum FinishReason {
|
|
|
3769
3944
|
IMAGE_OTHER = "IMAGE_OTHER"
|
|
3770
3945
|
}
|
|
3771
3946
|
|
|
3947
|
+
/** Tuning Spec for Full Fine Tuning. This data type is not supported in Gemini API. */
|
|
3948
|
+
export declare interface FullFineTuningSpec {
|
|
3949
|
+
/** Optional. Hyperparameters for Full Fine Tuning. */
|
|
3950
|
+
hyperParameters?: SupervisedHyperParameters;
|
|
3951
|
+
/** Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. */
|
|
3952
|
+
trainingDatasetUri?: string;
|
|
3953
|
+
/** Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. */
|
|
3954
|
+
validationDatasetUri?: string;
|
|
3955
|
+
}
|
|
3956
|
+
|
|
3772
3957
|
/**
|
|
3773
3958
|
* A tool that can be used by the model.
|
|
3774
3959
|
*/
|
|
@@ -3862,7 +4047,7 @@ export declare enum FunctionCallingConfigMode {
|
|
|
3862
4047
|
export declare interface FunctionDeclaration {
|
|
3863
4048
|
/** Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. */
|
|
3864
4049
|
description?: string;
|
|
3865
|
-
/** Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. */
|
|
4050
|
+
/** Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 64. */
|
|
3866
4051
|
name?: string;
|
|
3867
4052
|
/** Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 */
|
|
3868
4053
|
parameters?: Schema;
|
|
@@ -3966,7 +4151,7 @@ declare interface FunctionResultContent {
|
|
|
3966
4151
|
/**
|
|
3967
4152
|
* The result of the tool call.
|
|
3968
4153
|
*/
|
|
3969
|
-
result:
|
|
4154
|
+
result: unknown | Array<TextContent | ImageContent> | string;
|
|
3970
4155
|
type: 'function_result';
|
|
3971
4156
|
/**
|
|
3972
4157
|
* Whether the tool call resulted in an error.
|
|
@@ -3976,12 +4161,16 @@ declare interface FunctionResultContent {
|
|
|
3976
4161
|
* The name of the tool that was called.
|
|
3977
4162
|
*/
|
|
3978
4163
|
name?: string;
|
|
4164
|
+
/**
|
|
4165
|
+
* A signature hash for backend validation.
|
|
4166
|
+
*/
|
|
4167
|
+
signature?: string;
|
|
3979
4168
|
}
|
|
3980
4169
|
|
|
3981
|
-
|
|
3982
|
-
|
|
3983
|
-
|
|
3984
|
-
|
|
4170
|
+
/** The Google Cloud Storage location for the input content. This data type is not supported in Gemini API. */
|
|
4171
|
+
export declare interface GcsSource {
|
|
4172
|
+
/** Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards. */
|
|
4173
|
+
uris?: string[];
|
|
3985
4174
|
}
|
|
3986
4175
|
|
|
3987
4176
|
/**
|
|
@@ -4096,7 +4285,6 @@ export declare interface GenerateContentConfig {
|
|
|
4096
4285
|
- `application/json`: JSON response in the candidates.
|
|
4097
4286
|
The model needs to be prompted to output the appropriate response type,
|
|
4098
4287
|
otherwise the behavior is undefined.
|
|
4099
|
-
This is a preview feature.
|
|
4100
4288
|
*/
|
|
4101
4289
|
responseMimeType?: string;
|
|
4102
4290
|
/** The `Schema` object allows the definition of input and output data types.
|
|
@@ -4619,45 +4807,45 @@ export declare interface GenerationConfig {
|
|
|
4619
4807
|
`response_schema` that accepts [JSON Schema](https://json-schema.org/).
|
|
4620
4808
|
*/
|
|
4621
4809
|
responseJsonSchema?: unknown;
|
|
4622
|
-
/** Optional. If enabled, audio
|
|
4810
|
+
/** Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. This field is not supported in Gemini API. */
|
|
4623
4811
|
audioTimestamp?: boolean;
|
|
4624
|
-
/** Optional.
|
|
4812
|
+
/** Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. */
|
|
4625
4813
|
candidateCount?: number;
|
|
4626
|
-
/** Optional. If enabled, the model will detect emotions and adapt its responses accordingly. This field is not supported in Gemini API. */
|
|
4814
|
+
/** Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. This field is not supported in Gemini API. */
|
|
4627
4815
|
enableAffectiveDialog?: boolean;
|
|
4628
|
-
/** Optional.
|
|
4816
|
+
/** Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. */
|
|
4629
4817
|
frequencyPenalty?: number;
|
|
4630
|
-
/** Optional.
|
|
4818
|
+
/** Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. */
|
|
4631
4819
|
logprobs?: number;
|
|
4632
|
-
/** Optional. The maximum number of
|
|
4820
|
+
/** Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. */
|
|
4633
4821
|
maxOutputTokens?: number;
|
|
4634
|
-
/** Optional.
|
|
4822
|
+
/** Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. */
|
|
4635
4823
|
mediaResolution?: MediaResolution;
|
|
4636
|
-
/** Optional.
|
|
4824
|
+
/** Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. */
|
|
4637
4825
|
presencePenalty?: number;
|
|
4638
|
-
/** Optional. If true,
|
|
4826
|
+
/** Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. */
|
|
4639
4827
|
responseLogprobs?: boolean;
|
|
4640
|
-
/** Optional.
|
|
4828
|
+
/** Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. */
|
|
4641
4829
|
responseMimeType?: string;
|
|
4642
|
-
/** Optional. The modalities of the response. */
|
|
4830
|
+
/** Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. */
|
|
4643
4831
|
responseModalities?: Modality[];
|
|
4644
|
-
/** Optional.
|
|
4832
|
+
/** Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. */
|
|
4645
4833
|
responseSchema?: Schema;
|
|
4646
4834
|
/** Optional. Routing configuration. This field is not supported in Gemini API. */
|
|
4647
4835
|
routingConfig?: GenerationConfigRoutingConfig;
|
|
4648
|
-
/** Optional.
|
|
4836
|
+
/** Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. */
|
|
4649
4837
|
seed?: number;
|
|
4650
4838
|
/** Optional. The speech generation config. */
|
|
4651
4839
|
speechConfig?: SpeechConfig;
|
|
4652
|
-
/** Optional.
|
|
4840
|
+
/** Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. */
|
|
4653
4841
|
stopSequences?: string[];
|
|
4654
|
-
/** Optional. Controls the randomness of
|
|
4842
|
+
/** Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. */
|
|
4655
4843
|
temperature?: number;
|
|
4656
|
-
/** Optional.
|
|
4844
|
+
/** Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. */
|
|
4657
4845
|
thinkingConfig?: ThinkingConfig;
|
|
4658
|
-
/** Optional.
|
|
4846
|
+
/** Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. */
|
|
4659
4847
|
topK?: number;
|
|
4660
|
-
/** Optional.
|
|
4848
|
+
/** Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. */
|
|
4661
4849
|
topP?: number;
|
|
4662
4850
|
/** Optional. Enables enhanced civic answers. It may not be available for all models. This field is not supported in Vertex AI. */
|
|
4663
4851
|
enableEnhancedCivicAnswers?: boolean;
|
|
@@ -4709,23 +4897,23 @@ declare interface GenerationConfig_2 {
|
|
|
4709
4897
|
top_p?: number;
|
|
4710
4898
|
}
|
|
4711
4899
|
|
|
4712
|
-
/** The configuration for routing the request to a specific model. This data type is not supported in Gemini API. */
|
|
4900
|
+
/** The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. This data type is not supported in Gemini API. */
|
|
4713
4901
|
export declare interface GenerationConfigRoutingConfig {
|
|
4714
|
-
/**
|
|
4902
|
+
/** In this mode, the model is selected automatically based on the content of the request. */
|
|
4715
4903
|
autoMode?: GenerationConfigRoutingConfigAutoRoutingMode;
|
|
4716
|
-
/**
|
|
4904
|
+
/** In this mode, the model is specified manually. */
|
|
4717
4905
|
manualMode?: GenerationConfigRoutingConfigManualRoutingMode;
|
|
4718
4906
|
}
|
|
4719
4907
|
|
|
4720
|
-
/** When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. This data type is not supported in Gemini API. */
|
|
4908
|
+
/** The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. This data type is not supported in Gemini API. */
|
|
4721
4909
|
export declare interface GenerationConfigRoutingConfigAutoRoutingMode {
|
|
4722
4910
|
/** The model routing preference. */
|
|
4723
4911
|
modelRoutingPreference?: 'UNKNOWN' | 'PRIORITIZE_QUALITY' | 'BALANCED' | 'PRIORITIZE_COST';
|
|
4724
4912
|
}
|
|
4725
4913
|
|
|
4726
|
-
/** When manual routing is
|
|
4914
|
+
/** The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. This data type is not supported in Gemini API. */
|
|
4727
4915
|
export declare interface GenerationConfigRoutingConfigManualRoutingMode {
|
|
4728
|
-
/** The model
|
|
4916
|
+
/** The name of the model to use. Only public LLM models are accepted. */
|
|
4729
4917
|
modelName?: string;
|
|
4730
4918
|
}
|
|
4731
4919
|
|
|
@@ -5027,11 +5215,11 @@ export declare interface GoogleGenAIOptions {
|
|
|
5027
5215
|
httpOptions?: HttpOptions;
|
|
5028
5216
|
}
|
|
5029
5217
|
|
|
5030
|
-
/** Tool to retrieve
|
|
5218
|
+
/** Tool to retrieve knowledge from Google Maps. */
|
|
5031
5219
|
export declare interface GoogleMaps {
|
|
5032
5220
|
/** The authentication config to access the API. Only API key is supported. This field is not supported in Gemini API. */
|
|
5033
5221
|
authConfig?: AuthConfig;
|
|
5034
|
-
/** Optional.
|
|
5222
|
+
/** 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. */
|
|
5035
5223
|
enableWidget?: boolean;
|
|
5036
5224
|
}
|
|
5037
5225
|
|
|
@@ -5049,10 +5237,10 @@ export declare interface GoogleRpcStatus {
|
|
|
5049
5237
|
export declare interface GoogleSearch {
|
|
5050
5238
|
/** Different types of search that can be enabled on the GoogleSearch tool. */
|
|
5051
5239
|
searchTypes?: SearchTypes;
|
|
5052
|
-
/** 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. */
|
|
5053
|
-
excludeDomains?: string[];
|
|
5054
5240
|
/** Optional. Sites with confidence level chosen & above this value will be blocked from the search results. This field is not supported in Gemini API. */
|
|
5055
5241
|
blockingConfidence?: PhishBlockThreshold;
|
|
5242
|
+
/** 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. */
|
|
5243
|
+
excludeDomains?: string[];
|
|
5056
5244
|
/** 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. */
|
|
5057
5245
|
timeRangeFilter?: Interval;
|
|
5058
5246
|
}
|
|
@@ -5122,7 +5310,7 @@ declare interface GoogleSearchResultContent {
|
|
|
5122
5310
|
*/
|
|
5123
5311
|
is_error?: boolean;
|
|
5124
5312
|
/**
|
|
5125
|
-
*
|
|
5313
|
+
* A signature hash for backend validation.
|
|
5126
5314
|
*/
|
|
5127
5315
|
signature?: string;
|
|
5128
5316
|
}
|
|
@@ -5153,11 +5341,15 @@ export declare interface GroundingChunk {
|
|
|
5153
5341
|
message for details.
|
|
5154
5342
|
*/
|
|
5155
5343
|
image?: GroundingChunkImage;
|
|
5156
|
-
/**
|
|
5344
|
+
/** A `Maps` chunk is a piece of evidence that comes from Google Maps.
|
|
5345
|
+
|
|
5346
|
+
It contains information about a place, such as its name, address, and
|
|
5347
|
+
reviews. This is used to provide the user with rich, location-based
|
|
5348
|
+
information. */
|
|
5157
5349
|
maps?: GroundingChunkMaps;
|
|
5158
|
-
/**
|
|
5350
|
+
/** 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. */
|
|
5159
5351
|
retrievedContext?: GroundingChunkRetrievedContext;
|
|
5160
|
-
/**
|
|
5352
|
+
/** A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. */
|
|
5161
5353
|
web?: GroundingChunkWeb;
|
|
5162
5354
|
}
|
|
5163
5355
|
|
|
@@ -5177,29 +5369,42 @@ export declare interface GroundingChunkImage {
|
|
|
5177
5369
|
domain?: string;
|
|
5178
5370
|
}
|
|
5179
5371
|
|
|
5180
|
-
/**
|
|
5372
|
+
/** A `Maps` chunk is a piece of evidence that comes from Google Maps.
|
|
5373
|
+
|
|
5374
|
+
It contains information about a place, such as its name, address, and reviews.
|
|
5375
|
+
This is used to provide the user with rich, location-based information. */
|
|
5181
5376
|
export declare interface GroundingChunkMaps {
|
|
5182
|
-
/**
|
|
5377
|
+
/** The sources that were used to generate the place answer.
|
|
5378
|
+
|
|
5379
|
+
This includes review snippets and photos that were used to generate the
|
|
5380
|
+
answer, as well as URIs to flag content. */
|
|
5183
5381
|
placeAnswerSources?: GroundingChunkMapsPlaceAnswerSources;
|
|
5184
|
-
/** This Place's resource name, in `places/{place_id}` format.
|
|
5382
|
+
/** This Place's resource name, in `places/{place_id}` format.
|
|
5383
|
+
|
|
5384
|
+
This can be used to look up the place in the Google Maps API. */
|
|
5185
5385
|
placeId?: string;
|
|
5186
|
-
/**
|
|
5386
|
+
/** The text of the place answer. */
|
|
5187
5387
|
text?: string;
|
|
5188
|
-
/**
|
|
5388
|
+
/** The title of the place. */
|
|
5189
5389
|
title?: string;
|
|
5190
|
-
/** URI
|
|
5390
|
+
/** The URI of the place. */
|
|
5191
5391
|
uri?: string;
|
|
5192
5392
|
}
|
|
5193
5393
|
|
|
5194
|
-
/**
|
|
5394
|
+
/** The sources that were used to generate the place answer.
|
|
5395
|
+
|
|
5396
|
+
This includes review snippets and photos that were used to generate the
|
|
5397
|
+
answer, as well as URIs to flag content. */
|
|
5195
5398
|
export declare interface GroundingChunkMapsPlaceAnswerSources {
|
|
5399
|
+
/** Snippets of reviews that were used to generate the answer. */
|
|
5400
|
+
reviewSnippet?: GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
|
|
5196
5401
|
/** A link where users can flag a problem with the generated answer. */
|
|
5197
5402
|
flagContentUri?: string;
|
|
5198
|
-
/** Snippets of reviews that
|
|
5403
|
+
/** Snippets of reviews that were used to generate the answer. */
|
|
5199
5404
|
reviewSnippets?: GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
|
|
5200
5405
|
}
|
|
5201
5406
|
|
|
5202
|
-
/** Author attribution for a photo or review.
|
|
5407
|
+
/** Author attribution for a photo or review. */
|
|
5203
5408
|
export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
|
|
5204
5409
|
/** Name of the author of the Photo or Review. */
|
|
5205
5410
|
displayName?: string;
|
|
@@ -5209,7 +5414,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
|
|
|
5209
5414
|
uri?: string;
|
|
5210
5415
|
}
|
|
5211
5416
|
|
|
5212
|
-
/** Encapsulates a review snippet.
|
|
5417
|
+
/** Encapsulates a review snippet. */
|
|
5213
5418
|
export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
|
|
5214
5419
|
/** This review's author. */
|
|
5215
5420
|
authorAttribution?: GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution;
|
|
@@ -5227,30 +5432,31 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
|
|
|
5227
5432
|
title?: string;
|
|
5228
5433
|
}
|
|
5229
5434
|
|
|
5230
|
-
/**
|
|
5435
|
+
/** 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. */
|
|
5231
5436
|
export declare interface GroundingChunkRetrievedContext {
|
|
5232
|
-
/** Output only. The full
|
|
5437
|
+
/** 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}`. */
|
|
5233
5438
|
documentName?: string;
|
|
5234
|
-
/** Additional context for
|
|
5439
|
+
/** Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. */
|
|
5235
5440
|
ragChunk?: RagChunk;
|
|
5236
|
-
/**
|
|
5441
|
+
/** The content of the retrieved data source. */
|
|
5237
5442
|
text?: string;
|
|
5238
|
-
/**
|
|
5443
|
+
/** The title of the retrieved data source. */
|
|
5239
5444
|
title?: string;
|
|
5240
|
-
/** URI
|
|
5445
|
+
/** The URI of the retrieved data source. */
|
|
5241
5446
|
uri?: string;
|
|
5242
5447
|
}
|
|
5243
5448
|
|
|
5244
|
-
/**
|
|
5449
|
+
/** 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. */
|
|
5245
5450
|
export declare interface GroundingChunkWeb {
|
|
5246
|
-
/**
|
|
5451
|
+
/** 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. */
|
|
5247
5452
|
domain?: string;
|
|
5248
|
-
/**
|
|
5453
|
+
/** The title of the web page that contains the evidence. */
|
|
5249
5454
|
title?: string;
|
|
5250
|
-
/** URI
|
|
5455
|
+
/** The URI of the web page that contains the evidence. */
|
|
5251
5456
|
uri?: string;
|
|
5252
5457
|
}
|
|
5253
5458
|
|
|
5459
|
+
/** Information for various kinds of grounding. */
|
|
5254
5460
|
export declare interface GroundingMetadata {
|
|
5255
5461
|
/** Optional. The image search queries that were used to generate the
|
|
5256
5462
|
content. This field is populated only when the grounding source is Google
|
|
@@ -5262,41 +5468,48 @@ export declare interface GroundingMetadata {
|
|
|
5262
5468
|
Search, Vertex AI Search, or Google Maps.
|
|
5263
5469
|
*/
|
|
5264
5470
|
groundingChunks?: GroundingChunk[];
|
|
5265
|
-
/**
|
|
5266
|
-
googleMapsWidgetContextToken?: string;
|
|
5267
|
-
/** Optional. List of grounding support. */
|
|
5471
|
+
/** List of grounding support. */
|
|
5268
5472
|
groundingSupports?: GroundingSupport[];
|
|
5269
|
-
/**
|
|
5473
|
+
/** Metadata related to retrieval in the grounding flow. */
|
|
5270
5474
|
retrievalMetadata?: RetrievalMetadata;
|
|
5271
|
-
/** Optional.
|
|
5272
|
-
|
|
5273
|
-
/** Optional. Google search entry for the following-up web searches. */
|
|
5475
|
+
/** Optional. Google search entry for the following-up web
|
|
5476
|
+
searches. */
|
|
5274
5477
|
searchEntryPoint?: SearchEntryPoint;
|
|
5275
|
-
/**
|
|
5276
|
-
sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
|
|
5277
|
-
/** Optional. Web search queries for the following-up web search. */
|
|
5478
|
+
/** Web search queries for the following-up web search. */
|
|
5278
5479
|
webSearchQueries?: string[];
|
|
5480
|
+
/** 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. */
|
|
5481
|
+
googleMapsWidgetContextToken?: string;
|
|
5482
|
+
/** 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. */
|
|
5483
|
+
retrievalQueries?: string[];
|
|
5484
|
+
/** 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. */
|
|
5485
|
+
sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
|
|
5279
5486
|
}
|
|
5280
5487
|
|
|
5281
|
-
/**
|
|
5488
|
+
/** 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. */
|
|
5282
5489
|
export declare interface GroundingMetadataSourceFlaggingUri {
|
|
5283
|
-
/**
|
|
5490
|
+
/** The URI that can be used to flag the content. */
|
|
5284
5491
|
flagContentUri?: string;
|
|
5285
|
-
/**
|
|
5492
|
+
/** The ID of the place or review. */
|
|
5286
5493
|
sourceId?: string;
|
|
5287
5494
|
}
|
|
5288
5495
|
|
|
5289
5496
|
/** Grounding support. */
|
|
5290
5497
|
export declare interface GroundingSupport {
|
|
5291
|
-
/** Confidence score of the support references.
|
|
5498
|
+
/** Confidence score of the support references.
|
|
5499
|
+
|
|
5500
|
+
Ranges from 0 to 1. 1 is the most confident. This list must have the
|
|
5501
|
+
same size as the grounding_chunk_indices. */
|
|
5292
5502
|
confidenceScores?: number[];
|
|
5293
|
-
/** A list of indices (into 'grounding_chunk') specifying the
|
|
5503
|
+
/** A list of indices (into 'grounding_chunk') specifying the
|
|
5504
|
+
citations associated with the claim. For instance [1,3,4] means that
|
|
5505
|
+
grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the
|
|
5506
|
+
retrieved content attributed to the claim. */
|
|
5294
5507
|
groundingChunkIndices?: number[];
|
|
5295
5508
|
/** Segment of the content this support belongs to. */
|
|
5296
5509
|
segment?: Segment;
|
|
5297
5510
|
}
|
|
5298
5511
|
|
|
5299
|
-
/**
|
|
5512
|
+
/** 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. */
|
|
5300
5513
|
export declare enum HarmBlockMethod {
|
|
5301
5514
|
/**
|
|
5302
5515
|
* The harm block method is unspecified.
|
|
@@ -5312,54 +5525,54 @@ export declare enum HarmBlockMethod {
|
|
|
5312
5525
|
PROBABILITY = "PROBABILITY"
|
|
5313
5526
|
}
|
|
5314
5527
|
|
|
5315
|
-
/** The harm
|
|
5528
|
+
/** The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. */
|
|
5316
5529
|
export declare enum HarmBlockThreshold {
|
|
5317
5530
|
/**
|
|
5318
|
-
*
|
|
5531
|
+
* The harm block threshold is unspecified.
|
|
5319
5532
|
*/
|
|
5320
5533
|
HARM_BLOCK_THRESHOLD_UNSPECIFIED = "HARM_BLOCK_THRESHOLD_UNSPECIFIED",
|
|
5321
5534
|
/**
|
|
5322
|
-
* Block
|
|
5535
|
+
* Block content with a low harm probability or higher.
|
|
5323
5536
|
*/
|
|
5324
5537
|
BLOCK_LOW_AND_ABOVE = "BLOCK_LOW_AND_ABOVE",
|
|
5325
5538
|
/**
|
|
5326
|
-
* Block medium
|
|
5539
|
+
* Block content with a medium harm probability or higher.
|
|
5327
5540
|
*/
|
|
5328
5541
|
BLOCK_MEDIUM_AND_ABOVE = "BLOCK_MEDIUM_AND_ABOVE",
|
|
5329
5542
|
/**
|
|
5330
|
-
* Block
|
|
5543
|
+
* Block content with a high harm probability.
|
|
5331
5544
|
*/
|
|
5332
5545
|
BLOCK_ONLY_HIGH = "BLOCK_ONLY_HIGH",
|
|
5333
5546
|
/**
|
|
5334
|
-
*
|
|
5547
|
+
* Do not block any content, regardless of its harm probability.
|
|
5335
5548
|
*/
|
|
5336
5549
|
BLOCK_NONE = "BLOCK_NONE",
|
|
5337
5550
|
/**
|
|
5338
|
-
* Turn off the safety filter.
|
|
5551
|
+
* Turn off the safety filter entirely.
|
|
5339
5552
|
*/
|
|
5340
5553
|
OFF = "OFF"
|
|
5341
5554
|
}
|
|
5342
5555
|
|
|
5343
|
-
/**
|
|
5556
|
+
/** The harm category to be blocked. */
|
|
5344
5557
|
export declare enum HarmCategory {
|
|
5345
5558
|
/**
|
|
5346
|
-
*
|
|
5559
|
+
* Default value. This value is unused.
|
|
5347
5560
|
*/
|
|
5348
5561
|
HARM_CATEGORY_UNSPECIFIED = "HARM_CATEGORY_UNSPECIFIED",
|
|
5349
5562
|
/**
|
|
5350
|
-
*
|
|
5563
|
+
* Abusive, threatening, or content intended to bully, torment, or ridicule.
|
|
5351
5564
|
*/
|
|
5352
5565
|
HARM_CATEGORY_HARASSMENT = "HARM_CATEGORY_HARASSMENT",
|
|
5353
5566
|
/**
|
|
5354
|
-
*
|
|
5567
|
+
* Content that promotes violence or incites hatred against individuals or groups based on certain attributes.
|
|
5355
5568
|
*/
|
|
5356
5569
|
HARM_CATEGORY_HATE_SPEECH = "HARM_CATEGORY_HATE_SPEECH",
|
|
5357
5570
|
/**
|
|
5358
|
-
*
|
|
5571
|
+
* Content that contains sexually explicit material.
|
|
5359
5572
|
*/
|
|
5360
5573
|
HARM_CATEGORY_SEXUALLY_EXPLICIT = "HARM_CATEGORY_SEXUALLY_EXPLICIT",
|
|
5361
5574
|
/**
|
|
5362
|
-
*
|
|
5575
|
+
* Content that promotes, facilitates, or enables dangerous activities.
|
|
5363
5576
|
*/
|
|
5364
5577
|
HARM_CATEGORY_DANGEROUS_CONTENT = "HARM_CATEGORY_DANGEROUS_CONTENT",
|
|
5365
5578
|
/**
|
|
@@ -5367,71 +5580,71 @@ export declare enum HarmCategory {
|
|
|
5367
5580
|
*/
|
|
5368
5581
|
HARM_CATEGORY_CIVIC_INTEGRITY = "HARM_CATEGORY_CIVIC_INTEGRITY",
|
|
5369
5582
|
/**
|
|
5370
|
-
*
|
|
5583
|
+
* Images that contain hate speech. This enum value is not supported in Gemini API.
|
|
5371
5584
|
*/
|
|
5372
5585
|
HARM_CATEGORY_IMAGE_HATE = "HARM_CATEGORY_IMAGE_HATE",
|
|
5373
5586
|
/**
|
|
5374
|
-
*
|
|
5587
|
+
* Images that contain dangerous content. This enum value is not supported in Gemini API.
|
|
5375
5588
|
*/
|
|
5376
5589
|
HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT = "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT",
|
|
5377
5590
|
/**
|
|
5378
|
-
*
|
|
5591
|
+
* Images that contain harassment. This enum value is not supported in Gemini API.
|
|
5379
5592
|
*/
|
|
5380
5593
|
HARM_CATEGORY_IMAGE_HARASSMENT = "HARM_CATEGORY_IMAGE_HARASSMENT",
|
|
5381
5594
|
/**
|
|
5382
|
-
*
|
|
5595
|
+
* Images that contain sexually explicit content. This enum value is not supported in Gemini API.
|
|
5383
5596
|
*/
|
|
5384
5597
|
HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT = "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT",
|
|
5385
5598
|
/**
|
|
5386
|
-
*
|
|
5599
|
+
* Prompts designed to bypass safety filters. This enum value is not supported in Gemini API.
|
|
5387
5600
|
*/
|
|
5388
5601
|
HARM_CATEGORY_JAILBREAK = "HARM_CATEGORY_JAILBREAK"
|
|
5389
5602
|
}
|
|
5390
5603
|
|
|
5391
|
-
/** Output only.
|
|
5604
|
+
/** Output only. The probability of harm for this category. */
|
|
5392
5605
|
export declare enum HarmProbability {
|
|
5393
5606
|
/**
|
|
5394
|
-
*
|
|
5607
|
+
* The harm probability is unspecified.
|
|
5395
5608
|
*/
|
|
5396
5609
|
HARM_PROBABILITY_UNSPECIFIED = "HARM_PROBABILITY_UNSPECIFIED",
|
|
5397
5610
|
/**
|
|
5398
|
-
*
|
|
5611
|
+
* The harm probability is negligible.
|
|
5399
5612
|
*/
|
|
5400
5613
|
NEGLIGIBLE = "NEGLIGIBLE",
|
|
5401
5614
|
/**
|
|
5402
|
-
*
|
|
5615
|
+
* The harm probability is low.
|
|
5403
5616
|
*/
|
|
5404
5617
|
LOW = "LOW",
|
|
5405
5618
|
/**
|
|
5406
|
-
*
|
|
5619
|
+
* The harm probability is medium.
|
|
5407
5620
|
*/
|
|
5408
5621
|
MEDIUM = "MEDIUM",
|
|
5409
5622
|
/**
|
|
5410
|
-
*
|
|
5623
|
+
* The harm probability is high.
|
|
5411
5624
|
*/
|
|
5412
5625
|
HIGH = "HIGH"
|
|
5413
5626
|
}
|
|
5414
5627
|
|
|
5415
|
-
/** Output only.
|
|
5628
|
+
/** Output only. The severity of harm for this category. This enum is not supported in Gemini API. */
|
|
5416
5629
|
export declare enum HarmSeverity {
|
|
5417
5630
|
/**
|
|
5418
|
-
*
|
|
5631
|
+
* The harm severity is unspecified.
|
|
5419
5632
|
*/
|
|
5420
5633
|
HARM_SEVERITY_UNSPECIFIED = "HARM_SEVERITY_UNSPECIFIED",
|
|
5421
5634
|
/**
|
|
5422
|
-
*
|
|
5635
|
+
* The harm severity is negligible.
|
|
5423
5636
|
*/
|
|
5424
5637
|
HARM_SEVERITY_NEGLIGIBLE = "HARM_SEVERITY_NEGLIGIBLE",
|
|
5425
5638
|
/**
|
|
5426
|
-
*
|
|
5639
|
+
* The harm severity is low.
|
|
5427
5640
|
*/
|
|
5428
5641
|
HARM_SEVERITY_LOW = "HARM_SEVERITY_LOW",
|
|
5429
5642
|
/**
|
|
5430
|
-
*
|
|
5643
|
+
* The harm severity is medium.
|
|
5431
5644
|
*/
|
|
5432
5645
|
HARM_SEVERITY_MEDIUM = "HARM_SEVERITY_MEDIUM",
|
|
5433
5646
|
/**
|
|
5434
|
-
*
|
|
5647
|
+
* The harm severity is high.
|
|
5435
5648
|
*/
|
|
5436
5649
|
HARM_SEVERITY_HIGH = "HARM_SEVERITY_HIGH"
|
|
5437
5650
|
}
|
|
@@ -5599,6 +5812,8 @@ export declare interface ImageConfig {
|
|
|
5599
5812
|
/** Compression quality of the generated image (for
|
|
5600
5813
|
``image/jpeg`` only). This field is not supported in Gemini API. */
|
|
5601
5814
|
outputCompressionQuality?: number;
|
|
5815
|
+
/** Optional. The image output format for generated images. */
|
|
5816
|
+
imageOutputOptions?: ImageConfigImageOutputOptions;
|
|
5602
5817
|
}
|
|
5603
5818
|
|
|
5604
5819
|
/**
|
|
@@ -5609,6 +5824,14 @@ declare interface ImageConfig_2 {
|
|
|
5609
5824
|
image_size?: '1K' | '2K' | '4K' | '512';
|
|
5610
5825
|
}
|
|
5611
5826
|
|
|
5827
|
+
/** The image output format for generated images. This data type is not supported in Gemini API. */
|
|
5828
|
+
export declare interface ImageConfigImageOutputOptions {
|
|
5829
|
+
/** Optional. The compression quality of the output image. */
|
|
5830
|
+
compressionQuality?: number;
|
|
5831
|
+
/** Optional. The image format that the output should be saved as. */
|
|
5832
|
+
mimeType?: string;
|
|
5833
|
+
}
|
|
5834
|
+
|
|
5612
5835
|
/**
|
|
5613
5836
|
* An image content block.
|
|
5614
5837
|
*/
|
|
@@ -5794,13 +6017,13 @@ declare interface Interaction {
|
|
|
5794
6017
|
*/
|
|
5795
6018
|
agent?: (string & {}) | 'deep-research-pro-preview-12-2025';
|
|
5796
6019
|
/**
|
|
5797
|
-
* Configuration for the agent.
|
|
6020
|
+
* Configuration parameters for the agent interaction.
|
|
5798
6021
|
*/
|
|
5799
6022
|
agent_config?: DynamicAgentConfig | DeepResearchAgentConfig;
|
|
5800
6023
|
/**
|
|
5801
|
-
* The
|
|
6024
|
+
* The input for the interaction.
|
|
5802
6025
|
*/
|
|
5803
|
-
input?:
|
|
6026
|
+
input?: Array<Content_2> | string | Array<Turn> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent | ThoughtContent | FunctionCallContent | FunctionResultContent | CodeExecutionCallContent | CodeExecutionResultContent | URLContextCallContent | URLContextResultContent | GoogleSearchCallContent | GoogleSearchResultContent | MCPServerToolCallContent | MCPServerToolResultContent | FileSearchCallContent | FileSearchResultContent;
|
|
5804
6027
|
/**
|
|
5805
6028
|
* The name of the `Model` used for generating the interaction.
|
|
5806
6029
|
*/
|
|
@@ -6326,9 +6549,9 @@ export declare interface ListTuningJobsParameters {
|
|
|
6326
6549
|
export declare class ListTuningJobsResponse {
|
|
6327
6550
|
/** Used to retain the full HTTP response. */
|
|
6328
6551
|
sdkHttpResponse?: HttpResponse;
|
|
6329
|
-
/** A token to retrieve the next page of results. Pass
|
|
6552
|
+
/** 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. */
|
|
6330
6553
|
nextPageToken?: string;
|
|
6331
|
-
/**
|
|
6554
|
+
/** The tuning jobs that match the request. */
|
|
6332
6555
|
tuningJobs?: TuningJob[];
|
|
6333
6556
|
}
|
|
6334
6557
|
|
|
@@ -7114,27 +7337,27 @@ declare type Logger = {
|
|
|
7114
7337
|
|
|
7115
7338
|
declare type LogLevel = 'off' | 'error' | 'warn' | 'info' | 'debug';
|
|
7116
7339
|
|
|
7117
|
-
/**
|
|
7340
|
+
/** 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. */
|
|
7118
7341
|
export declare interface LogprobsResult {
|
|
7119
|
-
/**
|
|
7342
|
+
/** 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`. */
|
|
7120
7343
|
chosenCandidates?: LogprobsResultCandidate[];
|
|
7121
|
-
/**
|
|
7344
|
+
/** 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. */
|
|
7122
7345
|
topCandidates?: LogprobsResultTopCandidates[];
|
|
7123
7346
|
}
|
|
7124
7347
|
|
|
7125
|
-
/**
|
|
7348
|
+
/** A single token and its associated log probability. */
|
|
7126
7349
|
export declare interface LogprobsResultCandidate {
|
|
7127
|
-
/** The
|
|
7350
|
+
/** 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. */
|
|
7128
7351
|
logProbability?: number;
|
|
7129
|
-
/** The
|
|
7352
|
+
/** The token's string representation. */
|
|
7130
7353
|
token?: string;
|
|
7131
|
-
/** The
|
|
7354
|
+
/** 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. */
|
|
7132
7355
|
tokenId?: number;
|
|
7133
7356
|
}
|
|
7134
7357
|
|
|
7135
|
-
/**
|
|
7358
|
+
/** 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. */
|
|
7136
7359
|
export declare interface LogprobsResultTopCandidates {
|
|
7137
|
-
/**
|
|
7360
|
+
/** The list of candidate tokens, sorted by log probability in descending order. */
|
|
7138
7361
|
candidates?: LogprobsResultCandidate[];
|
|
7139
7362
|
}
|
|
7140
7363
|
|
|
@@ -7224,9 +7447,9 @@ declare interface MCPServerToolResultContent {
|
|
|
7224
7447
|
*/
|
|
7225
7448
|
call_id: string;
|
|
7226
7449
|
/**
|
|
7227
|
-
* The
|
|
7450
|
+
* The output from the MCP server call. Can be simple text or rich content.
|
|
7228
7451
|
*/
|
|
7229
|
-
result:
|
|
7452
|
+
result: unknown | Array<TextContent | ImageContent> | string;
|
|
7230
7453
|
type: 'mcp_server_tool_result';
|
|
7231
7454
|
/**
|
|
7232
7455
|
* Name of the tool which is called for this specific tool call.
|
|
@@ -7236,12 +7459,10 @@ declare interface MCPServerToolResultContent {
|
|
|
7236
7459
|
* The name of the used MCP server.
|
|
7237
7460
|
*/
|
|
7238
7461
|
server_name?: string;
|
|
7239
|
-
|
|
7240
|
-
|
|
7241
|
-
|
|
7242
|
-
|
|
7243
|
-
items?: Array<InteractionsAPI.TextContent | InteractionsAPI.ImageContent>;
|
|
7244
|
-
}
|
|
7462
|
+
/**
|
|
7463
|
+
* A signature hash for backend validation.
|
|
7464
|
+
*/
|
|
7465
|
+
signature?: string;
|
|
7245
7466
|
}
|
|
7246
7467
|
|
|
7247
7468
|
/**
|
|
@@ -7336,7 +7557,7 @@ export declare enum Modality {
|
|
|
7336
7557
|
export declare interface ModalityTokenCount {
|
|
7337
7558
|
/** The modality associated with this token count. */
|
|
7338
7559
|
modality?: MediaModality;
|
|
7339
|
-
/**
|
|
7560
|
+
/** The number of tokens counted for this modality. */
|
|
7340
7561
|
tokenCount?: number;
|
|
7341
7562
|
}
|
|
7342
7563
|
|
|
@@ -7398,13 +7619,13 @@ export declare interface Model {
|
|
|
7398
7619
|
/**
|
|
7399
7620
|
* The model that will complete your prompt.\n\nSee [models](https://ai.google.dev/gemini-api/docs/models) for additional details.
|
|
7400
7621
|
*/
|
|
7401
|
-
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 & {});
|
|
7622
|
+
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 & {});
|
|
7402
7623
|
|
|
7403
|
-
/** Configuration for Model Armor
|
|
7624
|
+
/** 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. */
|
|
7404
7625
|
export declare interface ModelArmorConfig {
|
|
7405
|
-
/** Optional. The name of the Model Armor template to use for prompt
|
|
7626
|
+
/** 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}`. */
|
|
7406
7627
|
promptTemplateName?: string;
|
|
7407
|
-
/** Optional. The name of the Model Armor template to use for response
|
|
7628
|
+
/** 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}`. */
|
|
7408
7629
|
responseTemplateName?: string;
|
|
7409
7630
|
}
|
|
7410
7631
|
|
|
@@ -7951,6 +8172,12 @@ export declare enum Outcome {
|
|
|
7951
8172
|
OUTCOME_DEADLINE_EXCEEDED = "OUTCOME_DEADLINE_EXCEEDED"
|
|
7952
8173
|
}
|
|
7953
8174
|
|
|
8175
|
+
/** Describes the info for output of EvaluationService. This data type is not supported in Gemini API. */
|
|
8176
|
+
export declare interface OutputInfo {
|
|
8177
|
+
/** Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. */
|
|
8178
|
+
gcsOutputDirectory?: string;
|
|
8179
|
+
}
|
|
8180
|
+
|
|
7954
8181
|
/**
|
|
7955
8182
|
* Some environments overload the global fetch function, and Parameters<T> only gets the last signature.
|
|
7956
8183
|
*/
|
|
@@ -8098,6 +8325,36 @@ export declare class Pager<T> implements AsyncIterable<T> {
|
|
|
8098
8325
|
hasNextPage(): boolean;
|
|
8099
8326
|
}
|
|
8100
8327
|
|
|
8328
|
+
/** Output only. Pairwise metric choice. This enum is not supported in Gemini API. */
|
|
8329
|
+
export declare enum PairwiseChoice {
|
|
8330
|
+
/**
|
|
8331
|
+
* Unspecified prediction choice.
|
|
8332
|
+
*/
|
|
8333
|
+
PAIRWISE_CHOICE_UNSPECIFIED = "PAIRWISE_CHOICE_UNSPECIFIED",
|
|
8334
|
+
/**
|
|
8335
|
+
* Baseline prediction wins
|
|
8336
|
+
*/
|
|
8337
|
+
BASELINE = "BASELINE",
|
|
8338
|
+
/**
|
|
8339
|
+
* Candidate prediction wins
|
|
8340
|
+
*/
|
|
8341
|
+
CANDIDATE = "CANDIDATE",
|
|
8342
|
+
/**
|
|
8343
|
+
* Winner cannot be determined
|
|
8344
|
+
*/
|
|
8345
|
+
TIE = "TIE"
|
|
8346
|
+
}
|
|
8347
|
+
|
|
8348
|
+
/** Spec for pairwise metric result. This data type is not supported in Gemini API. */
|
|
8349
|
+
export declare interface PairwiseMetricResult {
|
|
8350
|
+
/** Output only. Spec for custom output. */
|
|
8351
|
+
customOutput?: CustomOutput;
|
|
8352
|
+
/** Output only. Explanation for pairwise metric score. */
|
|
8353
|
+
explanation?: string;
|
|
8354
|
+
/** Output only. Pairwise metric choice. */
|
|
8355
|
+
pairwiseChoice?: PairwiseChoice;
|
|
8356
|
+
}
|
|
8357
|
+
|
|
8101
8358
|
/** A datatype containing media content.
|
|
8102
8359
|
|
|
8103
8360
|
Exactly one field within a Part should be set, representing the specific type
|
|
@@ -8107,21 +8364,21 @@ export declare interface Part {
|
|
|
8107
8364
|
/** Media resolution for the input media.
|
|
8108
8365
|
*/
|
|
8109
8366
|
mediaResolution?: PartMediaResolution;
|
|
8110
|
-
/** Optional.
|
|
8367
|
+
/** Optional. The result of executing the ExecutableCode. */
|
|
8111
8368
|
codeExecutionResult?: CodeExecutionResult;
|
|
8112
|
-
/** Optional. Code generated by the model that is
|
|
8369
|
+
/** Optional. Code generated by the model that is intended to be executed. */
|
|
8113
8370
|
executableCode?: ExecutableCode;
|
|
8114
|
-
/** Optional. URI
|
|
8371
|
+
/** Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. */
|
|
8115
8372
|
fileData?: FileData;
|
|
8116
|
-
/** Optional. A predicted
|
|
8373
|
+
/** 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. */
|
|
8117
8374
|
functionCall?: FunctionCall;
|
|
8118
|
-
/** Optional. The result
|
|
8375
|
+
/** Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. */
|
|
8119
8376
|
functionResponse?: FunctionResponse;
|
|
8120
|
-
/** Optional.
|
|
8377
|
+
/** Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. */
|
|
8121
8378
|
inlineData?: Blob_2;
|
|
8122
|
-
/** Optional.
|
|
8379
|
+
/** 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. */
|
|
8123
8380
|
text?: string;
|
|
8124
|
-
/** Optional. Indicates
|
|
8381
|
+
/** Optional. Indicates whether the `part` represents the model's thought process or reasoning. */
|
|
8125
8382
|
thought?: boolean;
|
|
8126
8383
|
/** Optional. An opaque signature for the thought so it can be reused in subsequent requests.
|
|
8127
8384
|
* @remarks Encoded as base64 string. */
|
|
@@ -8132,16 +8389,16 @@ export declare interface Part {
|
|
|
8132
8389
|
|
|
8133
8390
|
/** Partial argument value of the function call. This data type is not supported in Gemini API. */
|
|
8134
8391
|
export declare interface PartialArg {
|
|
8392
|
+
/** Optional. Represents a boolean value. */
|
|
8393
|
+
boolValue?: boolean;
|
|
8394
|
+
/** Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". */
|
|
8395
|
+
jsonPath?: string;
|
|
8135
8396
|
/** Optional. Represents a null value. */
|
|
8136
8397
|
nullValue?: 'NULL_VALUE';
|
|
8137
8398
|
/** Optional. Represents a double value. */
|
|
8138
8399
|
numberValue?: number;
|
|
8139
8400
|
/** Optional. Represents a string value. */
|
|
8140
8401
|
stringValue?: string;
|
|
8141
|
-
/** Optional. Represents a boolean value. */
|
|
8142
|
-
boolValue?: boolean;
|
|
8143
|
-
/** Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". */
|
|
8144
|
-
jsonPath?: string;
|
|
8145
8402
|
/** 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. */
|
|
8146
8403
|
willContinue?: boolean;
|
|
8147
8404
|
}
|
|
@@ -8245,14 +8502,28 @@ export declare enum PhishBlockThreshold {
|
|
|
8245
8502
|
BLOCK_ONLY_EXTREMELY_HIGH = "BLOCK_ONLY_EXTREMELY_HIGH"
|
|
8246
8503
|
}
|
|
8247
8504
|
|
|
8248
|
-
/**
|
|
8505
|
+
/** Spec for pointwise metric result. This data type is not supported in Gemini API. */
|
|
8506
|
+
export declare interface PointwiseMetricResult {
|
|
8507
|
+
/** Output only. Spec for custom output. */
|
|
8508
|
+
customOutput?: CustomOutput;
|
|
8509
|
+
/** Output only. Explanation for pointwise metric score. */
|
|
8510
|
+
explanation?: string;
|
|
8511
|
+
/** Output only. Pointwise metric score. */
|
|
8512
|
+
score?: number;
|
|
8513
|
+
}
|
|
8514
|
+
|
|
8515
|
+
/** Configuration for a prebuilt voice. */
|
|
8249
8516
|
export declare interface PrebuiltVoiceConfig {
|
|
8250
|
-
/** The name of the
|
|
8517
|
+
/** The name of the prebuilt voice to use. */
|
|
8251
8518
|
voiceName?: string;
|
|
8252
8519
|
}
|
|
8253
8520
|
|
|
8254
8521
|
/** Statistics computed for datasets used for preference optimization. This data type is not supported in Gemini API. */
|
|
8255
8522
|
export declare interface PreferenceOptimizationDataStats {
|
|
8523
|
+
/** Output only. A partial sample of the indices (starting from 1) of the dropped examples. */
|
|
8524
|
+
droppedExampleIndices?: string[];
|
|
8525
|
+
/** Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. */
|
|
8526
|
+
droppedExampleReasons?: string[];
|
|
8256
8527
|
/** Output only. Dataset distributions for scores variance per example. */
|
|
8257
8528
|
scoreVariancePerExampleDistribution?: DatasetDistribution;
|
|
8258
8529
|
/** Output only. Dataset distributions for scores. */
|
|
@@ -8409,6 +8680,12 @@ export declare interface RagRetrievalConfigRankingRankService {
|
|
|
8409
8680
|
declare class RateLimitError extends APIError<429, Headers> {
|
|
8410
8681
|
}
|
|
8411
8682
|
|
|
8683
|
+
/** Raw output. This data type is not supported in Gemini API. */
|
|
8684
|
+
export declare interface RawOutput {
|
|
8685
|
+
/** Output only. Raw output string. */
|
|
8686
|
+
rawOutput?: string[];
|
|
8687
|
+
}
|
|
8688
|
+
|
|
8412
8689
|
/** A raw reference image.
|
|
8413
8690
|
|
|
8414
8691
|
A raw reference image represents the base image to edit, provided by the user.
|
|
@@ -8710,12 +8987,23 @@ export declare interface RetrievalConfig {
|
|
|
8710
8987
|
languageCode?: string;
|
|
8711
8988
|
}
|
|
8712
8989
|
|
|
8713
|
-
/** Metadata
|
|
8990
|
+
/** Metadata returned to client when grounding is enabled. */
|
|
8714
8991
|
export declare interface RetrievalMetadata {
|
|
8715
|
-
/** Optional. Score indicating how likely information from
|
|
8992
|
+
/** Optional. Score indicating how likely information from google
|
|
8993
|
+
search could help answer the prompt. The score is in the range [0, 1],
|
|
8994
|
+
where 0 is the least likely and 1 is the most likely. This score is only
|
|
8995
|
+
populated when google search grounding and dynamic retrieval is enabled.
|
|
8996
|
+
It will be compared to the threshold to determine whether to trigger
|
|
8997
|
+
Google search. */
|
|
8716
8998
|
googleSearchDynamicRetrievalScore?: number;
|
|
8717
8999
|
}
|
|
8718
9000
|
|
|
9001
|
+
/** Rouge metric value for an instance. This data type is not supported in Gemini API. */
|
|
9002
|
+
export declare interface RougeMetricValue {
|
|
9003
|
+
/** Output only. Rouge score. */
|
|
9004
|
+
score?: number;
|
|
9005
|
+
}
|
|
9006
|
+
|
|
8719
9007
|
/** Safety attributes of a GeneratedImage or the user-provided prompt. */
|
|
8720
9008
|
export declare interface SafetyAttributes {
|
|
8721
9009
|
/** List of RAI categories. */
|
|
@@ -8734,31 +9022,31 @@ export declare enum SafetyFilterLevel {
|
|
|
8734
9022
|
BLOCK_NONE = "BLOCK_NONE"
|
|
8735
9023
|
}
|
|
8736
9024
|
|
|
8737
|
-
/**
|
|
9025
|
+
/** A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. */
|
|
8738
9026
|
export declare interface SafetyRating {
|
|
8739
|
-
/** Output only. Indicates whether the content was
|
|
9027
|
+
/** Output only. Indicates whether the content was blocked because of this rating. */
|
|
8740
9028
|
blocked?: boolean;
|
|
8741
|
-
/** Output only.
|
|
9029
|
+
/** Output only. The harm category of this rating. */
|
|
8742
9030
|
category?: HarmCategory;
|
|
8743
9031
|
/** 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. */
|
|
8744
9032
|
overwrittenThreshold?: HarmBlockThreshold;
|
|
8745
|
-
/** Output only.
|
|
9033
|
+
/** Output only. The probability of harm for this category. */
|
|
8746
9034
|
probability?: HarmProbability;
|
|
8747
|
-
/** Output only.
|
|
9035
|
+
/** Output only. The probability score of harm for this category. This field is not supported in Gemini API. */
|
|
8748
9036
|
probabilityScore?: number;
|
|
8749
|
-
/** Output only.
|
|
9037
|
+
/** Output only. The severity of harm for this category. This field is not supported in Gemini API. */
|
|
8750
9038
|
severity?: HarmSeverity;
|
|
8751
|
-
/** Output only.
|
|
9039
|
+
/** Output only. The severity score of harm for this category. This field is not supported in Gemini API. */
|
|
8752
9040
|
severityScore?: number;
|
|
8753
9041
|
}
|
|
8754
9042
|
|
|
8755
|
-
/**
|
|
9043
|
+
/** A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. */
|
|
8756
9044
|
export declare interface SafetySetting {
|
|
8757
|
-
/** Required.
|
|
9045
|
+
/** Required. The harm category to be blocked. */
|
|
8758
9046
|
category?: HarmCategory;
|
|
8759
|
-
/** Optional.
|
|
9047
|
+
/** 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. */
|
|
8760
9048
|
method?: HarmBlockMethod;
|
|
8761
|
-
/** Required. The harm
|
|
9049
|
+
/** Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. */
|
|
8762
9050
|
threshold?: HarmBlockThreshold;
|
|
8763
9051
|
}
|
|
8764
9052
|
|
|
@@ -8824,49 +9112,49 @@ export declare enum Scale {
|
|
|
8824
9112
|
object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may
|
|
8825
9113
|
be added in the future as needed. */
|
|
8826
9114
|
export declare interface Schema {
|
|
8827
|
-
/** Optional. The
|
|
9115
|
+
/** Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. */
|
|
8828
9116
|
anyOf?: Schema[];
|
|
8829
|
-
/** Optional. Default value
|
|
9117
|
+
/** Optional. Default value to use if the field is not specified. */
|
|
8830
9118
|
default?: unknown;
|
|
8831
|
-
/** Optional.
|
|
9119
|
+
/** Optional. Description of the schema. */
|
|
8832
9120
|
description?: string;
|
|
8833
|
-
/** Optional. Possible values of the
|
|
9121
|
+
/** 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"]}` */
|
|
8834
9122
|
enum?: string[];
|
|
8835
|
-
/** Optional. Example of
|
|
9123
|
+
/** Optional. Example of an instance of this schema. */
|
|
8836
9124
|
example?: unknown;
|
|
8837
|
-
/** Optional. The format of the data.
|
|
9125
|
+
/** 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. */
|
|
8838
9126
|
format?: string;
|
|
8839
|
-
/** Optional.
|
|
9127
|
+
/** Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. */
|
|
8840
9128
|
items?: Schema;
|
|
8841
|
-
/** Optional.
|
|
9129
|
+
/** Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. */
|
|
8842
9130
|
maxItems?: string;
|
|
8843
|
-
/** Optional.
|
|
9131
|
+
/** Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. */
|
|
8844
9132
|
maxLength?: string;
|
|
8845
|
-
/** Optional.
|
|
9133
|
+
/** Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. */
|
|
8846
9134
|
maxProperties?: string;
|
|
8847
|
-
/** Optional.
|
|
9135
|
+
/** Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. */
|
|
8848
9136
|
maximum?: number;
|
|
8849
|
-
/** Optional.
|
|
9137
|
+
/** Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. */
|
|
8850
9138
|
minItems?: string;
|
|
8851
|
-
/** Optional.
|
|
9139
|
+
/** Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. */
|
|
8852
9140
|
minLength?: string;
|
|
8853
|
-
/** Optional.
|
|
9141
|
+
/** Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. */
|
|
8854
9142
|
minProperties?: string;
|
|
8855
|
-
/** Optional.
|
|
9143
|
+
/** Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. */
|
|
8856
9144
|
minimum?: number;
|
|
8857
|
-
/** Optional. Indicates if the value
|
|
9145
|
+
/** Optional. Indicates if the value of this field can be null. */
|
|
8858
9146
|
nullable?: boolean;
|
|
8859
|
-
/** Optional.
|
|
9147
|
+
/** Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. */
|
|
8860
9148
|
pattern?: string;
|
|
8861
|
-
/** Optional.
|
|
9149
|
+
/** Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. */
|
|
8862
9150
|
properties?: Record<string, Schema>;
|
|
8863
|
-
/** Optional.
|
|
9151
|
+
/** 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. */
|
|
8864
9152
|
propertyOrdering?: string[];
|
|
8865
|
-
/** Optional.
|
|
9153
|
+
/** Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. */
|
|
8866
9154
|
required?: string[];
|
|
8867
|
-
/** Optional.
|
|
9155
|
+
/** Optional. Title for the schema. */
|
|
8868
9156
|
title?: string;
|
|
8869
|
-
/** Optional.
|
|
9157
|
+
/** Optional. Data type of the schema field. */
|
|
8870
9158
|
type?: Type;
|
|
8871
9159
|
}
|
|
8872
9160
|
|
|
@@ -8878,11 +9166,12 @@ export declare interface ScribbleImage {
|
|
|
8878
9166
|
image?: Image_2;
|
|
8879
9167
|
}
|
|
8880
9168
|
|
|
8881
|
-
/**
|
|
9169
|
+
/** The entry point used to search for grounding sources. */
|
|
8882
9170
|
export declare interface SearchEntryPoint {
|
|
8883
|
-
/** Optional. Web content snippet that can be embedded in a web page
|
|
9171
|
+
/** Optional. Web content snippet that can be embedded in a web page
|
|
9172
|
+
or an app webview. */
|
|
8884
9173
|
renderedContent?: string;
|
|
8885
|
-
/** Optional.
|
|
9174
|
+
/** Optional. JSON representing array of tuples.
|
|
8886
9175
|
* @remarks Encoded as base64 string. */
|
|
8887
9176
|
sdkBlob?: string;
|
|
8888
9177
|
}
|
|
@@ -8896,15 +9185,21 @@ export declare interface SearchTypes {
|
|
|
8896
9185
|
imageSearch?: ImageSearch;
|
|
8897
9186
|
}
|
|
8898
9187
|
|
|
8899
|
-
/** Segment of the content. */
|
|
9188
|
+
/** Segment of the content this support belongs to. */
|
|
8900
9189
|
export declare interface Segment {
|
|
8901
|
-
/** Output only.
|
|
9190
|
+
/** Output only. Start index in the given Part, measured in bytes.
|
|
9191
|
+
|
|
9192
|
+
Offset from the start of the Part, inclusive, starting at zero. */
|
|
9193
|
+
startIndex?: number;
|
|
9194
|
+
/** Output only. End index in the given Part, measured in bytes.
|
|
9195
|
+
|
|
9196
|
+
Offset from the start of the Part, exclusive, starting at zero. */
|
|
8902
9197
|
endIndex?: number;
|
|
8903
|
-
/** Output only. The index of a Part object within its parent
|
|
9198
|
+
/** Output only. The index of a Part object within its parent
|
|
9199
|
+
Content object. */
|
|
8904
9200
|
partIndex?: number;
|
|
8905
|
-
/** Output only.
|
|
8906
|
-
|
|
8907
|
-
/** Output only. The text corresponding to the segment from the response. */
|
|
9201
|
+
/** Output only. The text corresponding to the segment from the
|
|
9202
|
+
response. */
|
|
8908
9203
|
text?: string;
|
|
8909
9204
|
}
|
|
8910
9205
|
|
|
@@ -9180,7 +9475,7 @@ export declare interface SlidingWindow {
|
|
|
9180
9475
|
targetTokens?: string;
|
|
9181
9476
|
}
|
|
9182
9477
|
|
|
9183
|
-
/** Configuration for a single speaker in a multi
|
|
9478
|
+
/** Configuration for a single speaker in a multi-speaker setup. */
|
|
9184
9479
|
export declare interface SpeakerVoiceConfig {
|
|
9185
9480
|
/** Required. The name of the speaker. This should be the same as the speaker name used in the prompt. */
|
|
9186
9481
|
speaker?: string;
|
|
@@ -9191,7 +9486,7 @@ export declare interface SpeakerVoiceConfig {
|
|
|
9191
9486
|
export declare interface SpeechConfig {
|
|
9192
9487
|
/** Configuration for the voice of the response. */
|
|
9193
9488
|
voiceConfig?: VoiceConfig;
|
|
9194
|
-
/** Optional.
|
|
9489
|
+
/** Optional. The language code (ISO 639-1) for the speech synthesis. */
|
|
9195
9490
|
languageCode?: string;
|
|
9196
9491
|
/** The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. */
|
|
9197
9492
|
multiSpeakerVoiceConfig?: MultiSpeakerVoiceConfig;
|
|
@@ -9633,16 +9928,19 @@ export declare interface Tool {
|
|
|
9633
9928
|
fileSearch?: FileSearch;
|
|
9634
9929
|
/** Enables the model to execute Google Search as part of generation. */
|
|
9635
9930
|
googleSearch?: GoogleSearch;
|
|
9931
|
+
/** Optional. Tool that allows grounding the model's response with
|
|
9932
|
+
geospatial context related to the user's query. */
|
|
9933
|
+
googleMaps?: GoogleMaps;
|
|
9636
9934
|
/** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
|
|
9637
9935
|
codeExecution?: ToolCodeExecution;
|
|
9638
9936
|
/** Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. This field is not supported in Gemini API. */
|
|
9639
9937
|
enterpriseWebSearch?: EnterpriseWebSearch;
|
|
9640
9938
|
/** 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. */
|
|
9641
9939
|
functionDeclarations?: FunctionDeclaration[];
|
|
9642
|
-
/** Optional. GoogleMaps tool type. Tool to support Google Maps in Model. */
|
|
9643
|
-
googleMaps?: GoogleMaps;
|
|
9644
9940
|
/** Optional. Specialized retrieval tool that is powered by Google Search. */
|
|
9645
9941
|
googleSearchRetrieval?: GoogleSearchRetrieval;
|
|
9942
|
+
/** 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. */
|
|
9943
|
+
parallelAiSearch?: ToolParallelAiSearch;
|
|
9646
9944
|
/** Optional. Tool to support URL context retrieval. */
|
|
9647
9945
|
urlContext?: UrlContext;
|
|
9648
9946
|
/** Optional. MCP Servers to connect to. This field is not supported in Vertex AI. */
|
|
@@ -9652,19 +9950,9 @@ export declare interface Tool {
|
|
|
9652
9950
|
/**
|
|
9653
9951
|
* A tool that can be used by the model.
|
|
9654
9952
|
*/
|
|
9655
|
-
declare type Tool_2 = Function_2 | Tool_2.
|
|
9953
|
+
declare type Tool_2 = Function_2 | Tool_2.CodeExecution | Tool_2.URLContext | Tool_2.ComputerUse | Tool_2.MCPServer | Tool_2.GoogleSearch | Tool_2.FileSearch;
|
|
9656
9954
|
|
|
9657
9955
|
declare namespace Tool_2 {
|
|
9658
|
-
/**
|
|
9659
|
-
* A tool that can be used by the model to search Google.
|
|
9660
|
-
*/
|
|
9661
|
-
interface GoogleSearch {
|
|
9662
|
-
type: 'google_search';
|
|
9663
|
-
/**
|
|
9664
|
-
* The types of search grounding to enable.
|
|
9665
|
-
*/
|
|
9666
|
-
search_types?: Array<'web_search' | 'image_search'>;
|
|
9667
|
-
}
|
|
9668
9956
|
/**
|
|
9669
9957
|
* A tool that can be used by the model to execute code.
|
|
9670
9958
|
*/
|
|
@@ -9716,6 +10004,16 @@ declare namespace Tool_2 {
|
|
|
9716
10004
|
*/
|
|
9717
10005
|
url?: string;
|
|
9718
10006
|
}
|
|
10007
|
+
/**
|
|
10008
|
+
* A tool that can be used by the model to search Google.
|
|
10009
|
+
*/
|
|
10010
|
+
interface GoogleSearch {
|
|
10011
|
+
type: 'google_search';
|
|
10012
|
+
/**
|
|
10013
|
+
* The types of search grounding to enable.
|
|
10014
|
+
*/
|
|
10015
|
+
search_types?: Array<'web_search' | 'image_search'>;
|
|
10016
|
+
}
|
|
9719
10017
|
/**
|
|
9720
10018
|
* A tool that can be used by the model to search files.
|
|
9721
10019
|
*/
|
|
@@ -9764,6 +10062,14 @@ export declare interface ToolConfig {
|
|
|
9764
10062
|
|
|
9765
10063
|
export declare type ToolListUnion = ToolUnion[];
|
|
9766
10064
|
|
|
10065
|
+
/** ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. This data type is not supported in Gemini API. */
|
|
10066
|
+
export declare interface ToolParallelAiSearch {
|
|
10067
|
+
/** 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. */
|
|
10068
|
+
apiKey?: string;
|
|
10069
|
+
/** 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 } } */
|
|
10070
|
+
customConfigs?: Record<string, unknown>;
|
|
10071
|
+
}
|
|
10072
|
+
|
|
9767
10073
|
export declare type ToolUnion = Tool | CallableTool;
|
|
9768
10074
|
|
|
9769
10075
|
/** Output only. The traffic type for this request. This enum is not supported in Gemini API. */
|
|
@@ -9776,6 +10082,14 @@ export declare enum TrafficType {
|
|
|
9776
10082
|
* The request was processed using Pay-As-You-Go quota.
|
|
9777
10083
|
*/
|
|
9778
10084
|
ON_DEMAND = "ON_DEMAND",
|
|
10085
|
+
/**
|
|
10086
|
+
* Type for Priority Pay-As-You-Go traffic.
|
|
10087
|
+
*/
|
|
10088
|
+
ON_DEMAND_PRIORITY = "ON_DEMAND_PRIORITY",
|
|
10089
|
+
/**
|
|
10090
|
+
* Type for Flex traffic.
|
|
10091
|
+
*/
|
|
10092
|
+
ON_DEMAND_FLEX = "ON_DEMAND_FLEX",
|
|
9779
10093
|
/**
|
|
9780
10094
|
* Type for Provisioned Throughput traffic.
|
|
9781
10095
|
*/
|
|
@@ -9850,7 +10164,7 @@ export declare interface TuningDataset {
|
|
|
9850
10164
|
|
|
9851
10165
|
/** The tuning data statistic values for TuningJob. This data type is not supported in Gemini API. */
|
|
9852
10166
|
export declare interface TuningDataStats {
|
|
9853
|
-
/** Output only. Statistics for distillation. */
|
|
10167
|
+
/** Output only. Statistics for distillation prompt dataset. These statistics do not include the responses sampled from the teacher model. */
|
|
9854
10168
|
distillationDataStats?: DistillationDataStats;
|
|
9855
10169
|
/** Output only. Statistics for preference optimization. */
|
|
9856
10170
|
preferenceOptimizationDataStats?: PreferenceOptimizationDataStats;
|
|
@@ -9906,8 +10220,12 @@ export declare interface TuningJob {
|
|
|
9906
10220
|
partnerModelTuningSpec?: PartnerModelTuningSpec;
|
|
9907
10221
|
/** 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. */
|
|
9908
10222
|
customBaseModel?: string;
|
|
10223
|
+
/** Output only. Evaluation runs for the Tuning Job. */
|
|
10224
|
+
evaluateDatasetRuns?: EvaluateDatasetRun[];
|
|
9909
10225
|
/** Output only. The Experiment associated with this TuningJob. */
|
|
9910
10226
|
experiment?: string;
|
|
10227
|
+
/** Tuning Spec for Full Fine Tuning. */
|
|
10228
|
+
fullFineTuningSpec?: FullFineTuningSpec;
|
|
9911
10229
|
/** 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. */
|
|
9912
10230
|
labels?: Record<string, string>;
|
|
9913
10231
|
/** 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. */
|
|
@@ -9918,10 +10236,40 @@ export declare interface TuningJob {
|
|
|
9918
10236
|
serviceAccount?: string;
|
|
9919
10237
|
/** 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. */
|
|
9920
10238
|
tunedModelDisplayName?: string;
|
|
10239
|
+
/** Output only. The detail state of the tuning job (while the overall `JobState` is running). */
|
|
10240
|
+
tuningJobState?: TuningJobState;
|
|
9921
10241
|
/** Tuning Spec for Veo Tuning. */
|
|
9922
10242
|
veoTuningSpec?: VeoTuningSpec;
|
|
9923
10243
|
}
|
|
9924
10244
|
|
|
10245
|
+
/** Output only. The detail state of the tuning job (while the overall `JobState` is running). This enum is not supported in Gemini API. */
|
|
10246
|
+
export declare enum TuningJobState {
|
|
10247
|
+
/**
|
|
10248
|
+
* Default tuning job state.
|
|
10249
|
+
*/
|
|
10250
|
+
TUNING_JOB_STATE_UNSPECIFIED = "TUNING_JOB_STATE_UNSPECIFIED",
|
|
10251
|
+
/**
|
|
10252
|
+
* Tuning job is waiting for job quota.
|
|
10253
|
+
*/
|
|
10254
|
+
TUNING_JOB_STATE_WAITING_FOR_QUOTA = "TUNING_JOB_STATE_WAITING_FOR_QUOTA",
|
|
10255
|
+
/**
|
|
10256
|
+
* Tuning job is validating the dataset.
|
|
10257
|
+
*/
|
|
10258
|
+
TUNING_JOB_STATE_PROCESSING_DATASET = "TUNING_JOB_STATE_PROCESSING_DATASET",
|
|
10259
|
+
/**
|
|
10260
|
+
* Tuning job is waiting for hardware capacity.
|
|
10261
|
+
*/
|
|
10262
|
+
TUNING_JOB_STATE_WAITING_FOR_CAPACITY = "TUNING_JOB_STATE_WAITING_FOR_CAPACITY",
|
|
10263
|
+
/**
|
|
10264
|
+
* Tuning job is running.
|
|
10265
|
+
*/
|
|
10266
|
+
TUNING_JOB_STATE_TUNING = "TUNING_JOB_STATE_TUNING",
|
|
10267
|
+
/**
|
|
10268
|
+
* Tuning job is doing some post processing steps.
|
|
10269
|
+
*/
|
|
10270
|
+
TUNING_JOB_STATE_POST_PROCESSING = "TUNING_JOB_STATE_POST_PROCESSING"
|
|
10271
|
+
}
|
|
10272
|
+
|
|
9925
10273
|
/** Enum representing the tuning method. */
|
|
9926
10274
|
export declare enum TuningMethod {
|
|
9927
10275
|
/**
|
|
@@ -10099,7 +10447,7 @@ export declare enum TurnCoverage {
|
|
|
10099
10447
|
TURN_INCLUDES_ALL_INPUT = "TURN_INCLUDES_ALL_INPUT"
|
|
10100
10448
|
}
|
|
10101
10449
|
|
|
10102
|
-
/**
|
|
10450
|
+
/** Data type of the schema field. */
|
|
10103
10451
|
export declare enum Type {
|
|
10104
10452
|
/**
|
|
10105
10453
|
* Not specified, should not be used.
|
|
@@ -10153,13 +10501,14 @@ declare namespace types {
|
|
|
10153
10501
|
FunctionResponseScheduling,
|
|
10154
10502
|
Type,
|
|
10155
10503
|
PhishBlockThreshold,
|
|
10156
|
-
ApiSpec,
|
|
10157
10504
|
AuthType,
|
|
10158
10505
|
HttpElementLocation,
|
|
10506
|
+
ApiSpec,
|
|
10159
10507
|
Behavior,
|
|
10160
10508
|
DynamicRetrievalConfigMode,
|
|
10161
10509
|
FunctionCallingConfigMode,
|
|
10162
10510
|
ThinkingLevel,
|
|
10511
|
+
PersonGeneration,
|
|
10163
10512
|
HarmCategory,
|
|
10164
10513
|
HarmBlockMethod,
|
|
10165
10514
|
HarmBlockThreshold,
|
|
@@ -10174,6 +10523,9 @@ declare namespace types {
|
|
|
10174
10523
|
TuningMode,
|
|
10175
10524
|
AdapterSize,
|
|
10176
10525
|
JobState,
|
|
10526
|
+
TuningJobState,
|
|
10527
|
+
AggregationMetric,
|
|
10528
|
+
PairwiseChoice,
|
|
10177
10529
|
TuningTask,
|
|
10178
10530
|
PartMediaResolutionLevel,
|
|
10179
10531
|
ResourceScope,
|
|
@@ -10182,7 +10534,6 @@ declare namespace types {
|
|
|
10182
10534
|
ProminentPeople,
|
|
10183
10535
|
EmbeddingApiType,
|
|
10184
10536
|
SafetyFilterLevel,
|
|
10185
|
-
PersonGeneration,
|
|
10186
10537
|
ImagePromptLanguage,
|
|
10187
10538
|
MaskReferenceMode,
|
|
10188
10539
|
ControlReferenceType,
|
|
@@ -10232,14 +10583,15 @@ declare namespace types {
|
|
|
10232
10583
|
SearchTypes,
|
|
10233
10584
|
Interval,
|
|
10234
10585
|
GoogleSearch,
|
|
10235
|
-
ApiAuthApiKeyConfig,
|
|
10236
|
-
ApiAuth,
|
|
10237
10586
|
ApiKeyConfig,
|
|
10238
10587
|
AuthConfigGoogleServiceAccountConfig,
|
|
10239
10588
|
AuthConfigHttpBasicAuthConfig,
|
|
10240
10589
|
AuthConfigOauthConfig,
|
|
10241
10590
|
AuthConfigOidcConfig,
|
|
10242
10591
|
AuthConfig,
|
|
10592
|
+
GoogleMaps,
|
|
10593
|
+
ApiAuthApiKeyConfig,
|
|
10594
|
+
ApiAuth,
|
|
10243
10595
|
ExternalApiElasticSearchParams,
|
|
10244
10596
|
ExternalApiSimpleSearchParams,
|
|
10245
10597
|
ExternalApi,
|
|
@@ -10257,9 +10609,9 @@ declare namespace types {
|
|
|
10257
10609
|
ToolCodeExecution,
|
|
10258
10610
|
EnterpriseWebSearch,
|
|
10259
10611
|
FunctionDeclaration,
|
|
10260
|
-
GoogleMaps,
|
|
10261
10612
|
DynamicRetrievalConfig,
|
|
10262
10613
|
GoogleSearchRetrieval,
|
|
10614
|
+
ToolParallelAiSearch,
|
|
10263
10615
|
UrlContext,
|
|
10264
10616
|
StreamableHttpTransport,
|
|
10265
10617
|
McpServer,
|
|
@@ -10276,6 +10628,7 @@ declare namespace types {
|
|
|
10276
10628
|
SpeechConfig,
|
|
10277
10629
|
AutomaticFunctionCallingConfig,
|
|
10278
10630
|
ThinkingConfig,
|
|
10631
|
+
ImageConfigImageOutputOptions,
|
|
10279
10632
|
ImageConfig,
|
|
10280
10633
|
GenerationConfigRoutingConfigAutoRoutingMode,
|
|
10281
10634
|
GenerationConfigRoutingConfigManualRoutingMode,
|
|
@@ -10406,6 +10759,23 @@ declare namespace types {
|
|
|
10406
10759
|
TuningDataStats,
|
|
10407
10760
|
EncryptionSpec,
|
|
10408
10761
|
PartnerModelTuningSpec,
|
|
10762
|
+
BleuMetricValue,
|
|
10763
|
+
CustomCodeExecutionResult,
|
|
10764
|
+
ExactMatchMetricValue,
|
|
10765
|
+
RawOutput,
|
|
10766
|
+
CustomOutput,
|
|
10767
|
+
PairwiseMetricResult,
|
|
10768
|
+
PointwiseMetricResult,
|
|
10769
|
+
RougeMetricValue,
|
|
10770
|
+
AggregationResult,
|
|
10771
|
+
BigQuerySource,
|
|
10772
|
+
GcsSource,
|
|
10773
|
+
EvaluationDataset,
|
|
10774
|
+
AggregationOutput,
|
|
10775
|
+
OutputInfo,
|
|
10776
|
+
EvaluateDatasetResponse,
|
|
10777
|
+
EvaluateDatasetRun,
|
|
10778
|
+
FullFineTuningSpec,
|
|
10409
10779
|
VeoHyperParameters,
|
|
10410
10780
|
VeoTuningSpec,
|
|
10411
10781
|
TuningJob,
|
|
@@ -10911,9 +11281,9 @@ declare interface URLContextCallContent {
|
|
|
10911
11281
|
type: 'url_context_call';
|
|
10912
11282
|
}
|
|
10913
11283
|
|
|
10914
|
-
/** Metadata
|
|
11284
|
+
/** Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */
|
|
10915
11285
|
export declare interface UrlContextMetadata {
|
|
10916
|
-
/** Output only.
|
|
11286
|
+
/** Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. */
|
|
10917
11287
|
urlMetadata?: UrlMetadata[];
|
|
10918
11288
|
}
|
|
10919
11289
|
|
|
@@ -10949,31 +11319,31 @@ declare interface URLContextResultContent {
|
|
|
10949
11319
|
*/
|
|
10950
11320
|
is_error?: boolean;
|
|
10951
11321
|
/**
|
|
10952
|
-
*
|
|
11322
|
+
* A signature hash for backend validation.
|
|
10953
11323
|
*/
|
|
10954
11324
|
signature?: string;
|
|
10955
11325
|
}
|
|
10956
11326
|
|
|
10957
|
-
/**
|
|
11327
|
+
/** The metadata for a single URL retrieval. */
|
|
10958
11328
|
export declare interface UrlMetadata {
|
|
10959
|
-
/**
|
|
11329
|
+
/** The URL retrieved by the tool. */
|
|
10960
11330
|
retrievedUrl?: string;
|
|
10961
|
-
/**
|
|
11331
|
+
/** The status of the URL retrieval. */
|
|
10962
11332
|
urlRetrievalStatus?: UrlRetrievalStatus;
|
|
10963
11333
|
}
|
|
10964
11334
|
|
|
10965
|
-
/**
|
|
11335
|
+
/** The status of the URL retrieval. */
|
|
10966
11336
|
export declare enum UrlRetrievalStatus {
|
|
10967
11337
|
/**
|
|
10968
11338
|
* Default value. This value is unused.
|
|
10969
11339
|
*/
|
|
10970
11340
|
URL_RETRIEVAL_STATUS_UNSPECIFIED = "URL_RETRIEVAL_STATUS_UNSPECIFIED",
|
|
10971
11341
|
/**
|
|
10972
|
-
*
|
|
11342
|
+
* The URL was retrieved successfully.
|
|
10973
11343
|
*/
|
|
10974
11344
|
URL_RETRIEVAL_STATUS_SUCCESS = "URL_RETRIEVAL_STATUS_SUCCESS",
|
|
10975
11345
|
/**
|
|
10976
|
-
*
|
|
11346
|
+
* The URL retrieval failed.
|
|
10977
11347
|
*/
|
|
10978
11348
|
URL_RETRIEVAL_STATUS_ERROR = "URL_RETRIEVAL_STATUS_ERROR",
|
|
10979
11349
|
/**
|
|
@@ -11139,6 +11509,8 @@ export declare interface VeoHyperParameters {
|
|
|
11139
11509
|
learningRateMultiplier?: number;
|
|
11140
11510
|
/** Optional. The tuning task. Either I2V or T2V. */
|
|
11141
11511
|
tuningTask?: TuningTask;
|
|
11512
|
+
/** 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. */
|
|
11513
|
+
veoDataMixtureRatio?: number;
|
|
11142
11514
|
}
|
|
11143
11515
|
|
|
11144
11516
|
/** Tuning Spec for Veo Model Tuning. This data type is not supported in Gemini API. */
|
|
@@ -11306,11 +11678,11 @@ export declare enum VideoGenerationReferenceType {
|
|
|
11306
11678
|
STYLE = "STYLE"
|
|
11307
11679
|
}
|
|
11308
11680
|
|
|
11309
|
-
/**
|
|
11681
|
+
/** Provides metadata for a video, including the start and end offsets for clipping and the frame rate. */
|
|
11310
11682
|
export declare interface VideoMetadata {
|
|
11311
11683
|
/** Optional. The end offset of the video. */
|
|
11312
11684
|
endOffset?: string;
|
|
11313
|
-
/** Optional. The frame rate of the video sent to the model. If not specified, the default value
|
|
11685
|
+
/** 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]. */
|
|
11314
11686
|
fps?: number;
|
|
11315
11687
|
/** Optional. The start offset of the video. */
|
|
11316
11688
|
startOffset?: string;
|
|
@@ -11346,7 +11718,7 @@ export declare enum VoiceActivityType {
|
|
|
11346
11718
|
export declare interface VoiceConfig {
|
|
11347
11719
|
/** If true, the model will use a replicated voice for the response. */
|
|
11348
11720
|
replicatedVoiceConfig?: ReplicatedVoiceConfig;
|
|
11349
|
-
/** The configuration for
|
|
11721
|
+
/** The configuration for a prebuilt voice. */
|
|
11350
11722
|
prebuiltVoiceConfig?: PrebuiltVoiceConfig;
|
|
11351
11723
|
}
|
|
11352
11724
|
|