@google/genai 2.9.0 → 2.11.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 +1149 -566
- package/dist/index.cjs +579 -105
- package/dist/index.mjs +575 -106
- package/dist/index.mjs.map +1 -1
- package/dist/node/index.cjs +579 -105
- package/dist/node/index.mjs +575 -106
- package/dist/node/index.mjs.map +1 -1
- package/dist/node/node.d.ts +1149 -566
- package/dist/tokenizer/node.cjs +213 -73
- package/dist/tokenizer/node.d.ts +245 -14
- package/dist/tokenizer/node.mjs +213 -73
- package/dist/tokenizer/node.mjs.map +1 -1
- package/dist/vertex_internal/index.cjs +214 -74
- package/dist/vertex_internal/index.cjs.map +1 -1
- package/dist/vertex_internal/index.d.ts +339 -82
- package/dist/vertex_internal/index.js +214 -74
- package/dist/vertex_internal/index.js.map +1 -1
- package/dist/web/index.mjs +575 -106
- package/dist/web/index.mjs.map +1 -1
- package/dist/web/web.d.ts +1149 -566
- package/package.json +2 -9
package/dist/node/node.d.ts
CHANGED
|
@@ -80,30 +80,30 @@ declare type Agent$ = Agent;
|
|
|
80
80
|
* }
|
|
81
81
|
*/
|
|
82
82
|
declare type Agent = {
|
|
83
|
-
/**
|
|
84
|
-
* The unique identifier for the agent.
|
|
85
|
-
*/
|
|
86
|
-
id?: string | undefined;
|
|
87
83
|
/**
|
|
88
84
|
* The base agent to extend.
|
|
89
85
|
*/
|
|
90
86
|
base_agent?: string | undefined;
|
|
91
87
|
/**
|
|
92
|
-
*
|
|
88
|
+
* The environment configuration for the agent.
|
|
93
89
|
*/
|
|
94
|
-
|
|
90
|
+
base_environment?: interactions.Environment | string | undefined;
|
|
95
91
|
/**
|
|
96
92
|
* Agent description for developers to quickly read and understand.
|
|
97
93
|
*/
|
|
98
94
|
description?: string | undefined;
|
|
99
95
|
/**
|
|
100
|
-
* The
|
|
96
|
+
* The unique identifier for the agent.
|
|
101
97
|
*/
|
|
102
|
-
|
|
98
|
+
id?: string | undefined;
|
|
103
99
|
/**
|
|
104
|
-
*
|
|
100
|
+
* System instruction for the agent.
|
|
105
101
|
*/
|
|
106
|
-
|
|
102
|
+
system_instruction?: string | undefined;
|
|
103
|
+
/**
|
|
104
|
+
* The tools available to the agent.
|
|
105
|
+
*/
|
|
106
|
+
tools?: Array<AgentTool> | undefined;
|
|
107
107
|
};
|
|
108
108
|
|
|
109
109
|
declare type AgentCreateParams$ = CreateAgentParams;
|
|
@@ -160,7 +160,7 @@ declare type AgentTool$ = AgentTool;
|
|
|
160
160
|
/**
|
|
161
161
|
* A tool that the agent can use.
|
|
162
162
|
*/
|
|
163
|
-
declare type AgentTool = interactions.CodeExecution | interactions.GoogleSearch | interactions.URLContext | interactions.MCPServer;
|
|
163
|
+
declare type AgentTool = interactions.CodeExecution | interactions.GoogleSearch | interactions.URLContext | interactions.MCPServer | interactions.FunctionT;
|
|
164
164
|
|
|
165
165
|
/** Aggregation metric. This enum is not supported in Gemini API. */
|
|
166
166
|
export declare enum AggregationMetric {
|
|
@@ -251,8 +251,6 @@ declare type AllowedTools = {
|
|
|
251
251
|
|
|
252
252
|
declare type Allowlist$ = Allowlist;
|
|
253
253
|
|
|
254
|
-
declare type Allowlist$2 = AllowlistEntry;
|
|
255
|
-
|
|
256
254
|
/**
|
|
257
255
|
* Outbound networking configuration for the sandbox. When specified, restricts which external domains the sandbox can reach. Omit entirely to allow all outbound traffic with no header injection.
|
|
258
256
|
*/
|
|
@@ -263,13 +261,6 @@ declare type Allowlist = {
|
|
|
263
261
|
allowlist?: Array<AllowlistEntry> | undefined;
|
|
264
262
|
};
|
|
265
263
|
|
|
266
|
-
/**
|
|
267
|
-
* @license
|
|
268
|
-
* Copyright 2026 Google LLC
|
|
269
|
-
* SPDX-License-Identifier: Apache-2.0
|
|
270
|
-
*
|
|
271
|
-
* g3-prettier-ignore-file
|
|
272
|
-
*/
|
|
273
264
|
/**
|
|
274
265
|
* A single domain allowlist rule with optional header injection.
|
|
275
266
|
*/
|
|
@@ -279,9 +270,11 @@ declare type AllowlistEntry = {
|
|
|
279
270
|
*/
|
|
280
271
|
domain: string;
|
|
281
272
|
/**
|
|
282
|
-
* Headers to inject on all outbound requests matching this domain.
|
|
273
|
+
* Headers to inject on all outbound requests matching this domain. Accepts a single dict or a list of dicts. The egress proxy injects these automatically.
|
|
283
274
|
*/
|
|
284
|
-
transform?:
|
|
275
|
+
transform?: {
|
|
276
|
+
[k: string]: string;
|
|
277
|
+
} | Array<{
|
|
285
278
|
[k: string]: string;
|
|
286
279
|
}> | undefined;
|
|
287
280
|
};
|
|
@@ -496,24 +489,9 @@ declare type Arguments$2 = GoogleMapsCallArguments;
|
|
|
496
489
|
|
|
497
490
|
declare type Arguments$3 = GoogleSearchCallArguments;
|
|
498
491
|
|
|
499
|
-
declare type Arguments$4 =
|
|
492
|
+
declare type Arguments$4 = RetrievalCallArguments;
|
|
500
493
|
|
|
501
|
-
|
|
502
|
-
* @license
|
|
503
|
-
* Copyright 2026 Google LLC
|
|
504
|
-
* SPDX-License-Identifier: Apache-2.0
|
|
505
|
-
*
|
|
506
|
-
* g3-prettier-ignore-file
|
|
507
|
-
*/
|
|
508
|
-
/**
|
|
509
|
-
* The arguments to pass to the URL context.
|
|
510
|
-
*/
|
|
511
|
-
declare type Arguments = {
|
|
512
|
-
/**
|
|
513
|
-
* The URLs to fetch.
|
|
514
|
-
*/
|
|
515
|
-
urls?: Array<string> | undefined;
|
|
516
|
-
};
|
|
494
|
+
declare type Arguments$5 = URLContextCallArguments;
|
|
517
495
|
|
|
518
496
|
declare type ArgumentsDelta$ = ArgumentsDelta;
|
|
519
497
|
|
|
@@ -525,10 +503,74 @@ declare type ArgumentsDelta$ = ArgumentsDelta;
|
|
|
525
503
|
* g3-prettier-ignore-file
|
|
526
504
|
*/
|
|
527
505
|
declare type ArgumentsDelta = {
|
|
528
|
-
type: "arguments_delta";
|
|
529
506
|
arguments?: string | undefined;
|
|
507
|
+
type: "arguments_delta";
|
|
530
508
|
};
|
|
531
509
|
|
|
510
|
+
/** The aspect ratio for the image output. */
|
|
511
|
+
export declare enum AspectRatio {
|
|
512
|
+
/**
|
|
513
|
+
* Default value. This value is unused.
|
|
514
|
+
*/
|
|
515
|
+
ASPECT_RATIO_UNSPECIFIED = "ASPECT_RATIO_UNSPECIFIED",
|
|
516
|
+
/**
|
|
517
|
+
* 1:1 aspect ratio.
|
|
518
|
+
*/
|
|
519
|
+
ASPECT_RATIO_ONE_BY_ONE = "ASPECT_RATIO_ONE_BY_ONE",
|
|
520
|
+
/**
|
|
521
|
+
* 2:3 aspect ratio.
|
|
522
|
+
*/
|
|
523
|
+
ASPECT_RATIO_TWO_BY_THREE = "ASPECT_RATIO_TWO_BY_THREE",
|
|
524
|
+
/**
|
|
525
|
+
* 3:2 aspect ratio.
|
|
526
|
+
*/
|
|
527
|
+
ASPECT_RATIO_THREE_BY_TWO = "ASPECT_RATIO_THREE_BY_TWO",
|
|
528
|
+
/**
|
|
529
|
+
* 3:4 aspect ratio.
|
|
530
|
+
*/
|
|
531
|
+
ASPECT_RATIO_THREE_BY_FOUR = "ASPECT_RATIO_THREE_BY_FOUR",
|
|
532
|
+
/**
|
|
533
|
+
* 4:3 aspect ratio.
|
|
534
|
+
*/
|
|
535
|
+
ASPECT_RATIO_FOUR_BY_THREE = "ASPECT_RATIO_FOUR_BY_THREE",
|
|
536
|
+
/**
|
|
537
|
+
* 4:5 aspect ratio.
|
|
538
|
+
*/
|
|
539
|
+
ASPECT_RATIO_FOUR_BY_FIVE = "ASPECT_RATIO_FOUR_BY_FIVE",
|
|
540
|
+
/**
|
|
541
|
+
* 5:4 aspect ratio.
|
|
542
|
+
*/
|
|
543
|
+
ASPECT_RATIO_FIVE_BY_FOUR = "ASPECT_RATIO_FIVE_BY_FOUR",
|
|
544
|
+
/**
|
|
545
|
+
* 9:16 aspect ratio.
|
|
546
|
+
*/
|
|
547
|
+
ASPECT_RATIO_NINE_BY_SIXTEEN = "ASPECT_RATIO_NINE_BY_SIXTEEN",
|
|
548
|
+
/**
|
|
549
|
+
* 16:9 aspect ratio.
|
|
550
|
+
*/
|
|
551
|
+
ASPECT_RATIO_SIXTEEN_BY_NINE = "ASPECT_RATIO_SIXTEEN_BY_NINE",
|
|
552
|
+
/**
|
|
553
|
+
* 21:9 aspect ratio.
|
|
554
|
+
*/
|
|
555
|
+
ASPECT_RATIO_TWENTY_ONE_BY_NINE = "ASPECT_RATIO_TWENTY_ONE_BY_NINE",
|
|
556
|
+
/**
|
|
557
|
+
* 1:8 aspect ratio.
|
|
558
|
+
*/
|
|
559
|
+
ASPECT_RATIO_ONE_BY_EIGHT = "ASPECT_RATIO_ONE_BY_EIGHT",
|
|
560
|
+
/**
|
|
561
|
+
* 8:1 aspect ratio.
|
|
562
|
+
*/
|
|
563
|
+
ASPECT_RATIO_EIGHT_BY_ONE = "ASPECT_RATIO_EIGHT_BY_ONE",
|
|
564
|
+
/**
|
|
565
|
+
* 1:4 aspect ratio.
|
|
566
|
+
*/
|
|
567
|
+
ASPECT_RATIO_ONE_BY_FOUR = "ASPECT_RATIO_ONE_BY_FOUR",
|
|
568
|
+
/**
|
|
569
|
+
* 4:1 aspect ratio.
|
|
570
|
+
*/
|
|
571
|
+
ASPECT_RATIO_FOUR_BY_ONE = "ASPECT_RATIO_FOUR_BY_ONE"
|
|
572
|
+
}
|
|
573
|
+
|
|
532
574
|
declare type Audio$ = AudioDelta;
|
|
533
575
|
|
|
534
576
|
/** Representation of an audio chunk. */
|
|
@@ -548,27 +590,27 @@ declare type AudioContent$ = AudioContent;
|
|
|
548
590
|
* An audio content block.
|
|
549
591
|
*/
|
|
550
592
|
declare type AudioContent = {
|
|
551
|
-
type: "audio";
|
|
552
593
|
/**
|
|
553
|
-
* The audio
|
|
594
|
+
* The number of audio channels.
|
|
554
595
|
*/
|
|
555
|
-
|
|
596
|
+
channels?: number | undefined;
|
|
556
597
|
/**
|
|
557
|
-
* The
|
|
598
|
+
* The audio content.
|
|
558
599
|
*/
|
|
559
|
-
|
|
600
|
+
data?: string | undefined;
|
|
560
601
|
/**
|
|
561
602
|
* The mime type of the audio.
|
|
562
603
|
*/
|
|
563
604
|
mime_type?: AudioContentMimeType | undefined;
|
|
564
|
-
/**
|
|
565
|
-
* The number of audio channels.
|
|
566
|
-
*/
|
|
567
|
-
channels?: number | undefined;
|
|
568
605
|
/**
|
|
569
606
|
* The sample rate of the audio.
|
|
570
607
|
*/
|
|
571
608
|
sample_rate?: number | undefined;
|
|
609
|
+
type: "audio";
|
|
610
|
+
/**
|
|
611
|
+
* The URI of the audio.
|
|
612
|
+
*/
|
|
613
|
+
uri?: string | undefined;
|
|
572
614
|
};
|
|
573
615
|
|
|
574
616
|
/**
|
|
@@ -584,9 +626,11 @@ declare type AudioContent = {
|
|
|
584
626
|
declare type AudioContentMimeType = "audio/wav" | "audio/mp3" | "audio/aiff" | "audio/aac" | "audio/ogg" | "audio/flac" | "audio/mpeg" | "audio/m4a" | "audio/l16" | "audio/opus" | "audio/alaw" | "audio/mulaw" | (string & {});
|
|
585
627
|
|
|
586
628
|
declare type AudioDelta = {
|
|
587
|
-
|
|
629
|
+
/**
|
|
630
|
+
* The number of audio channels.
|
|
631
|
+
*/
|
|
632
|
+
channels?: number | undefined;
|
|
588
633
|
data?: string | undefined;
|
|
589
|
-
uri?: string | undefined;
|
|
590
634
|
mime_type?: AudioDeltaMimeType | undefined;
|
|
591
635
|
/**
|
|
592
636
|
* Deprecated. Use sample_rate instead. The value is ignored.
|
|
@@ -598,10 +642,8 @@ declare type AudioDelta = {
|
|
|
598
642
|
* The sample rate of the audio.
|
|
599
643
|
*/
|
|
600
644
|
sample_rate?: number | undefined;
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
*/
|
|
604
|
-
channels?: number | undefined;
|
|
645
|
+
type: "audio";
|
|
646
|
+
uri?: string | undefined;
|
|
605
647
|
};
|
|
606
648
|
|
|
607
649
|
/**
|
|
@@ -613,39 +655,46 @@ declare type AudioDelta = {
|
|
|
613
655
|
*/
|
|
614
656
|
declare type AudioDeltaMimeType = "audio/wav" | "audio/mp3" | "audio/aiff" | "audio/aac" | "audio/ogg" | "audio/flac" | "audio/mpeg" | "audio/m4a" | "audio/l16" | "audio/opus" | "audio/alaw" | "audio/mulaw" | (string & {});
|
|
615
657
|
|
|
616
|
-
declare type AudioResponseFormat$ =
|
|
658
|
+
declare type AudioResponseFormat$ = AudioResponseFormat_2;
|
|
659
|
+
|
|
660
|
+
/** Configuration for audio-specific output formatting. */
|
|
661
|
+
export declare class AudioResponseFormat {
|
|
662
|
+
/** Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). */
|
|
663
|
+
bitRate?: number;
|
|
664
|
+
/** Optional. Delivery mode for the generated content. */
|
|
665
|
+
delivery?: Delivery;
|
|
666
|
+
/** Optional. The MIME type of the audio output. */
|
|
667
|
+
mimeType?: string;
|
|
668
|
+
/** Optional. Sample rate for the generated audio in Hertz. */
|
|
669
|
+
sampleRate?: number;
|
|
670
|
+
}
|
|
617
671
|
|
|
618
672
|
/**
|
|
619
673
|
* Configuration for audio output format.
|
|
620
674
|
*/
|
|
621
|
-
declare type
|
|
622
|
-
type: "audio";
|
|
675
|
+
declare type AudioResponseFormat_2 = {
|
|
623
676
|
/**
|
|
624
|
-
*
|
|
677
|
+
* Bit rate in bits per second (bps). Only applicable for compressed formats
|
|
678
|
+
*
|
|
679
|
+
* @remarks
|
|
680
|
+
* (MP3, Opus).
|
|
625
681
|
*/
|
|
626
|
-
|
|
682
|
+
bit_rate?: number | undefined;
|
|
627
683
|
/**
|
|
628
684
|
* The delivery mode for the audio output.
|
|
629
685
|
*/
|
|
630
686
|
delivery?: AudioResponseFormatDelivery | undefined;
|
|
631
687
|
/**
|
|
632
|
-
*
|
|
688
|
+
* The MIME type of the audio output.
|
|
633
689
|
*/
|
|
634
|
-
|
|
690
|
+
mime_type?: AudioResponseFormatMimeType | undefined;
|
|
635
691
|
/**
|
|
636
|
-
*
|
|
637
|
-
*
|
|
638
|
-
* @remarks
|
|
639
|
-
* (MP3, Opus).
|
|
692
|
+
* Sample rate in Hz.
|
|
640
693
|
*/
|
|
641
|
-
|
|
694
|
+
sample_rate?: number | undefined;
|
|
695
|
+
type: "audio";
|
|
642
696
|
};
|
|
643
697
|
|
|
644
|
-
/**
|
|
645
|
-
* The delivery mode for the audio output.
|
|
646
|
-
*/
|
|
647
|
-
declare type AudioResponseFormatDelivery = "inline" | "uri" | (string & {});
|
|
648
|
-
|
|
649
698
|
/**
|
|
650
699
|
* @license
|
|
651
700
|
* Copyright 2026 Google LLC
|
|
@@ -653,6 +702,11 @@ declare type AudioResponseFormatDelivery = "inline" | "uri" | (string & {});
|
|
|
653
702
|
*
|
|
654
703
|
* g3-prettier-ignore-file
|
|
655
704
|
*/
|
|
705
|
+
/**
|
|
706
|
+
* The delivery mode for the audio output.
|
|
707
|
+
*/
|
|
708
|
+
declare type AudioResponseFormatDelivery = "inline" | "uri" | (string & {});
|
|
709
|
+
|
|
656
710
|
/**
|
|
657
711
|
* The MIME type of the audio output.
|
|
658
712
|
*/
|
|
@@ -1031,7 +1085,7 @@ export declare interface BatchJob {
|
|
|
1031
1085
|
outputInfo?: BatchJobOutputInfo;
|
|
1032
1086
|
}
|
|
1033
1087
|
|
|
1034
|
-
/** Config for `
|
|
1088
|
+
/** Config for `dest` parameter. */
|
|
1035
1089
|
export declare interface BatchJobDestination {
|
|
1036
1090
|
/** Storage format of the output files. Must be one of:
|
|
1037
1091
|
'jsonl', 'bigquery', 'vertex-dataset'.
|
|
@@ -1103,7 +1157,7 @@ export declare interface BatchJobSource {
|
|
|
1103
1157
|
|
|
1104
1158
|
export declare type BatchJobSourceUnion = BatchJobSource | InlinedRequest[] | string;
|
|
1105
1159
|
|
|
1106
|
-
/** Specifies the function Behavior.
|
|
1160
|
+
/** Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. */
|
|
1107
1161
|
export declare enum Behavior {
|
|
1108
1162
|
/**
|
|
1109
1163
|
* This value is unspecified.
|
|
@@ -1618,18 +1672,17 @@ declare type CodeExecutionCallArguments$ = CodeExecutionCallArguments;
|
|
|
1618
1672
|
* The arguments to pass to the code execution.
|
|
1619
1673
|
*/
|
|
1620
1674
|
declare type CodeExecutionCallArguments = {
|
|
1621
|
-
/**
|
|
1622
|
-
* Programming language of the `code`.
|
|
1623
|
-
*/
|
|
1624
|
-
language?: Language_2 | undefined;
|
|
1625
1675
|
/**
|
|
1626
1676
|
* The code to be executed.
|
|
1627
1677
|
*/
|
|
1628
1678
|
code?: string | undefined;
|
|
1679
|
+
/**
|
|
1680
|
+
* Programming language of the `code`.
|
|
1681
|
+
*/
|
|
1682
|
+
language?: Language_2 | undefined;
|
|
1629
1683
|
};
|
|
1630
1684
|
|
|
1631
1685
|
declare type CodeExecutionCallDelta = {
|
|
1632
|
-
type: "code_execution_call";
|
|
1633
1686
|
/**
|
|
1634
1687
|
* The arguments to pass to the code execution.
|
|
1635
1688
|
*/
|
|
@@ -1638,6 +1691,7 @@ declare type CodeExecutionCallDelta = {
|
|
|
1638
1691
|
* A signature hash for backend validation.
|
|
1639
1692
|
*/
|
|
1640
1693
|
signature?: string | undefined;
|
|
1694
|
+
type: "code_execution_call";
|
|
1641
1695
|
};
|
|
1642
1696
|
|
|
1643
1697
|
declare type CodeExecutionCallStep$ = CodeExecutionCallStep;
|
|
@@ -1646,7 +1700,6 @@ declare type CodeExecutionCallStep$ = CodeExecutionCallStep;
|
|
|
1646
1700
|
* Code execution call step.
|
|
1647
1701
|
*/
|
|
1648
1702
|
declare type CodeExecutionCallStep = {
|
|
1649
|
-
type: "code_execution_call";
|
|
1650
1703
|
/**
|
|
1651
1704
|
* The arguments to pass to the code execution.
|
|
1652
1705
|
*/
|
|
@@ -1659,6 +1712,7 @@ declare type CodeExecutionCallStep = {
|
|
|
1659
1712
|
* A signature hash for backend validation.
|
|
1660
1713
|
*/
|
|
1661
1714
|
signature?: string | undefined;
|
|
1715
|
+
type: "code_execution_call";
|
|
1662
1716
|
};
|
|
1663
1717
|
|
|
1664
1718
|
declare type CodeExecutionResult$ = CodeExecutionResultDelta;
|
|
@@ -1681,13 +1735,13 @@ export declare interface CodeExecutionResult {
|
|
|
1681
1735
|
* g3-prettier-ignore-file
|
|
1682
1736
|
*/
|
|
1683
1737
|
declare type CodeExecutionResultDelta = {
|
|
1684
|
-
type: "code_execution_result";
|
|
1685
|
-
result: string;
|
|
1686
1738
|
is_error?: boolean | undefined;
|
|
1739
|
+
result: string;
|
|
1687
1740
|
/**
|
|
1688
1741
|
* A signature hash for backend validation.
|
|
1689
1742
|
*/
|
|
1690
1743
|
signature?: string | undefined;
|
|
1744
|
+
type: "code_execution_result";
|
|
1691
1745
|
};
|
|
1692
1746
|
|
|
1693
1747
|
declare type CodeExecutionResultStep$ = CodeExecutionResultStep;
|
|
@@ -1703,23 +1757,23 @@ declare type CodeExecutionResultStep$ = CodeExecutionResultStep;
|
|
|
1703
1757
|
* Code execution result step.
|
|
1704
1758
|
*/
|
|
1705
1759
|
declare type CodeExecutionResultStep = {
|
|
1706
|
-
type: "code_execution_result";
|
|
1707
1760
|
/**
|
|
1708
|
-
* Required.
|
|
1761
|
+
* Required. ID to match the ID from the function call block.
|
|
1709
1762
|
*/
|
|
1710
|
-
|
|
1763
|
+
call_id: string;
|
|
1711
1764
|
/**
|
|
1712
1765
|
* Whether the code execution resulted in an error.
|
|
1713
1766
|
*/
|
|
1714
1767
|
is_error?: boolean | undefined;
|
|
1715
1768
|
/**
|
|
1716
|
-
* Required.
|
|
1769
|
+
* Required. The output of the code execution.
|
|
1717
1770
|
*/
|
|
1718
|
-
|
|
1771
|
+
result: string;
|
|
1719
1772
|
/**
|
|
1720
1773
|
* A signature hash for backend validation.
|
|
1721
1774
|
*/
|
|
1722
1775
|
signature?: string | undefined;
|
|
1776
|
+
type: "code_execution_result";
|
|
1723
1777
|
};
|
|
1724
1778
|
|
|
1725
1779
|
/** Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch. This data type is not supported in Gemini API. */
|
|
@@ -1736,13 +1790,15 @@ export declare interface CompletionStats {
|
|
|
1736
1790
|
|
|
1737
1791
|
/** Composite reinforcement tuning reward config. */
|
|
1738
1792
|
export declare interface CompositeReinforcementTuningRewardConfig {
|
|
1793
|
+
/** List of reward function configurations with weights. */
|
|
1739
1794
|
weightedRewardConfigs?: CompositeReinforcementTuningRewardConfigWeightedRewardConfig[];
|
|
1740
1795
|
}
|
|
1741
1796
|
|
|
1742
1797
|
/** Composite reinforcement tuning reward config weighted reward config. */
|
|
1743
1798
|
export declare interface CompositeReinforcementTuningRewardConfigWeightedRewardConfig {
|
|
1799
|
+
/** Single reward configuration. */
|
|
1744
1800
|
rewardConfig?: SingleReinforcementTuningRewardConfig;
|
|
1745
|
-
/** How much this single reward contributes to the total overall reward. */
|
|
1801
|
+
/** How much this single reward contributes to the total overall reward. Total reward is a linear combination of single rewards with their corresponding weights, i.e., ``` total_reward = ( weight_a * reward_a + weight_b * reward_b + ... ) / (weight_a + weight_b + ...) ``` */
|
|
1746
1802
|
weight?: number;
|
|
1747
1803
|
}
|
|
1748
1804
|
|
|
@@ -1752,30 +1808,22 @@ declare type ComputerUse$ = ComputerUse_2;
|
|
|
1752
1808
|
export declare interface ComputerUse {
|
|
1753
1809
|
/** Required. The environment being operated. */
|
|
1754
1810
|
environment?: Environment;
|
|
1755
|
-
/** By default, predefined functions are included in the final model call.
|
|
1756
|
-
Some of them can be explicitly excluded from being automatically included.
|
|
1757
|
-
This can serve two purposes:
|
|
1758
|
-
1. Using a more restricted / different action space.
|
|
1759
|
-
2. Improving the definitions / instructions of predefined functions. */
|
|
1811
|
+
/** Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. */
|
|
1760
1812
|
excludedPredefinedFunctions?: string[];
|
|
1761
|
-
/** Optional.
|
|
1762
|
-
*/
|
|
1813
|
+
/** Optional. Enables the prompt injection detection check on computer-use request. */
|
|
1763
1814
|
enablePromptInjectionDetection?: boolean;
|
|
1815
|
+
/** Optional. Disabled safety policies for computer use. This field is not supported in Vertex AI. */
|
|
1816
|
+
disabledSafetyPolicies?: SafetyPolicy[];
|
|
1764
1817
|
}
|
|
1765
1818
|
|
|
1766
1819
|
/**
|
|
1767
1820
|
* A tool that can be used by the model to interact with the computer.
|
|
1768
1821
|
*/
|
|
1769
1822
|
declare type ComputerUse_2 = {
|
|
1770
|
-
type: "computer_use";
|
|
1771
|
-
/**
|
|
1772
|
-
* The environment being operated.
|
|
1773
|
-
*/
|
|
1774
|
-
environment?: EnvironmentEnum | undefined;
|
|
1775
1823
|
/**
|
|
1776
|
-
*
|
|
1824
|
+
* Optional. Disabled safety policies for computer use.
|
|
1777
1825
|
*/
|
|
1778
|
-
|
|
1826
|
+
disabled_safety_policies?: Array<DisabledSafetyPolicy> | undefined;
|
|
1779
1827
|
/**
|
|
1780
1828
|
* Whether enable the prompt injection detection check on computer-use
|
|
1781
1829
|
*
|
|
@@ -1783,6 +1831,15 @@ declare type ComputerUse_2 = {
|
|
|
1783
1831
|
* request.
|
|
1784
1832
|
*/
|
|
1785
1833
|
enable_prompt_injection_detection?: boolean | undefined;
|
|
1834
|
+
/**
|
|
1835
|
+
* The environment being operated.
|
|
1836
|
+
*/
|
|
1837
|
+
environment?: EnvironmentEnum | undefined;
|
|
1838
|
+
/**
|
|
1839
|
+
* The list of predefined functions that are excluded from the model call.
|
|
1840
|
+
*/
|
|
1841
|
+
excluded_predefined_functions?: Array<string> | undefined;
|
|
1842
|
+
type: "computer_use";
|
|
1786
1843
|
};
|
|
1787
1844
|
|
|
1788
1845
|
/** Optional parameters for computing tokens. */
|
|
@@ -2031,7 +2088,7 @@ declare type CreateAgentInteraction = {
|
|
|
2031
2088
|
/**
|
|
2032
2089
|
* Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
|
|
2033
2090
|
*/
|
|
2034
|
-
response_format?: Array<
|
|
2091
|
+
response_format?: Array<ResponseFormat_2> | ResponseFormat_2 | undefined;
|
|
2035
2092
|
/**
|
|
2036
2093
|
* The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.
|
|
2037
2094
|
*/
|
|
@@ -2040,6 +2097,16 @@ declare type CreateAgentInteraction = {
|
|
|
2040
2097
|
* Configuration parameters for the agent interaction.
|
|
2041
2098
|
*/
|
|
2042
2099
|
agent_config?: DynamicAgentConfig | DeepResearchAgentConfig | undefined;
|
|
2100
|
+
/**
|
|
2101
|
+
* Safety settings for the interaction.
|
|
2102
|
+
*/
|
|
2103
|
+
safety_settings?: Array<SafetySetting_2> | undefined;
|
|
2104
|
+
/**
|
|
2105
|
+
* The labels with user-defined metadata for the request.
|
|
2106
|
+
*/
|
|
2107
|
+
labels?: {
|
|
2108
|
+
[k: string]: string;
|
|
2109
|
+
} | undefined;
|
|
2043
2110
|
/**
|
|
2044
2111
|
* The input for the interaction.
|
|
2045
2112
|
*/
|
|
@@ -2073,7 +2140,7 @@ declare type CreateAgentInteractionParamsStreaming = CreateAgentInteractionParam
|
|
|
2073
2140
|
/**
|
|
2074
2141
|
* Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
|
|
2075
2142
|
*/
|
|
2076
|
-
declare type CreateAgentInteractionResponseFormat = Array<
|
|
2143
|
+
declare type CreateAgentInteractionResponseFormat = Array<ResponseFormat_2> | ResponseFormat_2;
|
|
2077
2144
|
|
|
2078
2145
|
declare type CreateAgentParams = Omit<CreateAgentRequest, "body"> & CreateAgentRequest["body"];
|
|
2079
2146
|
|
|
@@ -2417,7 +2484,7 @@ declare type CreateModelInteraction = {
|
|
|
2417
2484
|
/**
|
|
2418
2485
|
* Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
|
|
2419
2486
|
*/
|
|
2420
|
-
response_format?: Array<
|
|
2487
|
+
response_format?: Array<ResponseFormat_2> | ResponseFormat_2 | undefined;
|
|
2421
2488
|
/**
|
|
2422
2489
|
* The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.
|
|
2423
2490
|
*/
|
|
@@ -2436,6 +2503,16 @@ declare type CreateModelInteraction = {
|
|
|
2436
2503
|
* `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
|
|
2437
2504
|
*/
|
|
2438
2505
|
cached_content?: string | undefined;
|
|
2506
|
+
/**
|
|
2507
|
+
* Safety settings for the interaction.
|
|
2508
|
+
*/
|
|
2509
|
+
safety_settings?: Array<SafetySetting_2> | undefined;
|
|
2510
|
+
/**
|
|
2511
|
+
* The labels with user-defined metadata for the request.
|
|
2512
|
+
*/
|
|
2513
|
+
labels?: {
|
|
2514
|
+
[k: string]: string;
|
|
2515
|
+
} | undefined;
|
|
2439
2516
|
/**
|
|
2440
2517
|
* The input for the interaction.
|
|
2441
2518
|
*/
|
|
@@ -2464,7 +2541,7 @@ declare type CreateModelInteractionParamsStreaming = CreateModelInteractionParam
|
|
|
2464
2541
|
/**
|
|
2465
2542
|
* Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
|
|
2466
2543
|
*/
|
|
2467
|
-
declare type CreateModelInteractionResponseFormat = Array<
|
|
2544
|
+
declare type CreateModelInteractionResponseFormat = Array<ResponseFormat_2> | ResponseFormat_2;
|
|
2468
2545
|
|
|
2469
2546
|
/**
|
|
2470
2547
|
* Creates a `Part` object from a `base64` encoded `string`.
|
|
@@ -2696,6 +2773,12 @@ export declare interface DatasetStats {
|
|
|
2696
2773
|
userMessagePerExampleDistribution?: DatasetDistribution;
|
|
2697
2774
|
/** Output only. Dataset distributions for the user output tokens. */
|
|
2698
2775
|
userOutputTokenDistribution?: DatasetDistribution;
|
|
2776
|
+
/** Output only. Dataset distributions for the number of contents per example. */
|
|
2777
|
+
contentsPerExampleDistribution?: DatasetDistribution;
|
|
2778
|
+
/** Output only. Sample user dataset examples in the training dataset uri for Reinforcement Tuning. */
|
|
2779
|
+
reinforcementTuningUserDatasetExamples?: ReinforcementTuningUserDatasetExamples;
|
|
2780
|
+
/** Output only. Number of billable tokens in the tuning dataset. */
|
|
2781
|
+
totalBillableTokenCount?: string;
|
|
2699
2782
|
}
|
|
2700
2783
|
|
|
2701
2784
|
declare type DeepResearchAgentConfig$ = DeepResearchAgentConfig;
|
|
@@ -2704,12 +2787,6 @@ declare type DeepResearchAgentConfig$ = DeepResearchAgentConfig;
|
|
|
2704
2787
|
* Configuration for the Deep Research agent.
|
|
2705
2788
|
*/
|
|
2706
2789
|
declare type DeepResearchAgentConfig = {
|
|
2707
|
-
type: "deep-research";
|
|
2708
|
-
thinking_summaries?: ThinkingSummaries | undefined;
|
|
2709
|
-
/**
|
|
2710
|
-
* Whether to include visualizations in the response.
|
|
2711
|
-
*/
|
|
2712
|
-
visualization?: Visualization | undefined;
|
|
2713
2790
|
/**
|
|
2714
2791
|
* Enables human-in-the-loop planning for the Deep Research agent. If set to
|
|
2715
2792
|
*
|
|
@@ -2723,6 +2800,12 @@ declare type DeepResearchAgentConfig = {
|
|
|
2723
2800
|
* Enables bigquery tool for the Deep Research agent.
|
|
2724
2801
|
*/
|
|
2725
2802
|
enable_bigquery_tool?: boolean | undefined;
|
|
2803
|
+
thinking_summaries?: ThinkingSummaries | undefined;
|
|
2804
|
+
type: "deep-research";
|
|
2805
|
+
/**
|
|
2806
|
+
* Whether to include visualizations in the response.
|
|
2807
|
+
*/
|
|
2808
|
+
visualization?: Visualization | undefined;
|
|
2726
2809
|
};
|
|
2727
2810
|
|
|
2728
2811
|
declare type DeleteAgentParams = Omit<DeleteAgentRequest, "id">;
|
|
@@ -2930,11 +3013,36 @@ declare type DeleteWebhookRequest = {
|
|
|
2930
3013
|
id: string;
|
|
2931
3014
|
};
|
|
2932
3015
|
|
|
3016
|
+
/** Delivery mode for the generated content. */
|
|
3017
|
+
export declare enum Delivery {
|
|
3018
|
+
/**
|
|
3019
|
+
* Default value. This value is unused.
|
|
3020
|
+
*/
|
|
3021
|
+
DELIVERY_UNSPECIFIED = "DELIVERY_UNSPECIFIED",
|
|
3022
|
+
/**
|
|
3023
|
+
* Generated bytes are returned inline in the response.
|
|
3024
|
+
*/
|
|
3025
|
+
INLINE = "INLINE",
|
|
3026
|
+
/**
|
|
3027
|
+
* Generated content is stored and a URI is returned.
|
|
3028
|
+
*/
|
|
3029
|
+
URI = "URI"
|
|
3030
|
+
}
|
|
3031
|
+
|
|
2933
3032
|
/**
|
|
2934
3033
|
* Turns all network off.
|
|
2935
3034
|
*/
|
|
2936
3035
|
declare type Disabled = "disabled";
|
|
2937
3036
|
|
|
3037
|
+
/**
|
|
3038
|
+
* @license
|
|
3039
|
+
* Copyright 2026 Google LLC
|
|
3040
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
3041
|
+
*
|
|
3042
|
+
* g3-prettier-ignore-file
|
|
3043
|
+
*/
|
|
3044
|
+
declare type DisabledSafetyPolicy = "financial_transactions" | "sensitive_data_modification" | "communication_tool" | "account_creation" | "data_modification" | "user_consent_management" | "legal_terms_and_agreements" | (string & {});
|
|
3045
|
+
|
|
2938
3046
|
/** 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. */
|
|
2939
3047
|
export declare interface DistillationDataStats {
|
|
2940
3048
|
/** Output only. Statistics computed for the training dataset. */
|
|
@@ -3034,19 +3142,19 @@ declare type DocumentContent$ = DocumentContent;
|
|
|
3034
3142
|
* A document content block.
|
|
3035
3143
|
*/
|
|
3036
3144
|
declare type DocumentContent = {
|
|
3037
|
-
type: "document";
|
|
3038
3145
|
/**
|
|
3039
3146
|
* The document content.
|
|
3040
3147
|
*/
|
|
3041
3148
|
data?: string | undefined;
|
|
3042
|
-
/**
|
|
3043
|
-
* The URI of the document.
|
|
3044
|
-
*/
|
|
3045
|
-
uri?: string | undefined;
|
|
3046
3149
|
/**
|
|
3047
3150
|
* The mime type of the document.
|
|
3048
3151
|
*/
|
|
3049
3152
|
mime_type?: DocumentContentMimeType | undefined;
|
|
3153
|
+
type: "document";
|
|
3154
|
+
/**
|
|
3155
|
+
* The URI of the document.
|
|
3156
|
+
*/
|
|
3157
|
+
uri?: string | undefined;
|
|
3050
3158
|
};
|
|
3051
3159
|
|
|
3052
3160
|
/**
|
|
@@ -3062,10 +3170,10 @@ declare type DocumentContent = {
|
|
|
3062
3170
|
declare type DocumentContentMimeType = "application/pdf" | "text/csv" | (string & {});
|
|
3063
3171
|
|
|
3064
3172
|
declare type DocumentDelta = {
|
|
3065
|
-
type: "document";
|
|
3066
3173
|
data?: string | undefined;
|
|
3067
|
-
uri?: string | undefined;
|
|
3068
3174
|
mime_type?: DocumentDeltaMimeType | undefined;
|
|
3175
|
+
type: "document";
|
|
3176
|
+
uri?: string | undefined;
|
|
3069
3177
|
};
|
|
3070
3178
|
|
|
3071
3179
|
/**
|
|
@@ -3523,21 +3631,21 @@ export declare enum Environment {
|
|
|
3523
3631
|
* Configuration for a custom environment.
|
|
3524
3632
|
*/
|
|
3525
3633
|
declare type Environment_2 = {
|
|
3526
|
-
|
|
3527
|
-
|
|
3634
|
+
/**
|
|
3635
|
+
* Optional. The environment ID for the interaction. If specified, the request will
|
|
3636
|
+
*
|
|
3637
|
+
* @remarks
|
|
3638
|
+
* update the existing environment instead of creating a new one.
|
|
3639
|
+
*/
|
|
3640
|
+
environment_id?: string | undefined;
|
|
3528
3641
|
/**
|
|
3529
3642
|
* Network configuration for the environment.
|
|
3530
3643
|
*/
|
|
3531
3644
|
network?: EnvironmentNetworkEgressAllowlist | NetworkEnum | undefined;
|
|
3645
|
+
sources?: Array<Source> | undefined;
|
|
3646
|
+
type: "remote";
|
|
3532
3647
|
};
|
|
3533
3648
|
|
|
3534
|
-
/**
|
|
3535
|
-
* @license
|
|
3536
|
-
* Copyright 2026 Google LLC
|
|
3537
|
-
* SPDX-License-Identifier: Apache-2.0
|
|
3538
|
-
*
|
|
3539
|
-
* g3-prettier-ignore-file
|
|
3540
|
-
*/
|
|
3541
3649
|
/**
|
|
3542
3650
|
* The environment being operated.
|
|
3543
3651
|
*/
|
|
@@ -3550,10 +3658,11 @@ declare type EnvironmentNetworkEgressAllowlist = Allowlist | Disabled;
|
|
|
3550
3658
|
|
|
3551
3659
|
declare type Error$ = ErrorT;
|
|
3552
3660
|
|
|
3661
|
+
declare type Error$2 = Status;
|
|
3662
|
+
|
|
3553
3663
|
declare type ErrorEvent$ = ErrorEvent_2;
|
|
3554
3664
|
|
|
3555
3665
|
declare type ErrorEvent_2 = {
|
|
3556
|
-
event_type: "error";
|
|
3557
3666
|
/**
|
|
3558
3667
|
* Error message from an interaction.
|
|
3559
3668
|
*/
|
|
@@ -3565,6 +3674,7 @@ declare type ErrorEvent_2 = {
|
|
|
3565
3674
|
* this event.
|
|
3566
3675
|
*/
|
|
3567
3676
|
event_id?: string | undefined;
|
|
3677
|
+
event_type: "error";
|
|
3568
3678
|
metadata?: StreamMetadata | undefined;
|
|
3569
3679
|
};
|
|
3570
3680
|
|
|
@@ -3763,33 +3873,36 @@ declare type FileCitation$ = FileCitation;
|
|
|
3763
3873
|
* A file citation annotation.
|
|
3764
3874
|
*/
|
|
3765
3875
|
declare type FileCitation = {
|
|
3766
|
-
|
|
3876
|
+
/**
|
|
3877
|
+
* User provided metadata about the retrieved context.
|
|
3878
|
+
*/
|
|
3879
|
+
custom_metadata?: {
|
|
3880
|
+
[k: string]: any;
|
|
3881
|
+
} | undefined;
|
|
3767
3882
|
/**
|
|
3768
3883
|
* The URI of the file.
|
|
3769
3884
|
*/
|
|
3770
3885
|
document_uri?: string | undefined;
|
|
3771
3886
|
/**
|
|
3772
|
-
*
|
|
3887
|
+
* End of the attributed segment, exclusive.
|
|
3773
3888
|
*/
|
|
3774
|
-
|
|
3889
|
+
end_index?: number | undefined;
|
|
3775
3890
|
/**
|
|
3776
|
-
*
|
|
3891
|
+
* The name of the file.
|
|
3777
3892
|
*/
|
|
3778
|
-
|
|
3893
|
+
file_name?: string | undefined;
|
|
3779
3894
|
/**
|
|
3780
|
-
*
|
|
3895
|
+
* Media ID in-case of image citations, if applicable.
|
|
3781
3896
|
*/
|
|
3782
|
-
|
|
3783
|
-
[k: string]: any;
|
|
3784
|
-
} | undefined;
|
|
3897
|
+
media_id?: string | undefined;
|
|
3785
3898
|
/**
|
|
3786
3899
|
* Page number of the cited document, if applicable.
|
|
3787
3900
|
*/
|
|
3788
3901
|
page_number?: number | undefined;
|
|
3789
3902
|
/**
|
|
3790
|
-
*
|
|
3903
|
+
* Source attributed for a portion of the text.
|
|
3791
3904
|
*/
|
|
3792
|
-
|
|
3905
|
+
source?: string | undefined;
|
|
3793
3906
|
/**
|
|
3794
3907
|
* Start of segment of the response that is attributed to this source.
|
|
3795
3908
|
*
|
|
@@ -3798,10 +3911,7 @@ declare type FileCitation = {
|
|
|
3798
3911
|
* Index indicates the start of the segment, measured in bytes.
|
|
3799
3912
|
*/
|
|
3800
3913
|
start_index?: number | undefined;
|
|
3801
|
-
|
|
3802
|
-
* End of the attributed segment, exclusive.
|
|
3803
|
-
*/
|
|
3804
|
-
end_index?: number | undefined;
|
|
3914
|
+
type: "file_citation";
|
|
3805
3915
|
};
|
|
3806
3916
|
|
|
3807
3917
|
/** 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. */
|
|
@@ -3845,7 +3955,7 @@ export declare class Files extends BaseModule {
|
|
|
3845
3955
|
* file extension.
|
|
3846
3956
|
* - For Blob object inputs, the `mimeType` will be set to the Blob's `type`
|
|
3847
3957
|
* property.
|
|
3848
|
-
*
|
|
3958
|
+
* Some examples for file extension to mimeType mapping:
|
|
3849
3959
|
* .txt -> text/plain
|
|
3850
3960
|
* .json -> application/json
|
|
3851
3961
|
* .jpg -> image/jpeg
|
|
@@ -3957,19 +4067,19 @@ export declare interface FileSearch {
|
|
|
3957
4067
|
* A tool that can be used by the model to search files.
|
|
3958
4068
|
*/
|
|
3959
4069
|
declare type FileSearch_2 = {
|
|
3960
|
-
type: "file_search";
|
|
3961
4070
|
/**
|
|
3962
4071
|
* The file search store names to search.
|
|
3963
4072
|
*/
|
|
3964
4073
|
file_search_store_names?: Array<string> | undefined;
|
|
3965
|
-
/**
|
|
3966
|
-
* The number of semantic retrieval chunks to retrieve.
|
|
3967
|
-
*/
|
|
3968
|
-
top_k?: number | undefined;
|
|
3969
4074
|
/**
|
|
3970
4075
|
* Metadata filter to apply to the semantic retrieval documents and chunks.
|
|
3971
4076
|
*/
|
|
3972
4077
|
metadata_filter?: string | undefined;
|
|
4078
|
+
/**
|
|
4079
|
+
* The number of semantic retrieval chunks to retrieve.
|
|
4080
|
+
*/
|
|
4081
|
+
top_k?: number | undefined;
|
|
4082
|
+
type: "file_search";
|
|
3973
4083
|
};
|
|
3974
4084
|
|
|
3975
4085
|
declare type FileSearchCall$ = FileSearchCallDelta;
|
|
@@ -3982,11 +4092,11 @@ declare type FileSearchCall$ = FileSearchCallDelta;
|
|
|
3982
4092
|
* g3-prettier-ignore-file
|
|
3983
4093
|
*/
|
|
3984
4094
|
declare type FileSearchCallDelta = {
|
|
3985
|
-
type: "file_search_call";
|
|
3986
4095
|
/**
|
|
3987
4096
|
* A signature hash for backend validation.
|
|
3988
4097
|
*/
|
|
3989
4098
|
signature?: string | undefined;
|
|
4099
|
+
type: "file_search_call";
|
|
3990
4100
|
};
|
|
3991
4101
|
|
|
3992
4102
|
declare type FileSearchCallStep$ = FileSearchCallStep;
|
|
@@ -4002,7 +4112,6 @@ declare type FileSearchCallStep$ = FileSearchCallStep;
|
|
|
4002
4112
|
* File Search call step.
|
|
4003
4113
|
*/
|
|
4004
4114
|
declare type FileSearchCallStep = {
|
|
4005
|
-
type: "file_search_call";
|
|
4006
4115
|
/**
|
|
4007
4116
|
* Required. A unique ID for this specific tool call.
|
|
4008
4117
|
*/
|
|
@@ -4011,6 +4120,7 @@ declare type FileSearchCallStep = {
|
|
|
4011
4120
|
* A signature hash for backend validation.
|
|
4012
4121
|
*/
|
|
4013
4122
|
signature?: string | undefined;
|
|
4123
|
+
type: "file_search_call";
|
|
4014
4124
|
};
|
|
4015
4125
|
|
|
4016
4126
|
declare type FileSearchResult$ = FileSearchResultDelta;
|
|
@@ -4028,12 +4138,12 @@ declare type FileSearchResult$ = FileSearchResultDelta;
|
|
|
4028
4138
|
declare type FileSearchResult = {};
|
|
4029
4139
|
|
|
4030
4140
|
declare type FileSearchResultDelta = {
|
|
4031
|
-
type: "file_search_result";
|
|
4032
4141
|
result: Array<FileSearchResult>;
|
|
4033
4142
|
/**
|
|
4034
4143
|
* A signature hash for backend validation.
|
|
4035
4144
|
*/
|
|
4036
4145
|
signature?: string | undefined;
|
|
4146
|
+
type: "file_search_result";
|
|
4037
4147
|
};
|
|
4038
4148
|
|
|
4039
4149
|
declare type FileSearchResultStep$ = FileSearchResultStep;
|
|
@@ -4049,7 +4159,6 @@ declare type FileSearchResultStep$ = FileSearchResultStep;
|
|
|
4049
4159
|
* File Search result step.
|
|
4050
4160
|
*/
|
|
4051
4161
|
declare type FileSearchResultStep = {
|
|
4052
|
-
type: "file_search_result";
|
|
4053
4162
|
/**
|
|
4054
4163
|
* Required. ID to match the ID from the function call block.
|
|
4055
4164
|
*/
|
|
@@ -4058,6 +4167,7 @@ declare type FileSearchResultStep = {
|
|
|
4058
4167
|
* A signature hash for backend validation.
|
|
4059
4168
|
*/
|
|
4060
4169
|
signature?: string | undefined;
|
|
4170
|
+
type: "file_search_result";
|
|
4061
4171
|
};
|
|
4062
4172
|
|
|
4063
4173
|
/** A collection of Documents. */
|
|
@@ -4234,6 +4344,10 @@ export declare interface FileStatus {
|
|
|
4234
4344
|
* Config for filters.
|
|
4235
4345
|
*/
|
|
4236
4346
|
declare type Filter = {
|
|
4347
|
+
/**
|
|
4348
|
+
* Optional. String for metadata filtering.
|
|
4349
|
+
*/
|
|
4350
|
+
metadata_filter?: string | undefined;
|
|
4237
4351
|
/**
|
|
4238
4352
|
* Optional. Only returns contexts with vector distance smaller than the
|
|
4239
4353
|
*
|
|
@@ -4248,10 +4362,6 @@ declare type Filter = {
|
|
|
4248
4362
|
* threshold.
|
|
4249
4363
|
*/
|
|
4250
4364
|
vector_similarity_threshold?: number | undefined;
|
|
4251
|
-
/**
|
|
4252
|
-
* Optional. String for metadata filtering.
|
|
4253
|
-
*/
|
|
4254
|
-
metadata_filter?: string | undefined;
|
|
4255
4365
|
};
|
|
4256
4366
|
|
|
4257
4367
|
/** Output only. The reason why the model stopped generating tokens.
|
|
@@ -4401,11 +4511,6 @@ declare type FunctionCallStep$ = FunctionCallStep;
|
|
|
4401
4511
|
* A function tool call step.
|
|
4402
4512
|
*/
|
|
4403
4513
|
declare type FunctionCallStep = {
|
|
4404
|
-
type: "function_call";
|
|
4405
|
-
/**
|
|
4406
|
-
* Required. The name of the tool to call.
|
|
4407
|
-
*/
|
|
4408
|
-
name: string;
|
|
4409
4514
|
/**
|
|
4410
4515
|
* Required. The arguments to pass to the function.
|
|
4411
4516
|
*/
|
|
@@ -4416,6 +4521,11 @@ declare type FunctionCallStep = {
|
|
|
4416
4521
|
* Required. A unique ID for this specific tool call.
|
|
4417
4522
|
*/
|
|
4418
4523
|
id: string;
|
|
4524
|
+
/**
|
|
4525
|
+
* Required. The name of the tool to call.
|
|
4526
|
+
*/
|
|
4527
|
+
name: string;
|
|
4528
|
+
type: "function_call";
|
|
4419
4529
|
};
|
|
4420
4530
|
|
|
4421
4531
|
/** Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. */
|
|
@@ -4432,7 +4542,7 @@ export declare interface FunctionDeclaration {
|
|
|
4432
4542
|
response?: Schema;
|
|
4433
4543
|
/** Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. */
|
|
4434
4544
|
responseJsonSchema?: unknown;
|
|
4435
|
-
/** Optional. Specifies the function Behavior.
|
|
4545
|
+
/** Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. */
|
|
4436
4546
|
behavior?: Behavior;
|
|
4437
4547
|
}
|
|
4438
4548
|
|
|
@@ -4504,14 +4614,14 @@ export declare enum FunctionResponseScheduling {
|
|
|
4504
4614
|
declare type FunctionResult$ = FunctionResultDelta;
|
|
4505
4615
|
|
|
4506
4616
|
declare type FunctionResultDelta = {
|
|
4507
|
-
type: "function_result";
|
|
4508
|
-
name?: string | undefined;
|
|
4509
|
-
is_error?: boolean | undefined;
|
|
4510
4617
|
/**
|
|
4511
4618
|
* Required. ID to match the ID from the function call block.
|
|
4512
4619
|
*/
|
|
4513
4620
|
call_id: string;
|
|
4621
|
+
is_error?: boolean | undefined;
|
|
4622
|
+
name?: string | undefined;
|
|
4514
4623
|
result: FunctionResultDeltaResult | Array<FunctionResultSubcontent> | string;
|
|
4624
|
+
type: "function_result";
|
|
4515
4625
|
};
|
|
4516
4626
|
|
|
4517
4627
|
declare type FunctionResultDeltaResult = {};
|
|
@@ -4524,23 +4634,23 @@ declare type FunctionResultStep$ = FunctionResultStep;
|
|
|
4524
4634
|
* Result of a function tool call.
|
|
4525
4635
|
*/
|
|
4526
4636
|
declare type FunctionResultStep = {
|
|
4527
|
-
type: "function_result";
|
|
4528
4637
|
/**
|
|
4529
|
-
*
|
|
4638
|
+
* Required. ID to match the ID from the function call block.
|
|
4530
4639
|
*/
|
|
4531
|
-
|
|
4640
|
+
call_id: string;
|
|
4532
4641
|
/**
|
|
4533
4642
|
* Whether the tool call resulted in an error.
|
|
4534
4643
|
*/
|
|
4535
4644
|
is_error?: boolean | undefined;
|
|
4536
4645
|
/**
|
|
4537
|
-
*
|
|
4646
|
+
* The name of the tool that was called.
|
|
4538
4647
|
*/
|
|
4539
|
-
|
|
4648
|
+
name?: string | undefined;
|
|
4540
4649
|
/**
|
|
4541
4650
|
* The result of the tool call.
|
|
4542
4651
|
*/
|
|
4543
4652
|
result: FunctionResultStepResult | Array<FunctionResultSubcontent> | string;
|
|
4653
|
+
type: "function_result";
|
|
4544
4654
|
};
|
|
4545
4655
|
|
|
4546
4656
|
declare type FunctionResultStepResult = {};
|
|
@@ -4563,19 +4673,19 @@ declare type FunctionResultSubcontent = TextContent | ImageContent;
|
|
|
4563
4673
|
* A tool that can be used by the model.
|
|
4564
4674
|
*/
|
|
4565
4675
|
declare type FunctionT = {
|
|
4566
|
-
type: "function";
|
|
4567
|
-
/**
|
|
4568
|
-
* The name of the function.
|
|
4569
|
-
*/
|
|
4570
|
-
name?: string | undefined;
|
|
4571
4676
|
/**
|
|
4572
4677
|
* A description of the function.
|
|
4573
4678
|
*/
|
|
4574
4679
|
description?: string | undefined;
|
|
4680
|
+
/**
|
|
4681
|
+
* The name of the function.
|
|
4682
|
+
*/
|
|
4683
|
+
name?: string | undefined;
|
|
4575
4684
|
/**
|
|
4576
4685
|
* The JSON Schema for the function's parameters.
|
|
4577
4686
|
*/
|
|
4578
4687
|
parameters?: any | undefined;
|
|
4688
|
+
type: "function";
|
|
4579
4689
|
};
|
|
4580
4690
|
|
|
4581
4691
|
/** The Google Cloud Storage location for the input content. This data type is not supported in Gemini API. */
|
|
@@ -5282,11 +5392,11 @@ export declare interface GenerationConfig {
|
|
|
5282
5392
|
presencePenalty?: number;
|
|
5283
5393
|
/** 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. */
|
|
5284
5394
|
responseLogprobs?: boolean;
|
|
5285
|
-
/** 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. */
|
|
5395
|
+
/** 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. Deprecated: Use `response_format` instead. */
|
|
5286
5396
|
responseMimeType?: string;
|
|
5287
5397
|
/** 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. */
|
|
5288
5398
|
responseModalities?: Modality[];
|
|
5289
|
-
/** 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`. */
|
|
5399
|
+
/** 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`. Deprecated: Use `response_format` instead. */
|
|
5290
5400
|
responseSchema?: Schema;
|
|
5291
5401
|
/** Optional. Routing configuration. This field is not supported in Gemini API. */
|
|
5292
5402
|
routingConfig?: GenerationConfigRoutingConfig;
|
|
@@ -5306,6 +5416,10 @@ export declare interface GenerationConfig {
|
|
|
5306
5416
|
topP?: number;
|
|
5307
5417
|
/** Optional. Enables enhanced civic answers. It may not be available for all models. This field is not supported in Vertex AI. */
|
|
5308
5418
|
enableEnhancedCivicAnswers?: boolean;
|
|
5419
|
+
/** Optional. New response format field for the model to configure output formatting and delivery. */
|
|
5420
|
+
responseFormat?: ResponseFormat[];
|
|
5421
|
+
/** Optional. Config for translation. This field is not supported in Vertex AI. */
|
|
5422
|
+
translationConfig?: TranslationConfig;
|
|
5309
5423
|
}
|
|
5310
5424
|
|
|
5311
5425
|
/**
|
|
@@ -5313,57 +5427,45 @@ export declare interface GenerationConfig {
|
|
|
5313
5427
|
*/
|
|
5314
5428
|
declare type GenerationConfig_2 = {
|
|
5315
5429
|
/**
|
|
5316
|
-
*
|
|
5430
|
+
* The configuration for image interaction.
|
|
5431
|
+
*
|
|
5432
|
+
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
5317
5433
|
*/
|
|
5318
|
-
|
|
5434
|
+
image_config?: ImageConfig_2 | undefined;
|
|
5319
5435
|
/**
|
|
5320
|
-
* The maximum
|
|
5436
|
+
* The maximum number of tokens to include in the response.
|
|
5321
5437
|
*/
|
|
5322
|
-
|
|
5438
|
+
max_output_tokens?: number | undefined;
|
|
5323
5439
|
/**
|
|
5324
5440
|
* Seed used in decoding for reproducibility.
|
|
5325
5441
|
*/
|
|
5326
5442
|
seed?: number | undefined;
|
|
5327
|
-
/**
|
|
5328
|
-
* A list of character sequences that will stop output interaction.
|
|
5329
|
-
*/
|
|
5330
|
-
stop_sequences?: Array<string> | undefined;
|
|
5331
|
-
thinking_level?: ThinkingLevel_2 | undefined;
|
|
5332
|
-
thinking_summaries?: ThinkingSummaries | undefined;
|
|
5333
|
-
/**
|
|
5334
|
-
* The maximum number of tokens to include in the response.
|
|
5335
|
-
*/
|
|
5336
|
-
max_output_tokens?: number | undefined;
|
|
5337
5443
|
/**
|
|
5338
5444
|
* Configuration for speech interaction.
|
|
5339
5445
|
*/
|
|
5340
5446
|
speech_config?: Array<SpeechConfig_2> | undefined;
|
|
5341
5447
|
/**
|
|
5342
|
-
*
|
|
5343
|
-
*
|
|
5344
|
-
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
5345
|
-
*/
|
|
5346
|
-
image_config?: ImageConfig_2 | undefined;
|
|
5347
|
-
/**
|
|
5348
|
-
* Penalizes tokens that have already appeared in the generated
|
|
5349
|
-
*
|
|
5350
|
-
* @remarks
|
|
5351
|
-
* text. A positive value encourages the model to generate more diverse and
|
|
5352
|
-
* less repetitive text. Valid values can range from [-2.0, 2.0].
|
|
5448
|
+
* A list of character sequences that will stop output interaction.
|
|
5353
5449
|
*/
|
|
5354
|
-
|
|
5450
|
+
stop_sequences?: Array<string> | undefined;
|
|
5355
5451
|
/**
|
|
5356
|
-
*
|
|
5357
|
-
*
|
|
5358
|
-
* @remarks
|
|
5359
|
-
* A positive value helps to reduce the repetition of words and phrases.
|
|
5360
|
-
* Valid values can range from [-2.0, 2.0].
|
|
5452
|
+
* Controls the randomness of the output.
|
|
5361
5453
|
*/
|
|
5362
|
-
|
|
5454
|
+
temperature?: number | undefined;
|
|
5455
|
+
thinking_level?: ThinkingLevel_2 | undefined;
|
|
5456
|
+
thinking_summaries?: ThinkingSummaries | undefined;
|
|
5363
5457
|
/**
|
|
5364
5458
|
* The tool choice configuration.
|
|
5365
5459
|
*/
|
|
5366
5460
|
tool_choice?: ToolChoiceType | ToolChoiceConfig | undefined;
|
|
5461
|
+
/**
|
|
5462
|
+
* The maximum cumulative probability of tokens to consider when sampling.
|
|
5463
|
+
*/
|
|
5464
|
+
top_p?: number | undefined;
|
|
5465
|
+
/**
|
|
5466
|
+
* Configuration options for video generation.
|
|
5467
|
+
*/
|
|
5468
|
+
video_config?: VideoConfig | undefined;
|
|
5367
5469
|
};
|
|
5368
5470
|
|
|
5369
5471
|
/** 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. */
|
|
@@ -5826,7 +5928,6 @@ export declare interface GoogleMaps {
|
|
|
5826
5928
|
* A tool that can be used by the model to call Google Maps.
|
|
5827
5929
|
*/
|
|
5828
5930
|
declare type GoogleMaps_2 = {
|
|
5829
|
-
type: "google_maps";
|
|
5830
5931
|
/**
|
|
5831
5932
|
* Whether to return a widget context token in the tool call result of the
|
|
5832
5933
|
*
|
|
@@ -5842,6 +5943,7 @@ declare type GoogleMaps_2 = {
|
|
|
5842
5943
|
* The longitude of the user's location.
|
|
5843
5944
|
*/
|
|
5844
5945
|
longitude?: number | undefined;
|
|
5946
|
+
type: "google_maps";
|
|
5845
5947
|
};
|
|
5846
5948
|
|
|
5847
5949
|
declare type GoogleMapsCall$ = GoogleMapsCallDelta;
|
|
@@ -5866,7 +5968,6 @@ declare type GoogleMapsCallArguments = {
|
|
|
5866
5968
|
};
|
|
5867
5969
|
|
|
5868
5970
|
declare type GoogleMapsCallDelta = {
|
|
5869
|
-
type: "google_maps_call";
|
|
5870
5971
|
/**
|
|
5871
5972
|
* The arguments to pass to the Google Maps tool.
|
|
5872
5973
|
*/
|
|
@@ -5875,6 +5976,7 @@ declare type GoogleMapsCallDelta = {
|
|
|
5875
5976
|
* A signature hash for backend validation.
|
|
5876
5977
|
*/
|
|
5877
5978
|
signature?: string | undefined;
|
|
5979
|
+
type: "google_maps_call";
|
|
5878
5980
|
};
|
|
5879
5981
|
|
|
5880
5982
|
declare type GoogleMapsCallStep$ = GoogleMapsCallStep;
|
|
@@ -5883,7 +5985,6 @@ declare type GoogleMapsCallStep$ = GoogleMapsCallStep;
|
|
|
5883
5985
|
* Google Maps call step.
|
|
5884
5986
|
*/
|
|
5885
5987
|
declare type GoogleMapsCallStep = {
|
|
5886
|
-
type: "google_maps_call";
|
|
5887
5988
|
/**
|
|
5888
5989
|
* The arguments to pass to the Google Maps tool.
|
|
5889
5990
|
*/
|
|
@@ -5896,6 +5997,7 @@ declare type GoogleMapsCallStep = {
|
|
|
5896
5997
|
* A signature hash for backend validation.
|
|
5897
5998
|
*/
|
|
5898
5999
|
signature?: string | undefined;
|
|
6000
|
+
type: "google_maps_call";
|
|
5899
6001
|
};
|
|
5900
6002
|
|
|
5901
6003
|
declare type GoogleMapsResult$ = GoogleMapsResult;
|
|
@@ -5911,7 +6013,6 @@ declare type GoogleMapsResult = {
|
|
|
5911
6013
|
};
|
|
5912
6014
|
|
|
5913
6015
|
declare type GoogleMapsResultDelta = {
|
|
5914
|
-
type: "google_maps_result";
|
|
5915
6016
|
/**
|
|
5916
6017
|
* The results of the Google Maps.
|
|
5917
6018
|
*/
|
|
@@ -5920,13 +6021,14 @@ declare type GoogleMapsResultDelta = {
|
|
|
5920
6021
|
* A signature hash for backend validation.
|
|
5921
6022
|
*/
|
|
5922
6023
|
signature?: string | undefined;
|
|
6024
|
+
type: "google_maps_result";
|
|
5923
6025
|
};
|
|
5924
6026
|
|
|
5925
6027
|
declare type GoogleMapsResultPlaces = {
|
|
5926
|
-
place_id?: string | undefined;
|
|
5927
6028
|
name?: string | undefined;
|
|
5928
|
-
|
|
6029
|
+
place_id?: string | undefined;
|
|
5929
6030
|
review_snippets?: Array<ReviewSnippet> | undefined;
|
|
6031
|
+
url?: string | undefined;
|
|
5930
6032
|
};
|
|
5931
6033
|
|
|
5932
6034
|
declare type GoogleMapsResultStep$ = GoogleMapsResultStep;
|
|
@@ -5935,16 +6037,16 @@ declare type GoogleMapsResultStep$ = GoogleMapsResultStep;
|
|
|
5935
6037
|
* Google Maps result step.
|
|
5936
6038
|
*/
|
|
5937
6039
|
declare type GoogleMapsResultStep = {
|
|
5938
|
-
type: "google_maps_result";
|
|
5939
|
-
result: Array<GoogleMapsResult>;
|
|
5940
6040
|
/**
|
|
5941
6041
|
* Required. ID to match the ID from the function call block.
|
|
5942
6042
|
*/
|
|
5943
6043
|
call_id: string;
|
|
6044
|
+
result: Array<GoogleMapsResult>;
|
|
5944
6045
|
/**
|
|
5945
6046
|
* A signature hash for backend validation.
|
|
5946
6047
|
*/
|
|
5947
6048
|
signature?: string | undefined;
|
|
6049
|
+
type: "google_maps_result";
|
|
5948
6050
|
};
|
|
5949
6051
|
|
|
5950
6052
|
/** The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). This data type is not supported in Gemini API. */
|
|
@@ -5975,11 +6077,11 @@ export declare interface GoogleSearch {
|
|
|
5975
6077
|
* A tool that can be used by the model to search Google.
|
|
5976
6078
|
*/
|
|
5977
6079
|
declare type GoogleSearch_2 = {
|
|
5978
|
-
type: "google_search";
|
|
5979
6080
|
/**
|
|
5980
6081
|
* The types of search grounding to enable.
|
|
5981
6082
|
*/
|
|
5982
6083
|
search_types?: Array<GoogleSearchSearchType> | undefined;
|
|
6084
|
+
type: "google_search";
|
|
5983
6085
|
};
|
|
5984
6086
|
|
|
5985
6087
|
declare type GoogleSearchCall$ = GoogleSearchCallDelta;
|
|
@@ -6004,7 +6106,6 @@ declare type GoogleSearchCallArguments = {
|
|
|
6004
6106
|
};
|
|
6005
6107
|
|
|
6006
6108
|
declare type GoogleSearchCallDelta = {
|
|
6007
|
-
type: "google_search_call";
|
|
6008
6109
|
/**
|
|
6009
6110
|
* The arguments to pass to Google Search.
|
|
6010
6111
|
*/
|
|
@@ -6013,6 +6114,7 @@ declare type GoogleSearchCallDelta = {
|
|
|
6013
6114
|
* A signature hash for backend validation.
|
|
6014
6115
|
*/
|
|
6015
6116
|
signature?: string | undefined;
|
|
6117
|
+
type: "google_search_call";
|
|
6016
6118
|
};
|
|
6017
6119
|
|
|
6018
6120
|
declare type GoogleSearchCallStep$ = GoogleSearchCallStep;
|
|
@@ -6021,23 +6123,23 @@ declare type GoogleSearchCallStep$ = GoogleSearchCallStep;
|
|
|
6021
6123
|
* Google Search call step.
|
|
6022
6124
|
*/
|
|
6023
6125
|
declare type GoogleSearchCallStep = {
|
|
6024
|
-
type: "google_search_call";
|
|
6025
6126
|
/**
|
|
6026
6127
|
* The arguments to pass to Google Search.
|
|
6027
6128
|
*/
|
|
6028
6129
|
arguments: GoogleSearchCallArguments;
|
|
6029
|
-
/**
|
|
6030
|
-
* The type of search grounding enabled.
|
|
6031
|
-
*/
|
|
6032
|
-
search_type?: GoogleSearchCallStepSearchType | undefined;
|
|
6033
6130
|
/**
|
|
6034
6131
|
* Required. A unique ID for this specific tool call.
|
|
6035
6132
|
*/
|
|
6036
6133
|
id: string;
|
|
6134
|
+
/**
|
|
6135
|
+
* The type of search grounding enabled.
|
|
6136
|
+
*/
|
|
6137
|
+
search_type?: GoogleSearchCallStepSearchType | undefined;
|
|
6037
6138
|
/**
|
|
6038
6139
|
* A signature hash for backend validation.
|
|
6039
6140
|
*/
|
|
6040
6141
|
signature?: string | undefined;
|
|
6142
|
+
type: "google_search_call";
|
|
6041
6143
|
};
|
|
6042
6144
|
|
|
6043
6145
|
/**
|
|
@@ -6067,13 +6169,13 @@ declare type GoogleSearchResult = {
|
|
|
6067
6169
|
};
|
|
6068
6170
|
|
|
6069
6171
|
declare type GoogleSearchResultDelta = {
|
|
6070
|
-
type: "google_search_result";
|
|
6071
|
-
result: Array<GoogleSearchResult>;
|
|
6072
6172
|
is_error?: boolean | undefined;
|
|
6173
|
+
result: Array<GoogleSearchResult>;
|
|
6073
6174
|
/**
|
|
6074
6175
|
* A signature hash for backend validation.
|
|
6075
6176
|
*/
|
|
6076
6177
|
signature?: string | undefined;
|
|
6178
|
+
type: "google_search_result";
|
|
6077
6179
|
};
|
|
6078
6180
|
|
|
6079
6181
|
declare type GoogleSearchResultStep$ = GoogleSearchResultStep;
|
|
@@ -6082,23 +6184,23 @@ declare type GoogleSearchResultStep$ = GoogleSearchResultStep;
|
|
|
6082
6184
|
* Google Search result step.
|
|
6083
6185
|
*/
|
|
6084
6186
|
declare type GoogleSearchResultStep = {
|
|
6085
|
-
type: "google_search_result";
|
|
6086
6187
|
/**
|
|
6087
|
-
* Required.
|
|
6188
|
+
* Required. ID to match the ID from the function call block.
|
|
6088
6189
|
*/
|
|
6089
|
-
|
|
6190
|
+
call_id: string;
|
|
6090
6191
|
/**
|
|
6091
6192
|
* Whether the Google Search resulted in an error.
|
|
6092
6193
|
*/
|
|
6093
6194
|
is_error?: boolean | undefined;
|
|
6094
6195
|
/**
|
|
6095
|
-
* Required.
|
|
6196
|
+
* Required. The results of the Google Search.
|
|
6096
6197
|
*/
|
|
6097
|
-
|
|
6198
|
+
result: Array<GoogleSearchResult>;
|
|
6098
6199
|
/**
|
|
6099
6200
|
* A signature hash for backend validation.
|
|
6100
6201
|
*/
|
|
6101
6202
|
signature?: string | undefined;
|
|
6203
|
+
type: "google_search_result";
|
|
6102
6204
|
};
|
|
6103
6205
|
|
|
6104
6206
|
/** Tool to retrieve public web data for grounding, powered by Google. */
|
|
@@ -6301,7 +6403,7 @@ export declare interface GroundingMetadata {
|
|
|
6301
6403
|
searchEntryPoint?: SearchEntryPoint;
|
|
6302
6404
|
/** Web search queries for the following-up web search. */
|
|
6303
6405
|
webSearchQueries?: string[];
|
|
6304
|
-
/** 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. */
|
|
6406
|
+
/** Optional. Output only. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and will no longer be populated once removed. 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. */
|
|
6305
6407
|
googleMapsWidgetContextToken?: string;
|
|
6306
6408
|
/** 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. */
|
|
6307
6409
|
retrievalQueries?: string[];
|
|
@@ -6341,14 +6443,14 @@ declare type GroundingToolCount$ = GroundingToolCount;
|
|
|
6341
6443
|
* The number of grounding tool counts.
|
|
6342
6444
|
*/
|
|
6343
6445
|
declare type GroundingToolCount = {
|
|
6344
|
-
/**
|
|
6345
|
-
* The grounding tool type associated with the count.
|
|
6346
|
-
*/
|
|
6347
|
-
type?: GroundingToolCountType | undefined;
|
|
6348
6446
|
/**
|
|
6349
6447
|
* The number of grounding tool counts.
|
|
6350
6448
|
*/
|
|
6351
6449
|
count?: number | undefined;
|
|
6450
|
+
/**
|
|
6451
|
+
* The grounding tool type associated with the count.
|
|
6452
|
+
*/
|
|
6453
|
+
type?: GroundingToolCountType | undefined;
|
|
6352
6454
|
};
|
|
6353
6455
|
|
|
6354
6456
|
/**
|
|
@@ -6407,6 +6509,8 @@ export declare enum HarmBlockThreshold {
|
|
|
6407
6509
|
OFF = "OFF"
|
|
6408
6510
|
}
|
|
6409
6511
|
|
|
6512
|
+
declare type HarmCategory$ = HarmCategory_2;
|
|
6513
|
+
|
|
6410
6514
|
/** The harm category to be blocked. */
|
|
6411
6515
|
export declare enum HarmCategory {
|
|
6412
6516
|
/**
|
|
@@ -6455,6 +6559,15 @@ export declare enum HarmCategory {
|
|
|
6455
6559
|
HARM_CATEGORY_JAILBREAK = "HARM_CATEGORY_JAILBREAK"
|
|
6456
6560
|
}
|
|
6457
6561
|
|
|
6562
|
+
/**
|
|
6563
|
+
* @license
|
|
6564
|
+
* Copyright 2026 Google LLC
|
|
6565
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
6566
|
+
*
|
|
6567
|
+
* g3-prettier-ignore-file
|
|
6568
|
+
*/
|
|
6569
|
+
declare type HarmCategory_2 = "hate_speech" | "dangerous_content" | "harassment" | "sexually_explicit" | "civic_integrity" | "image_hate" | "image_dangerous_content" | "image_harassment" | "image_sexually_explicit" | "jailbreak" | (string & {});
|
|
6570
|
+
|
|
6458
6571
|
/** Output only. The probability of harm for this category. */
|
|
6459
6572
|
export declare enum HarmProbability {
|
|
6460
6573
|
/**
|
|
@@ -6714,20 +6827,20 @@ declare type ImageContent$ = ImageContent;
|
|
|
6714
6827
|
* An image content block.
|
|
6715
6828
|
*/
|
|
6716
6829
|
declare type ImageContent = {
|
|
6717
|
-
type: "image";
|
|
6718
6830
|
/**
|
|
6719
6831
|
* The image content.
|
|
6720
6832
|
*/
|
|
6721
6833
|
data?: string | undefined;
|
|
6722
|
-
/**
|
|
6723
|
-
* The URI of the image.
|
|
6724
|
-
*/
|
|
6725
|
-
uri?: string | undefined;
|
|
6726
6834
|
/**
|
|
6727
6835
|
* The mime type of the image.
|
|
6728
6836
|
*/
|
|
6729
6837
|
mime_type?: ImageContentMimeType | undefined;
|
|
6730
6838
|
resolution?: MediaResolution_2 | undefined;
|
|
6839
|
+
type: "image";
|
|
6840
|
+
/**
|
|
6841
|
+
* The URI of the image.
|
|
6842
|
+
*/
|
|
6843
|
+
uri?: string | undefined;
|
|
6731
6844
|
};
|
|
6732
6845
|
|
|
6733
6846
|
/**
|
|
@@ -6736,11 +6849,11 @@ declare type ImageContent = {
|
|
|
6736
6849
|
declare type ImageContentMimeType = "image/png" | "image/jpeg" | "image/webp" | "image/heic" | "image/heif" | "image/gif" | "image/bmp" | "image/tiff" | (string & {});
|
|
6737
6850
|
|
|
6738
6851
|
declare type ImageDelta = {
|
|
6739
|
-
type: "image";
|
|
6740
6852
|
data?: string | undefined;
|
|
6741
|
-
uri?: string | undefined;
|
|
6742
6853
|
mime_type?: ImageDeltaMimeType | undefined;
|
|
6743
6854
|
resolution?: MediaResolution_2 | undefined;
|
|
6855
|
+
type: "image";
|
|
6856
|
+
uri?: string | undefined;
|
|
6744
6857
|
};
|
|
6745
6858
|
|
|
6746
6859
|
declare type ImageDeltaMimeType = "image/png" | "image/jpeg" | "image/webp" | "image/heic" | "image/heif" | "image/gif" | "image/bmp" | "image/tiff" | (string & {});
|
|
@@ -6795,31 +6908,50 @@ export declare enum ImageResizeMode {
|
|
|
6795
6908
|
PAD = "PAD"
|
|
6796
6909
|
}
|
|
6797
6910
|
|
|
6798
|
-
declare type ImageResponseFormat$ =
|
|
6911
|
+
declare type ImageResponseFormat$ = ImageResponseFormat_2;
|
|
6912
|
+
|
|
6913
|
+
/** Configuration for image-specific output formatting. */
|
|
6914
|
+
export declare class ImageResponseFormat {
|
|
6915
|
+
/** Optional. The aspect ratio for the image output. */
|
|
6916
|
+
aspectRatio?: AspectRatio;
|
|
6917
|
+
/** Optional. Delivery mode for the generated content. */
|
|
6918
|
+
delivery?: Delivery;
|
|
6919
|
+
/** Optional. The size of the image output. */
|
|
6920
|
+
imageSize?: ImageSize;
|
|
6921
|
+
/** Optional. The MIME type of the image output. */
|
|
6922
|
+
mimeType?: string;
|
|
6923
|
+
}
|
|
6799
6924
|
|
|
6800
6925
|
/**
|
|
6801
6926
|
* Configuration for image output format.
|
|
6802
6927
|
*/
|
|
6803
|
-
declare type
|
|
6804
|
-
type: "image";
|
|
6928
|
+
declare type ImageResponseFormat_2 = {
|
|
6805
6929
|
/**
|
|
6806
|
-
* The
|
|
6930
|
+
* The aspect ratio for the image output.
|
|
6807
6931
|
*/
|
|
6808
|
-
|
|
6932
|
+
aspect_ratio?: ImageResponseFormatAspectRatio | undefined;
|
|
6809
6933
|
/**
|
|
6810
6934
|
* The delivery mode for the image output.
|
|
6811
6935
|
*/
|
|
6812
6936
|
delivery?: ImageResponseFormatDelivery | undefined;
|
|
6813
|
-
/**
|
|
6814
|
-
* The aspect ratio for the image output.
|
|
6815
|
-
*/
|
|
6816
|
-
aspect_ratio?: ImageResponseFormatAspectRatio | undefined;
|
|
6817
6937
|
/**
|
|
6818
6938
|
* The size of the image output.
|
|
6819
6939
|
*/
|
|
6820
6940
|
image_size?: ImageResponseFormatImageSize | undefined;
|
|
6941
|
+
/**
|
|
6942
|
+
* The MIME type of the image output.
|
|
6943
|
+
*/
|
|
6944
|
+
mime_type?: ImageResponseFormatMimeType | undefined;
|
|
6945
|
+
type: "image";
|
|
6821
6946
|
};
|
|
6822
6947
|
|
|
6948
|
+
/**
|
|
6949
|
+
* @license
|
|
6950
|
+
* Copyright 2026 Google LLC
|
|
6951
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
6952
|
+
*
|
|
6953
|
+
* g3-prettier-ignore-file
|
|
6954
|
+
*/
|
|
6823
6955
|
/**
|
|
6824
6956
|
* The aspect ratio for the image output.
|
|
6825
6957
|
*/
|
|
@@ -6835,13 +6967,6 @@ declare type ImageResponseFormatDelivery = "inline" | "uri" | (string & {});
|
|
|
6835
6967
|
*/
|
|
6836
6968
|
declare type ImageResponseFormatImageSize = "512" | "1K" | "2K" | "4K" | (string & {});
|
|
6837
6969
|
|
|
6838
|
-
/**
|
|
6839
|
-
* @license
|
|
6840
|
-
* Copyright 2026 Google LLC
|
|
6841
|
-
* SPDX-License-Identifier: Apache-2.0
|
|
6842
|
-
*
|
|
6843
|
-
* g3-prettier-ignore-file
|
|
6844
|
-
*/
|
|
6845
6970
|
/**
|
|
6846
6971
|
* The MIME type of the image output.
|
|
6847
6972
|
*/
|
|
@@ -6851,16 +6976,40 @@ declare type ImageResponseFormatMimeType = "image/jpeg";
|
|
|
6851
6976
|
export declare interface ImageSearch {
|
|
6852
6977
|
}
|
|
6853
6978
|
|
|
6854
|
-
/**
|
|
6855
|
-
export declare
|
|
6856
|
-
/**
|
|
6857
|
-
|
|
6858
|
-
|
|
6859
|
-
|
|
6860
|
-
|
|
6861
|
-
|
|
6862
|
-
|
|
6863
|
-
|
|
6979
|
+
/** The size of the image output. */
|
|
6980
|
+
export declare enum ImageSize {
|
|
6981
|
+
/**
|
|
6982
|
+
* Default value. This value is unused.
|
|
6983
|
+
*/
|
|
6984
|
+
IMAGE_SIZE_UNSPECIFIED = "IMAGE_SIZE_UNSPECIFIED",
|
|
6985
|
+
/**
|
|
6986
|
+
* 512px image size.
|
|
6987
|
+
*/
|
|
6988
|
+
IMAGE_SIZE_FIVE_TWELVE = "IMAGE_SIZE_FIVE_TWELVE",
|
|
6989
|
+
/**
|
|
6990
|
+
* 1K image size.
|
|
6991
|
+
*/
|
|
6992
|
+
IMAGE_SIZE_ONE_K = "IMAGE_SIZE_ONE_K",
|
|
6993
|
+
/**
|
|
6994
|
+
* 2K image size.
|
|
6995
|
+
*/
|
|
6996
|
+
IMAGE_SIZE_TWO_K = "IMAGE_SIZE_TWO_K",
|
|
6997
|
+
/**
|
|
6998
|
+
* 4K image size.
|
|
6999
|
+
*/
|
|
7000
|
+
IMAGE_SIZE_FOUR_K = "IMAGE_SIZE_FOUR_K"
|
|
7001
|
+
}
|
|
7002
|
+
|
|
7003
|
+
/** Optional parameters for importing a file. */
|
|
7004
|
+
export declare interface ImportFileConfig {
|
|
7005
|
+
/** Used to override HTTP request options. */
|
|
7006
|
+
httpOptions?: HttpOptions;
|
|
7007
|
+
/** Abort signal which can be used to cancel the request.
|
|
7008
|
+
|
|
7009
|
+
NOTE: AbortSignal is a client-only operation. Using it to cancel an
|
|
7010
|
+
operation will not cancel the request in the service. You will still
|
|
7011
|
+
be charged usage for any applicable operations.
|
|
7012
|
+
*/
|
|
6864
7013
|
abortSignal?: AbortSignal;
|
|
6865
7014
|
/** User provided custom metadata stored as key-value pairs used for querying. */
|
|
6866
7015
|
customMetadata?: CustomMetadata[];
|
|
@@ -7028,7 +7177,7 @@ declare type Interaction = {
|
|
|
7028
7177
|
/**
|
|
7029
7178
|
* Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
|
|
7030
7179
|
*/
|
|
7031
|
-
response_format?: Array<
|
|
7180
|
+
response_format?: Array<ResponseFormat_2> | ResponseFormat_2 | undefined;
|
|
7032
7181
|
/**
|
|
7033
7182
|
* The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.
|
|
7034
7183
|
*/
|
|
@@ -7051,6 +7200,16 @@ declare type Interaction = {
|
|
|
7051
7200
|
* Configuration parameters for the agent interaction.
|
|
7052
7201
|
*/
|
|
7053
7202
|
agent_config?: DynamicAgentConfig | DeepResearchAgentConfig | undefined;
|
|
7203
|
+
/**
|
|
7204
|
+
* Safety settings for the interaction.
|
|
7205
|
+
*/
|
|
7206
|
+
safety_settings?: Array<SafetySetting_2> | undefined;
|
|
7207
|
+
/**
|
|
7208
|
+
* The labels with user-defined metadata for the request.
|
|
7209
|
+
*/
|
|
7210
|
+
labels?: {
|
|
7211
|
+
[k: string]: string;
|
|
7212
|
+
} | undefined;
|
|
7054
7213
|
/**
|
|
7055
7214
|
* The input for the interaction.
|
|
7056
7215
|
*/
|
|
@@ -7164,7 +7323,7 @@ declare type InteractionGetParamsStreaming = GetInteractionByIdParamsStreaming;
|
|
|
7164
7323
|
/**
|
|
7165
7324
|
* Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
|
|
7166
7325
|
*/
|
|
7167
|
-
declare type InteractionResponseFormat = Array<
|
|
7326
|
+
declare type InteractionResponseFormat = Array<ResponseFormat_2> | ResponseFormat_2;
|
|
7168
7327
|
|
|
7169
7328
|
export declare namespace Interactions {
|
|
7170
7329
|
export type AllowedTools = AllowedTools$;
|
|
@@ -7207,6 +7366,7 @@ export declare namespace Interactions {
|
|
|
7207
7366
|
export type GoogleSearchResult = GoogleSearchResult$;
|
|
7208
7367
|
export interface GoogleSearchResultStep extends GoogleSearchResultStep$ {
|
|
7209
7368
|
}
|
|
7369
|
+
export type HarmCategory = HarmCategory$;
|
|
7210
7370
|
export type ImageConfig = ImageConfig$;
|
|
7211
7371
|
export type ImageContent = ImageContent$;
|
|
7212
7372
|
export type ImageResponseFormat = ImageResponseFormat$;
|
|
@@ -7228,9 +7388,15 @@ export declare namespace Interactions {
|
|
|
7228
7388
|
export type MCPServerToolCallStep = MCPServerToolCallStep$;
|
|
7229
7389
|
export type MCPServerToolResultStep = MCPServerToolResultStep$;
|
|
7230
7390
|
export type Model = Model$;
|
|
7231
|
-
export
|
|
7391
|
+
export interface ModelOutputStep extends ModelOutputStep$ {
|
|
7392
|
+
}
|
|
7232
7393
|
export interface PlaceCitation extends PlaceCitation$ {
|
|
7233
7394
|
}
|
|
7395
|
+
export type RetrievalCallArguments = RetrievalCallArguments$;
|
|
7396
|
+
export interface RetrievalCallDelta extends RetrievalCallDelta$ {
|
|
7397
|
+
}
|
|
7398
|
+
export type RetrievalResultDelta = RetrievalResultDelta$;
|
|
7399
|
+
export type SafetySetting = SafetySetting$;
|
|
7234
7400
|
export type SpeechConfig = SpeechConfig$;
|
|
7235
7401
|
export type Step = Step$;
|
|
7236
7402
|
export interface StepDelta extends StepDelta$ {
|
|
@@ -7256,18 +7422,16 @@ export declare namespace Interactions {
|
|
|
7256
7422
|
export interface Usage extends Usage$ {
|
|
7257
7423
|
}
|
|
7258
7424
|
export type UserInputStep = UserInputStep$;
|
|
7425
|
+
export type VideoConfig = VideoConfig$;
|
|
7259
7426
|
export type VideoContent = VideoContent$;
|
|
7427
|
+
export type VideoResponseFormat = VideoResponseFormat$;
|
|
7260
7428
|
export type WebhookConfig = WebhookConfig$;
|
|
7261
7429
|
export namespace CodeExecutionCallStep {
|
|
7262
7430
|
export type Arguments = Arguments$;
|
|
7263
7431
|
}
|
|
7264
7432
|
export namespace Environment {
|
|
7265
|
-
export
|
|
7266
|
-
}
|
|
7433
|
+
export type Allowlist = Allowlist$;
|
|
7267
7434
|
export type Source = Source$;
|
|
7268
|
-
export namespace Allowlist {
|
|
7269
|
-
export type Allowlist = Allowlist$2;
|
|
7270
|
-
}
|
|
7271
7435
|
}
|
|
7272
7436
|
export namespace ErrorEvent {
|
|
7273
7437
|
export type Error = Error$;
|
|
@@ -7313,9 +7477,15 @@ export declare namespace Interactions {
|
|
|
7313
7477
|
export namespace InteractionStatusUpdate {
|
|
7314
7478
|
export type Metadata = Metadata$4;
|
|
7315
7479
|
}
|
|
7480
|
+
export namespace ModelOutputStep {
|
|
7481
|
+
export type Error = Error$2;
|
|
7482
|
+
}
|
|
7316
7483
|
export namespace PlaceCitation {
|
|
7317
7484
|
export type ReviewSnippet = ReviewSnippet$3;
|
|
7318
7485
|
}
|
|
7486
|
+
export namespace RetrievalCallDelta {
|
|
7487
|
+
export type Arguments = Arguments$4;
|
|
7488
|
+
}
|
|
7319
7489
|
export namespace StepDelta {
|
|
7320
7490
|
export type ArgumentsDelta = ArgumentsDelta$;
|
|
7321
7491
|
export type Audio = Audio$;
|
|
@@ -7362,7 +7532,7 @@ export declare namespace Interactions {
|
|
|
7362
7532
|
}
|
|
7363
7533
|
}
|
|
7364
7534
|
export namespace URLContextCallStep {
|
|
7365
|
-
export type Arguments = Arguments$
|
|
7535
|
+
export type Arguments = Arguments$5;
|
|
7366
7536
|
}
|
|
7367
7537
|
export namespace URLContextResultStep {
|
|
7368
7538
|
export type Result = Result$3;
|
|
@@ -7380,6 +7550,7 @@ declare namespace interactions {
|
|
|
7380
7550
|
export {
|
|
7381
7551
|
AgentOption,
|
|
7382
7552
|
AllowedTools,
|
|
7553
|
+
Transform,
|
|
7383
7554
|
AllowlistEntry,
|
|
7384
7555
|
Annotation,
|
|
7385
7556
|
ArgumentsDelta,
|
|
@@ -7387,9 +7558,9 @@ declare namespace interactions {
|
|
|
7387
7558
|
AudioContent,
|
|
7388
7559
|
AudioDeltaMimeType,
|
|
7389
7560
|
AudioDelta,
|
|
7390
|
-
AudioResponseFormatMimeType,
|
|
7391
7561
|
AudioResponseFormatDelivery,
|
|
7392
|
-
|
|
7562
|
+
AudioResponseFormatMimeType,
|
|
7563
|
+
AudioResponseFormat_2 as AudioResponseFormat,
|
|
7393
7564
|
Language_2 as Language,
|
|
7394
7565
|
CodeExecutionCallArguments,
|
|
7395
7566
|
CodeExecutionCallDelta,
|
|
@@ -7397,6 +7568,7 @@ declare namespace interactions {
|
|
|
7397
7568
|
CodeExecutionResultDelta,
|
|
7398
7569
|
CodeExecutionResultStep,
|
|
7399
7570
|
CodeExecution,
|
|
7571
|
+
DisabledSafetyPolicy,
|
|
7400
7572
|
EnvironmentEnum,
|
|
7401
7573
|
ComputerUse_2 as ComputerUse,
|
|
7402
7574
|
Content_2 as Content,
|
|
@@ -7462,6 +7634,7 @@ declare namespace interactions {
|
|
|
7462
7634
|
GoogleSearch_2 as GoogleSearch,
|
|
7463
7635
|
GroundingToolCountType,
|
|
7464
7636
|
GroundingToolCount,
|
|
7637
|
+
HarmCategory_2 as HarmCategory,
|
|
7465
7638
|
HybridSearch,
|
|
7466
7639
|
ImageConfigAspectRatio,
|
|
7467
7640
|
ImageConfigImageSize,
|
|
@@ -7470,11 +7643,11 @@ declare namespace interactions {
|
|
|
7470
7643
|
ImageContent,
|
|
7471
7644
|
ImageDeltaMimeType,
|
|
7472
7645
|
ImageDelta,
|
|
7473
|
-
ImageResponseFormatMimeType,
|
|
7474
|
-
ImageResponseFormatDelivery,
|
|
7475
7646
|
ImageResponseFormatAspectRatio,
|
|
7647
|
+
ImageResponseFormatDelivery,
|
|
7476
7648
|
ImageResponseFormatImageSize,
|
|
7477
|
-
|
|
7649
|
+
ImageResponseFormatMimeType,
|
|
7650
|
+
ImageResponseFormat_2 as ImageResponseFormat,
|
|
7478
7651
|
InteractionCompletedEvent,
|
|
7479
7652
|
InteractionCreatedEvent,
|
|
7480
7653
|
InteractionSseEventInteractionStatus,
|
|
@@ -7508,15 +7681,23 @@ declare namespace interactions {
|
|
|
7508
7681
|
RagRetrievalConfig_2 as RagRetrievalConfig,
|
|
7509
7682
|
RagStoreConfig,
|
|
7510
7683
|
Ranking,
|
|
7511
|
-
ResponseFormat,
|
|
7684
|
+
ResponseFormat_2 as ResponseFormat,
|
|
7512
7685
|
ResponseModality,
|
|
7513
|
-
|
|
7686
|
+
RetrievalCallArguments,
|
|
7687
|
+
RetrievalCallDeltaRetrievalType,
|
|
7688
|
+
RetrievalCallDelta,
|
|
7689
|
+
RetrievalResultDelta,
|
|
7690
|
+
RetrievalRetrievalType,
|
|
7514
7691
|
Retrieval_2 as Retrieval,
|
|
7515
7692
|
ReviewSnippet,
|
|
7693
|
+
Method,
|
|
7694
|
+
Threshold,
|
|
7695
|
+
SafetySetting_2 as SafetySetting,
|
|
7516
7696
|
ServiceTier_2 as ServiceTier,
|
|
7517
7697
|
SourceType,
|
|
7518
7698
|
Source,
|
|
7519
7699
|
SpeechConfig_2 as SpeechConfig,
|
|
7700
|
+
Status,
|
|
7520
7701
|
StepDeltaData,
|
|
7521
7702
|
StepDeltaMetadata,
|
|
7522
7703
|
StepDelta,
|
|
@@ -7528,7 +7709,7 @@ declare namespace interactions {
|
|
|
7528
7709
|
TextContent,
|
|
7529
7710
|
TextDelta,
|
|
7530
7711
|
TextResponseFormatMimeType,
|
|
7531
|
-
TextResponseFormat,
|
|
7712
|
+
TextResponseFormat_2 as TextResponseFormat,
|
|
7532
7713
|
ThinkingLevel_2 as ThinkingLevel,
|
|
7533
7714
|
ThinkingSummaries,
|
|
7534
7715
|
ThoughtSignatureDelta,
|
|
@@ -7543,7 +7724,6 @@ declare namespace interactions {
|
|
|
7543
7724
|
URLCitation,
|
|
7544
7725
|
URLContextCallArguments,
|
|
7545
7726
|
URLContextCallDelta,
|
|
7546
|
-
Arguments,
|
|
7547
7727
|
URLContextCallStep,
|
|
7548
7728
|
URLContextResultDelta,
|
|
7549
7729
|
URLContextResultStep,
|
|
@@ -7553,10 +7733,15 @@ declare namespace interactions {
|
|
|
7553
7733
|
Usage,
|
|
7554
7734
|
UserInputStep,
|
|
7555
7735
|
VertexAISearchConfig,
|
|
7736
|
+
Task,
|
|
7737
|
+
VideoConfig,
|
|
7556
7738
|
VideoContentMimeType,
|
|
7557
7739
|
VideoContent,
|
|
7558
7740
|
VideoDeltaMimeType,
|
|
7559
7741
|
VideoDelta,
|
|
7742
|
+
VideoResponseFormatAspectRatio,
|
|
7743
|
+
VideoResponseFormatDelivery,
|
|
7744
|
+
VideoResponseFormat_2 as VideoResponseFormat,
|
|
7560
7745
|
WebhookConfig_2 as WebhookConfig
|
|
7561
7746
|
}
|
|
7562
7747
|
}
|
|
@@ -7634,9 +7819,6 @@ declare type InteractionStatus = "in_progress" | "requires_action" | "completed"
|
|
|
7634
7819
|
declare type InteractionStatusUpdate$ = InteractionStatusUpdate;
|
|
7635
7820
|
|
|
7636
7821
|
declare type InteractionStatusUpdate = {
|
|
7637
|
-
event_type: "interaction.status_update";
|
|
7638
|
-
interaction_id: string;
|
|
7639
|
-
status: InteractionStatusUpdateStatus;
|
|
7640
7822
|
/**
|
|
7641
7823
|
* The event_id token to be used to resume the interaction stream, from
|
|
7642
7824
|
*
|
|
@@ -7644,7 +7826,10 @@ declare type InteractionStatusUpdate = {
|
|
|
7644
7826
|
* this event.
|
|
7645
7827
|
*/
|
|
7646
7828
|
event_id?: string | undefined;
|
|
7829
|
+
event_type: "interaction.status_update";
|
|
7830
|
+
interaction_id: string;
|
|
7647
7831
|
metadata?: StreamMetadata | undefined;
|
|
7832
|
+
status: InteractionStatusUpdateStatus;
|
|
7648
7833
|
};
|
|
7649
7834
|
|
|
7650
7835
|
declare type InteractionStatusUpdateStatus = "in_progress" | "requires_action" | "completed" | "failed" | "cancelled" | "incomplete" | "budget_exceeded" | (string & {});
|
|
@@ -8783,9 +8968,9 @@ export declare interface LiveServerSessionResumptionUpdate {
|
|
|
8783
8968
|
resumable?: boolean;
|
|
8784
8969
|
/** Index of last message sent by client that is included in state represented by this SessionResumptionToken. Only sent when `SessionResumptionConfig.transparent` is set.
|
|
8785
8970
|
|
|
8786
|
-
Presence of this index allows users to transparently reconnect and avoid issue of losing some part of realtime audio input/video. If client wishes to temporarily disconnect (for example as result of receiving GoAway) they can do it without losing state by buffering messages sent since last `
|
|
8971
|
+
Presence of this index allows users to transparently reconnect and avoid issue of losing some part of realtime audio input/video. If client wishes to temporarily disconnect (for example as result of receiving GoAway) they can do it without losing state by buffering messages sent since last `SessionResumptionTokenUpdate`. This field will enable them to limit buffering (avoid keeping all requests in RAM).
|
|
8787
8972
|
|
|
8788
|
-
Note: This should not be used for when resuming a session at some time later -- in those cases partial audio and video frames
|
|
8973
|
+
Note: This should not be used for when resuming a session at some time later -- in those cases partial audio and video frames are likely not needed. */
|
|
8789
8974
|
lastConsumedClientMessageIndex?: string;
|
|
8790
8975
|
}
|
|
8791
8976
|
|
|
@@ -8793,6 +8978,11 @@ export declare interface LiveServerSessionResumptionUpdate {
|
|
|
8793
8978
|
export declare interface LiveServerSetupComplete {
|
|
8794
8979
|
/** The session id of the live session. */
|
|
8795
8980
|
sessionId?: string;
|
|
8981
|
+
/** Signature of the verified consent audio. This is populated when the
|
|
8982
|
+
request has a ReplicatedVoiceConfig with consent_audio set, if the consent
|
|
8983
|
+
verification was successful. This may be used in a subsequent request
|
|
8984
|
+
instead of the consent_audio to verify the same consent. */
|
|
8985
|
+
voiceConsentSignature?: VoiceConsentSignature;
|
|
8796
8986
|
}
|
|
8797
8987
|
|
|
8798
8988
|
/** Request for the client to execute the `function_calls` and return the responses with the matching `id`s. */
|
|
@@ -8881,22 +9071,22 @@ export declare enum MaskReferenceMode {
|
|
|
8881
9071
|
MASK_MODE_SEMANTIC = "MASK_MODE_SEMANTIC"
|
|
8882
9072
|
}
|
|
8883
9073
|
|
|
8884
|
-
/** Match operation to use for
|
|
9074
|
+
/** Match operation to use for evaluating rewards. This enum is not supported in Gemini API. */
|
|
8885
9075
|
export declare enum MatchOperation {
|
|
8886
9076
|
/**
|
|
8887
|
-
* Default value.
|
|
9077
|
+
* Default value. A user error will be returned if not set.
|
|
8888
9078
|
*/
|
|
8889
9079
|
MATCH_OPERATION_UNSPECIFIED = "MATCH_OPERATION_UNSPECIFIED",
|
|
8890
9080
|
/**
|
|
8891
|
-
* Equivalent to GoogleSQL `REGEX_CONTAINS(target, expression)`.
|
|
9081
|
+
* Equivalent to [GoogleSQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/string_functions#regexp_contains) `REGEX_CONTAINS(target, expression)`.
|
|
8892
9082
|
*/
|
|
8893
9083
|
REGEX_CONTAINS = "REGEX_CONTAINS",
|
|
8894
9084
|
/**
|
|
8895
|
-
* `
|
|
9085
|
+
* The match operation returns `true` if expression is a substring of the target.
|
|
8896
9086
|
*/
|
|
8897
9087
|
PARTIAL_MATCH = "PARTIAL_MATCH",
|
|
8898
9088
|
/**
|
|
8899
|
-
* `
|
|
9089
|
+
* The match operation returns `true` expression is an exact match of the target.
|
|
8900
9090
|
*/
|
|
8901
9091
|
EXACT_MATCH = "EXACT_MATCH"
|
|
8902
9092
|
}
|
|
@@ -8907,11 +9097,21 @@ declare type MCPServer$ = MCPServer;
|
|
|
8907
9097
|
* A MCPServer is a server that can be called by the model to perform actions.
|
|
8908
9098
|
*/
|
|
8909
9099
|
declare type MCPServer = {
|
|
8910
|
-
|
|
9100
|
+
/**
|
|
9101
|
+
* The allowed tools.
|
|
9102
|
+
*/
|
|
9103
|
+
allowed_tools?: Array<AllowedTools> | undefined;
|
|
9104
|
+
/**
|
|
9105
|
+
* Optional: Fields for authentication headers, timeouts, etc., if needed.
|
|
9106
|
+
*/
|
|
9107
|
+
headers?: {
|
|
9108
|
+
[k: string]: string;
|
|
9109
|
+
} | undefined;
|
|
8911
9110
|
/**
|
|
8912
9111
|
* The name of the MCPServer.
|
|
8913
9112
|
*/
|
|
8914
9113
|
name?: string | undefined;
|
|
9114
|
+
type: "mcp_server";
|
|
8915
9115
|
/**
|
|
8916
9116
|
* The full URL for the MCPServer endpoint.
|
|
8917
9117
|
*
|
|
@@ -8919,16 +9119,6 @@ declare type MCPServer = {
|
|
|
8919
9119
|
* Example: "https://api.example.com/mcp"
|
|
8920
9120
|
*/
|
|
8921
9121
|
url?: string | undefined;
|
|
8922
|
-
/**
|
|
8923
|
-
* Optional: Fields for authentication headers, timeouts, etc., if needed.
|
|
8924
|
-
*/
|
|
8925
|
-
headers?: {
|
|
8926
|
-
[k: string]: string;
|
|
8927
|
-
} | undefined;
|
|
8928
|
-
/**
|
|
8929
|
-
* The allowed tools.
|
|
8930
|
-
*/
|
|
8931
|
-
allowed_tools?: Array<AllowedTools> | undefined;
|
|
8932
9122
|
};
|
|
8933
9123
|
|
|
8934
9124
|
/** A MCPServer is a server that can be called by the model to perform actions. It is a server that implements the MCP protocol. Next ID: 6. This data type is not supported in Vertex AI. */
|
|
@@ -8949,12 +9139,12 @@ declare type MCPServerToolCall$ = MCPServerToolCallDelta;
|
|
|
8949
9139
|
* g3-prettier-ignore-file
|
|
8950
9140
|
*/
|
|
8951
9141
|
declare type MCPServerToolCallDelta = {
|
|
8952
|
-
type: "mcp_server_tool_call";
|
|
8953
|
-
name: string;
|
|
8954
|
-
server_name: string;
|
|
8955
9142
|
arguments: {
|
|
8956
9143
|
[k: string]: any;
|
|
8957
9144
|
};
|
|
9145
|
+
name: string;
|
|
9146
|
+
server_name: string;
|
|
9147
|
+
type: "mcp_server_tool_call";
|
|
8958
9148
|
};
|
|
8959
9149
|
|
|
8960
9150
|
declare type MCPServerToolCallStep$ = MCPServerToolCallStep;
|
|
@@ -8970,15 +9160,6 @@ declare type MCPServerToolCallStep$ = MCPServerToolCallStep;
|
|
|
8970
9160
|
* MCPServer tool call step.
|
|
8971
9161
|
*/
|
|
8972
9162
|
declare type MCPServerToolCallStep = {
|
|
8973
|
-
type: "mcp_server_tool_call";
|
|
8974
|
-
/**
|
|
8975
|
-
* Required. The name of the tool which was called.
|
|
8976
|
-
*/
|
|
8977
|
-
name: string;
|
|
8978
|
-
/**
|
|
8979
|
-
* Required. The name of the used MCP server.
|
|
8980
|
-
*/
|
|
8981
|
-
server_name: string;
|
|
8982
9163
|
/**
|
|
8983
9164
|
* Required. The JSON object of arguments for the function.
|
|
8984
9165
|
*/
|
|
@@ -8989,15 +9170,24 @@ declare type MCPServerToolCallStep = {
|
|
|
8989
9170
|
* Required. A unique ID for this specific tool call.
|
|
8990
9171
|
*/
|
|
8991
9172
|
id: string;
|
|
9173
|
+
/**
|
|
9174
|
+
* Required. The name of the tool which was called.
|
|
9175
|
+
*/
|
|
9176
|
+
name: string;
|
|
9177
|
+
/**
|
|
9178
|
+
* Required. The name of the used MCP server.
|
|
9179
|
+
*/
|
|
9180
|
+
server_name: string;
|
|
9181
|
+
type: "mcp_server_tool_call";
|
|
8992
9182
|
};
|
|
8993
9183
|
|
|
8994
9184
|
declare type MCPServerToolResult$ = MCPServerToolResultDelta;
|
|
8995
9185
|
|
|
8996
9186
|
declare type MCPServerToolResultDelta = {
|
|
8997
|
-
type: "mcp_server_tool_result";
|
|
8998
9187
|
name?: string | undefined;
|
|
8999
|
-
server_name?: string | undefined;
|
|
9000
9188
|
result: MCPServerToolResultDeltaResult | Array<FunctionResultSubcontent> | string;
|
|
9189
|
+
server_name?: string | undefined;
|
|
9190
|
+
type: "mcp_server_tool_result";
|
|
9001
9191
|
};
|
|
9002
9192
|
|
|
9003
9193
|
declare type MCPServerToolResultDeltaResult = {};
|
|
@@ -9010,23 +9200,23 @@ declare type MCPServerToolResultStep$ = MCPServerToolResultStep;
|
|
|
9010
9200
|
* MCPServer tool result step.
|
|
9011
9201
|
*/
|
|
9012
9202
|
declare type MCPServerToolResultStep = {
|
|
9013
|
-
type: "mcp_server_tool_result";
|
|
9014
|
-
/**
|
|
9015
|
-
* Name of the tool which is called for this specific tool call.
|
|
9016
|
-
*/
|
|
9017
|
-
name?: string | undefined;
|
|
9018
|
-
/**
|
|
9019
|
-
* The name of the used MCP server.
|
|
9020
|
-
*/
|
|
9021
|
-
server_name?: string | undefined;
|
|
9022
9203
|
/**
|
|
9023
9204
|
* Required. ID to match the ID from the function call block.
|
|
9024
9205
|
*/
|
|
9025
9206
|
call_id: string;
|
|
9207
|
+
/**
|
|
9208
|
+
* Name of the tool which is called for this specific tool call.
|
|
9209
|
+
*/
|
|
9210
|
+
name?: string | undefined;
|
|
9026
9211
|
/**
|
|
9027
9212
|
* The output from the MCP server call. Can be simple text or rich content.
|
|
9028
9213
|
*/
|
|
9029
9214
|
result: MCPServerToolResultStepResult | string | Array<FunctionResultSubcontent>;
|
|
9215
|
+
/**
|
|
9216
|
+
* The name of the used MCP server.
|
|
9217
|
+
*/
|
|
9218
|
+
server_name?: string | undefined;
|
|
9219
|
+
type: "mcp_server_tool_result";
|
|
9030
9220
|
};
|
|
9031
9221
|
|
|
9032
9222
|
declare type MCPServerToolResultStepResult = {};
|
|
@@ -9119,6 +9309,14 @@ declare type Metadata$6 = StreamMetadata;
|
|
|
9119
9309
|
|
|
9120
9310
|
declare type Metadata$7 = StreamMetadata;
|
|
9121
9311
|
|
|
9312
|
+
/**
|
|
9313
|
+
* Optional. The method for blocking content. If not specified, the default
|
|
9314
|
+
*
|
|
9315
|
+
* @remarks
|
|
9316
|
+
* behavior is to use the probability score.
|
|
9317
|
+
*/
|
|
9318
|
+
declare type Method = "severity" | "probability" | (string & {});
|
|
9319
|
+
|
|
9122
9320
|
/** Server content modalities. */
|
|
9123
9321
|
export declare enum Modality {
|
|
9124
9322
|
/**
|
|
@@ -9245,8 +9443,20 @@ declare type ModelOutputStep$ = ModelOutputStep;
|
|
|
9245
9443
|
* Output generated by the model.
|
|
9246
9444
|
*/
|
|
9247
9445
|
declare type ModelOutputStep = {
|
|
9248
|
-
type: "model_output";
|
|
9249
9446
|
content?: Array<Content_2> | undefined;
|
|
9447
|
+
/**
|
|
9448
|
+
* The `Status` type defines a logical error model that is suitable for
|
|
9449
|
+
*
|
|
9450
|
+
* @remarks
|
|
9451
|
+
* different programming environments, including REST APIs and RPC APIs. It is
|
|
9452
|
+
* used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
|
9453
|
+
* three pieces of data: error code, error message, and error details.
|
|
9454
|
+
*
|
|
9455
|
+
* You can find out more about this error model and how to work with it in the
|
|
9456
|
+
* [API Design Guide](https://cloud.google.com/apis/design/errors).
|
|
9457
|
+
*/
|
|
9458
|
+
error?: Status | undefined;
|
|
9459
|
+
type: "model_output";
|
|
9250
9460
|
};
|
|
9251
9461
|
|
|
9252
9462
|
export declare class Models extends BaseModule {
|
|
@@ -9320,7 +9530,7 @@ export declare class Models extends BaseModule {
|
|
|
9320
9530
|
* To maintain backward compatibility, we move the data that was treated as
|
|
9321
9531
|
* JSON schema from the responseSchema field to the responseJsonSchema field.
|
|
9322
9532
|
*/
|
|
9323
|
-
private
|
|
9533
|
+
private maybeMoveToResponseJsonSchema;
|
|
9324
9534
|
/**
|
|
9325
9535
|
* Makes an API request to generate content with a given model and yields the
|
|
9326
9536
|
* response in chunks.
|
|
@@ -10155,19 +10365,18 @@ declare type PlaceCitation$ = PlaceCitation;
|
|
|
10155
10365
|
* A place citation annotation.
|
|
10156
10366
|
*/
|
|
10157
10367
|
declare type PlaceCitation = {
|
|
10158
|
-
type: "place_citation";
|
|
10159
10368
|
/**
|
|
10160
|
-
*
|
|
10369
|
+
* End of the attributed segment, exclusive.
|
|
10161
10370
|
*/
|
|
10162
|
-
|
|
10371
|
+
end_index?: number | undefined;
|
|
10163
10372
|
/**
|
|
10164
10373
|
* Title of the place.
|
|
10165
10374
|
*/
|
|
10166
10375
|
name?: string | undefined;
|
|
10167
10376
|
/**
|
|
10168
|
-
*
|
|
10377
|
+
* The ID of the place, in `places/{place_id}` format.
|
|
10169
10378
|
*/
|
|
10170
|
-
|
|
10379
|
+
place_id?: string | undefined;
|
|
10171
10380
|
/**
|
|
10172
10381
|
* Snippets of reviews that are used to generate answers about the
|
|
10173
10382
|
*
|
|
@@ -10183,10 +10392,11 @@ declare type PlaceCitation = {
|
|
|
10183
10392
|
* Index indicates the start of the segment, measured in bytes.
|
|
10184
10393
|
*/
|
|
10185
10394
|
start_index?: number | undefined;
|
|
10395
|
+
type: "place_citation";
|
|
10186
10396
|
/**
|
|
10187
|
-
*
|
|
10397
|
+
* URI reference of the place.
|
|
10188
10398
|
*/
|
|
10189
|
-
|
|
10399
|
+
url?: string | undefined;
|
|
10190
10400
|
};
|
|
10191
10401
|
|
|
10192
10402
|
/** Spec for pointwise metric result. This data type is not supported in Gemini API. */
|
|
@@ -10354,21 +10564,21 @@ export declare interface RagRetrievalConfig {
|
|
|
10354
10564
|
*/
|
|
10355
10565
|
declare type RagRetrievalConfig_2 = {
|
|
10356
10566
|
/**
|
|
10357
|
-
*
|
|
10567
|
+
* Config for filters.
|
|
10358
10568
|
*/
|
|
10359
|
-
|
|
10569
|
+
filter?: Filter | undefined;
|
|
10360
10570
|
/**
|
|
10361
10571
|
* Config for Hybrid Search.
|
|
10362
10572
|
*/
|
|
10363
10573
|
hybrid_search?: HybridSearch | undefined;
|
|
10364
|
-
/**
|
|
10365
|
-
* Config for filters.
|
|
10366
|
-
*/
|
|
10367
|
-
filter?: Filter | undefined;
|
|
10368
10574
|
/**
|
|
10369
10575
|
* Config for Rank Service.
|
|
10370
10576
|
*/
|
|
10371
10577
|
ranking?: Ranking | undefined;
|
|
10578
|
+
/**
|
|
10579
|
+
* Optional. The number of contexts to retrieve.
|
|
10580
|
+
*/
|
|
10581
|
+
top_k?: number | undefined;
|
|
10372
10582
|
};
|
|
10373
10583
|
|
|
10374
10584
|
/** Config for filters. This data type is not supported in Gemini API. */
|
|
@@ -10415,6 +10625,10 @@ declare type RagStoreConfig = {
|
|
|
10415
10625
|
* Optional. The representation of the rag source.
|
|
10416
10626
|
*/
|
|
10417
10627
|
rag_resources?: Array<RagResource> | undefined;
|
|
10628
|
+
/**
|
|
10629
|
+
* Specifies the context retrieval config.
|
|
10630
|
+
*/
|
|
10631
|
+
rag_retrieval_config?: RagRetrievalConfig_2 | undefined;
|
|
10418
10632
|
/**
|
|
10419
10633
|
* Optional. Number of top k results to return from the selected corpora.
|
|
10420
10634
|
*
|
|
@@ -10427,10 +10641,6 @@ declare type RagStoreConfig = {
|
|
|
10427
10641
|
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
10428
10642
|
*/
|
|
10429
10643
|
vector_distance_threshold?: number | undefined;
|
|
10430
|
-
/**
|
|
10431
|
-
* Specifies the context retrieval config.
|
|
10432
|
-
*/
|
|
10433
|
-
rag_retrieval_config?: RagRetrievalConfig_2 | undefined;
|
|
10434
10644
|
};
|
|
10435
10645
|
|
|
10436
10646
|
/**
|
|
@@ -10444,11 +10654,11 @@ declare type RagStoreConfig = {
|
|
|
10444
10654
|
* Config for Rank Service.
|
|
10445
10655
|
*/
|
|
10446
10656
|
declare type Ranking = {
|
|
10447
|
-
ranking_config: "rank_service";
|
|
10448
10657
|
/**
|
|
10449
10658
|
* Optional. The model name of the rank service.
|
|
10450
10659
|
*/
|
|
10451
10660
|
model_name?: string | undefined;
|
|
10661
|
+
ranking_config: "rank_service";
|
|
10452
10662
|
};
|
|
10453
10663
|
|
|
10454
10664
|
/** Raw output. This data type is not supported in Gemini API. */
|
|
@@ -10612,39 +10822,39 @@ export declare class RegisterFilesResponse {
|
|
|
10612
10822
|
export declare interface ReinforcementTuningAutoraterScorer {
|
|
10613
10823
|
/** Autorater config for evaluation. */
|
|
10614
10824
|
autoraterConfig?: AutoraterConfig;
|
|
10615
|
-
/**
|
|
10825
|
+
/** The prompt for an autorater to scorer the parsed sample response. This field supports the following placeholders that will be replaced before scoring: - {{prompt}} - {{response}} - {{system_instruction}} - {{references.key}} */
|
|
10616
10826
|
autoraterPrompt?: string;
|
|
10617
|
-
/** Parses autorater returned response. */
|
|
10827
|
+
/** Parses autorater returned response for scoring. For example, if the autorater response has reward stored in the `2.0` block, defining a parsing response config using regex `".*(.*?)"` will return a score `"2.0"`. */
|
|
10618
10828
|
autoraterResponseParseConfig?: ReinforcementTuningParseResponseConfig;
|
|
10619
|
-
/** Scores autorater responses by directly converting parsed autorater response to float reward. */
|
|
10829
|
+
/** Scores autorater responses by directly converting parsed autorater response to a float reward. Note: Reward is clipped to be within `[-1, 1]`, i.e., `reward = max(min(reward, 1.0), -1.0)`. */
|
|
10620
10830
|
parsedResponseConversionScorer?: ReinforcementTuningAutoraterScorerParsedResponseConversionScorer;
|
|
10621
|
-
/** Scores autorater responses by using
|
|
10831
|
+
/** Scores autorater responses by using string match reward scorer. */
|
|
10622
10832
|
exactMatchScorer?: ReinforcementTuningAutoraterScorerExactMatchScorer;
|
|
10623
10833
|
}
|
|
10624
10834
|
|
|
10625
|
-
/** Scores autorater responses by using exact string match reward scorer. */
|
|
10835
|
+
/** Scores autorater responses by using exact string match reward scorer. This data type is not supported in Gemini API. */
|
|
10626
10836
|
export declare interface ReinforcementTuningAutoraterScorerExactMatchScorer {
|
|
10627
|
-
/** Assigns this reward score if parsed response string equals the expression. */
|
|
10837
|
+
/** Assigns this reward score if the parsed response string equals the expression. */
|
|
10628
10838
|
correctAnswerReward?: number;
|
|
10629
|
-
/** Assigns this reward score if parsed reward value does not equal the expression. */
|
|
10839
|
+
/** Assigns this reward score if the parsed reward value does not equal the expression. */
|
|
10630
10840
|
wrongAnswerReward?: number;
|
|
10631
|
-
/** The string expression to match against.
|
|
10841
|
+
/** The string expression to match against for scoring. This field supports placeholders in the format of {{references.key}} that will be replaced before matching. Regex is not supported for this expression. For example, users can define an ExactMatchScorer as follows: { "correctAnswerReward": 1.0, "wrongAnswerReward": -1.0, "expression": "{{references.concise_answer}}" } When evaluating the reward for each parsed autorater response, if the prompt references in the training/validation dataset has the following fields: ``` { "example": ..., "references": { "concise_ansser": "Yes", "verbose_answer": "The answer is Yes" } } ``` The above ExactMatchScorer will be replaced as follows for scoring: ``` { "correctAnswerReward": 1.0, "wrongAnswerReward": -1.0, "expression": "Yes" } ``` If the *parsed* autorater response is equal to the string `"Yes"`, then the reward is `1.0`, otherwise the reward is `-1.0`. */
|
|
10632
10842
|
expression?: string;
|
|
10633
10843
|
}
|
|
10634
10844
|
|
|
10635
|
-
/** Scores responses by directly converting parsed autorater response to float reward
|
|
10845
|
+
/** Scores responses by directly converting the parsed autorater response to a float reward. Note: Reward is clipped to be within `[-1, 1]`, i.e., `reward = max(min(reward, 1.0), -1.0)`. This data type is not supported in Gemini API. */
|
|
10636
10846
|
export declare class ReinforcementTuningAutoraterScorerParsedResponseConversionScorer {
|
|
10637
10847
|
}
|
|
10638
10848
|
|
|
10639
|
-
/**
|
|
10849
|
+
/** ReinforcementTuningCloudRunRewardScorer allows users to implement a reward function through GCP Cloud Run. Comparing with ReinforcementTuningCodeExecutionRewardScorer that runs in a Sandbox and has no internet access, Cloud Run reward scorer is fully controlled by users. The Cloud Run service should implement the following HTTP API: HTTP method: `POST` HTTP request body: ``` { "example": ReinforcementTuningExample, "response": Content, "metadata": { "step": int "tuning_job_id": int64 } } ``` * `example` is a ReinforcementTuningExample in ProtoJSON format, (i.e., the format is the same as as one line in the training/validation dataset except that the keys must be in camel case). System instructions (i.e., `example.get("systemInstruction")`) and references (i.e., `example.get("references")`) are also included in the `example` provided that they are set in the training/validation dataset. * `response` is a Content in ProtoJSON format (i.e., keys must be in camel case), which is the same as the Online Prediction response for Gemini models. HTTP response body: { "reward": float, "user_requested_aux_info": str // Optional } where the field "user_requested_aux_info" is any (optional) string provided by users for assisting debugging. It's in snake case. This field is mostly useful when calling the GenAiTuningService.ValidateReinforcementTuningReward API, where the proto field (not Cloud Run HTTP response body) userRequestedAuxInfo will be populated if the Cloud Run reward function sets this field in the HTTP response. The following are examples for the HTTP request and response body. Example HTTP request body: ``` { "example": { "contents": [ { "role": "user", "parts": [ { "text": "What is the capital of France?" } ] } ], "references": { "answer": "Paris" } }, "response": { "parts": [ { "text": "London" } ] }, "metadata": { "step": 1, "tuning_job_id": 123456789 } } ``` Example HTTP response body: ``` { "reward": -1.0 } ``` Note: Reward output by Cloud Run reward function is clipped to be within `[-1, 1]`, i.e., `reward = max(min(reward, 1.0), -1.0)`. This data type is not supported in Gemini API. */
|
|
10640
10850
|
export declare interface ReinforcementTuningCloudRunRewardScorer {
|
|
10641
|
-
/** URI of the Cloud Run service that will be used to compute the reward. The Vertex AI Secure Fine Tuning Service Agent (`service
|
|
10851
|
+
/** URI of the Cloud Run service that will be used to compute the reward. The [Vertex AI Secure Fine Tuning Service Agent](https://docs.cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent) (`service-@gcp-sa-vertex-tune.iam.gserviceaccount.com`) must be granted the permission (e.g. by granting `roles/run.invoker` in IAM) to invoke the Cloud Run service. */
|
|
10642
10852
|
cloudRunUri?: string;
|
|
10643
10853
|
}
|
|
10644
10854
|
|
|
10645
|
-
/**
|
|
10855
|
+
/** ReinforcementTuningCodeExecutionRewardScorer allows users to implement a function to evaluate rewards for the sample response. The function signature is as follows: ``` def evaluate(example: dict[str, Any], response: dict[str, Any]) -> float: ... ``` `example` is a ReinforcementTuningExample in ProtoJSON format, (i.e., the format is the same as as one line in the training/validation dataset except that the keys must be in camel case). System instructions (i.e., `example.get("systemInstruction")`) and references (i.e., `example.get("references")`) are also included in the `example` provided that they are set in the training/validation dataset. `response` is a Content in ProtoJSON format (i.e., keys must be in camel case), which is the same as the Online Prediction response for Gemini models. Note: Reward output by the `evaluate` function is clipped to be within `[-1, 1]`, i.e., `reward = max(min(reward, 1.0), -1.0)`. This data type is not supported in Gemini API. */
|
|
10646
10856
|
export declare interface ReinforcementTuningCodeExecutionRewardScorer {
|
|
10647
|
-
/**
|
|
10857
|
+
/** The python code snippet as a string for evaluating rewards. The following is an example python code snippet that returns a reward `1.0` for a parsed response matching the user-provided reference answer in per prompt references map. ``` def evaluate(example, response) -> float: response_str = response.get("parts", [])0 references = example.get("references", {}) if response_str == references.get("concise_answer"): return 1.0 return -1.0 ``` Note: Reward output by the evaluate function is clipped to be within `[-1, 1]`, i.e., `reward = max(min(reward, 1.0), -1.0)`. */
|
|
10648
10858
|
pythonCodeSnippet?: string;
|
|
10649
10859
|
}
|
|
10650
10860
|
|
|
@@ -10654,37 +10864,39 @@ export declare interface ReinforcementTuningExample {
|
|
|
10654
10864
|
contents?: Content[];
|
|
10655
10865
|
/** References for the given prompt. The key is the name of the reference, and the value is the reference itself. */
|
|
10656
10866
|
references?: Record<string, string>;
|
|
10657
|
-
/** Corresponds to
|
|
10867
|
+
/** Corresponds to system_instruction in user-facing GenerateContentRequest. */
|
|
10658
10868
|
systemInstruction?: Content;
|
|
10659
10869
|
}
|
|
10660
10870
|
|
|
10661
10871
|
/** Hyperparameters for Reinforcement Tuning. */
|
|
10662
10872
|
export declare interface ReinforcementTuningHyperParameters {
|
|
10663
|
-
/** Number of training
|
|
10873
|
+
/** Optional. Number of training epoches for the tuning job. */
|
|
10664
10874
|
epochCount?: string;
|
|
10665
10875
|
/** Learning rate multiplier for Reinforcement Learning. */
|
|
10666
10876
|
learningRateMultiplier?: number;
|
|
10667
|
-
/** Adapter size for Reinforcement Tuning. */
|
|
10877
|
+
/** Optional. Adapter size for Reinforcement Tuning. */
|
|
10668
10878
|
adapterSize?: AdapterSize;
|
|
10669
|
-
/** Number of different responses to generate per prompt during tuning. */
|
|
10879
|
+
/** Optional. Number of different responses to generate per prompt during tuning. */
|
|
10670
10880
|
samplesPerPrompt?: number;
|
|
10671
|
-
/** Batch size for the tuning job. How many prompts to process at a train step. If not set, the batch size will be determined automatically. */
|
|
10881
|
+
/** Optional. Batch size for the tuning job. How many prompts to process at a train step. If not set, the batch size will be determined automatically. */
|
|
10672
10882
|
batchSize?: number;
|
|
10673
|
-
/** How often
|
|
10883
|
+
/** Optional. How often at steps to evaluate the tuning job during training. If not set, evel will be run per epoch. `total_steps = epoch_count * samples_per_prompt / total_prompts_in_dataset` */
|
|
10674
10884
|
evaluateInterval?: number;
|
|
10675
|
-
/** How often
|
|
10885
|
+
/** Optional. How often at steps to save checkpoints during training. If not set, one checkpoint per epoch will be set. ```total_steps = epoch_count * samples_per_prompt / total_prompts_in_dataset``` */
|
|
10676
10886
|
checkpointInterval?: number;
|
|
10677
|
-
/** The maximum number of tokens to generate per prompt.
|
|
10887
|
+
/** Optional. The maximum number of tokens to generate per prompt. Default to 32768. */
|
|
10678
10888
|
maxOutputTokens?: number;
|
|
10679
|
-
/** Indicates the maximum thinking depth.
|
|
10889
|
+
/** Indicates the maximum thinking depth during tuning. Starting from Gemini 3.5 models, the old thinking_budget will no longer be supported and will result in a user error if set. Instead, users should use the thinking_level parameter to control the maximum thinking depth. */
|
|
10680
10890
|
thinkingLevel?: ReinforcementTuningThinkingLevel;
|
|
10891
|
+
/** Optional. The thinking budget for the tuning job to optimize for (Gemini 2.5 only). * -1 means dynamic thinking * 0 means no thinking * > 0 means thinking budget in tokens If not set, default to -1 (dynamic thinking). */
|
|
10892
|
+
thinkingBudget?: number;
|
|
10681
10893
|
}
|
|
10682
10894
|
|
|
10683
|
-
/** Defines how to parse sample response for reinforcement tuning. */
|
|
10895
|
+
/** Defines how to parse sample response config for reinforcement tuning. The parsed response (i.e., substring) will be passed to the reward functions. For example, the input prompt might be: > "Perform step-by-step thoughts first to problem A, finally output answer in the <ans> </ans> block." The sample response from the model under tuning might look like: > "<ans>Yes</ans>" Here, users can define the following parse config: ``` { "parseType": "REGEX_EXTRACT", "regexExtractExpression": ".*(.*?)" } ``` The resulting parsed response would be `"Yes"` and will be passed to the reward functions for evaluating rewards. This data type is not supported in Gemini API. */
|
|
10684
10896
|
export declare class ReinforcementTuningParseResponseConfig {
|
|
10685
|
-
/** Defines
|
|
10897
|
+
/** Defines the type for parsing sample response. */
|
|
10686
10898
|
parseType?: ResponseParseType;
|
|
10687
|
-
/** Defines the regex
|
|
10899
|
+
/** Defines the regex for extracting the important part of sample response. This field is only used when parse_type is ResponseParseType.REGEX_EXTRACT. */
|
|
10688
10900
|
regexExtractExpression?: string;
|
|
10689
10901
|
}
|
|
10690
10902
|
|
|
@@ -10692,16 +10904,17 @@ export declare class ReinforcementTuningParseResponseConfig {
|
|
|
10692
10904
|
export declare interface ReinforcementTuningRewardInfo {
|
|
10693
10905
|
/** Output only. The calculated reward for the reward function. */
|
|
10694
10906
|
reward?: number;
|
|
10695
|
-
/** Output only. The user-requested auxiliary info for the reward function. */
|
|
10907
|
+
/** Output only. The user-requested auxiliary info for the reward function. This field is set only if the Cloud Run reward function configured by user returns a "user_requested_aux_info". Refer to ReinforcementTuningCloudRunRewardScorer for more details. */
|
|
10696
10908
|
userRequestedAuxInfo?: string;
|
|
10697
10909
|
}
|
|
10698
10910
|
|
|
10699
10911
|
/** Reinforcement tuning spec for tuning. */
|
|
10700
10912
|
export declare interface ReinforcementTuningSpec {
|
|
10913
|
+
/** Composite reward function configuration for reinforcement tuning. */
|
|
10701
10914
|
compositeRewardConfig?: CompositeReinforcementTuningRewardConfig;
|
|
10702
|
-
/** Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. */
|
|
10915
|
+
/** Cloud Storage path to the file containing training dataset for tuning. The dataset must be formatted as a JSONL file. */
|
|
10703
10916
|
trainingDatasetUri?: string;
|
|
10704
|
-
/** Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.
|
|
10917
|
+
/** Cloud Storage path to the file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. */
|
|
10705
10918
|
validationDatasetUri?: string;
|
|
10706
10919
|
/** Additional hyper-parameters to use during tuning. */
|
|
10707
10920
|
hyperParameters?: ReinforcementTuningHyperParameters;
|
|
@@ -10709,11 +10922,11 @@ export declare interface ReinforcementTuningSpec {
|
|
|
10709
10922
|
singleRewardConfig?: SingleReinforcementTuningRewardConfig;
|
|
10710
10923
|
}
|
|
10711
10924
|
|
|
10712
|
-
/**
|
|
10925
|
+
/** ReinforcementTuningStringMatchRewardScorer is used to score parsed responses for string matching use cases. For example, for math problems, users can use string match scorer to check if the correct exact answer is generated. Note: Reward returned by the string match reward function is clipped to be within `[-1, 1]` if wrongAnswerReward or correctAnswerReward are beyond the range, i.e., `reward = max(min(reward, 1.0), -1.0)`. This data type is not supported in Gemini API. */
|
|
10713
10926
|
export declare interface ReinforcementTuningStringMatchRewardScorer {
|
|
10714
|
-
/** Wrong answer reward is returned if
|
|
10927
|
+
/** Wrong answer reward is returned if the parsed response is evaluated as `false`. All wrong answers get the same reward. */
|
|
10715
10928
|
wrongAnswerReward?: number;
|
|
10716
|
-
/** Correct answer
|
|
10929
|
+
/** Correct answer rewawrd is returned if the parsed response is evaluated as `true`. All correct answers get the same reward. */
|
|
10717
10930
|
correctAnswerReward?: number;
|
|
10718
10931
|
/** Uses string match expression to evaluate parsed response. */
|
|
10719
10932
|
stringMatchExpression?: ReinforcementTuningStringMatchRewardScorerStringMatchExpression;
|
|
@@ -10721,19 +10934,19 @@ export declare interface ReinforcementTuningStringMatchRewardScorer {
|
|
|
10721
10934
|
jsonMatchExpression?: ReinforcementTuningStringMatchRewardScorerJsonMatchExpression;
|
|
10722
10935
|
}
|
|
10723
10936
|
|
|
10724
|
-
/**
|
|
10937
|
+
/** JsonMatchExpression supports converting the parsed responses to JSON format, finding the value in the JSON response that matches the key_name in the first level, and performing StringMatchExpression operation on the matched JSON value. This data type is not supported in Gemini API. */
|
|
10725
10938
|
export declare interface ReinforcementTuningStringMatchRewardScorerJsonMatchExpression {
|
|
10726
|
-
/**
|
|
10939
|
+
/** The key name to find the value in the parsed response that's in JSON format. Only first-level key matching is supported. */
|
|
10727
10940
|
keyName?: string;
|
|
10728
|
-
/** String match expression to match against the value of
|
|
10941
|
+
/** String match expression to match against the extracted value from the JSON representation of the parsed response. */
|
|
10729
10942
|
valueStringMatchExpression?: ReinforcementTuningStringMatchRewardScorerStringMatchExpression;
|
|
10730
10943
|
}
|
|
10731
10944
|
|
|
10732
|
-
/** Evaluates parsed response using match type against expression. */
|
|
10945
|
+
/** Evaluates parsed response using match type against the expression. Returns `true` if `MatchOperation(target, expression)` evaluates to `true`, and `false` otherwise. This data type is not supported in Gemini API. */
|
|
10733
10946
|
export declare interface ReinforcementTuningStringMatchRewardScorerStringMatchExpression {
|
|
10734
|
-
/** Match operation to use for
|
|
10947
|
+
/** Match operation to use for evaluating rewards. */
|
|
10735
10948
|
matchOperation?: MatchOperation;
|
|
10736
|
-
/**
|
|
10949
|
+
/** A string or a regular expression to match against for evaluating rewards. Users can also provide a references map of `{key: value}` whose `value` will be used to replace the placeholder {{references.key}} in the expression. For example, if the following `references` are defined in the training / validation dataset: ``` { "systemInstruction": ..., "contents": ..., "references": { "concise_answer": "Yes", "verbose_answer": "The answer is Yes" } } ``` and if users define the following StringMatchExpression: { "matchOperation": "REGEX_CONTAINS", "expression": ".*{{references.concise_answer}}.*" } On evaluating the reward for each sample response, this StringMatchExpression will be substituted as: ``` { "matchOperation": "REGEX_CONTAINS", "expression": ".*Yes.*" } ``` */
|
|
10737
10950
|
expression?: string;
|
|
10738
10951
|
}
|
|
10739
10952
|
|
|
@@ -10753,6 +10966,12 @@ export declare enum ReinforcementTuningThinkingLevel {
|
|
|
10753
10966
|
HIGH = "HIGH"
|
|
10754
10967
|
}
|
|
10755
10968
|
|
|
10969
|
+
/** Sample reinforcement tuning user data in the training dataset. The contents are truncated for better UI showing. This data type is not supported in Gemini API. */
|
|
10970
|
+
export declare interface ReinforcementTuningUserDatasetExamples {
|
|
10971
|
+
/** List of user datasset examples showing to user. */
|
|
10972
|
+
userDatasetExamples?: ReinforcementTuningExample[];
|
|
10973
|
+
}
|
|
10974
|
+
|
|
10756
10975
|
/** Represents a recorded session. */
|
|
10757
10976
|
export declare interface ReplayFile {
|
|
10758
10977
|
replayId?: string;
|
|
@@ -10792,6 +11011,17 @@ export declare interface ReplicatedVoiceConfig {
|
|
|
10792
11011
|
|
|
10793
11012
|
* @remarks Encoded as base64 string. */
|
|
10794
11013
|
voiceSampleAudio?: string;
|
|
11014
|
+
/** Recorded consent verifying ownership of the voice. This
|
|
11015
|
+
represents 16-bit signed little-endian wav data, with a 24kHz sampling
|
|
11016
|
+
rate.
|
|
11017
|
+
* @remarks Encoded as base64 string. */
|
|
11018
|
+
consentAudio?: string;
|
|
11019
|
+
/** Signature of a previously verified consent audio. This should be
|
|
11020
|
+
populated with a signature generated by the server for a previous
|
|
11021
|
+
request containing the consent_audio field. When provided, the
|
|
11022
|
+
signature is verified instead of the consent_audio field to reduce
|
|
11023
|
+
latency. Requests will fail if the signature is invalid or expired. */
|
|
11024
|
+
voiceConsentSignature?: VoiceConsentSignature;
|
|
10795
11025
|
}
|
|
10796
11026
|
|
|
10797
11027
|
declare type RequestOptions = {
|
|
@@ -10848,7 +11078,19 @@ export declare enum ResourceScope {
|
|
|
10848
11078
|
COLLECTION = "COLLECTION"
|
|
10849
11079
|
}
|
|
10850
11080
|
|
|
10851
|
-
|
|
11081
|
+
/** Configuration for the model to configure output formatting and delivery. This data type is not supported in Gemini API. */
|
|
11082
|
+
export declare class ResponseFormat {
|
|
11083
|
+
/** Audio output format. */
|
|
11084
|
+
audio?: AudioResponseFormat;
|
|
11085
|
+
/** Image output format. */
|
|
11086
|
+
image?: ImageResponseFormat;
|
|
11087
|
+
/** Text output format. */
|
|
11088
|
+
text?: TextResponseFormat;
|
|
11089
|
+
/** Video output format. */
|
|
11090
|
+
video?: VideoResponseFormat;
|
|
11091
|
+
}
|
|
11092
|
+
|
|
11093
|
+
declare type ResponseFormat_2 = AudioResponseFormat_2 | TextResponseFormat_2 | ImageResponseFormat_2 | VideoResponseFormat_2 | {
|
|
10852
11094
|
[k: string]: any;
|
|
10853
11095
|
};
|
|
10854
11096
|
|
|
@@ -10861,18 +11103,18 @@ declare type ResponseFormat = AudioResponseFormat | TextResponseFormat | ImageRe
|
|
|
10861
11103
|
*/
|
|
10862
11104
|
declare type ResponseModality = "text" | "image" | "audio" | "video" | "document" | (string & {});
|
|
10863
11105
|
|
|
10864
|
-
/** Defines
|
|
11106
|
+
/** Defines the type for parsing sample response. This enum is not supported in Gemini API. */
|
|
10865
11107
|
export declare enum ResponseParseType {
|
|
10866
11108
|
/**
|
|
10867
|
-
* Default value.
|
|
11109
|
+
* Default value. Fallback to IDENTITY
|
|
10868
11110
|
*/
|
|
10869
11111
|
RESPONSE_PARSE_TYPE_UNSPECIFIED = "RESPONSE_PARSE_TYPE_UNSPECIFIED",
|
|
10870
11112
|
/**
|
|
10871
|
-
*
|
|
11113
|
+
* Returns the sample response as is.
|
|
10872
11114
|
*/
|
|
10873
11115
|
IDENTITY = "IDENTITY",
|
|
10874
11116
|
/**
|
|
10875
|
-
*
|
|
11117
|
+
* Uses regex to extract the important part of sample response. Similar to [GoogleSQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/string_functions#regexp_extract) `REGEX_EXTRACT(response, regex_extract_expression)`, but different in that if there are multiple matches, the last match will be returned.
|
|
10876
11118
|
*/
|
|
10877
11119
|
REGEX_EXTRACT = "REGEX_EXTRACT"
|
|
10878
11120
|
}
|
|
@@ -10901,29 +11143,77 @@ export declare interface Retrieval {
|
|
|
10901
11143
|
* A tool that can be used by the model to retrieve files.
|
|
10902
11144
|
*/
|
|
10903
11145
|
declare type Retrieval_2 = {
|
|
10904
|
-
|
|
11146
|
+
/**
|
|
11147
|
+
* Used to specify configuration for ExaAISearch.
|
|
11148
|
+
*/
|
|
11149
|
+
exa_ai_search_config?: ExaAISearchConfig | undefined;
|
|
11150
|
+
/**
|
|
11151
|
+
* Used to specify configuration for ParallelAISearch.
|
|
11152
|
+
*/
|
|
11153
|
+
parallel_ai_search_config?: ParallelAISearchConfig | undefined;
|
|
11154
|
+
/**
|
|
11155
|
+
* Use to specify configuration for RAG Store.
|
|
11156
|
+
*/
|
|
11157
|
+
rag_store_config?: RagStoreConfig | undefined;
|
|
10905
11158
|
/**
|
|
10906
11159
|
* The types of file retrieval to enable.
|
|
10907
11160
|
*/
|
|
10908
|
-
retrieval_types?: Array<
|
|
11161
|
+
retrieval_types?: Array<RetrievalRetrievalType> | undefined;
|
|
11162
|
+
type: "retrieval";
|
|
10909
11163
|
/**
|
|
10910
11164
|
* Used to specify configuration for VertexAISearch.
|
|
10911
11165
|
*/
|
|
10912
11166
|
vertex_ai_search_config?: VertexAISearchConfig | undefined;
|
|
11167
|
+
};
|
|
11168
|
+
|
|
11169
|
+
declare type RetrievalCallArguments$ = RetrievalCallArguments;
|
|
11170
|
+
|
|
11171
|
+
/**
|
|
11172
|
+
* @license
|
|
11173
|
+
* Copyright 2026 Google LLC
|
|
11174
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
11175
|
+
*
|
|
11176
|
+
* g3-prettier-ignore-file
|
|
11177
|
+
*/
|
|
11178
|
+
/**
|
|
11179
|
+
* The arguments to pass to Retrieval tools.
|
|
11180
|
+
*/
|
|
11181
|
+
declare type RetrievalCallArguments = {
|
|
10913
11182
|
/**
|
|
10914
|
-
*
|
|
11183
|
+
* Queries for Retrieval information.
|
|
10915
11184
|
*/
|
|
10916
|
-
|
|
11185
|
+
queries?: Array<string> | undefined;
|
|
11186
|
+
};
|
|
11187
|
+
|
|
11188
|
+
declare type RetrievalCallDelta$ = RetrievalCallDelta;
|
|
11189
|
+
|
|
11190
|
+
/**
|
|
11191
|
+
* Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search,
|
|
11192
|
+
*
|
|
11193
|
+
* @remarks
|
|
11194
|
+
* etc. RetrievalType decides which tool is used.
|
|
11195
|
+
*/
|
|
11196
|
+
declare type RetrievalCallDelta = {
|
|
10917
11197
|
/**
|
|
10918
|
-
*
|
|
11198
|
+
* The arguments to pass to Retrieval tools.
|
|
10919
11199
|
*/
|
|
10920
|
-
|
|
11200
|
+
arguments: RetrievalCallArguments;
|
|
10921
11201
|
/**
|
|
10922
|
-
*
|
|
11202
|
+
* The type of retrieval tools.
|
|
10923
11203
|
*/
|
|
10924
|
-
|
|
11204
|
+
retrieval_type?: RetrievalCallDeltaRetrievalType | undefined;
|
|
11205
|
+
/**
|
|
11206
|
+
* A signature hash for backend validation.
|
|
11207
|
+
*/
|
|
11208
|
+
signature?: string | undefined;
|
|
11209
|
+
type: "retrieval_call";
|
|
10925
11210
|
};
|
|
10926
11211
|
|
|
11212
|
+
/**
|
|
11213
|
+
* The type of retrieval tools.
|
|
11214
|
+
*/
|
|
11215
|
+
declare type RetrievalCallDeltaRetrievalType = "vertex_ai_search" | "rag_store" | "exa_ai_search" | "parallel_ai_search" | (string & {});
|
|
11216
|
+
|
|
10927
11217
|
/** Retrieval config. */
|
|
10928
11218
|
export declare interface RetrievalConfig {
|
|
10929
11219
|
/** The location of the user. */
|
|
@@ -10943,7 +11233,35 @@ export declare interface RetrievalMetadata {
|
|
|
10943
11233
|
googleSearchDynamicRetrievalScore?: number;
|
|
10944
11234
|
}
|
|
10945
11235
|
|
|
10946
|
-
declare type
|
|
11236
|
+
declare type RetrievalResultDelta$ = RetrievalResultDelta;
|
|
11237
|
+
|
|
11238
|
+
/**
|
|
11239
|
+
* @license
|
|
11240
|
+
* Copyright 2026 Google LLC
|
|
11241
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
11242
|
+
*
|
|
11243
|
+
* g3-prettier-ignore-file
|
|
11244
|
+
*/
|
|
11245
|
+
/**
|
|
11246
|
+
* Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search,
|
|
11247
|
+
*
|
|
11248
|
+
* @remarks
|
|
11249
|
+
* etc.
|
|
11250
|
+
* ToolResultDelta.type
|
|
11251
|
+
*/
|
|
11252
|
+
declare type RetrievalResultDelta = {
|
|
11253
|
+
/**
|
|
11254
|
+
* Whether the retrieval resulted in an error.
|
|
11255
|
+
*/
|
|
11256
|
+
is_error?: boolean | undefined;
|
|
11257
|
+
/**
|
|
11258
|
+
* A signature hash for backend validation.
|
|
11259
|
+
*/
|
|
11260
|
+
signature?: string | undefined;
|
|
11261
|
+
type: "retrieval_result";
|
|
11262
|
+
};
|
|
11263
|
+
|
|
11264
|
+
declare type RetrievalRetrievalType = "vertex_ai_search" | "rag_store" | "exa_ai_search" | "parallel_ai_search" | (string & {});
|
|
10947
11265
|
|
|
10948
11266
|
declare type RetryConfig = {
|
|
10949
11267
|
strategy: "none";
|
|
@@ -10978,6 +11296,10 @@ declare type ReviewSnippet$3 = ReviewSnippet;
|
|
|
10978
11296
|
* the features of a specific place in Google Maps.
|
|
10979
11297
|
*/
|
|
10980
11298
|
declare type ReviewSnippet = {
|
|
11299
|
+
/**
|
|
11300
|
+
* The ID of the review snippet.
|
|
11301
|
+
*/
|
|
11302
|
+
review_id?: string | undefined;
|
|
10981
11303
|
/**
|
|
10982
11304
|
* Title of the review.
|
|
10983
11305
|
*/
|
|
@@ -10986,10 +11308,6 @@ declare type ReviewSnippet = {
|
|
|
10986
11308
|
* A link that corresponds to the user review on Google Maps.
|
|
10987
11309
|
*/
|
|
10988
11310
|
url?: string | undefined;
|
|
10989
|
-
/**
|
|
10990
|
-
* The ID of the review snippet.
|
|
10991
|
-
*/
|
|
10992
|
-
review_id?: string | undefined;
|
|
10993
11311
|
};
|
|
10994
11312
|
|
|
10995
11313
|
/**
|
|
@@ -11040,8 +11358,44 @@ export declare enum SafetyFilterLevel {
|
|
|
11040
11358
|
BLOCK_NONE = "BLOCK_NONE"
|
|
11041
11359
|
}
|
|
11042
11360
|
|
|
11043
|
-
/**
|
|
11044
|
-
export declare
|
|
11361
|
+
/** SafetyPolicy */
|
|
11362
|
+
export declare enum SafetyPolicy {
|
|
11363
|
+
/**
|
|
11364
|
+
* Unspecified safety policy.
|
|
11365
|
+
*/
|
|
11366
|
+
SAFETY_POLICY_UNSPECIFIED = "SAFETY_POLICY_UNSPECIFIED",
|
|
11367
|
+
/**
|
|
11368
|
+
* Safety policy for financial transactions.
|
|
11369
|
+
*/
|
|
11370
|
+
FINANCIAL_TRANSACTIONS = "FINANCIAL_TRANSACTIONS",
|
|
11371
|
+
/**
|
|
11372
|
+
* Safety policy for sensitive data modification.
|
|
11373
|
+
*/
|
|
11374
|
+
SENSITIVE_DATA_MODIFICATION = "SENSITIVE_DATA_MODIFICATION",
|
|
11375
|
+
/**
|
|
11376
|
+
* Safety policy for communication tools (e.g. Gmail, Chat, Meet).
|
|
11377
|
+
*/
|
|
11378
|
+
COMMUNICATION_TOOL = "COMMUNICATION_TOOL",
|
|
11379
|
+
/**
|
|
11380
|
+
* Safety policy for account creation.
|
|
11381
|
+
*/
|
|
11382
|
+
ACCOUNT_CREATION = "ACCOUNT_CREATION",
|
|
11383
|
+
/**
|
|
11384
|
+
* Safety policy for data modification.
|
|
11385
|
+
*/
|
|
11386
|
+
DATA_MODIFICATION = "DATA_MODIFICATION",
|
|
11387
|
+
/**
|
|
11388
|
+
* Safety policy for user consent management.
|
|
11389
|
+
*/
|
|
11390
|
+
USER_CONSENT_MANAGEMENT = "USER_CONSENT_MANAGEMENT",
|
|
11391
|
+
/**
|
|
11392
|
+
* Safety policy for legal terms and agreements.
|
|
11393
|
+
*/
|
|
11394
|
+
LEGAL_TERMS_AND_AGREEMENTS = "LEGAL_TERMS_AND_AGREEMENTS"
|
|
11395
|
+
}
|
|
11396
|
+
|
|
11397
|
+
/** A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. */
|
|
11398
|
+
export declare interface SafetyRating {
|
|
11045
11399
|
/** Output only. Indicates whether the content was blocked because of this rating. */
|
|
11046
11400
|
blocked?: boolean;
|
|
11047
11401
|
/** Output only. The harm category of this rating. */
|
|
@@ -11058,6 +11412,8 @@ export declare interface SafetyRating {
|
|
|
11058
11412
|
severityScore?: number;
|
|
11059
11413
|
}
|
|
11060
11414
|
|
|
11415
|
+
declare type SafetySetting$ = SafetySetting_2;
|
|
11416
|
+
|
|
11061
11417
|
/** A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. */
|
|
11062
11418
|
export declare interface SafetySetting {
|
|
11063
11419
|
/** Required. The harm category to be blocked. */
|
|
@@ -11068,6 +11424,34 @@ export declare interface SafetySetting {
|
|
|
11068
11424
|
threshold?: HarmBlockThreshold;
|
|
11069
11425
|
}
|
|
11070
11426
|
|
|
11427
|
+
/**
|
|
11428
|
+
* A safety setting that affects the safety-blocking behavior.
|
|
11429
|
+
*
|
|
11430
|
+
* @remarks
|
|
11431
|
+
*
|
|
11432
|
+
* A SafetySetting consists of a
|
|
11433
|
+
* harm category and a
|
|
11434
|
+
* threshold for that
|
|
11435
|
+
* category.
|
|
11436
|
+
*/
|
|
11437
|
+
declare type SafetySetting_2 = {
|
|
11438
|
+
/**
|
|
11439
|
+
* Optional. The method for blocking content. If not specified, the default
|
|
11440
|
+
*
|
|
11441
|
+
* @remarks
|
|
11442
|
+
* behavior is to use the probability score.
|
|
11443
|
+
*/
|
|
11444
|
+
method?: Method | undefined;
|
|
11445
|
+
/**
|
|
11446
|
+
* Required. The threshold for blocking content. If the harm probability
|
|
11447
|
+
*
|
|
11448
|
+
* @remarks
|
|
11449
|
+
* exceeds this threshold, the content will be blocked.
|
|
11450
|
+
*/
|
|
11451
|
+
threshold: Threshold;
|
|
11452
|
+
type: HarmCategory_2;
|
|
11453
|
+
};
|
|
11454
|
+
|
|
11071
11455
|
/** Scale of the generated music. */
|
|
11072
11456
|
export declare enum Scale {
|
|
11073
11457
|
/**
|
|
@@ -11348,6 +11732,7 @@ declare type ServiceTier_2 = "flex" | "standard" | "priority" | (string & {});
|
|
|
11348
11732
|
export declare class Session {
|
|
11349
11733
|
readonly conn: WebSocket_2;
|
|
11350
11734
|
private readonly apiClient;
|
|
11735
|
+
setupComplete?: types.LiveServerSetupComplete;
|
|
11351
11736
|
constructor(conn: WebSocket_2, apiClient: ApiClient);
|
|
11352
11737
|
private tLiveClientContent;
|
|
11353
11738
|
private tLiveClienttToolResponse;
|
|
@@ -11513,14 +11898,14 @@ declare type SigningSecret$ = SigningSecret;
|
|
|
11513
11898
|
* Represents a signing secret used to verify webhook payloads.
|
|
11514
11899
|
*/
|
|
11515
11900
|
declare type SigningSecret = {
|
|
11516
|
-
/**
|
|
11517
|
-
* Output only. The truncated version of the signing secret.
|
|
11518
|
-
*/
|
|
11519
|
-
truncated_secret?: string | undefined;
|
|
11520
11901
|
/**
|
|
11521
11902
|
* Output only. The expiration date of the signing secret.
|
|
11522
11903
|
*/
|
|
11523
11904
|
expire_time?: string | undefined;
|
|
11905
|
+
/**
|
|
11906
|
+
* Output only. The truncated version of the signing secret.
|
|
11907
|
+
*/
|
|
11908
|
+
truncated_secret?: string | undefined;
|
|
11524
11909
|
};
|
|
11525
11910
|
|
|
11526
11911
|
/** Config for `response` parameter. */
|
|
@@ -11537,15 +11922,15 @@ export declare class SingleEmbedContentResponse {
|
|
|
11537
11922
|
export declare interface SingleReinforcementTuningRewardConfig {
|
|
11538
11923
|
/** Scores parsed responses for autorater use cases by using a model to compute the reward. */
|
|
11539
11924
|
autoraterScorer?: ReinforcementTuningAutoraterScorer;
|
|
11540
|
-
/** A unique reward name
|
|
11925
|
+
/** A unique reward name for identifying each single reinforcement tuning reward. */
|
|
11541
11926
|
rewardName?: string;
|
|
11542
|
-
/** Defines how to parse sample response. */
|
|
11927
|
+
/** Defines how to parse sample response. For example, given a sample response for evaluating the reward, users might want to extract the text only between `` and `` in the sample response, and keeps only the last one in case there are multiple such tags. To achieve such a purpose, they can define a regex `".*(.*?)"` using the ReinforcementTuningParseResponseConfig.ResponseParseType.REGEX_EXTRACT parse type. */
|
|
11543
11928
|
parseResponseConfig?: ReinforcementTuningParseResponseConfig;
|
|
11544
|
-
/**
|
|
11929
|
+
/** ReinforcementTuningCodeExecutionRewardScorer is used to score parsed responses for code execution use cases. */
|
|
11545
11930
|
codeExecutionRewardScorer?: ReinforcementTuningCodeExecutionRewardScorer;
|
|
11546
|
-
/**
|
|
11931
|
+
/** ReinforcementTuningStringMatchRewardScorer is used to score parsed responses for simple string matching use cases against reference answers. */
|
|
11547
11932
|
stringMatchRewardScorer?: ReinforcementTuningStringMatchRewardScorer;
|
|
11548
|
-
/**
|
|
11933
|
+
/** ReinforcementTuningCloudRunRewardScorer is used to score parsed responses by calling a Cloud Run service. */
|
|
11549
11934
|
cloudRunRewardScorer?: ReinforcementTuningCloudRunRewardScorer;
|
|
11550
11935
|
}
|
|
11551
11936
|
|
|
@@ -11566,7 +11951,14 @@ declare type Source$ = Source;
|
|
|
11566
11951
|
* A source to be mounted into the environment.
|
|
11567
11952
|
*/
|
|
11568
11953
|
declare type Source = {
|
|
11569
|
-
|
|
11954
|
+
/**
|
|
11955
|
+
* The inline content if `type` is `INLINE`.
|
|
11956
|
+
*/
|
|
11957
|
+
content?: string | undefined;
|
|
11958
|
+
/**
|
|
11959
|
+
* Optional encoding for inline content (e.g. `base64`).
|
|
11960
|
+
*/
|
|
11961
|
+
encoding?: string | undefined;
|
|
11570
11962
|
/**
|
|
11571
11963
|
* The source of the environment.
|
|
11572
11964
|
*
|
|
@@ -11579,14 +11971,7 @@ declare type Source = {
|
|
|
11579
11971
|
* Where the source should appear in the environment.
|
|
11580
11972
|
*/
|
|
11581
11973
|
target?: string | undefined;
|
|
11582
|
-
|
|
11583
|
-
* The inline content if `type` is `INLINE`.
|
|
11584
|
-
*/
|
|
11585
|
-
content?: string | undefined;
|
|
11586
|
-
/**
|
|
11587
|
-
* Optional encoding for inline content (e.g. `base64`).
|
|
11588
|
-
*/
|
|
11589
|
-
encoding?: string | undefined;
|
|
11974
|
+
type?: SourceType | undefined;
|
|
11590
11975
|
};
|
|
11591
11976
|
|
|
11592
11977
|
/**
|
|
@@ -11629,10 +12014,6 @@ export declare interface SpeechConfig {
|
|
|
11629
12014
|
* The configuration for speech interaction.
|
|
11630
12015
|
*/
|
|
11631
12016
|
declare type SpeechConfig_2 = {
|
|
11632
|
-
/**
|
|
11633
|
-
* The voice of the speaker.
|
|
11634
|
-
*/
|
|
11635
|
-
voice?: string | undefined;
|
|
11636
12017
|
/**
|
|
11637
12018
|
* The language of the speech.
|
|
11638
12019
|
*/
|
|
@@ -11641,6 +12022,10 @@ declare type SpeechConfig_2 = {
|
|
|
11641
12022
|
* The speaker's name, it should match the speaker name given in the prompt.
|
|
11642
12023
|
*/
|
|
11643
12024
|
speaker?: string | undefined;
|
|
12025
|
+
/**
|
|
12026
|
+
* The voice of the speaker.
|
|
12027
|
+
*/
|
|
12028
|
+
voice?: string | undefined;
|
|
11644
12029
|
};
|
|
11645
12030
|
|
|
11646
12031
|
export declare type SpeechConfigUnion = SpeechConfig | string;
|
|
@@ -11668,6 +12053,48 @@ export declare enum StartSensitivity {
|
|
|
11668
12053
|
START_SENSITIVITY_LOW = "START_SENSITIVITY_LOW"
|
|
11669
12054
|
}
|
|
11670
12055
|
|
|
12056
|
+
/**
|
|
12057
|
+
* @license
|
|
12058
|
+
* Copyright 2026 Google LLC
|
|
12059
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
12060
|
+
*
|
|
12061
|
+
* g3-prettier-ignore-file
|
|
12062
|
+
*/
|
|
12063
|
+
/**
|
|
12064
|
+
* The `Status` type defines a logical error model that is suitable for
|
|
12065
|
+
*
|
|
12066
|
+
* @remarks
|
|
12067
|
+
* different programming environments, including REST APIs and RPC APIs. It is
|
|
12068
|
+
* used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
|
12069
|
+
* three pieces of data: error code, error message, and error details.
|
|
12070
|
+
*
|
|
12071
|
+
* You can find out more about this error model and how to work with it in the
|
|
12072
|
+
* [API Design Guide](https://cloud.google.com/apis/design/errors).
|
|
12073
|
+
*/
|
|
12074
|
+
declare type Status = {
|
|
12075
|
+
/**
|
|
12076
|
+
* The status code, which should be an enum value of google.rpc.Code.
|
|
12077
|
+
*/
|
|
12078
|
+
code?: number | undefined;
|
|
12079
|
+
/**
|
|
12080
|
+
* A list of messages that carry the error details. There is a common set of
|
|
12081
|
+
*
|
|
12082
|
+
* @remarks
|
|
12083
|
+
* message types for APIs to use.
|
|
12084
|
+
*/
|
|
12085
|
+
details?: Array<{
|
|
12086
|
+
[k: string]: any;
|
|
12087
|
+
}> | undefined;
|
|
12088
|
+
/**
|
|
12089
|
+
* A developer-facing error message, which should be in English. Any
|
|
12090
|
+
*
|
|
12091
|
+
* @remarks
|
|
12092
|
+
* user-facing error message should be localized and sent in the
|
|
12093
|
+
* google.rpc.Status.details field, or localized by the client.
|
|
12094
|
+
*/
|
|
12095
|
+
message?: string | undefined;
|
|
12096
|
+
};
|
|
12097
|
+
|
|
11671
12098
|
declare type Step$ = Step;
|
|
11672
12099
|
|
|
11673
12100
|
/**
|
|
@@ -11678,8 +12105,6 @@ declare type Step = UserInputStep | ModelOutputStep | ThoughtStep | FunctionCall
|
|
|
11678
12105
|
declare type StepDelta$ = StepDelta;
|
|
11679
12106
|
|
|
11680
12107
|
declare type StepDelta = {
|
|
11681
|
-
event_type: "step.delta";
|
|
11682
|
-
index: number;
|
|
11683
12108
|
delta: StepDeltaData;
|
|
11684
12109
|
/**
|
|
11685
12110
|
* The event_id token to be used to resume the interaction stream, from
|
|
@@ -11688,13 +12113,15 @@ declare type StepDelta = {
|
|
|
11688
12113
|
* this event.
|
|
11689
12114
|
*/
|
|
11690
12115
|
event_id?: string | undefined;
|
|
12116
|
+
event_type: "step.delta";
|
|
12117
|
+
index: number;
|
|
11691
12118
|
/**
|
|
11692
12119
|
* Optional metadata accompanying ANY streamed event.
|
|
11693
12120
|
*/
|
|
11694
12121
|
metadata?: StepDeltaMetadata | undefined;
|
|
11695
12122
|
};
|
|
11696
12123
|
|
|
11697
|
-
declare type StepDeltaData = TextDelta | ImageDelta | AudioDelta | DocumentDelta | VideoDelta | ThoughtSummaryDelta | ThoughtSignatureDelta | TextAnnotationDelta | ArgumentsDelta | CodeExecutionCallDelta | URLContextCallDelta | GoogleSearchCallDelta | MCPServerToolCallDelta | FileSearchCallDelta | GoogleMapsCallDelta | CodeExecutionResultDelta | URLContextResultDelta | GoogleSearchResultDelta | MCPServerToolResultDelta | FileSearchResultDelta | GoogleMapsResultDelta | FunctionResultDelta;
|
|
12124
|
+
declare type StepDeltaData = TextDelta | ImageDelta | AudioDelta | DocumentDelta | VideoDelta | ThoughtSummaryDelta | ThoughtSignatureDelta | TextAnnotationDelta | ArgumentsDelta | CodeExecutionCallDelta | URLContextCallDelta | GoogleSearchCallDelta | MCPServerToolCallDelta | FileSearchCallDelta | GoogleMapsCallDelta | RetrievalCallDelta | CodeExecutionResultDelta | URLContextResultDelta | GoogleSearchResultDelta | MCPServerToolResultDelta | FileSearchResultDelta | GoogleMapsResultDelta | RetrievalResultDelta | FunctionResultDelta;
|
|
11698
12125
|
|
|
11699
12126
|
/**
|
|
11700
12127
|
* Optional metadata accompanying ANY streamed event.
|
|
@@ -11709,12 +12136,6 @@ declare type StepDeltaMetadata = {
|
|
|
11709
12136
|
declare type StepStart$ = StepStart;
|
|
11710
12137
|
|
|
11711
12138
|
declare type StepStart = {
|
|
11712
|
-
event_type: "step.start";
|
|
11713
|
-
index: number;
|
|
11714
|
-
/**
|
|
11715
|
-
* A step in the interaction.
|
|
11716
|
-
*/
|
|
11717
|
-
step: Step;
|
|
11718
12139
|
/**
|
|
11719
12140
|
* The event_id token to be used to resume the interaction stream, from
|
|
11720
12141
|
*
|
|
@@ -11722,14 +12143,18 @@ declare type StepStart = {
|
|
|
11722
12143
|
* this event.
|
|
11723
12144
|
*/
|
|
11724
12145
|
event_id?: string | undefined;
|
|
12146
|
+
event_type: "step.start";
|
|
12147
|
+
index: number;
|
|
11725
12148
|
metadata?: StreamMetadata | undefined;
|
|
12149
|
+
/**
|
|
12150
|
+
* A step in the interaction.
|
|
12151
|
+
*/
|
|
12152
|
+
step: Step;
|
|
11726
12153
|
};
|
|
11727
12154
|
|
|
11728
12155
|
declare type StepStop$ = StepStop;
|
|
11729
12156
|
|
|
11730
12157
|
declare type StepStop = {
|
|
11731
|
-
event_type: "step.stop";
|
|
11732
|
-
index: number;
|
|
11733
12158
|
/**
|
|
11734
12159
|
* The event_id token to be used to resume the interaction stream, from
|
|
11735
12160
|
*
|
|
@@ -11737,7 +12162,17 @@ declare type StepStop = {
|
|
|
11737
12162
|
* this event.
|
|
11738
12163
|
*/
|
|
11739
12164
|
event_id?: string | undefined;
|
|
12165
|
+
event_type: "step.stop";
|
|
12166
|
+
index: number;
|
|
11740
12167
|
metadata?: StreamMetadata | undefined;
|
|
12168
|
+
/**
|
|
12169
|
+
* Statistics on the interaction request's token usage.
|
|
12170
|
+
*/
|
|
12171
|
+
step_usage?: Usage | undefined;
|
|
12172
|
+
/**
|
|
12173
|
+
* Statistics on the interaction request's token usage.
|
|
12174
|
+
*/
|
|
12175
|
+
usage?: Usage | undefined;
|
|
11741
12176
|
};
|
|
11742
12177
|
|
|
11743
12178
|
export declare class Stream<T> extends ReadableStream<T> {
|
|
@@ -11942,6 +12377,22 @@ export declare interface SupervisedTuningSpec {
|
|
|
11942
12377
|
validationDatasetUri?: string;
|
|
11943
12378
|
}
|
|
11944
12379
|
|
|
12380
|
+
/**
|
|
12381
|
+
* @license
|
|
12382
|
+
* Copyright 2026 Google LLC
|
|
12383
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
12384
|
+
*
|
|
12385
|
+
* g3-prettier-ignore-file
|
|
12386
|
+
*/
|
|
12387
|
+
/**
|
|
12388
|
+
* Optional task mode for video generation. If not specified, the model
|
|
12389
|
+
*
|
|
12390
|
+
* @remarks
|
|
12391
|
+
* automatically determines the appropriate mode based on the provided text
|
|
12392
|
+
* prompt and input media.
|
|
12393
|
+
*/
|
|
12394
|
+
declare type Task = "text_to_video" | "image_to_video" | "reference_to_video" | "edit" | (string & {});
|
|
12395
|
+
|
|
11945
12396
|
export declare interface TestTableFile {
|
|
11946
12397
|
comment?: string;
|
|
11947
12398
|
testMethod?: string;
|
|
@@ -11973,11 +12424,11 @@ declare type Text$ = TextDelta;
|
|
|
11973
12424
|
declare type TextAnnotationDelta$ = TextAnnotationDelta;
|
|
11974
12425
|
|
|
11975
12426
|
declare type TextAnnotationDelta = {
|
|
11976
|
-
type: "text_annotation_delta";
|
|
11977
12427
|
/**
|
|
11978
12428
|
* Citation information for model-generated content.
|
|
11979
12429
|
*/
|
|
11980
12430
|
annotations?: Array<Annotation> | undefined;
|
|
12431
|
+
type: "text_annotation_delta";
|
|
11981
12432
|
};
|
|
11982
12433
|
|
|
11983
12434
|
declare type TextContent$ = TextContent;
|
|
@@ -11986,15 +12437,15 @@ declare type TextContent$ = TextContent;
|
|
|
11986
12437
|
* A text content block.
|
|
11987
12438
|
*/
|
|
11988
12439
|
declare type TextContent = {
|
|
11989
|
-
type: "text";
|
|
11990
|
-
/**
|
|
11991
|
-
* Required. The text content.
|
|
11992
|
-
*/
|
|
11993
|
-
text: string;
|
|
11994
12440
|
/**
|
|
11995
12441
|
* Citation information for model-generated content.
|
|
11996
12442
|
*/
|
|
11997
12443
|
annotations?: Array<Annotation> | undefined;
|
|
12444
|
+
/**
|
|
12445
|
+
* Required. The text content.
|
|
12446
|
+
*/
|
|
12447
|
+
text: string;
|
|
12448
|
+
type: "text";
|
|
11998
12449
|
};
|
|
11999
12450
|
|
|
12000
12451
|
/**
|
|
@@ -12005,17 +12456,24 @@ declare type TextContent = {
|
|
|
12005
12456
|
* g3-prettier-ignore-file
|
|
12006
12457
|
*/
|
|
12007
12458
|
declare type TextDelta = {
|
|
12008
|
-
type: "text";
|
|
12009
12459
|
text: string;
|
|
12460
|
+
type: "text";
|
|
12010
12461
|
};
|
|
12011
12462
|
|
|
12012
|
-
declare type TextResponseFormat$ =
|
|
12463
|
+
declare type TextResponseFormat$ = TextResponseFormat_2;
|
|
12464
|
+
|
|
12465
|
+
/** Configuration for text-specific output formatting. */
|
|
12466
|
+
export declare class TextResponseFormat {
|
|
12467
|
+
/** Optional. The IANA standard MIME type of the response. */
|
|
12468
|
+
mimeType?: string;
|
|
12469
|
+
/** Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON. */
|
|
12470
|
+
schema?: unknown;
|
|
12471
|
+
}
|
|
12013
12472
|
|
|
12014
12473
|
/**
|
|
12015
12474
|
* Configuration for text output format.
|
|
12016
12475
|
*/
|
|
12017
|
-
declare type
|
|
12018
|
-
type: "text";
|
|
12476
|
+
declare type TextResponseFormat_2 = {
|
|
12019
12477
|
/**
|
|
12020
12478
|
* The MIME type of the text output.
|
|
12021
12479
|
*/
|
|
@@ -12029,6 +12487,7 @@ declare type TextResponseFormat = {
|
|
|
12029
12487
|
schema?: {
|
|
12030
12488
|
[k: string]: any;
|
|
12031
12489
|
} | undefined;
|
|
12490
|
+
type: "text";
|
|
12032
12491
|
};
|
|
12033
12492
|
|
|
12034
12493
|
/**
|
|
@@ -12109,11 +12568,11 @@ declare type ThoughtSignature$ = ThoughtSignatureDelta;
|
|
|
12109
12568
|
* g3-prettier-ignore-file
|
|
12110
12569
|
*/
|
|
12111
12570
|
declare type ThoughtSignatureDelta = {
|
|
12112
|
-
type: "thought_signature";
|
|
12113
12571
|
/**
|
|
12114
12572
|
* Signature to match the backend source to be part of the generation.
|
|
12115
12573
|
*/
|
|
12116
12574
|
signature?: string | undefined;
|
|
12575
|
+
type: "thought_signature";
|
|
12117
12576
|
};
|
|
12118
12577
|
|
|
12119
12578
|
declare type ThoughtStep$ = ThoughtStep;
|
|
@@ -12122,7 +12581,6 @@ declare type ThoughtStep$ = ThoughtStep;
|
|
|
12122
12581
|
* A thought step.
|
|
12123
12582
|
*/
|
|
12124
12583
|
declare type ThoughtStep = {
|
|
12125
|
-
type: "thought";
|
|
12126
12584
|
/**
|
|
12127
12585
|
* A signature hash for backend validation.
|
|
12128
12586
|
*/
|
|
@@ -12131,6 +12589,7 @@ declare type ThoughtStep = {
|
|
|
12131
12589
|
* A summary of the thought.
|
|
12132
12590
|
*/
|
|
12133
12591
|
summary?: Array<ThoughtSummaryContent> | undefined;
|
|
12592
|
+
type: "thought";
|
|
12134
12593
|
};
|
|
12135
12594
|
|
|
12136
12595
|
declare type ThoughtSummary$ = ThoughtSummaryDelta;
|
|
@@ -12138,13 +12597,21 @@ declare type ThoughtSummary$ = ThoughtSummaryDelta;
|
|
|
12138
12597
|
declare type ThoughtSummaryContent = TextContent | ImageContent;
|
|
12139
12598
|
|
|
12140
12599
|
declare type ThoughtSummaryDelta = {
|
|
12141
|
-
type: "thought_summary";
|
|
12142
12600
|
/**
|
|
12143
12601
|
* The content of the response.
|
|
12144
12602
|
*/
|
|
12145
12603
|
content?: Content_2 | undefined;
|
|
12604
|
+
type: "thought_summary";
|
|
12146
12605
|
};
|
|
12147
12606
|
|
|
12607
|
+
/**
|
|
12608
|
+
* Required. The threshold for blocking content. If the harm probability
|
|
12609
|
+
*
|
|
12610
|
+
* @remarks
|
|
12611
|
+
* exceeds this threshold, the content will be blocked.
|
|
12612
|
+
*/
|
|
12613
|
+
declare type Threshold = "block_low_and_above" | "block_medium_and_above" | "block_only_high" | "block_none" | "off" | (string & {});
|
|
12614
|
+
|
|
12148
12615
|
export declare class Tokens extends BaseModule {
|
|
12149
12616
|
private readonly apiClient;
|
|
12150
12617
|
constructor(apiClient: ApiClient);
|
|
@@ -12251,9 +12718,7 @@ declare type Tool$ = Tool_2;
|
|
|
12251
12718
|
export declare interface Tool {
|
|
12252
12719
|
/** Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. This field is not supported in Gemini API. */
|
|
12253
12720
|
retrieval?: Retrieval;
|
|
12254
|
-
/** Optional. Tool to support the model interacting directly with the
|
|
12255
|
-
computer. If enabled, it automatically populates computer-use specific
|
|
12256
|
-
Function Declarations. */
|
|
12721
|
+
/** Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. */
|
|
12257
12722
|
computerUse?: ComputerUse;
|
|
12258
12723
|
/** Optional. FileSearch tool type. Tool to retrieve knowledge from Semantic Retrieval corpora. This field is not supported in Vertex AI. */
|
|
12259
12724
|
fileSearch?: FileSearch;
|
|
@@ -12276,6 +12741,8 @@ export declare interface Tool {
|
|
|
12276
12741
|
urlContext?: UrlContext;
|
|
12277
12742
|
/** Optional. MCP Servers to connect to. This field is not supported in Vertex AI. */
|
|
12278
12743
|
mcpServers?: McpServer[];
|
|
12744
|
+
/** Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation. This field is not supported in Gemini API. */
|
|
12745
|
+
exaAiSearch?: ToolExaAiSearch;
|
|
12279
12746
|
}
|
|
12280
12747
|
|
|
12281
12748
|
/**
|
|
@@ -12340,6 +12807,14 @@ export declare interface ToolConfig {
|
|
|
12340
12807
|
includeServerSideToolInvocations?: boolean;
|
|
12341
12808
|
}
|
|
12342
12809
|
|
|
12810
|
+
/** ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. This data type is not supported in Gemini API. */
|
|
12811
|
+
export declare interface ToolExaAiSearch {
|
|
12812
|
+
/** Required. The API key for ExaAiSearch. */
|
|
12813
|
+
apiKey?: string;
|
|
12814
|
+
/** Optional. This field can be used to pass any parameter from the Exa.ai Search API. */
|
|
12815
|
+
customConfigs?: Record<string, unknown>;
|
|
12816
|
+
}
|
|
12817
|
+
|
|
12343
12818
|
export declare type ToolListUnion = ToolUnion[];
|
|
12344
12819
|
|
|
12345
12820
|
/** ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. This data type is not supported in Gemini API. */
|
|
@@ -12431,14 +12906,27 @@ export declare interface Transcription {
|
|
|
12431
12906
|
languageCode?: string;
|
|
12432
12907
|
}
|
|
12433
12908
|
|
|
12909
|
+
/**
|
|
12910
|
+
* @license
|
|
12911
|
+
* Copyright 2026 Google LLC
|
|
12912
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
12913
|
+
*
|
|
12914
|
+
* g3-prettier-ignore-file
|
|
12915
|
+
*/
|
|
12916
|
+
/**
|
|
12917
|
+
* Headers to inject on all outbound requests matching this domain. Accepts a single dict or a list of dicts. The egress proxy injects these automatically.
|
|
12918
|
+
*/
|
|
12919
|
+
declare type Transform = {
|
|
12920
|
+
[k: string]: string;
|
|
12921
|
+
} | Array<{
|
|
12922
|
+
[k: string]: string;
|
|
12923
|
+
}>;
|
|
12924
|
+
|
|
12434
12925
|
/** Config for stream translation. */
|
|
12435
12926
|
export declare interface TranslationConfig {
|
|
12436
|
-
/** If true, the model will generate audio when the target language is
|
|
12437
|
-
spoken, essentially it will parrot the input. If false, we will not produce
|
|
12438
|
-
audio for the target language. */
|
|
12927
|
+
/** Optional. If true, the model will generate audio when the target language is spoken, essentially it will parrot the input. If false, we will not produce audio for the target language. */
|
|
12439
12928
|
echoTargetLanguage?: boolean;
|
|
12440
|
-
/** The target language for translation. Supported values are BCP-47
|
|
12441
|
-
language codes (e.g. "en", "es", "fr"). */
|
|
12929
|
+
/** Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). */
|
|
12442
12930
|
targetLanguageCode?: string;
|
|
12443
12931
|
}
|
|
12444
12932
|
|
|
@@ -12506,6 +12994,8 @@ export declare interface TuningDataStats {
|
|
|
12506
12994
|
preferenceOptimizationDataStats?: PreferenceOptimizationDataStats;
|
|
12507
12995
|
/** The SFT Tuning data stats. */
|
|
12508
12996
|
supervisedTuningDataStats?: SupervisedTuningDataStats;
|
|
12997
|
+
/** Output only. Statistics for reinforcement tuning. */
|
|
12998
|
+
reinforcementTuningDataStats?: DatasetStats;
|
|
12509
12999
|
}
|
|
12510
13000
|
|
|
12511
13001
|
/** A single example for tuning. This data type is not supported in Vertex AI. */
|
|
@@ -12548,6 +13038,7 @@ export declare interface TuningJob {
|
|
|
12548
13038
|
preferenceOptimizationSpec?: PreferenceOptimizationSpec;
|
|
12549
13039
|
/** Tuning Spec for Distillation. */
|
|
12550
13040
|
distillationSpec?: DistillationSpec;
|
|
13041
|
+
/** Tuning Spec for Reinforcement Tuning. */
|
|
12551
13042
|
reinforcementTuningSpec?: ReinforcementTuningSpec;
|
|
12552
13043
|
/** Output only. The tuning data statistics associated with this TuningJob. */
|
|
12553
13044
|
tuningDataStats?: TuningDataStats;
|
|
@@ -12774,6 +13265,7 @@ export declare interface TuningValidationDataset {
|
|
|
12774
13265
|
* @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
12775
13266
|
*/
|
|
12776
13267
|
declare type Turn = {
|
|
13268
|
+
content?: Array<Content_2> | string | undefined;
|
|
12777
13269
|
/**
|
|
12778
13270
|
* The originator of this turn. Must be user for input or model for
|
|
12779
13271
|
*
|
|
@@ -12781,7 +13273,6 @@ declare type Turn = {
|
|
|
12781
13273
|
* model output.
|
|
12782
13274
|
*/
|
|
12783
13275
|
role?: string | undefined;
|
|
12784
|
-
content?: Array<Content_2> | string | undefined;
|
|
12785
13276
|
};
|
|
12786
13277
|
|
|
12787
13278
|
/** The reason why the turn is complete. */
|
|
@@ -12975,10 +13466,11 @@ declare namespace types {
|
|
|
12975
13466
|
Language,
|
|
12976
13467
|
FunctionResponseScheduling,
|
|
12977
13468
|
Type,
|
|
12978
|
-
Environment,
|
|
12979
13469
|
AuthType,
|
|
12980
13470
|
HttpElementLocation,
|
|
12981
13471
|
ApiSpec,
|
|
13472
|
+
Environment,
|
|
13473
|
+
SafetyPolicy,
|
|
12982
13474
|
PhishBlockThreshold,
|
|
12983
13475
|
Behavior,
|
|
12984
13476
|
DynamicRetrievalConfigMode,
|
|
@@ -12999,8 +13491,14 @@ declare namespace types {
|
|
|
12999
13491
|
ModelStage,
|
|
13000
13492
|
MediaResolution,
|
|
13001
13493
|
Modality,
|
|
13494
|
+
Delivery,
|
|
13495
|
+
AspectRatio,
|
|
13496
|
+
ImageSize,
|
|
13002
13497
|
TuningMode,
|
|
13003
13498
|
AdapterSize,
|
|
13499
|
+
ResponseParseType,
|
|
13500
|
+
MatchOperation,
|
|
13501
|
+
ReinforcementTuningThinkingLevel,
|
|
13004
13502
|
JobState,
|
|
13005
13503
|
TuningJobState,
|
|
13006
13504
|
AggregationMetric,
|
|
@@ -13026,9 +13524,6 @@ declare namespace types {
|
|
|
13026
13524
|
VideoGenerationMaskMode,
|
|
13027
13525
|
VideoCompressionQuality,
|
|
13028
13526
|
ImageResizeMode,
|
|
13029
|
-
ResponseParseType,
|
|
13030
|
-
MatchOperation,
|
|
13031
|
-
ReinforcementTuningThinkingLevel,
|
|
13032
13527
|
TuningMethod,
|
|
13033
13528
|
FileState,
|
|
13034
13529
|
FileSource,
|
|
@@ -13062,7 +13557,6 @@ declare namespace types {
|
|
|
13062
13557
|
HttpOptions,
|
|
13063
13558
|
Schema,
|
|
13064
13559
|
ModelSelectionConfig,
|
|
13065
|
-
ComputerUse,
|
|
13066
13560
|
ApiKeyConfig,
|
|
13067
13561
|
AuthConfigGoogleServiceAccountConfig,
|
|
13068
13562
|
AuthConfigHttpBasicAuthConfig,
|
|
@@ -13086,6 +13580,7 @@ declare namespace types {
|
|
|
13086
13580
|
RagRetrievalConfig,
|
|
13087
13581
|
VertexRagStore,
|
|
13088
13582
|
Retrieval,
|
|
13583
|
+
ComputerUse,
|
|
13089
13584
|
FileSearch,
|
|
13090
13585
|
WebSearch,
|
|
13091
13586
|
ImageSearch,
|
|
@@ -13101,7 +13596,9 @@ declare namespace types {
|
|
|
13101
13596
|
UrlContext,
|
|
13102
13597
|
StreamableHttpTransport,
|
|
13103
13598
|
McpServer,
|
|
13599
|
+
ToolExaAiSearch,
|
|
13104
13600
|
Tool,
|
|
13601
|
+
VoiceConsentSignature,
|
|
13105
13602
|
ReplicatedVoiceConfig,
|
|
13106
13603
|
PrebuiltVoiceConfig,
|
|
13107
13604
|
VoiceConfig,
|
|
@@ -13206,6 +13703,12 @@ declare namespace types {
|
|
|
13206
13703
|
DeleteModelConfig,
|
|
13207
13704
|
DeleteModelParameters,
|
|
13208
13705
|
DeleteModelResponse,
|
|
13706
|
+
AudioResponseFormat,
|
|
13707
|
+
ImageResponseFormat,
|
|
13708
|
+
TextResponseFormat,
|
|
13709
|
+
VideoResponseFormat,
|
|
13710
|
+
ResponseFormat,
|
|
13711
|
+
TranslationConfig,
|
|
13209
13712
|
GenerationConfig,
|
|
13210
13713
|
CountTokensConfig,
|
|
13211
13714
|
CountTokensParameters,
|
|
@@ -13255,6 +13758,8 @@ declare namespace types {
|
|
|
13255
13758
|
PreTunedModel,
|
|
13256
13759
|
DatasetDistributionDistributionBucket,
|
|
13257
13760
|
DatasetDistribution,
|
|
13761
|
+
ReinforcementTuningExample,
|
|
13762
|
+
ReinforcementTuningUserDatasetExamples,
|
|
13258
13763
|
DatasetStats,
|
|
13259
13764
|
DistillationDataStats,
|
|
13260
13765
|
GeminiPreferenceExampleCompletion,
|
|
@@ -13300,7 +13805,6 @@ declare namespace types {
|
|
|
13300
13805
|
CreateTuningJobConfig,
|
|
13301
13806
|
CreateTuningJobParametersPrivate,
|
|
13302
13807
|
TuningOperation,
|
|
13303
|
-
ReinforcementTuningExample,
|
|
13304
13808
|
ValidateRewardConfig,
|
|
13305
13809
|
ValidateRewardParameters,
|
|
13306
13810
|
ReinforcementTuningRewardInfo,
|
|
@@ -13444,7 +13948,6 @@ declare namespace types {
|
|
|
13444
13948
|
LiveClientRealtimeInput,
|
|
13445
13949
|
LiveClientToolResponse,
|
|
13446
13950
|
LiveClientMessage,
|
|
13447
|
-
TranslationConfig,
|
|
13448
13951
|
LiveConnectConfig,
|
|
13449
13952
|
LiveConnectParameters,
|
|
13450
13953
|
CreateChatParameters,
|
|
@@ -13756,15 +14259,10 @@ declare type URLCitation$ = URLCitation;
|
|
|
13756
14259
|
* A URL citation annotation.
|
|
13757
14260
|
*/
|
|
13758
14261
|
declare type URLCitation = {
|
|
13759
|
-
type: "url_citation";
|
|
13760
14262
|
/**
|
|
13761
|
-
*
|
|
13762
|
-
*/
|
|
13763
|
-
url?: string | undefined;
|
|
13764
|
-
/**
|
|
13765
|
-
* The title of the URL.
|
|
14263
|
+
* End of the attributed segment, exclusive.
|
|
13766
14264
|
*/
|
|
13767
|
-
|
|
14265
|
+
end_index?: number | undefined;
|
|
13768
14266
|
/**
|
|
13769
14267
|
* Start of segment of the response that is attributed to this source.
|
|
13770
14268
|
*
|
|
@@ -13774,9 +14272,14 @@ declare type URLCitation = {
|
|
|
13774
14272
|
*/
|
|
13775
14273
|
start_index?: number | undefined;
|
|
13776
14274
|
/**
|
|
13777
|
-
*
|
|
14275
|
+
* The title of the URL.
|
|
13778
14276
|
*/
|
|
13779
|
-
|
|
14277
|
+
title?: string | undefined;
|
|
14278
|
+
type: "url_citation";
|
|
14279
|
+
/**
|
|
14280
|
+
* The URL.
|
|
14281
|
+
*/
|
|
14282
|
+
url?: string | undefined;
|
|
13780
14283
|
};
|
|
13781
14284
|
|
|
13782
14285
|
declare type URLContext$ = URLContext;
|
|
@@ -13821,7 +14324,6 @@ declare type URLContextCallArguments = {
|
|
|
13821
14324
|
};
|
|
13822
14325
|
|
|
13823
14326
|
declare type URLContextCallDelta = {
|
|
13824
|
-
type: "url_context_call";
|
|
13825
14327
|
/**
|
|
13826
14328
|
* The arguments to pass to the URL context.
|
|
13827
14329
|
*/
|
|
@@ -13830,6 +14332,7 @@ declare type URLContextCallDelta = {
|
|
|
13830
14332
|
* A signature hash for backend validation.
|
|
13831
14333
|
*/
|
|
13832
14334
|
signature?: string | undefined;
|
|
14335
|
+
type: "url_context_call";
|
|
13833
14336
|
};
|
|
13834
14337
|
|
|
13835
14338
|
declare type URLContextCallStep$ = URLContextCallStep;
|
|
@@ -13838,7 +14341,10 @@ declare type URLContextCallStep$ = URLContextCallStep;
|
|
|
13838
14341
|
* URL context call step.
|
|
13839
14342
|
*/
|
|
13840
14343
|
declare type URLContextCallStep = {
|
|
13841
|
-
|
|
14344
|
+
/**
|
|
14345
|
+
* The arguments to pass to the URL context.
|
|
14346
|
+
*/
|
|
14347
|
+
arguments: URLContextCallArguments;
|
|
13842
14348
|
/**
|
|
13843
14349
|
* Required. A unique ID for this specific tool call.
|
|
13844
14350
|
*/
|
|
@@ -13847,10 +14353,7 @@ declare type URLContextCallStep = {
|
|
|
13847
14353
|
* A signature hash for backend validation.
|
|
13848
14354
|
*/
|
|
13849
14355
|
signature?: string | undefined;
|
|
13850
|
-
|
|
13851
|
-
* The arguments to pass to the URL context.
|
|
13852
|
-
*/
|
|
13853
|
-
arguments: Arguments;
|
|
14356
|
+
type: "url_context_call";
|
|
13854
14357
|
};
|
|
13855
14358
|
|
|
13856
14359
|
/** Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */
|
|
@@ -13867,24 +14370,24 @@ declare type URLContextResult$2 = URLContextResultDelta;
|
|
|
13867
14370
|
* The result of the URL context.
|
|
13868
14371
|
*/
|
|
13869
14372
|
declare type URLContextResult = {
|
|
13870
|
-
/**
|
|
13871
|
-
* The URL that was fetched.
|
|
13872
|
-
*/
|
|
13873
|
-
url?: string | undefined;
|
|
13874
14373
|
/**
|
|
13875
14374
|
* The status of the URL retrieval.
|
|
13876
14375
|
*/
|
|
13877
14376
|
status?: URLContextResultStatus | undefined;
|
|
14377
|
+
/**
|
|
14378
|
+
* The URL that was fetched.
|
|
14379
|
+
*/
|
|
14380
|
+
url?: string | undefined;
|
|
13878
14381
|
};
|
|
13879
14382
|
|
|
13880
14383
|
declare type URLContextResultDelta = {
|
|
13881
|
-
type: "url_context_result";
|
|
13882
|
-
result: Array<URLContextResult>;
|
|
13883
14384
|
is_error?: boolean | undefined;
|
|
14385
|
+
result: Array<URLContextResult>;
|
|
13884
14386
|
/**
|
|
13885
14387
|
* A signature hash for backend validation.
|
|
13886
14388
|
*/
|
|
13887
14389
|
signature?: string | undefined;
|
|
14390
|
+
type: "url_context_result";
|
|
13888
14391
|
};
|
|
13889
14392
|
|
|
13890
14393
|
/**
|
|
@@ -13905,23 +14408,23 @@ declare type URLContextResultStep$ = URLContextResultStep;
|
|
|
13905
14408
|
* URL context result step.
|
|
13906
14409
|
*/
|
|
13907
14410
|
declare type URLContextResultStep = {
|
|
13908
|
-
type: "url_context_result";
|
|
13909
14411
|
/**
|
|
13910
|
-
* Required.
|
|
14412
|
+
* Required. ID to match the ID from the function call block.
|
|
13911
14413
|
*/
|
|
13912
|
-
|
|
14414
|
+
call_id: string;
|
|
13913
14415
|
/**
|
|
13914
14416
|
* Whether the URL context resulted in an error.
|
|
13915
14417
|
*/
|
|
13916
14418
|
is_error?: boolean | undefined;
|
|
13917
14419
|
/**
|
|
13918
|
-
* Required.
|
|
14420
|
+
* Required. The results of the URL context.
|
|
13919
14421
|
*/
|
|
13920
|
-
|
|
14422
|
+
result: Array<URLContextResult>;
|
|
13921
14423
|
/**
|
|
13922
14424
|
* A signature hash for backend validation.
|
|
13923
14425
|
*/
|
|
13924
14426
|
signature?: string | undefined;
|
|
14427
|
+
type: "url_context_result";
|
|
13925
14428
|
};
|
|
13926
14429
|
|
|
13927
14430
|
/** The metadata for a single URL retrieval. */
|
|
@@ -13963,37 +14466,37 @@ declare type Usage$ = Usage;
|
|
|
13963
14466
|
*/
|
|
13964
14467
|
declare type Usage = {
|
|
13965
14468
|
/**
|
|
13966
|
-
*
|
|
14469
|
+
* A breakdown of cached token usage by modality.
|
|
13967
14470
|
*/
|
|
13968
|
-
|
|
14471
|
+
cached_tokens_by_modality?: Array<ModalityTokens> | undefined;
|
|
13969
14472
|
/**
|
|
13970
|
-
*
|
|
14473
|
+
* Grounding tool count.
|
|
13971
14474
|
*/
|
|
13972
|
-
|
|
14475
|
+
grounding_tool_count?: Array<GroundingToolCount> | undefined;
|
|
13973
14476
|
/**
|
|
13974
|
-
*
|
|
14477
|
+
* A breakdown of input token usage by modality.
|
|
13975
14478
|
*/
|
|
13976
|
-
|
|
14479
|
+
input_tokens_by_modality?: Array<ModalityTokens> | undefined;
|
|
13977
14480
|
/**
|
|
13978
|
-
* A breakdown of
|
|
14481
|
+
* A breakdown of output token usage by modality.
|
|
13979
14482
|
*/
|
|
13980
|
-
|
|
14483
|
+
output_tokens_by_modality?: Array<ModalityTokens> | undefined;
|
|
13981
14484
|
/**
|
|
13982
|
-
*
|
|
14485
|
+
* A breakdown of tool-use token usage by modality.
|
|
13983
14486
|
*/
|
|
13984
|
-
|
|
14487
|
+
tool_use_tokens_by_modality?: Array<ModalityTokens> | undefined;
|
|
13985
14488
|
/**
|
|
13986
|
-
*
|
|
14489
|
+
* Number of tokens in the cached part of the prompt (the cached content).
|
|
13987
14490
|
*/
|
|
13988
|
-
|
|
14491
|
+
total_cached_tokens?: number | undefined;
|
|
13989
14492
|
/**
|
|
13990
|
-
* Number of tokens
|
|
14493
|
+
* Number of tokens in the prompt (context).
|
|
13991
14494
|
*/
|
|
13992
|
-
|
|
14495
|
+
total_input_tokens?: number | undefined;
|
|
13993
14496
|
/**
|
|
13994
|
-
*
|
|
14497
|
+
* Total number of tokens across all the generated responses.
|
|
13995
14498
|
*/
|
|
13996
|
-
|
|
14499
|
+
total_output_tokens?: number | undefined;
|
|
13997
14500
|
/**
|
|
13998
14501
|
* Number of tokens of thoughts for thinking models.
|
|
13999
14502
|
*/
|
|
@@ -14006,9 +14509,9 @@ declare type Usage = {
|
|
|
14006
14509
|
*/
|
|
14007
14510
|
total_tokens?: number | undefined;
|
|
14008
14511
|
/**
|
|
14009
|
-
*
|
|
14512
|
+
* Number of tokens present in tool-use prompt(s).
|
|
14010
14513
|
*/
|
|
14011
|
-
|
|
14514
|
+
total_tool_use_tokens?: number | undefined;
|
|
14012
14515
|
};
|
|
14013
14516
|
|
|
14014
14517
|
/** Usage metadata about response(s). */
|
|
@@ -14177,14 +14680,14 @@ declare type VertexAISearchConfig$ = VertexAISearchConfig;
|
|
|
14177
14680
|
* Used to specify configuration for VertexAISearch.
|
|
14178
14681
|
*/
|
|
14179
14682
|
declare type VertexAISearchConfig = {
|
|
14180
|
-
/**
|
|
14181
|
-
* Optional. Used to specify Vertex AI Search engine.
|
|
14182
|
-
*/
|
|
14183
|
-
engine?: string | undefined;
|
|
14184
14683
|
/**
|
|
14185
14684
|
* Optional. Used to specify Vertex AI Search datastores.
|
|
14186
14685
|
*/
|
|
14187
14686
|
datastores?: Array<string> | undefined;
|
|
14687
|
+
/**
|
|
14688
|
+
* Optional. Used to specify Vertex AI Search engine.
|
|
14689
|
+
*/
|
|
14690
|
+
engine?: string | undefined;
|
|
14188
14691
|
};
|
|
14189
14692
|
|
|
14190
14693
|
/** Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec. This data type is not supported in Gemini API. */
|
|
@@ -14256,26 +14759,42 @@ export declare enum VideoCompressionQuality {
|
|
|
14256
14759
|
LOSSLESS = "LOSSLESS"
|
|
14257
14760
|
}
|
|
14258
14761
|
|
|
14762
|
+
declare type VideoConfig$ = VideoConfig;
|
|
14763
|
+
|
|
14764
|
+
/**
|
|
14765
|
+
* Configuration options for video generation.
|
|
14766
|
+
*/
|
|
14767
|
+
declare type VideoConfig = {
|
|
14768
|
+
/**
|
|
14769
|
+
* Optional task mode for video generation. If not specified, the model
|
|
14770
|
+
*
|
|
14771
|
+
* @remarks
|
|
14772
|
+
* automatically determines the appropriate mode based on the provided text
|
|
14773
|
+
* prompt and input media.
|
|
14774
|
+
*/
|
|
14775
|
+
task?: Task | undefined;
|
|
14776
|
+
};
|
|
14777
|
+
|
|
14259
14778
|
declare type VideoContent$ = VideoContent;
|
|
14260
14779
|
|
|
14261
14780
|
/**
|
|
14262
14781
|
* A video content block.
|
|
14263
14782
|
*/
|
|
14264
14783
|
declare type VideoContent = {
|
|
14265
|
-
type: "video";
|
|
14266
14784
|
/**
|
|
14267
14785
|
* The video content.
|
|
14268
14786
|
*/
|
|
14269
14787
|
data?: string | undefined;
|
|
14270
|
-
/**
|
|
14271
|
-
* The URI of the video.
|
|
14272
|
-
*/
|
|
14273
|
-
uri?: string | undefined;
|
|
14274
14788
|
/**
|
|
14275
14789
|
* The mime type of the video.
|
|
14276
14790
|
*/
|
|
14277
14791
|
mime_type?: VideoContentMimeType | undefined;
|
|
14278
14792
|
resolution?: MediaResolution_2 | undefined;
|
|
14793
|
+
type: "video";
|
|
14794
|
+
/**
|
|
14795
|
+
* The URI of the video.
|
|
14796
|
+
*/
|
|
14797
|
+
uri?: string | undefined;
|
|
14279
14798
|
};
|
|
14280
14799
|
|
|
14281
14800
|
/**
|
|
@@ -14284,11 +14803,11 @@ declare type VideoContent = {
|
|
|
14284
14803
|
declare type VideoContentMimeType = "video/mp4" | "video/mpeg" | "video/mpg" | "video/mov" | "video/avi" | "video/x-flv" | "video/webm" | "video/wmv" | "video/3gpp" | (string & {});
|
|
14285
14804
|
|
|
14286
14805
|
declare type VideoDelta = {
|
|
14287
|
-
type: "video";
|
|
14288
14806
|
data?: string | undefined;
|
|
14289
|
-
uri?: string | undefined;
|
|
14290
14807
|
mime_type?: VideoDeltaMimeType | undefined;
|
|
14291
14808
|
resolution?: MediaResolution_2 | undefined;
|
|
14809
|
+
type: "video";
|
|
14810
|
+
uri?: string | undefined;
|
|
14292
14811
|
};
|
|
14293
14812
|
|
|
14294
14813
|
declare type VideoDeltaMimeType = "video/mp4" | "video/mpeg" | "video/mpg" | "video/mov" | "video/avi" | "video/x-flv" | "video/webm" | "video/wmv" | "video/3gpp" | (string & {});
|
|
@@ -14380,6 +14899,63 @@ export declare enum VideoOrientation {
|
|
|
14380
14899
|
PORTRAIT = "PORTRAIT"
|
|
14381
14900
|
}
|
|
14382
14901
|
|
|
14902
|
+
declare type VideoResponseFormat$ = VideoResponseFormat_2;
|
|
14903
|
+
|
|
14904
|
+
/** Configuration for video-specific output formatting. This data type is not supported in Gemini API. */
|
|
14905
|
+
export declare class VideoResponseFormat {
|
|
14906
|
+
/** The aspect ratio for the video output. */
|
|
14907
|
+
aspectRatio?: AspectRatio;
|
|
14908
|
+
/** Optional. Delivery mode for the generated content. */
|
|
14909
|
+
delivery?: Delivery;
|
|
14910
|
+
/** Optional. The duration for the video output. */
|
|
14911
|
+
duration?: string;
|
|
14912
|
+
/** Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI. */
|
|
14913
|
+
gcsUri?: string;
|
|
14914
|
+
}
|
|
14915
|
+
|
|
14916
|
+
/**
|
|
14917
|
+
* Configuration for video output format.
|
|
14918
|
+
*/
|
|
14919
|
+
declare type VideoResponseFormat_2 = {
|
|
14920
|
+
/**
|
|
14921
|
+
* The aspect ratio for the video output.
|
|
14922
|
+
*/
|
|
14923
|
+
aspect_ratio?: VideoResponseFormatAspectRatio | undefined;
|
|
14924
|
+
/**
|
|
14925
|
+
* The delivery mode for the video output.
|
|
14926
|
+
*/
|
|
14927
|
+
delivery?: VideoResponseFormatDelivery | undefined;
|
|
14928
|
+
/**
|
|
14929
|
+
* The duration for the video output.
|
|
14930
|
+
*/
|
|
14931
|
+
duration?: string | undefined;
|
|
14932
|
+
/**
|
|
14933
|
+
* The GCS URI to store the video output. Required for Vertex if delivery mode
|
|
14934
|
+
*
|
|
14935
|
+
* @remarks
|
|
14936
|
+
* is URI.
|
|
14937
|
+
*/
|
|
14938
|
+
gcs_uri?: string | undefined;
|
|
14939
|
+
type: "video";
|
|
14940
|
+
};
|
|
14941
|
+
|
|
14942
|
+
/**
|
|
14943
|
+
* @license
|
|
14944
|
+
* Copyright 2026 Google LLC
|
|
14945
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
14946
|
+
*
|
|
14947
|
+
* g3-prettier-ignore-file
|
|
14948
|
+
*/
|
|
14949
|
+
/**
|
|
14950
|
+
* The aspect ratio for the video output.
|
|
14951
|
+
*/
|
|
14952
|
+
declare type VideoResponseFormatAspectRatio = "16:9" | "9:16" | (string & {});
|
|
14953
|
+
|
|
14954
|
+
/**
|
|
14955
|
+
* The delivery mode for the video output.
|
|
14956
|
+
*/
|
|
14957
|
+
declare type VideoResponseFormatDelivery = "inline" | "uri" | (string & {});
|
|
14958
|
+
|
|
14383
14959
|
/**
|
|
14384
14960
|
* Whether to include visualizations in the response.
|
|
14385
14961
|
*/
|
|
@@ -14424,20 +15000,43 @@ export declare interface VoiceConfig {
|
|
|
14424
15000
|
prebuiltVoiceConfig?: PrebuiltVoiceConfig;
|
|
14425
15001
|
}
|
|
14426
15002
|
|
|
15003
|
+
/** The signature of the voice consent check. */
|
|
15004
|
+
export declare interface VoiceConsentSignature {
|
|
15005
|
+
/** The signature string.
|
|
15006
|
+
*/
|
|
15007
|
+
signature?: string;
|
|
15008
|
+
}
|
|
15009
|
+
|
|
14427
15010
|
declare type Webhook$ = Webhook;
|
|
14428
15011
|
|
|
14429
15012
|
/**
|
|
14430
15013
|
* A Webhook resource.
|
|
14431
15014
|
*/
|
|
14432
15015
|
declare type Webhook = {
|
|
15016
|
+
/**
|
|
15017
|
+
* Output only. The timestamp when the webhook was created.
|
|
15018
|
+
*/
|
|
15019
|
+
create_time?: string | undefined;
|
|
15020
|
+
/**
|
|
15021
|
+
* Output only. The ID of the webhook.
|
|
15022
|
+
*/
|
|
15023
|
+
id?: string | undefined;
|
|
14433
15024
|
/**
|
|
14434
15025
|
* Optional. The user-provided name of the webhook.
|
|
14435
15026
|
*/
|
|
14436
15027
|
name?: string | undefined;
|
|
14437
15028
|
/**
|
|
14438
|
-
*
|
|
15029
|
+
* Output only. The new signing secret for the webhook. Only populated on create.
|
|
14439
15030
|
*/
|
|
14440
|
-
|
|
15031
|
+
new_signing_secret?: string | undefined;
|
|
15032
|
+
/**
|
|
15033
|
+
* Output only. The signing secrets associated with this webhook.
|
|
15034
|
+
*/
|
|
15035
|
+
signing_secrets?: Array<SigningSecret> | undefined;
|
|
15036
|
+
/**
|
|
15037
|
+
* Output only. The state of the webhook.
|
|
15038
|
+
*/
|
|
15039
|
+
state?: WebhookState | undefined;
|
|
14441
15040
|
/**
|
|
14442
15041
|
* Required. The events that the webhook is subscribed to.
|
|
14443
15042
|
*
|
|
@@ -14452,30 +15051,14 @@ declare type Webhook = {
|
|
|
14452
15051
|
* - video.generated
|
|
14453
15052
|
*/
|
|
14454
15053
|
subscribed_events: Array<WebhookSubscribedEvent>;
|
|
14455
|
-
/**
|
|
14456
|
-
* Output only. The timestamp when the webhook was created.
|
|
14457
|
-
*/
|
|
14458
|
-
create_time?: string | undefined;
|
|
14459
15054
|
/**
|
|
14460
15055
|
* Output only. The timestamp when the webhook was last updated.
|
|
14461
15056
|
*/
|
|
14462
15057
|
update_time?: string | undefined;
|
|
14463
15058
|
/**
|
|
14464
|
-
*
|
|
14465
|
-
*/
|
|
14466
|
-
signing_secrets?: Array<SigningSecret> | undefined;
|
|
14467
|
-
/**
|
|
14468
|
-
* Output only. The state of the webhook.
|
|
14469
|
-
*/
|
|
14470
|
-
state?: WebhookState | undefined;
|
|
14471
|
-
/**
|
|
14472
|
-
* Output only. The new signing secret for the webhook. Only populated on create.
|
|
14473
|
-
*/
|
|
14474
|
-
new_signing_secret?: string | undefined;
|
|
14475
|
-
/**
|
|
14476
|
-
* Output only. The ID of the webhook.
|
|
15059
|
+
* Required. The URI to which webhook events will be sent.
|
|
14477
15060
|
*/
|
|
14478
|
-
|
|
15061
|
+
uri: string;
|
|
14479
15062
|
};
|
|
14480
15063
|
|
|
14481
15064
|
declare type WebhookConfig$ = WebhookConfig_2;
|
|
@@ -14541,10 +15124,6 @@ declare type WebhookInput = {
|
|
|
14541
15124
|
* Optional. The user-provided name of the webhook.
|
|
14542
15125
|
*/
|
|
14543
15126
|
name?: string | undefined;
|
|
14544
|
-
/**
|
|
14545
|
-
* Required. The URI to which webhook events will be sent.
|
|
14546
|
-
*/
|
|
14547
|
-
uri: string;
|
|
14548
15127
|
/**
|
|
14549
15128
|
* Required. The events that the webhook is subscribed to.
|
|
14550
15129
|
*
|
|
@@ -14559,6 +15138,10 @@ declare type WebhookInput = {
|
|
|
14559
15138
|
* - video.generated
|
|
14560
15139
|
*/
|
|
14561
15140
|
subscribed_events: Array<WebhookSubscribedEvent>;
|
|
15141
|
+
/**
|
|
15142
|
+
* Required. The URI to which webhook events will be sent.
|
|
15143
|
+
*/
|
|
15144
|
+
uri: string;
|
|
14562
15145
|
};
|
|
14563
15146
|
|
|
14564
15147
|
declare type WebhookListParams$ = ListWebhooksParams;
|
|
@@ -14575,10 +15158,6 @@ declare type WebhookListResponse$ = WebhookListResponse;
|
|
|
14575
15158
|
* Response message for WebhookService.ListWebhooks.
|
|
14576
15159
|
*/
|
|
14577
15160
|
declare type WebhookListResponse = {
|
|
14578
|
-
/**
|
|
14579
|
-
* The webhooks.
|
|
14580
|
-
*/
|
|
14581
|
-
webhooks?: Array<Webhook> | undefined;
|
|
14582
15161
|
/**
|
|
14583
15162
|
* A token, which can be sent as `page_token` to retrieve the next page.
|
|
14584
15163
|
*
|
|
@@ -14586,6 +15165,10 @@ declare type WebhookListResponse = {
|
|
|
14586
15165
|
* If this field is omitted, there are no subsequent pages.
|
|
14587
15166
|
*/
|
|
14588
15167
|
next_page_token?: string | undefined;
|
|
15168
|
+
/**
|
|
15169
|
+
* The webhooks.
|
|
15170
|
+
*/
|
|
15171
|
+
webhooks?: Array<Webhook> | undefined;
|
|
14589
15172
|
};
|
|
14590
15173
|
|
|
14591
15174
|
declare type WebhookPingParams$ = PingWebhookRequest;
|
|
@@ -14663,11 +15246,11 @@ declare namespace webhooks {
|
|
|
14663
15246
|
WebhookListResponse,
|
|
14664
15247
|
WebhookPingResponse,
|
|
14665
15248
|
WebhookRotateSigningSecretResponse,
|
|
14666
|
-
WebhookUpdateSubscribedEvent,
|
|
14667
15249
|
WebhookUpdateState,
|
|
15250
|
+
WebhookUpdateSubscribedEvent,
|
|
14668
15251
|
WebhookUpdate,
|
|
14669
|
-
WebhookSubscribedEvent,
|
|
14670
15252
|
WebhookState,
|
|
15253
|
+
WebhookSubscribedEvent,
|
|
14671
15254
|
Webhook,
|
|
14672
15255
|
WebhookInput
|
|
14673
15256
|
}
|
|
@@ -14688,9 +15271,9 @@ declare type WebhookUpdate = {
|
|
|
14688
15271
|
*/
|
|
14689
15272
|
name?: string | undefined;
|
|
14690
15273
|
/**
|
|
14691
|
-
* Optional. The
|
|
15274
|
+
* Optional. The state of the webhook.
|
|
14692
15275
|
*/
|
|
14693
|
-
|
|
15276
|
+
state?: WebhookUpdateState | undefined;
|
|
14694
15277
|
/**
|
|
14695
15278
|
* Optional. The events that the webhook is subscribed to.
|
|
14696
15279
|
*
|
|
@@ -14706,9 +15289,9 @@ declare type WebhookUpdate = {
|
|
|
14706
15289
|
*/
|
|
14707
15290
|
subscribed_events?: Array<WebhookUpdateSubscribedEvent> | undefined;
|
|
14708
15291
|
/**
|
|
14709
|
-
* Optional. The
|
|
15292
|
+
* Optional. The URI to which webhook events will be sent.
|
|
14710
15293
|
*/
|
|
14711
|
-
|
|
15294
|
+
uri?: string | undefined;
|
|
14712
15295
|
};
|
|
14713
15296
|
|
|
14714
15297
|
declare type WebhookUpdateParams$ = WebhookUpdate;
|
|
@@ -14718,11 +15301,6 @@ declare type WebhookUpdateParams = {
|
|
|
14718
15301
|
update_mask?: string;
|
|
14719
15302
|
} & webhooks.WebhookUpdate;
|
|
14720
15303
|
|
|
14721
|
-
/**
|
|
14722
|
-
* Optional. The state of the webhook.
|
|
14723
|
-
*/
|
|
14724
|
-
declare type WebhookUpdateState = "enabled" | "disabled" | "disabled_due_to_failed_deliveries";
|
|
14725
|
-
|
|
14726
15304
|
/**
|
|
14727
15305
|
* @license
|
|
14728
15306
|
* Copyright 2026 Google LLC
|
|
@@ -14730,6 +15308,11 @@ declare type WebhookUpdateState = "enabled" | "disabled" | "disabled_due_to_fail
|
|
|
14730
15308
|
*
|
|
14731
15309
|
* g3-prettier-ignore-file
|
|
14732
15310
|
*/
|
|
15311
|
+
/**
|
|
15312
|
+
* Optional. The state of the webhook.
|
|
15313
|
+
*/
|
|
15314
|
+
declare type WebhookUpdateState = "enabled" | "disabled" | "disabled_due_to_failed_deliveries";
|
|
15315
|
+
|
|
14733
15316
|
declare type WebhookUpdateSubscribedEvent = "batch.succeeded" | "batch.expired" | "batch.failed" | "interaction.requires_action" | "interaction.completed" | "interaction.failed" | "video.generated" | (string & {});
|
|
14734
15317
|
|
|
14735
15318
|
/** Standard web search for grounding and related configurations. Only text results are returned. */
|