@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/node/node.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
|
|
|
@@ -5034,11 +5222,11 @@ export declare interface GoogleGenAIOptions {
|
|
|
5034
5222
|
httpOptions?: HttpOptions;
|
|
5035
5223
|
}
|
|
5036
5224
|
|
|
5037
|
-
/** Tool to retrieve
|
|
5225
|
+
/** Tool to retrieve knowledge from Google Maps. */
|
|
5038
5226
|
export declare interface GoogleMaps {
|
|
5039
5227
|
/** The authentication config to access the API. Only API key is supported. This field is not supported in Gemini API. */
|
|
5040
5228
|
authConfig?: AuthConfig;
|
|
5041
|
-
/** Optional.
|
|
5229
|
+
/** 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. */
|
|
5042
5230
|
enableWidget?: boolean;
|
|
5043
5231
|
}
|
|
5044
5232
|
|
|
@@ -5056,10 +5244,10 @@ export declare interface GoogleRpcStatus {
|
|
|
5056
5244
|
export declare interface GoogleSearch {
|
|
5057
5245
|
/** Different types of search that can be enabled on the GoogleSearch tool. */
|
|
5058
5246
|
searchTypes?: SearchTypes;
|
|
5059
|
-
/** 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. */
|
|
5060
|
-
excludeDomains?: string[];
|
|
5061
5247
|
/** Optional. Sites with confidence level chosen & above this value will be blocked from the search results. This field is not supported in Gemini API. */
|
|
5062
5248
|
blockingConfidence?: PhishBlockThreshold;
|
|
5249
|
+
/** 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. */
|
|
5250
|
+
excludeDomains?: string[];
|
|
5063
5251
|
/** 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. */
|
|
5064
5252
|
timeRangeFilter?: Interval;
|
|
5065
5253
|
}
|
|
@@ -5129,7 +5317,7 @@ declare interface GoogleSearchResultContent {
|
|
|
5129
5317
|
*/
|
|
5130
5318
|
is_error?: boolean;
|
|
5131
5319
|
/**
|
|
5132
|
-
*
|
|
5320
|
+
* A signature hash for backend validation.
|
|
5133
5321
|
*/
|
|
5134
5322
|
signature?: string;
|
|
5135
5323
|
}
|
|
@@ -5160,11 +5348,15 @@ export declare interface GroundingChunk {
|
|
|
5160
5348
|
message for details.
|
|
5161
5349
|
*/
|
|
5162
5350
|
image?: GroundingChunkImage;
|
|
5163
|
-
/**
|
|
5351
|
+
/** A `Maps` chunk is a piece of evidence that comes from Google Maps.
|
|
5352
|
+
|
|
5353
|
+
It contains information about a place, such as its name, address, and
|
|
5354
|
+
reviews. This is used to provide the user with rich, location-based
|
|
5355
|
+
information. */
|
|
5164
5356
|
maps?: GroundingChunkMaps;
|
|
5165
|
-
/**
|
|
5357
|
+
/** 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. */
|
|
5166
5358
|
retrievedContext?: GroundingChunkRetrievedContext;
|
|
5167
|
-
/**
|
|
5359
|
+
/** A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. */
|
|
5168
5360
|
web?: GroundingChunkWeb;
|
|
5169
5361
|
}
|
|
5170
5362
|
|
|
@@ -5184,29 +5376,42 @@ export declare interface GroundingChunkImage {
|
|
|
5184
5376
|
domain?: string;
|
|
5185
5377
|
}
|
|
5186
5378
|
|
|
5187
|
-
/**
|
|
5379
|
+
/** A `Maps` chunk is a piece of evidence that comes from Google Maps.
|
|
5380
|
+
|
|
5381
|
+
It contains information about a place, such as its name, address, and reviews.
|
|
5382
|
+
This is used to provide the user with rich, location-based information. */
|
|
5188
5383
|
export declare interface GroundingChunkMaps {
|
|
5189
|
-
/**
|
|
5384
|
+
/** The sources that were used to generate the place answer.
|
|
5385
|
+
|
|
5386
|
+
This includes review snippets and photos that were used to generate the
|
|
5387
|
+
answer, as well as URIs to flag content. */
|
|
5190
5388
|
placeAnswerSources?: GroundingChunkMapsPlaceAnswerSources;
|
|
5191
|
-
/** This Place's resource name, in `places/{place_id}` format.
|
|
5389
|
+
/** This Place's resource name, in `places/{place_id}` format.
|
|
5390
|
+
|
|
5391
|
+
This can be used to look up the place in the Google Maps API. */
|
|
5192
5392
|
placeId?: string;
|
|
5193
|
-
/**
|
|
5393
|
+
/** The text of the place answer. */
|
|
5194
5394
|
text?: string;
|
|
5195
|
-
/**
|
|
5395
|
+
/** The title of the place. */
|
|
5196
5396
|
title?: string;
|
|
5197
|
-
/** URI
|
|
5397
|
+
/** The URI of the place. */
|
|
5198
5398
|
uri?: string;
|
|
5199
5399
|
}
|
|
5200
5400
|
|
|
5201
|
-
/**
|
|
5401
|
+
/** The sources that were used to generate the place answer.
|
|
5402
|
+
|
|
5403
|
+
This includes review snippets and photos that were used to generate the
|
|
5404
|
+
answer, as well as URIs to flag content. */
|
|
5202
5405
|
export declare interface GroundingChunkMapsPlaceAnswerSources {
|
|
5406
|
+
/** Snippets of reviews that were used to generate the answer. */
|
|
5407
|
+
reviewSnippet?: GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
|
|
5203
5408
|
/** A link where users can flag a problem with the generated answer. */
|
|
5204
5409
|
flagContentUri?: string;
|
|
5205
|
-
/** Snippets of reviews that
|
|
5410
|
+
/** Snippets of reviews that were used to generate the answer. */
|
|
5206
5411
|
reviewSnippets?: GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[];
|
|
5207
5412
|
}
|
|
5208
5413
|
|
|
5209
|
-
/** Author attribution for a photo or review.
|
|
5414
|
+
/** Author attribution for a photo or review. */
|
|
5210
5415
|
export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
|
|
5211
5416
|
/** Name of the author of the Photo or Review. */
|
|
5212
5417
|
displayName?: string;
|
|
@@ -5216,7 +5421,7 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution {
|
|
|
5216
5421
|
uri?: string;
|
|
5217
5422
|
}
|
|
5218
5423
|
|
|
5219
|
-
/** Encapsulates a review snippet.
|
|
5424
|
+
/** Encapsulates a review snippet. */
|
|
5220
5425
|
export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
|
|
5221
5426
|
/** This review's author. */
|
|
5222
5427
|
authorAttribution?: GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution;
|
|
@@ -5234,30 +5439,31 @@ export declare interface GroundingChunkMapsPlaceAnswerSourcesReviewSnippet {
|
|
|
5234
5439
|
title?: string;
|
|
5235
5440
|
}
|
|
5236
5441
|
|
|
5237
|
-
/**
|
|
5442
|
+
/** 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. */
|
|
5238
5443
|
export declare interface GroundingChunkRetrievedContext {
|
|
5239
|
-
/** Output only. The full
|
|
5444
|
+
/** 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}`. */
|
|
5240
5445
|
documentName?: string;
|
|
5241
|
-
/** Additional context for
|
|
5446
|
+
/** Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. */
|
|
5242
5447
|
ragChunk?: RagChunk;
|
|
5243
|
-
/**
|
|
5448
|
+
/** The content of the retrieved data source. */
|
|
5244
5449
|
text?: string;
|
|
5245
|
-
/**
|
|
5450
|
+
/** The title of the retrieved data source. */
|
|
5246
5451
|
title?: string;
|
|
5247
|
-
/** URI
|
|
5452
|
+
/** The URI of the retrieved data source. */
|
|
5248
5453
|
uri?: string;
|
|
5249
5454
|
}
|
|
5250
5455
|
|
|
5251
|
-
/**
|
|
5456
|
+
/** 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. */
|
|
5252
5457
|
export declare interface GroundingChunkWeb {
|
|
5253
|
-
/**
|
|
5458
|
+
/** 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. */
|
|
5254
5459
|
domain?: string;
|
|
5255
|
-
/**
|
|
5460
|
+
/** The title of the web page that contains the evidence. */
|
|
5256
5461
|
title?: string;
|
|
5257
|
-
/** URI
|
|
5462
|
+
/** The URI of the web page that contains the evidence. */
|
|
5258
5463
|
uri?: string;
|
|
5259
5464
|
}
|
|
5260
5465
|
|
|
5466
|
+
/** Information for various kinds of grounding. */
|
|
5261
5467
|
export declare interface GroundingMetadata {
|
|
5262
5468
|
/** Optional. The image search queries that were used to generate the
|
|
5263
5469
|
content. This field is populated only when the grounding source is Google
|
|
@@ -5269,41 +5475,48 @@ export declare interface GroundingMetadata {
|
|
|
5269
5475
|
Search, Vertex AI Search, or Google Maps.
|
|
5270
5476
|
*/
|
|
5271
5477
|
groundingChunks?: GroundingChunk[];
|
|
5272
|
-
/**
|
|
5273
|
-
googleMapsWidgetContextToken?: string;
|
|
5274
|
-
/** Optional. List of grounding support. */
|
|
5478
|
+
/** List of grounding support. */
|
|
5275
5479
|
groundingSupports?: GroundingSupport[];
|
|
5276
|
-
/**
|
|
5480
|
+
/** Metadata related to retrieval in the grounding flow. */
|
|
5277
5481
|
retrievalMetadata?: RetrievalMetadata;
|
|
5278
|
-
/** Optional.
|
|
5279
|
-
|
|
5280
|
-
/** Optional. Google search entry for the following-up web searches. */
|
|
5482
|
+
/** Optional. Google search entry for the following-up web
|
|
5483
|
+
searches. */
|
|
5281
5484
|
searchEntryPoint?: SearchEntryPoint;
|
|
5282
|
-
/**
|
|
5283
|
-
sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
|
|
5284
|
-
/** Optional. Web search queries for the following-up web search. */
|
|
5485
|
+
/** Web search queries for the following-up web search. */
|
|
5285
5486
|
webSearchQueries?: string[];
|
|
5487
|
+
/** 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. */
|
|
5488
|
+
googleMapsWidgetContextToken?: string;
|
|
5489
|
+
/** 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. */
|
|
5490
|
+
retrievalQueries?: string[];
|
|
5491
|
+
/** 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. */
|
|
5492
|
+
sourceFlaggingUris?: GroundingMetadataSourceFlaggingUri[];
|
|
5286
5493
|
}
|
|
5287
5494
|
|
|
5288
|
-
/**
|
|
5495
|
+
/** 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. */
|
|
5289
5496
|
export declare interface GroundingMetadataSourceFlaggingUri {
|
|
5290
|
-
/**
|
|
5497
|
+
/** The URI that can be used to flag the content. */
|
|
5291
5498
|
flagContentUri?: string;
|
|
5292
|
-
/**
|
|
5499
|
+
/** The ID of the place or review. */
|
|
5293
5500
|
sourceId?: string;
|
|
5294
5501
|
}
|
|
5295
5502
|
|
|
5296
5503
|
/** Grounding support. */
|
|
5297
5504
|
export declare interface GroundingSupport {
|
|
5298
|
-
/** Confidence score of the support references.
|
|
5505
|
+
/** Confidence score of the support references.
|
|
5506
|
+
|
|
5507
|
+
Ranges from 0 to 1. 1 is the most confident. This list must have the
|
|
5508
|
+
same size as the grounding_chunk_indices. */
|
|
5299
5509
|
confidenceScores?: number[];
|
|
5300
|
-
/** A list of indices (into 'grounding_chunk') specifying the
|
|
5510
|
+
/** A list of indices (into 'grounding_chunk') specifying the
|
|
5511
|
+
citations associated with the claim. For instance [1,3,4] means that
|
|
5512
|
+
grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the
|
|
5513
|
+
retrieved content attributed to the claim. */
|
|
5301
5514
|
groundingChunkIndices?: number[];
|
|
5302
5515
|
/** Segment of the content this support belongs to. */
|
|
5303
5516
|
segment?: Segment;
|
|
5304
5517
|
}
|
|
5305
5518
|
|
|
5306
|
-
/**
|
|
5519
|
+
/** 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. */
|
|
5307
5520
|
export declare enum HarmBlockMethod {
|
|
5308
5521
|
/**
|
|
5309
5522
|
* The harm block method is unspecified.
|
|
@@ -5319,54 +5532,54 @@ export declare enum HarmBlockMethod {
|
|
|
5319
5532
|
PROBABILITY = "PROBABILITY"
|
|
5320
5533
|
}
|
|
5321
5534
|
|
|
5322
|
-
/** The harm
|
|
5535
|
+
/** The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. */
|
|
5323
5536
|
export declare enum HarmBlockThreshold {
|
|
5324
5537
|
/**
|
|
5325
|
-
*
|
|
5538
|
+
* The harm block threshold is unspecified.
|
|
5326
5539
|
*/
|
|
5327
5540
|
HARM_BLOCK_THRESHOLD_UNSPECIFIED = "HARM_BLOCK_THRESHOLD_UNSPECIFIED",
|
|
5328
5541
|
/**
|
|
5329
|
-
* Block
|
|
5542
|
+
* Block content with a low harm probability or higher.
|
|
5330
5543
|
*/
|
|
5331
5544
|
BLOCK_LOW_AND_ABOVE = "BLOCK_LOW_AND_ABOVE",
|
|
5332
5545
|
/**
|
|
5333
|
-
* Block medium
|
|
5546
|
+
* Block content with a medium harm probability or higher.
|
|
5334
5547
|
*/
|
|
5335
5548
|
BLOCK_MEDIUM_AND_ABOVE = "BLOCK_MEDIUM_AND_ABOVE",
|
|
5336
5549
|
/**
|
|
5337
|
-
* Block
|
|
5550
|
+
* Block content with a high harm probability.
|
|
5338
5551
|
*/
|
|
5339
5552
|
BLOCK_ONLY_HIGH = "BLOCK_ONLY_HIGH",
|
|
5340
5553
|
/**
|
|
5341
|
-
*
|
|
5554
|
+
* Do not block any content, regardless of its harm probability.
|
|
5342
5555
|
*/
|
|
5343
5556
|
BLOCK_NONE = "BLOCK_NONE",
|
|
5344
5557
|
/**
|
|
5345
|
-
* Turn off the safety filter.
|
|
5558
|
+
* Turn off the safety filter entirely.
|
|
5346
5559
|
*/
|
|
5347
5560
|
OFF = "OFF"
|
|
5348
5561
|
}
|
|
5349
5562
|
|
|
5350
|
-
/**
|
|
5563
|
+
/** The harm category to be blocked. */
|
|
5351
5564
|
export declare enum HarmCategory {
|
|
5352
5565
|
/**
|
|
5353
|
-
*
|
|
5566
|
+
* Default value. This value is unused.
|
|
5354
5567
|
*/
|
|
5355
5568
|
HARM_CATEGORY_UNSPECIFIED = "HARM_CATEGORY_UNSPECIFIED",
|
|
5356
5569
|
/**
|
|
5357
|
-
*
|
|
5570
|
+
* Abusive, threatening, or content intended to bully, torment, or ridicule.
|
|
5358
5571
|
*/
|
|
5359
5572
|
HARM_CATEGORY_HARASSMENT = "HARM_CATEGORY_HARASSMENT",
|
|
5360
5573
|
/**
|
|
5361
|
-
*
|
|
5574
|
+
* Content that promotes violence or incites hatred against individuals or groups based on certain attributes.
|
|
5362
5575
|
*/
|
|
5363
5576
|
HARM_CATEGORY_HATE_SPEECH = "HARM_CATEGORY_HATE_SPEECH",
|
|
5364
5577
|
/**
|
|
5365
|
-
*
|
|
5578
|
+
* Content that contains sexually explicit material.
|
|
5366
5579
|
*/
|
|
5367
5580
|
HARM_CATEGORY_SEXUALLY_EXPLICIT = "HARM_CATEGORY_SEXUALLY_EXPLICIT",
|
|
5368
5581
|
/**
|
|
5369
|
-
*
|
|
5582
|
+
* Content that promotes, facilitates, or enables dangerous activities.
|
|
5370
5583
|
*/
|
|
5371
5584
|
HARM_CATEGORY_DANGEROUS_CONTENT = "HARM_CATEGORY_DANGEROUS_CONTENT",
|
|
5372
5585
|
/**
|
|
@@ -5374,71 +5587,71 @@ export declare enum HarmCategory {
|
|
|
5374
5587
|
*/
|
|
5375
5588
|
HARM_CATEGORY_CIVIC_INTEGRITY = "HARM_CATEGORY_CIVIC_INTEGRITY",
|
|
5376
5589
|
/**
|
|
5377
|
-
*
|
|
5590
|
+
* Images that contain hate speech. This enum value is not supported in Gemini API.
|
|
5378
5591
|
*/
|
|
5379
5592
|
HARM_CATEGORY_IMAGE_HATE = "HARM_CATEGORY_IMAGE_HATE",
|
|
5380
5593
|
/**
|
|
5381
|
-
*
|
|
5594
|
+
* Images that contain dangerous content. This enum value is not supported in Gemini API.
|
|
5382
5595
|
*/
|
|
5383
5596
|
HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT = "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT",
|
|
5384
5597
|
/**
|
|
5385
|
-
*
|
|
5598
|
+
* Images that contain harassment. This enum value is not supported in Gemini API.
|
|
5386
5599
|
*/
|
|
5387
5600
|
HARM_CATEGORY_IMAGE_HARASSMENT = "HARM_CATEGORY_IMAGE_HARASSMENT",
|
|
5388
5601
|
/**
|
|
5389
|
-
*
|
|
5602
|
+
* Images that contain sexually explicit content. This enum value is not supported in Gemini API.
|
|
5390
5603
|
*/
|
|
5391
5604
|
HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT = "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT",
|
|
5392
5605
|
/**
|
|
5393
|
-
*
|
|
5606
|
+
* Prompts designed to bypass safety filters. This enum value is not supported in Gemini API.
|
|
5394
5607
|
*/
|
|
5395
5608
|
HARM_CATEGORY_JAILBREAK = "HARM_CATEGORY_JAILBREAK"
|
|
5396
5609
|
}
|
|
5397
5610
|
|
|
5398
|
-
/** Output only.
|
|
5611
|
+
/** Output only. The probability of harm for this category. */
|
|
5399
5612
|
export declare enum HarmProbability {
|
|
5400
5613
|
/**
|
|
5401
|
-
*
|
|
5614
|
+
* The harm probability is unspecified.
|
|
5402
5615
|
*/
|
|
5403
5616
|
HARM_PROBABILITY_UNSPECIFIED = "HARM_PROBABILITY_UNSPECIFIED",
|
|
5404
5617
|
/**
|
|
5405
|
-
*
|
|
5618
|
+
* The harm probability is negligible.
|
|
5406
5619
|
*/
|
|
5407
5620
|
NEGLIGIBLE = "NEGLIGIBLE",
|
|
5408
5621
|
/**
|
|
5409
|
-
*
|
|
5622
|
+
* The harm probability is low.
|
|
5410
5623
|
*/
|
|
5411
5624
|
LOW = "LOW",
|
|
5412
5625
|
/**
|
|
5413
|
-
*
|
|
5626
|
+
* The harm probability is medium.
|
|
5414
5627
|
*/
|
|
5415
5628
|
MEDIUM = "MEDIUM",
|
|
5416
5629
|
/**
|
|
5417
|
-
*
|
|
5630
|
+
* The harm probability is high.
|
|
5418
5631
|
*/
|
|
5419
5632
|
HIGH = "HIGH"
|
|
5420
5633
|
}
|
|
5421
5634
|
|
|
5422
|
-
/** Output only.
|
|
5635
|
+
/** Output only. The severity of harm for this category. This enum is not supported in Gemini API. */
|
|
5423
5636
|
export declare enum HarmSeverity {
|
|
5424
5637
|
/**
|
|
5425
|
-
*
|
|
5638
|
+
* The harm severity is unspecified.
|
|
5426
5639
|
*/
|
|
5427
5640
|
HARM_SEVERITY_UNSPECIFIED = "HARM_SEVERITY_UNSPECIFIED",
|
|
5428
5641
|
/**
|
|
5429
|
-
*
|
|
5642
|
+
* The harm severity is negligible.
|
|
5430
5643
|
*/
|
|
5431
5644
|
HARM_SEVERITY_NEGLIGIBLE = "HARM_SEVERITY_NEGLIGIBLE",
|
|
5432
5645
|
/**
|
|
5433
|
-
*
|
|
5646
|
+
* The harm severity is low.
|
|
5434
5647
|
*/
|
|
5435
5648
|
HARM_SEVERITY_LOW = "HARM_SEVERITY_LOW",
|
|
5436
5649
|
/**
|
|
5437
|
-
*
|
|
5650
|
+
* The harm severity is medium.
|
|
5438
5651
|
*/
|
|
5439
5652
|
HARM_SEVERITY_MEDIUM = "HARM_SEVERITY_MEDIUM",
|
|
5440
5653
|
/**
|
|
5441
|
-
*
|
|
5654
|
+
* The harm severity is high.
|
|
5442
5655
|
*/
|
|
5443
5656
|
HARM_SEVERITY_HIGH = "HARM_SEVERITY_HIGH"
|
|
5444
5657
|
}
|
|
@@ -5606,6 +5819,8 @@ export declare interface ImageConfig {
|
|
|
5606
5819
|
/** Compression quality of the generated image (for
|
|
5607
5820
|
``image/jpeg`` only). This field is not supported in Gemini API. */
|
|
5608
5821
|
outputCompressionQuality?: number;
|
|
5822
|
+
/** Optional. The image output format for generated images. */
|
|
5823
|
+
imageOutputOptions?: ImageConfigImageOutputOptions;
|
|
5609
5824
|
}
|
|
5610
5825
|
|
|
5611
5826
|
/**
|
|
@@ -5616,6 +5831,14 @@ declare interface ImageConfig_2 {
|
|
|
5616
5831
|
image_size?: '1K' | '2K' | '4K' | '512';
|
|
5617
5832
|
}
|
|
5618
5833
|
|
|
5834
|
+
/** The image output format for generated images. This data type is not supported in Gemini API. */
|
|
5835
|
+
export declare interface ImageConfigImageOutputOptions {
|
|
5836
|
+
/** Optional. The compression quality of the output image. */
|
|
5837
|
+
compressionQuality?: number;
|
|
5838
|
+
/** Optional. The image format that the output should be saved as. */
|
|
5839
|
+
mimeType?: string;
|
|
5840
|
+
}
|
|
5841
|
+
|
|
5619
5842
|
/**
|
|
5620
5843
|
* An image content block.
|
|
5621
5844
|
*/
|
|
@@ -5801,13 +6024,13 @@ declare interface Interaction {
|
|
|
5801
6024
|
*/
|
|
5802
6025
|
agent?: (string & {}) | 'deep-research-pro-preview-12-2025';
|
|
5803
6026
|
/**
|
|
5804
|
-
* Configuration for the agent.
|
|
6027
|
+
* Configuration parameters for the agent interaction.
|
|
5805
6028
|
*/
|
|
5806
6029
|
agent_config?: DynamicAgentConfig | DeepResearchAgentConfig;
|
|
5807
6030
|
/**
|
|
5808
|
-
* The
|
|
6031
|
+
* The input for the interaction.
|
|
5809
6032
|
*/
|
|
5810
|
-
input?:
|
|
6033
|
+
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;
|
|
5811
6034
|
/**
|
|
5812
6035
|
* The name of the `Model` used for generating the interaction.
|
|
5813
6036
|
*/
|
|
@@ -6333,9 +6556,9 @@ export declare interface ListTuningJobsParameters {
|
|
|
6333
6556
|
export declare class ListTuningJobsResponse {
|
|
6334
6557
|
/** Used to retain the full HTTP response. */
|
|
6335
6558
|
sdkHttpResponse?: HttpResponse;
|
|
6336
|
-
/** A token to retrieve the next page of results. Pass
|
|
6559
|
+
/** 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. */
|
|
6337
6560
|
nextPageToken?: string;
|
|
6338
|
-
/**
|
|
6561
|
+
/** The tuning jobs that match the request. */
|
|
6339
6562
|
tuningJobs?: TuningJob[];
|
|
6340
6563
|
}
|
|
6341
6564
|
|
|
@@ -7121,27 +7344,27 @@ declare type Logger = {
|
|
|
7121
7344
|
|
|
7122
7345
|
declare type LogLevel = 'off' | 'error' | 'warn' | 'info' | 'debug';
|
|
7123
7346
|
|
|
7124
|
-
/**
|
|
7347
|
+
/** 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. */
|
|
7125
7348
|
export declare interface LogprobsResult {
|
|
7126
|
-
/**
|
|
7349
|
+
/** 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`. */
|
|
7127
7350
|
chosenCandidates?: LogprobsResultCandidate[];
|
|
7128
|
-
/**
|
|
7351
|
+
/** 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. */
|
|
7129
7352
|
topCandidates?: LogprobsResultTopCandidates[];
|
|
7130
7353
|
}
|
|
7131
7354
|
|
|
7132
|
-
/**
|
|
7355
|
+
/** A single token and its associated log probability. */
|
|
7133
7356
|
export declare interface LogprobsResultCandidate {
|
|
7134
|
-
/** The
|
|
7357
|
+
/** 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. */
|
|
7135
7358
|
logProbability?: number;
|
|
7136
|
-
/** The
|
|
7359
|
+
/** The token's string representation. */
|
|
7137
7360
|
token?: string;
|
|
7138
|
-
/** The
|
|
7361
|
+
/** 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. */
|
|
7139
7362
|
tokenId?: number;
|
|
7140
7363
|
}
|
|
7141
7364
|
|
|
7142
|
-
/**
|
|
7365
|
+
/** 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. */
|
|
7143
7366
|
export declare interface LogprobsResultTopCandidates {
|
|
7144
|
-
/**
|
|
7367
|
+
/** The list of candidate tokens, sorted by log probability in descending order. */
|
|
7145
7368
|
candidates?: LogprobsResultCandidate[];
|
|
7146
7369
|
}
|
|
7147
7370
|
|
|
@@ -7231,9 +7454,9 @@ declare interface MCPServerToolResultContent {
|
|
|
7231
7454
|
*/
|
|
7232
7455
|
call_id: string;
|
|
7233
7456
|
/**
|
|
7234
|
-
* The
|
|
7457
|
+
* The output from the MCP server call. Can be simple text or rich content.
|
|
7235
7458
|
*/
|
|
7236
|
-
result:
|
|
7459
|
+
result: unknown | Array<TextContent | ImageContent> | string;
|
|
7237
7460
|
type: 'mcp_server_tool_result';
|
|
7238
7461
|
/**
|
|
7239
7462
|
* Name of the tool which is called for this specific tool call.
|
|
@@ -7243,12 +7466,10 @@ declare interface MCPServerToolResultContent {
|
|
|
7243
7466
|
* The name of the used MCP server.
|
|
7244
7467
|
*/
|
|
7245
7468
|
server_name?: string;
|
|
7246
|
-
|
|
7247
|
-
|
|
7248
|
-
|
|
7249
|
-
|
|
7250
|
-
items?: Array<InteractionsAPI.TextContent | InteractionsAPI.ImageContent>;
|
|
7251
|
-
}
|
|
7469
|
+
/**
|
|
7470
|
+
* A signature hash for backend validation.
|
|
7471
|
+
*/
|
|
7472
|
+
signature?: string;
|
|
7252
7473
|
}
|
|
7253
7474
|
|
|
7254
7475
|
/**
|
|
@@ -7343,7 +7564,7 @@ export declare enum Modality {
|
|
|
7343
7564
|
export declare interface ModalityTokenCount {
|
|
7344
7565
|
/** The modality associated with this token count. */
|
|
7345
7566
|
modality?: MediaModality;
|
|
7346
|
-
/**
|
|
7567
|
+
/** The number of tokens counted for this modality. */
|
|
7347
7568
|
tokenCount?: number;
|
|
7348
7569
|
}
|
|
7349
7570
|
|
|
@@ -7405,13 +7626,13 @@ export declare interface Model {
|
|
|
7405
7626
|
/**
|
|
7406
7627
|
* The model that will complete your prompt.\n\nSee [models](https://ai.google.dev/gemini-api/docs/models) for additional details.
|
|
7407
7628
|
*/
|
|
7408
|
-
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 & {});
|
|
7629
|
+
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 & {});
|
|
7409
7630
|
|
|
7410
|
-
/** Configuration for Model Armor
|
|
7631
|
+
/** 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. */
|
|
7411
7632
|
export declare interface ModelArmorConfig {
|
|
7412
|
-
/** Optional. The name of the Model Armor template to use for prompt
|
|
7633
|
+
/** 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}`. */
|
|
7413
7634
|
promptTemplateName?: string;
|
|
7414
|
-
/** Optional. The name of the Model Armor template to use for response
|
|
7635
|
+
/** 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}`. */
|
|
7415
7636
|
responseTemplateName?: string;
|
|
7416
7637
|
}
|
|
7417
7638
|
|
|
@@ -7958,6 +8179,12 @@ export declare enum Outcome {
|
|
|
7958
8179
|
OUTCOME_DEADLINE_EXCEEDED = "OUTCOME_DEADLINE_EXCEEDED"
|
|
7959
8180
|
}
|
|
7960
8181
|
|
|
8182
|
+
/** Describes the info for output of EvaluationService. This data type is not supported in Gemini API. */
|
|
8183
|
+
export declare interface OutputInfo {
|
|
8184
|
+
/** Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. */
|
|
8185
|
+
gcsOutputDirectory?: string;
|
|
8186
|
+
}
|
|
8187
|
+
|
|
7961
8188
|
/**
|
|
7962
8189
|
* Some environments overload the global fetch function, and Parameters<T> only gets the last signature.
|
|
7963
8190
|
*/
|
|
@@ -8105,6 +8332,36 @@ export declare class Pager<T> implements AsyncIterable<T> {
|
|
|
8105
8332
|
hasNextPage(): boolean;
|
|
8106
8333
|
}
|
|
8107
8334
|
|
|
8335
|
+
/** Output only. Pairwise metric choice. This enum is not supported in Gemini API. */
|
|
8336
|
+
export declare enum PairwiseChoice {
|
|
8337
|
+
/**
|
|
8338
|
+
* Unspecified prediction choice.
|
|
8339
|
+
*/
|
|
8340
|
+
PAIRWISE_CHOICE_UNSPECIFIED = "PAIRWISE_CHOICE_UNSPECIFIED",
|
|
8341
|
+
/**
|
|
8342
|
+
* Baseline prediction wins
|
|
8343
|
+
*/
|
|
8344
|
+
BASELINE = "BASELINE",
|
|
8345
|
+
/**
|
|
8346
|
+
* Candidate prediction wins
|
|
8347
|
+
*/
|
|
8348
|
+
CANDIDATE = "CANDIDATE",
|
|
8349
|
+
/**
|
|
8350
|
+
* Winner cannot be determined
|
|
8351
|
+
*/
|
|
8352
|
+
TIE = "TIE"
|
|
8353
|
+
}
|
|
8354
|
+
|
|
8355
|
+
/** Spec for pairwise metric result. This data type is not supported in Gemini API. */
|
|
8356
|
+
export declare interface PairwiseMetricResult {
|
|
8357
|
+
/** Output only. Spec for custom output. */
|
|
8358
|
+
customOutput?: CustomOutput;
|
|
8359
|
+
/** Output only. Explanation for pairwise metric score. */
|
|
8360
|
+
explanation?: string;
|
|
8361
|
+
/** Output only. Pairwise metric choice. */
|
|
8362
|
+
pairwiseChoice?: PairwiseChoice;
|
|
8363
|
+
}
|
|
8364
|
+
|
|
8108
8365
|
/** A datatype containing media content.
|
|
8109
8366
|
|
|
8110
8367
|
Exactly one field within a Part should be set, representing the specific type
|
|
@@ -8114,21 +8371,21 @@ export declare interface Part {
|
|
|
8114
8371
|
/** Media resolution for the input media.
|
|
8115
8372
|
*/
|
|
8116
8373
|
mediaResolution?: PartMediaResolution;
|
|
8117
|
-
/** Optional.
|
|
8374
|
+
/** Optional. The result of executing the ExecutableCode. */
|
|
8118
8375
|
codeExecutionResult?: CodeExecutionResult;
|
|
8119
|
-
/** Optional. Code generated by the model that is
|
|
8376
|
+
/** Optional. Code generated by the model that is intended to be executed. */
|
|
8120
8377
|
executableCode?: ExecutableCode;
|
|
8121
|
-
/** Optional. URI
|
|
8378
|
+
/** Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. */
|
|
8122
8379
|
fileData?: FileData;
|
|
8123
|
-
/** Optional. A predicted
|
|
8380
|
+
/** 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. */
|
|
8124
8381
|
functionCall?: FunctionCall;
|
|
8125
|
-
/** Optional. The result
|
|
8382
|
+
/** Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. */
|
|
8126
8383
|
functionResponse?: FunctionResponse;
|
|
8127
|
-
/** Optional.
|
|
8384
|
+
/** Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. */
|
|
8128
8385
|
inlineData?: Blob_2;
|
|
8129
|
-
/** Optional.
|
|
8386
|
+
/** 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. */
|
|
8130
8387
|
text?: string;
|
|
8131
|
-
/** Optional. Indicates
|
|
8388
|
+
/** Optional. Indicates whether the `part` represents the model's thought process or reasoning. */
|
|
8132
8389
|
thought?: boolean;
|
|
8133
8390
|
/** Optional. An opaque signature for the thought so it can be reused in subsequent requests.
|
|
8134
8391
|
* @remarks Encoded as base64 string. */
|
|
@@ -8139,16 +8396,16 @@ export declare interface Part {
|
|
|
8139
8396
|
|
|
8140
8397
|
/** Partial argument value of the function call. This data type is not supported in Gemini API. */
|
|
8141
8398
|
export declare interface PartialArg {
|
|
8399
|
+
/** Optional. Represents a boolean value. */
|
|
8400
|
+
boolValue?: boolean;
|
|
8401
|
+
/** Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". */
|
|
8402
|
+
jsonPath?: string;
|
|
8142
8403
|
/** Optional. Represents a null value. */
|
|
8143
8404
|
nullValue?: 'NULL_VALUE';
|
|
8144
8405
|
/** Optional. Represents a double value. */
|
|
8145
8406
|
numberValue?: number;
|
|
8146
8407
|
/** Optional. Represents a string value. */
|
|
8147
8408
|
stringValue?: string;
|
|
8148
|
-
/** Optional. Represents a boolean value. */
|
|
8149
|
-
boolValue?: boolean;
|
|
8150
|
-
/** Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". */
|
|
8151
|
-
jsonPath?: string;
|
|
8152
8409
|
/** 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. */
|
|
8153
8410
|
willContinue?: boolean;
|
|
8154
8411
|
}
|
|
@@ -8252,14 +8509,28 @@ export declare enum PhishBlockThreshold {
|
|
|
8252
8509
|
BLOCK_ONLY_EXTREMELY_HIGH = "BLOCK_ONLY_EXTREMELY_HIGH"
|
|
8253
8510
|
}
|
|
8254
8511
|
|
|
8255
|
-
/**
|
|
8512
|
+
/** Spec for pointwise metric result. This data type is not supported in Gemini API. */
|
|
8513
|
+
export declare interface PointwiseMetricResult {
|
|
8514
|
+
/** Output only. Spec for custom output. */
|
|
8515
|
+
customOutput?: CustomOutput;
|
|
8516
|
+
/** Output only. Explanation for pointwise metric score. */
|
|
8517
|
+
explanation?: string;
|
|
8518
|
+
/** Output only. Pointwise metric score. */
|
|
8519
|
+
score?: number;
|
|
8520
|
+
}
|
|
8521
|
+
|
|
8522
|
+
/** Configuration for a prebuilt voice. */
|
|
8256
8523
|
export declare interface PrebuiltVoiceConfig {
|
|
8257
|
-
/** The name of the
|
|
8524
|
+
/** The name of the prebuilt voice to use. */
|
|
8258
8525
|
voiceName?: string;
|
|
8259
8526
|
}
|
|
8260
8527
|
|
|
8261
8528
|
/** Statistics computed for datasets used for preference optimization. This data type is not supported in Gemini API. */
|
|
8262
8529
|
export declare interface PreferenceOptimizationDataStats {
|
|
8530
|
+
/** Output only. A partial sample of the indices (starting from 1) of the dropped examples. */
|
|
8531
|
+
droppedExampleIndices?: string[];
|
|
8532
|
+
/** Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. */
|
|
8533
|
+
droppedExampleReasons?: string[];
|
|
8263
8534
|
/** Output only. Dataset distributions for scores variance per example. */
|
|
8264
8535
|
scoreVariancePerExampleDistribution?: DatasetDistribution;
|
|
8265
8536
|
/** Output only. Dataset distributions for scores. */
|
|
@@ -8416,6 +8687,12 @@ export declare interface RagRetrievalConfigRankingRankService {
|
|
|
8416
8687
|
declare class RateLimitError extends APIError<429, Headers> {
|
|
8417
8688
|
}
|
|
8418
8689
|
|
|
8690
|
+
/** Raw output. This data type is not supported in Gemini API. */
|
|
8691
|
+
export declare interface RawOutput {
|
|
8692
|
+
/** Output only. Raw output string. */
|
|
8693
|
+
rawOutput?: string[];
|
|
8694
|
+
}
|
|
8695
|
+
|
|
8419
8696
|
/** A raw reference image.
|
|
8420
8697
|
|
|
8421
8698
|
A raw reference image represents the base image to edit, provided by the user.
|
|
@@ -8717,12 +8994,23 @@ export declare interface RetrievalConfig {
|
|
|
8717
8994
|
languageCode?: string;
|
|
8718
8995
|
}
|
|
8719
8996
|
|
|
8720
|
-
/** Metadata
|
|
8997
|
+
/** Metadata returned to client when grounding is enabled. */
|
|
8721
8998
|
export declare interface RetrievalMetadata {
|
|
8722
|
-
/** Optional. Score indicating how likely information from
|
|
8999
|
+
/** Optional. Score indicating how likely information from google
|
|
9000
|
+
search could help answer the prompt. The score is in the range [0, 1],
|
|
9001
|
+
where 0 is the least likely and 1 is the most likely. This score is only
|
|
9002
|
+
populated when google search grounding and dynamic retrieval is enabled.
|
|
9003
|
+
It will be compared to the threshold to determine whether to trigger
|
|
9004
|
+
Google search. */
|
|
8723
9005
|
googleSearchDynamicRetrievalScore?: number;
|
|
8724
9006
|
}
|
|
8725
9007
|
|
|
9008
|
+
/** Rouge metric value for an instance. This data type is not supported in Gemini API. */
|
|
9009
|
+
export declare interface RougeMetricValue {
|
|
9010
|
+
/** Output only. Rouge score. */
|
|
9011
|
+
score?: number;
|
|
9012
|
+
}
|
|
9013
|
+
|
|
8726
9014
|
/** Safety attributes of a GeneratedImage or the user-provided prompt. */
|
|
8727
9015
|
export declare interface SafetyAttributes {
|
|
8728
9016
|
/** List of RAI categories. */
|
|
@@ -8741,31 +9029,31 @@ export declare enum SafetyFilterLevel {
|
|
|
8741
9029
|
BLOCK_NONE = "BLOCK_NONE"
|
|
8742
9030
|
}
|
|
8743
9031
|
|
|
8744
|
-
/**
|
|
9032
|
+
/** A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. */
|
|
8745
9033
|
export declare interface SafetyRating {
|
|
8746
|
-
/** Output only. Indicates whether the content was
|
|
9034
|
+
/** Output only. Indicates whether the content was blocked because of this rating. */
|
|
8747
9035
|
blocked?: boolean;
|
|
8748
|
-
/** Output only.
|
|
9036
|
+
/** Output only. The harm category of this rating. */
|
|
8749
9037
|
category?: HarmCategory;
|
|
8750
9038
|
/** 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. */
|
|
8751
9039
|
overwrittenThreshold?: HarmBlockThreshold;
|
|
8752
|
-
/** Output only.
|
|
9040
|
+
/** Output only. The probability of harm for this category. */
|
|
8753
9041
|
probability?: HarmProbability;
|
|
8754
|
-
/** Output only.
|
|
9042
|
+
/** Output only. The probability score of harm for this category. This field is not supported in Gemini API. */
|
|
8755
9043
|
probabilityScore?: number;
|
|
8756
|
-
/** Output only.
|
|
9044
|
+
/** Output only. The severity of harm for this category. This field is not supported in Gemini API. */
|
|
8757
9045
|
severity?: HarmSeverity;
|
|
8758
|
-
/** Output only.
|
|
9046
|
+
/** Output only. The severity score of harm for this category. This field is not supported in Gemini API. */
|
|
8759
9047
|
severityScore?: number;
|
|
8760
9048
|
}
|
|
8761
9049
|
|
|
8762
|
-
/**
|
|
9050
|
+
/** A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. */
|
|
8763
9051
|
export declare interface SafetySetting {
|
|
8764
|
-
/** Required.
|
|
9052
|
+
/** Required. The harm category to be blocked. */
|
|
8765
9053
|
category?: HarmCategory;
|
|
8766
|
-
/** Optional.
|
|
9054
|
+
/** 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. */
|
|
8767
9055
|
method?: HarmBlockMethod;
|
|
8768
|
-
/** Required. The harm
|
|
9056
|
+
/** Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. */
|
|
8769
9057
|
threshold?: HarmBlockThreshold;
|
|
8770
9058
|
}
|
|
8771
9059
|
|
|
@@ -8831,49 +9119,49 @@ export declare enum Scale {
|
|
|
8831
9119
|
object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may
|
|
8832
9120
|
be added in the future as needed. */
|
|
8833
9121
|
export declare interface Schema {
|
|
8834
|
-
/** Optional. The
|
|
9122
|
+
/** Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. */
|
|
8835
9123
|
anyOf?: Schema[];
|
|
8836
|
-
/** Optional. Default value
|
|
9124
|
+
/** Optional. Default value to use if the field is not specified. */
|
|
8837
9125
|
default?: unknown;
|
|
8838
|
-
/** Optional.
|
|
9126
|
+
/** Optional. Description of the schema. */
|
|
8839
9127
|
description?: string;
|
|
8840
|
-
/** Optional. Possible values of the
|
|
9128
|
+
/** 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"]}` */
|
|
8841
9129
|
enum?: string[];
|
|
8842
|
-
/** Optional. Example of
|
|
9130
|
+
/** Optional. Example of an instance of this schema. */
|
|
8843
9131
|
example?: unknown;
|
|
8844
|
-
/** Optional. The format of the data.
|
|
9132
|
+
/** 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. */
|
|
8845
9133
|
format?: string;
|
|
8846
|
-
/** Optional.
|
|
9134
|
+
/** Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. */
|
|
8847
9135
|
items?: Schema;
|
|
8848
|
-
/** Optional.
|
|
9136
|
+
/** Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. */
|
|
8849
9137
|
maxItems?: string;
|
|
8850
|
-
/** Optional.
|
|
9138
|
+
/** Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. */
|
|
8851
9139
|
maxLength?: string;
|
|
8852
|
-
/** Optional.
|
|
9140
|
+
/** Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. */
|
|
8853
9141
|
maxProperties?: string;
|
|
8854
|
-
/** Optional.
|
|
9142
|
+
/** Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. */
|
|
8855
9143
|
maximum?: number;
|
|
8856
|
-
/** Optional.
|
|
9144
|
+
/** Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. */
|
|
8857
9145
|
minItems?: string;
|
|
8858
|
-
/** Optional.
|
|
9146
|
+
/** Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. */
|
|
8859
9147
|
minLength?: string;
|
|
8860
|
-
/** Optional.
|
|
9148
|
+
/** Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. */
|
|
8861
9149
|
minProperties?: string;
|
|
8862
|
-
/** Optional.
|
|
9150
|
+
/** Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. */
|
|
8863
9151
|
minimum?: number;
|
|
8864
|
-
/** Optional. Indicates if the value
|
|
9152
|
+
/** Optional. Indicates if the value of this field can be null. */
|
|
8865
9153
|
nullable?: boolean;
|
|
8866
|
-
/** Optional.
|
|
9154
|
+
/** Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. */
|
|
8867
9155
|
pattern?: string;
|
|
8868
|
-
/** Optional.
|
|
9156
|
+
/** Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. */
|
|
8869
9157
|
properties?: Record<string, Schema>;
|
|
8870
|
-
/** Optional.
|
|
9158
|
+
/** 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. */
|
|
8871
9159
|
propertyOrdering?: string[];
|
|
8872
|
-
/** Optional.
|
|
9160
|
+
/** Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. */
|
|
8873
9161
|
required?: string[];
|
|
8874
|
-
/** Optional.
|
|
9162
|
+
/** Optional. Title for the schema. */
|
|
8875
9163
|
title?: string;
|
|
8876
|
-
/** Optional.
|
|
9164
|
+
/** Optional. Data type of the schema field. */
|
|
8877
9165
|
type?: Type;
|
|
8878
9166
|
}
|
|
8879
9167
|
|
|
@@ -8885,11 +9173,12 @@ export declare interface ScribbleImage {
|
|
|
8885
9173
|
image?: Image_2;
|
|
8886
9174
|
}
|
|
8887
9175
|
|
|
8888
|
-
/**
|
|
9176
|
+
/** The entry point used to search for grounding sources. */
|
|
8889
9177
|
export declare interface SearchEntryPoint {
|
|
8890
|
-
/** Optional. Web content snippet that can be embedded in a web page
|
|
9178
|
+
/** Optional. Web content snippet that can be embedded in a web page
|
|
9179
|
+
or an app webview. */
|
|
8891
9180
|
renderedContent?: string;
|
|
8892
|
-
/** Optional.
|
|
9181
|
+
/** Optional. JSON representing array of tuples.
|
|
8893
9182
|
* @remarks Encoded as base64 string. */
|
|
8894
9183
|
sdkBlob?: string;
|
|
8895
9184
|
}
|
|
@@ -8903,15 +9192,21 @@ export declare interface SearchTypes {
|
|
|
8903
9192
|
imageSearch?: ImageSearch;
|
|
8904
9193
|
}
|
|
8905
9194
|
|
|
8906
|
-
/** Segment of the content. */
|
|
9195
|
+
/** Segment of the content this support belongs to. */
|
|
8907
9196
|
export declare interface Segment {
|
|
8908
|
-
/** Output only.
|
|
9197
|
+
/** Output only. Start index in the given Part, measured in bytes.
|
|
9198
|
+
|
|
9199
|
+
Offset from the start of the Part, inclusive, starting at zero. */
|
|
9200
|
+
startIndex?: number;
|
|
9201
|
+
/** Output only. End index in the given Part, measured in bytes.
|
|
9202
|
+
|
|
9203
|
+
Offset from the start of the Part, exclusive, starting at zero. */
|
|
8909
9204
|
endIndex?: number;
|
|
8910
|
-
/** Output only. The index of a Part object within its parent
|
|
9205
|
+
/** Output only. The index of a Part object within its parent
|
|
9206
|
+
Content object. */
|
|
8911
9207
|
partIndex?: number;
|
|
8912
|
-
/** Output only.
|
|
8913
|
-
|
|
8914
|
-
/** Output only. The text corresponding to the segment from the response. */
|
|
9208
|
+
/** Output only. The text corresponding to the segment from the
|
|
9209
|
+
response. */
|
|
8915
9210
|
text?: string;
|
|
8916
9211
|
}
|
|
8917
9212
|
|
|
@@ -9187,7 +9482,7 @@ export declare interface SlidingWindow {
|
|
|
9187
9482
|
targetTokens?: string;
|
|
9188
9483
|
}
|
|
9189
9484
|
|
|
9190
|
-
/** Configuration for a single speaker in a multi
|
|
9485
|
+
/** Configuration for a single speaker in a multi-speaker setup. */
|
|
9191
9486
|
export declare interface SpeakerVoiceConfig {
|
|
9192
9487
|
/** Required. The name of the speaker. This should be the same as the speaker name used in the prompt. */
|
|
9193
9488
|
speaker?: string;
|
|
@@ -9198,7 +9493,7 @@ export declare interface SpeakerVoiceConfig {
|
|
|
9198
9493
|
export declare interface SpeechConfig {
|
|
9199
9494
|
/** Configuration for the voice of the response. */
|
|
9200
9495
|
voiceConfig?: VoiceConfig;
|
|
9201
|
-
/** Optional.
|
|
9496
|
+
/** Optional. The language code (ISO 639-1) for the speech synthesis. */
|
|
9202
9497
|
languageCode?: string;
|
|
9203
9498
|
/** The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. */
|
|
9204
9499
|
multiSpeakerVoiceConfig?: MultiSpeakerVoiceConfig;
|
|
@@ -9640,16 +9935,19 @@ export declare interface Tool {
|
|
|
9640
9935
|
fileSearch?: FileSearch;
|
|
9641
9936
|
/** Enables the model to execute Google Search as part of generation. */
|
|
9642
9937
|
googleSearch?: GoogleSearch;
|
|
9938
|
+
/** Optional. Tool that allows grounding the model's response with
|
|
9939
|
+
geospatial context related to the user's query. */
|
|
9940
|
+
googleMaps?: GoogleMaps;
|
|
9643
9941
|
/** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
|
|
9644
9942
|
codeExecution?: ToolCodeExecution;
|
|
9645
9943
|
/** Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. This field is not supported in Gemini API. */
|
|
9646
9944
|
enterpriseWebSearch?: EnterpriseWebSearch;
|
|
9647
9945
|
/** 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. */
|
|
9648
9946
|
functionDeclarations?: FunctionDeclaration[];
|
|
9649
|
-
/** Optional. GoogleMaps tool type. Tool to support Google Maps in Model. */
|
|
9650
|
-
googleMaps?: GoogleMaps;
|
|
9651
9947
|
/** Optional. Specialized retrieval tool that is powered by Google Search. */
|
|
9652
9948
|
googleSearchRetrieval?: GoogleSearchRetrieval;
|
|
9949
|
+
/** 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. */
|
|
9950
|
+
parallelAiSearch?: ToolParallelAiSearch;
|
|
9653
9951
|
/** Optional. Tool to support URL context retrieval. */
|
|
9654
9952
|
urlContext?: UrlContext;
|
|
9655
9953
|
/** Optional. MCP Servers to connect to. This field is not supported in Vertex AI. */
|
|
@@ -9659,19 +9957,9 @@ export declare interface Tool {
|
|
|
9659
9957
|
/**
|
|
9660
9958
|
* A tool that can be used by the model.
|
|
9661
9959
|
*/
|
|
9662
|
-
declare type Tool_2 = Function_2 | Tool_2.
|
|
9960
|
+
declare type Tool_2 = Function_2 | Tool_2.CodeExecution | Tool_2.URLContext | Tool_2.ComputerUse | Tool_2.MCPServer | Tool_2.GoogleSearch | Tool_2.FileSearch;
|
|
9663
9961
|
|
|
9664
9962
|
declare namespace Tool_2 {
|
|
9665
|
-
/**
|
|
9666
|
-
* A tool that can be used by the model to search Google.
|
|
9667
|
-
*/
|
|
9668
|
-
interface GoogleSearch {
|
|
9669
|
-
type: 'google_search';
|
|
9670
|
-
/**
|
|
9671
|
-
* The types of search grounding to enable.
|
|
9672
|
-
*/
|
|
9673
|
-
search_types?: Array<'web_search' | 'image_search'>;
|
|
9674
|
-
}
|
|
9675
9963
|
/**
|
|
9676
9964
|
* A tool that can be used by the model to execute code.
|
|
9677
9965
|
*/
|
|
@@ -9723,6 +10011,16 @@ declare namespace Tool_2 {
|
|
|
9723
10011
|
*/
|
|
9724
10012
|
url?: string;
|
|
9725
10013
|
}
|
|
10014
|
+
/**
|
|
10015
|
+
* A tool that can be used by the model to search Google.
|
|
10016
|
+
*/
|
|
10017
|
+
interface GoogleSearch {
|
|
10018
|
+
type: 'google_search';
|
|
10019
|
+
/**
|
|
10020
|
+
* The types of search grounding to enable.
|
|
10021
|
+
*/
|
|
10022
|
+
search_types?: Array<'web_search' | 'image_search'>;
|
|
10023
|
+
}
|
|
9726
10024
|
/**
|
|
9727
10025
|
* A tool that can be used by the model to search files.
|
|
9728
10026
|
*/
|
|
@@ -9771,6 +10069,14 @@ export declare interface ToolConfig {
|
|
|
9771
10069
|
|
|
9772
10070
|
export declare type ToolListUnion = ToolUnion[];
|
|
9773
10071
|
|
|
10072
|
+
/** ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. This data type is not supported in Gemini API. */
|
|
10073
|
+
export declare interface ToolParallelAiSearch {
|
|
10074
|
+
/** 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. */
|
|
10075
|
+
apiKey?: string;
|
|
10076
|
+
/** 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 } } */
|
|
10077
|
+
customConfigs?: Record<string, unknown>;
|
|
10078
|
+
}
|
|
10079
|
+
|
|
9774
10080
|
export declare type ToolUnion = Tool | CallableTool;
|
|
9775
10081
|
|
|
9776
10082
|
/** Output only. The traffic type for this request. This enum is not supported in Gemini API. */
|
|
@@ -9783,6 +10089,14 @@ export declare enum TrafficType {
|
|
|
9783
10089
|
* The request was processed using Pay-As-You-Go quota.
|
|
9784
10090
|
*/
|
|
9785
10091
|
ON_DEMAND = "ON_DEMAND",
|
|
10092
|
+
/**
|
|
10093
|
+
* Type for Priority Pay-As-You-Go traffic.
|
|
10094
|
+
*/
|
|
10095
|
+
ON_DEMAND_PRIORITY = "ON_DEMAND_PRIORITY",
|
|
10096
|
+
/**
|
|
10097
|
+
* Type for Flex traffic.
|
|
10098
|
+
*/
|
|
10099
|
+
ON_DEMAND_FLEX = "ON_DEMAND_FLEX",
|
|
9786
10100
|
/**
|
|
9787
10101
|
* Type for Provisioned Throughput traffic.
|
|
9788
10102
|
*/
|
|
@@ -9857,7 +10171,7 @@ export declare interface TuningDataset {
|
|
|
9857
10171
|
|
|
9858
10172
|
/** The tuning data statistic values for TuningJob. This data type is not supported in Gemini API. */
|
|
9859
10173
|
export declare interface TuningDataStats {
|
|
9860
|
-
/** Output only. Statistics for distillation. */
|
|
10174
|
+
/** Output only. Statistics for distillation prompt dataset. These statistics do not include the responses sampled from the teacher model. */
|
|
9861
10175
|
distillationDataStats?: DistillationDataStats;
|
|
9862
10176
|
/** Output only. Statistics for preference optimization. */
|
|
9863
10177
|
preferenceOptimizationDataStats?: PreferenceOptimizationDataStats;
|
|
@@ -9913,8 +10227,12 @@ export declare interface TuningJob {
|
|
|
9913
10227
|
partnerModelTuningSpec?: PartnerModelTuningSpec;
|
|
9914
10228
|
/** 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. */
|
|
9915
10229
|
customBaseModel?: string;
|
|
10230
|
+
/** Output only. Evaluation runs for the Tuning Job. */
|
|
10231
|
+
evaluateDatasetRuns?: EvaluateDatasetRun[];
|
|
9916
10232
|
/** Output only. The Experiment associated with this TuningJob. */
|
|
9917
10233
|
experiment?: string;
|
|
10234
|
+
/** Tuning Spec for Full Fine Tuning. */
|
|
10235
|
+
fullFineTuningSpec?: FullFineTuningSpec;
|
|
9918
10236
|
/** 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. */
|
|
9919
10237
|
labels?: Record<string, string>;
|
|
9920
10238
|
/** 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. */
|
|
@@ -9925,10 +10243,40 @@ export declare interface TuningJob {
|
|
|
9925
10243
|
serviceAccount?: string;
|
|
9926
10244
|
/** 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. */
|
|
9927
10245
|
tunedModelDisplayName?: string;
|
|
10246
|
+
/** Output only. The detail state of the tuning job (while the overall `JobState` is running). */
|
|
10247
|
+
tuningJobState?: TuningJobState;
|
|
9928
10248
|
/** Tuning Spec for Veo Tuning. */
|
|
9929
10249
|
veoTuningSpec?: VeoTuningSpec;
|
|
9930
10250
|
}
|
|
9931
10251
|
|
|
10252
|
+
/** Output only. The detail state of the tuning job (while the overall `JobState` is running). This enum is not supported in Gemini API. */
|
|
10253
|
+
export declare enum TuningJobState {
|
|
10254
|
+
/**
|
|
10255
|
+
* Default tuning job state.
|
|
10256
|
+
*/
|
|
10257
|
+
TUNING_JOB_STATE_UNSPECIFIED = "TUNING_JOB_STATE_UNSPECIFIED",
|
|
10258
|
+
/**
|
|
10259
|
+
* Tuning job is waiting for job quota.
|
|
10260
|
+
*/
|
|
10261
|
+
TUNING_JOB_STATE_WAITING_FOR_QUOTA = "TUNING_JOB_STATE_WAITING_FOR_QUOTA",
|
|
10262
|
+
/**
|
|
10263
|
+
* Tuning job is validating the dataset.
|
|
10264
|
+
*/
|
|
10265
|
+
TUNING_JOB_STATE_PROCESSING_DATASET = "TUNING_JOB_STATE_PROCESSING_DATASET",
|
|
10266
|
+
/**
|
|
10267
|
+
* Tuning job is waiting for hardware capacity.
|
|
10268
|
+
*/
|
|
10269
|
+
TUNING_JOB_STATE_WAITING_FOR_CAPACITY = "TUNING_JOB_STATE_WAITING_FOR_CAPACITY",
|
|
10270
|
+
/**
|
|
10271
|
+
* Tuning job is running.
|
|
10272
|
+
*/
|
|
10273
|
+
TUNING_JOB_STATE_TUNING = "TUNING_JOB_STATE_TUNING",
|
|
10274
|
+
/**
|
|
10275
|
+
* Tuning job is doing some post processing steps.
|
|
10276
|
+
*/
|
|
10277
|
+
TUNING_JOB_STATE_POST_PROCESSING = "TUNING_JOB_STATE_POST_PROCESSING"
|
|
10278
|
+
}
|
|
10279
|
+
|
|
9932
10280
|
/** Enum representing the tuning method. */
|
|
9933
10281
|
export declare enum TuningMethod {
|
|
9934
10282
|
/**
|
|
@@ -10106,7 +10454,7 @@ export declare enum TurnCoverage {
|
|
|
10106
10454
|
TURN_INCLUDES_ALL_INPUT = "TURN_INCLUDES_ALL_INPUT"
|
|
10107
10455
|
}
|
|
10108
10456
|
|
|
10109
|
-
/**
|
|
10457
|
+
/** Data type of the schema field. */
|
|
10110
10458
|
export declare enum Type {
|
|
10111
10459
|
/**
|
|
10112
10460
|
* Not specified, should not be used.
|
|
@@ -10160,13 +10508,14 @@ declare namespace types {
|
|
|
10160
10508
|
FunctionResponseScheduling,
|
|
10161
10509
|
Type,
|
|
10162
10510
|
PhishBlockThreshold,
|
|
10163
|
-
ApiSpec,
|
|
10164
10511
|
AuthType,
|
|
10165
10512
|
HttpElementLocation,
|
|
10513
|
+
ApiSpec,
|
|
10166
10514
|
Behavior,
|
|
10167
10515
|
DynamicRetrievalConfigMode,
|
|
10168
10516
|
FunctionCallingConfigMode,
|
|
10169
10517
|
ThinkingLevel,
|
|
10518
|
+
PersonGeneration,
|
|
10170
10519
|
HarmCategory,
|
|
10171
10520
|
HarmBlockMethod,
|
|
10172
10521
|
HarmBlockThreshold,
|
|
@@ -10181,6 +10530,9 @@ declare namespace types {
|
|
|
10181
10530
|
TuningMode,
|
|
10182
10531
|
AdapterSize,
|
|
10183
10532
|
JobState,
|
|
10533
|
+
TuningJobState,
|
|
10534
|
+
AggregationMetric,
|
|
10535
|
+
PairwiseChoice,
|
|
10184
10536
|
TuningTask,
|
|
10185
10537
|
PartMediaResolutionLevel,
|
|
10186
10538
|
ResourceScope,
|
|
@@ -10189,7 +10541,6 @@ declare namespace types {
|
|
|
10189
10541
|
ProminentPeople,
|
|
10190
10542
|
EmbeddingApiType,
|
|
10191
10543
|
SafetyFilterLevel,
|
|
10192
|
-
PersonGeneration,
|
|
10193
10544
|
ImagePromptLanguage,
|
|
10194
10545
|
MaskReferenceMode,
|
|
10195
10546
|
ControlReferenceType,
|
|
@@ -10239,14 +10590,15 @@ declare namespace types {
|
|
|
10239
10590
|
SearchTypes,
|
|
10240
10591
|
Interval,
|
|
10241
10592
|
GoogleSearch,
|
|
10242
|
-
ApiAuthApiKeyConfig,
|
|
10243
|
-
ApiAuth,
|
|
10244
10593
|
ApiKeyConfig,
|
|
10245
10594
|
AuthConfigGoogleServiceAccountConfig,
|
|
10246
10595
|
AuthConfigHttpBasicAuthConfig,
|
|
10247
10596
|
AuthConfigOauthConfig,
|
|
10248
10597
|
AuthConfigOidcConfig,
|
|
10249
10598
|
AuthConfig,
|
|
10599
|
+
GoogleMaps,
|
|
10600
|
+
ApiAuthApiKeyConfig,
|
|
10601
|
+
ApiAuth,
|
|
10250
10602
|
ExternalApiElasticSearchParams,
|
|
10251
10603
|
ExternalApiSimpleSearchParams,
|
|
10252
10604
|
ExternalApi,
|
|
@@ -10264,9 +10616,9 @@ declare namespace types {
|
|
|
10264
10616
|
ToolCodeExecution,
|
|
10265
10617
|
EnterpriseWebSearch,
|
|
10266
10618
|
FunctionDeclaration,
|
|
10267
|
-
GoogleMaps,
|
|
10268
10619
|
DynamicRetrievalConfig,
|
|
10269
10620
|
GoogleSearchRetrieval,
|
|
10621
|
+
ToolParallelAiSearch,
|
|
10270
10622
|
UrlContext,
|
|
10271
10623
|
StreamableHttpTransport,
|
|
10272
10624
|
McpServer,
|
|
@@ -10283,6 +10635,7 @@ declare namespace types {
|
|
|
10283
10635
|
SpeechConfig,
|
|
10284
10636
|
AutomaticFunctionCallingConfig,
|
|
10285
10637
|
ThinkingConfig,
|
|
10638
|
+
ImageConfigImageOutputOptions,
|
|
10286
10639
|
ImageConfig,
|
|
10287
10640
|
GenerationConfigRoutingConfigAutoRoutingMode,
|
|
10288
10641
|
GenerationConfigRoutingConfigManualRoutingMode,
|
|
@@ -10413,6 +10766,23 @@ declare namespace types {
|
|
|
10413
10766
|
TuningDataStats,
|
|
10414
10767
|
EncryptionSpec,
|
|
10415
10768
|
PartnerModelTuningSpec,
|
|
10769
|
+
BleuMetricValue,
|
|
10770
|
+
CustomCodeExecutionResult,
|
|
10771
|
+
ExactMatchMetricValue,
|
|
10772
|
+
RawOutput,
|
|
10773
|
+
CustomOutput,
|
|
10774
|
+
PairwiseMetricResult,
|
|
10775
|
+
PointwiseMetricResult,
|
|
10776
|
+
RougeMetricValue,
|
|
10777
|
+
AggregationResult,
|
|
10778
|
+
BigQuerySource,
|
|
10779
|
+
GcsSource,
|
|
10780
|
+
EvaluationDataset,
|
|
10781
|
+
AggregationOutput,
|
|
10782
|
+
OutputInfo,
|
|
10783
|
+
EvaluateDatasetResponse,
|
|
10784
|
+
EvaluateDatasetRun,
|
|
10785
|
+
FullFineTuningSpec,
|
|
10416
10786
|
VeoHyperParameters,
|
|
10417
10787
|
VeoTuningSpec,
|
|
10418
10788
|
TuningJob,
|
|
@@ -10918,9 +11288,9 @@ declare interface URLContextCallContent {
|
|
|
10918
11288
|
type: 'url_context_call';
|
|
10919
11289
|
}
|
|
10920
11290
|
|
|
10921
|
-
/** Metadata
|
|
11291
|
+
/** Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */
|
|
10922
11292
|
export declare interface UrlContextMetadata {
|
|
10923
|
-
/** Output only.
|
|
11293
|
+
/** Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. */
|
|
10924
11294
|
urlMetadata?: UrlMetadata[];
|
|
10925
11295
|
}
|
|
10926
11296
|
|
|
@@ -10956,31 +11326,31 @@ declare interface URLContextResultContent {
|
|
|
10956
11326
|
*/
|
|
10957
11327
|
is_error?: boolean;
|
|
10958
11328
|
/**
|
|
10959
|
-
*
|
|
11329
|
+
* A signature hash for backend validation.
|
|
10960
11330
|
*/
|
|
10961
11331
|
signature?: string;
|
|
10962
11332
|
}
|
|
10963
11333
|
|
|
10964
|
-
/**
|
|
11334
|
+
/** The metadata for a single URL retrieval. */
|
|
10965
11335
|
export declare interface UrlMetadata {
|
|
10966
|
-
/**
|
|
11336
|
+
/** The URL retrieved by the tool. */
|
|
10967
11337
|
retrievedUrl?: string;
|
|
10968
|
-
/**
|
|
11338
|
+
/** The status of the URL retrieval. */
|
|
10969
11339
|
urlRetrievalStatus?: UrlRetrievalStatus;
|
|
10970
11340
|
}
|
|
10971
11341
|
|
|
10972
|
-
/**
|
|
11342
|
+
/** The status of the URL retrieval. */
|
|
10973
11343
|
export declare enum UrlRetrievalStatus {
|
|
10974
11344
|
/**
|
|
10975
11345
|
* Default value. This value is unused.
|
|
10976
11346
|
*/
|
|
10977
11347
|
URL_RETRIEVAL_STATUS_UNSPECIFIED = "URL_RETRIEVAL_STATUS_UNSPECIFIED",
|
|
10978
11348
|
/**
|
|
10979
|
-
*
|
|
11349
|
+
* The URL was retrieved successfully.
|
|
10980
11350
|
*/
|
|
10981
11351
|
URL_RETRIEVAL_STATUS_SUCCESS = "URL_RETRIEVAL_STATUS_SUCCESS",
|
|
10982
11352
|
/**
|
|
10983
|
-
*
|
|
11353
|
+
* The URL retrieval failed.
|
|
10984
11354
|
*/
|
|
10985
11355
|
URL_RETRIEVAL_STATUS_ERROR = "URL_RETRIEVAL_STATUS_ERROR",
|
|
10986
11356
|
/**
|
|
@@ -11146,6 +11516,8 @@ export declare interface VeoHyperParameters {
|
|
|
11146
11516
|
learningRateMultiplier?: number;
|
|
11147
11517
|
/** Optional. The tuning task. Either I2V or T2V. */
|
|
11148
11518
|
tuningTask?: TuningTask;
|
|
11519
|
+
/** 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. */
|
|
11520
|
+
veoDataMixtureRatio?: number;
|
|
11149
11521
|
}
|
|
11150
11522
|
|
|
11151
11523
|
/** Tuning Spec for Veo Model Tuning. This data type is not supported in Gemini API. */
|
|
@@ -11313,11 +11685,11 @@ export declare enum VideoGenerationReferenceType {
|
|
|
11313
11685
|
STYLE = "STYLE"
|
|
11314
11686
|
}
|
|
11315
11687
|
|
|
11316
|
-
/**
|
|
11688
|
+
/** Provides metadata for a video, including the start and end offsets for clipping and the frame rate. */
|
|
11317
11689
|
export declare interface VideoMetadata {
|
|
11318
11690
|
/** Optional. The end offset of the video. */
|
|
11319
11691
|
endOffset?: string;
|
|
11320
|
-
/** Optional. The frame rate of the video sent to the model. If not specified, the default value
|
|
11692
|
+
/** 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]. */
|
|
11321
11693
|
fps?: number;
|
|
11322
11694
|
/** Optional. The start offset of the video. */
|
|
11323
11695
|
startOffset?: string;
|
|
@@ -11353,7 +11725,7 @@ export declare enum VoiceActivityType {
|
|
|
11353
11725
|
export declare interface VoiceConfig {
|
|
11354
11726
|
/** If true, the model will use a replicated voice for the response. */
|
|
11355
11727
|
replicatedVoiceConfig?: ReplicatedVoiceConfig;
|
|
11356
|
-
/** The configuration for
|
|
11728
|
+
/** The configuration for a prebuilt voice. */
|
|
11357
11729
|
prebuiltVoiceConfig?: PrebuiltVoiceConfig;
|
|
11358
11730
|
}
|
|
11359
11731
|
|