@google/genai 2.10.0 → 2.12.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 +1623 -595
- package/dist/index.cjs +1296 -179
- package/dist/index.mjs +1292 -180
- package/dist/index.mjs.map +1 -1
- package/dist/node/index.cjs +1347 -230
- package/dist/node/index.mjs +1343 -231
- package/dist/node/index.mjs.map +1 -1
- package/dist/node/node.d.ts +1623 -595
- package/dist/tokenizer/node.cjs +157 -53
- package/dist/tokenizer/node.d.ts +204 -4
- package/dist/tokenizer/node.mjs +157 -53
- package/dist/tokenizer/node.mjs.map +1 -1
- package/dist/vertex_internal/index.cjs +158 -54
- package/dist/vertex_internal/index.cjs.map +1 -1
- package/dist/vertex_internal/index.d.ts +308 -67
- package/dist/vertex_internal/index.js +158 -54
- package/dist/vertex_internal/index.js.map +1 -1
- package/dist/web/index.mjs +1343 -231
- package/dist/web/index.mjs.map +1 -1
- package/dist/web/web.d.ts +1623 -595
- package/package.json +2 -9
package/dist/web/web.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
|
};
|
|
@@ -293,6 +286,30 @@ declare type Annotation$ = Annotation;
|
|
|
293
286
|
*/
|
|
294
287
|
declare type Annotation = URLCitation | FileCitation | PlaceCitation;
|
|
295
288
|
|
|
289
|
+
declare type AntigravityAgentConfig$ = AntigravityAgentConfig;
|
|
290
|
+
|
|
291
|
+
/**
|
|
292
|
+
* @license
|
|
293
|
+
* Copyright 2026 Google LLC
|
|
294
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
295
|
+
*
|
|
296
|
+
* g3-prettier-ignore-file
|
|
297
|
+
*/
|
|
298
|
+
/**
|
|
299
|
+
* Configuration for the Antigravity agent runtime.
|
|
300
|
+
*
|
|
301
|
+
* @remarks
|
|
302
|
+
* Provides server-side control over the agent's execution environment
|
|
303
|
+
* and tool configuration.
|
|
304
|
+
*/
|
|
305
|
+
declare type AntigravityAgentConfig = {
|
|
306
|
+
/**
|
|
307
|
+
* Max total tokens for the agent run.
|
|
308
|
+
*/
|
|
309
|
+
max_total_tokens?: string | undefined;
|
|
310
|
+
type: "antigravity";
|
|
311
|
+
};
|
|
312
|
+
|
|
296
313
|
/** The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. This data type is not supported in Gemini API. */
|
|
297
314
|
export declare interface ApiAuth {
|
|
298
315
|
/** The API secret. */
|
|
@@ -496,24 +513,9 @@ declare type Arguments$2 = GoogleMapsCallArguments;
|
|
|
496
513
|
|
|
497
514
|
declare type Arguments$3 = GoogleSearchCallArguments;
|
|
498
515
|
|
|
499
|
-
declare type Arguments$4 =
|
|
516
|
+
declare type Arguments$4 = RetrievalCallArguments;
|
|
500
517
|
|
|
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
|
-
};
|
|
518
|
+
declare type Arguments$5 = URLContextCallArguments;
|
|
517
519
|
|
|
518
520
|
declare type ArgumentsDelta$ = ArgumentsDelta;
|
|
519
521
|
|
|
@@ -525,10 +527,74 @@ declare type ArgumentsDelta$ = ArgumentsDelta;
|
|
|
525
527
|
* g3-prettier-ignore-file
|
|
526
528
|
*/
|
|
527
529
|
declare type ArgumentsDelta = {
|
|
528
|
-
type: "arguments_delta";
|
|
529
530
|
arguments?: string | undefined;
|
|
531
|
+
type: "arguments_delta";
|
|
530
532
|
};
|
|
531
533
|
|
|
534
|
+
/** The aspect ratio for the image output. */
|
|
535
|
+
export declare enum AspectRatio {
|
|
536
|
+
/**
|
|
537
|
+
* Default value. This value is unused.
|
|
538
|
+
*/
|
|
539
|
+
ASPECT_RATIO_UNSPECIFIED = "ASPECT_RATIO_UNSPECIFIED",
|
|
540
|
+
/**
|
|
541
|
+
* 1:1 aspect ratio.
|
|
542
|
+
*/
|
|
543
|
+
ASPECT_RATIO_ONE_BY_ONE = "ASPECT_RATIO_ONE_BY_ONE",
|
|
544
|
+
/**
|
|
545
|
+
* 2:3 aspect ratio.
|
|
546
|
+
*/
|
|
547
|
+
ASPECT_RATIO_TWO_BY_THREE = "ASPECT_RATIO_TWO_BY_THREE",
|
|
548
|
+
/**
|
|
549
|
+
* 3:2 aspect ratio.
|
|
550
|
+
*/
|
|
551
|
+
ASPECT_RATIO_THREE_BY_TWO = "ASPECT_RATIO_THREE_BY_TWO",
|
|
552
|
+
/**
|
|
553
|
+
* 3:4 aspect ratio.
|
|
554
|
+
*/
|
|
555
|
+
ASPECT_RATIO_THREE_BY_FOUR = "ASPECT_RATIO_THREE_BY_FOUR",
|
|
556
|
+
/**
|
|
557
|
+
* 4:3 aspect ratio.
|
|
558
|
+
*/
|
|
559
|
+
ASPECT_RATIO_FOUR_BY_THREE = "ASPECT_RATIO_FOUR_BY_THREE",
|
|
560
|
+
/**
|
|
561
|
+
* 4:5 aspect ratio.
|
|
562
|
+
*/
|
|
563
|
+
ASPECT_RATIO_FOUR_BY_FIVE = "ASPECT_RATIO_FOUR_BY_FIVE",
|
|
564
|
+
/**
|
|
565
|
+
* 5:4 aspect ratio.
|
|
566
|
+
*/
|
|
567
|
+
ASPECT_RATIO_FIVE_BY_FOUR = "ASPECT_RATIO_FIVE_BY_FOUR",
|
|
568
|
+
/**
|
|
569
|
+
* 9:16 aspect ratio.
|
|
570
|
+
*/
|
|
571
|
+
ASPECT_RATIO_NINE_BY_SIXTEEN = "ASPECT_RATIO_NINE_BY_SIXTEEN",
|
|
572
|
+
/**
|
|
573
|
+
* 16:9 aspect ratio.
|
|
574
|
+
*/
|
|
575
|
+
ASPECT_RATIO_SIXTEEN_BY_NINE = "ASPECT_RATIO_SIXTEEN_BY_NINE",
|
|
576
|
+
/**
|
|
577
|
+
* 21:9 aspect ratio.
|
|
578
|
+
*/
|
|
579
|
+
ASPECT_RATIO_TWENTY_ONE_BY_NINE = "ASPECT_RATIO_TWENTY_ONE_BY_NINE",
|
|
580
|
+
/**
|
|
581
|
+
* 1:8 aspect ratio.
|
|
582
|
+
*/
|
|
583
|
+
ASPECT_RATIO_ONE_BY_EIGHT = "ASPECT_RATIO_ONE_BY_EIGHT",
|
|
584
|
+
/**
|
|
585
|
+
* 8:1 aspect ratio.
|
|
586
|
+
*/
|
|
587
|
+
ASPECT_RATIO_EIGHT_BY_ONE = "ASPECT_RATIO_EIGHT_BY_ONE",
|
|
588
|
+
/**
|
|
589
|
+
* 1:4 aspect ratio.
|
|
590
|
+
*/
|
|
591
|
+
ASPECT_RATIO_ONE_BY_FOUR = "ASPECT_RATIO_ONE_BY_FOUR",
|
|
592
|
+
/**
|
|
593
|
+
* 4:1 aspect ratio.
|
|
594
|
+
*/
|
|
595
|
+
ASPECT_RATIO_FOUR_BY_ONE = "ASPECT_RATIO_FOUR_BY_ONE"
|
|
596
|
+
}
|
|
597
|
+
|
|
532
598
|
declare type Audio$ = AudioDelta;
|
|
533
599
|
|
|
534
600
|
/** Representation of an audio chunk. */
|
|
@@ -548,27 +614,27 @@ declare type AudioContent$ = AudioContent;
|
|
|
548
614
|
* An audio content block.
|
|
549
615
|
*/
|
|
550
616
|
declare type AudioContent = {
|
|
551
|
-
type: "audio";
|
|
552
617
|
/**
|
|
553
|
-
* The audio
|
|
618
|
+
* The number of audio channels.
|
|
554
619
|
*/
|
|
555
|
-
|
|
620
|
+
channels?: number | undefined;
|
|
556
621
|
/**
|
|
557
|
-
* The
|
|
622
|
+
* The audio content.
|
|
558
623
|
*/
|
|
559
|
-
|
|
624
|
+
data?: string | undefined;
|
|
560
625
|
/**
|
|
561
626
|
* The mime type of the audio.
|
|
562
627
|
*/
|
|
563
628
|
mime_type?: AudioContentMimeType | undefined;
|
|
564
|
-
/**
|
|
565
|
-
* The number of audio channels.
|
|
566
|
-
*/
|
|
567
|
-
channels?: number | undefined;
|
|
568
629
|
/**
|
|
569
630
|
* The sample rate of the audio.
|
|
570
631
|
*/
|
|
571
632
|
sample_rate?: number | undefined;
|
|
633
|
+
type: "audio";
|
|
634
|
+
/**
|
|
635
|
+
* The URI of the audio.
|
|
636
|
+
*/
|
|
637
|
+
uri?: string | undefined;
|
|
572
638
|
};
|
|
573
639
|
|
|
574
640
|
/**
|
|
@@ -584,9 +650,11 @@ declare type AudioContent = {
|
|
|
584
650
|
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
651
|
|
|
586
652
|
declare type AudioDelta = {
|
|
587
|
-
|
|
653
|
+
/**
|
|
654
|
+
* The number of audio channels.
|
|
655
|
+
*/
|
|
656
|
+
channels?: number | undefined;
|
|
588
657
|
data?: string | undefined;
|
|
589
|
-
uri?: string | undefined;
|
|
590
658
|
mime_type?: AudioDeltaMimeType | undefined;
|
|
591
659
|
/**
|
|
592
660
|
* Deprecated. Use sample_rate instead. The value is ignored.
|
|
@@ -598,10 +666,8 @@ declare type AudioDelta = {
|
|
|
598
666
|
* The sample rate of the audio.
|
|
599
667
|
*/
|
|
600
668
|
sample_rate?: number | undefined;
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
*/
|
|
604
|
-
channels?: number | undefined;
|
|
669
|
+
type: "audio";
|
|
670
|
+
uri?: string | undefined;
|
|
605
671
|
};
|
|
606
672
|
|
|
607
673
|
/**
|
|
@@ -613,39 +679,46 @@ declare type AudioDelta = {
|
|
|
613
679
|
*/
|
|
614
680
|
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
681
|
|
|
616
|
-
declare type AudioResponseFormat$ =
|
|
682
|
+
declare type AudioResponseFormat$ = AudioResponseFormat_2;
|
|
683
|
+
|
|
684
|
+
/** Configuration for audio-specific output formatting. */
|
|
685
|
+
export declare class AudioResponseFormat {
|
|
686
|
+
/** Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). */
|
|
687
|
+
bitRate?: number;
|
|
688
|
+
/** Optional. Delivery mode for the generated content. */
|
|
689
|
+
delivery?: Delivery;
|
|
690
|
+
/** Optional. The MIME type of the audio output. */
|
|
691
|
+
mimeType?: string;
|
|
692
|
+
/** Optional. Sample rate for the generated audio in Hertz. */
|
|
693
|
+
sampleRate?: number;
|
|
694
|
+
}
|
|
617
695
|
|
|
618
696
|
/**
|
|
619
697
|
* Configuration for audio output format.
|
|
620
698
|
*/
|
|
621
|
-
declare type
|
|
622
|
-
type: "audio";
|
|
699
|
+
declare type AudioResponseFormat_2 = {
|
|
623
700
|
/**
|
|
624
|
-
*
|
|
701
|
+
* Bit rate in bits per second (bps). Only applicable for compressed formats
|
|
702
|
+
*
|
|
703
|
+
* @remarks
|
|
704
|
+
* (MP3, Opus).
|
|
625
705
|
*/
|
|
626
|
-
|
|
706
|
+
bit_rate?: number | undefined;
|
|
627
707
|
/**
|
|
628
708
|
* The delivery mode for the audio output.
|
|
629
709
|
*/
|
|
630
710
|
delivery?: AudioResponseFormatDelivery | undefined;
|
|
631
711
|
/**
|
|
632
|
-
*
|
|
712
|
+
* The MIME type of the audio output.
|
|
633
713
|
*/
|
|
634
|
-
|
|
714
|
+
mime_type?: AudioResponseFormatMimeType | undefined;
|
|
635
715
|
/**
|
|
636
|
-
*
|
|
637
|
-
*
|
|
638
|
-
* @remarks
|
|
639
|
-
* (MP3, Opus).
|
|
716
|
+
* Sample rate in Hz.
|
|
640
717
|
*/
|
|
641
|
-
|
|
718
|
+
sample_rate?: number | undefined;
|
|
719
|
+
type: "audio";
|
|
642
720
|
};
|
|
643
721
|
|
|
644
|
-
/**
|
|
645
|
-
* The delivery mode for the audio output.
|
|
646
|
-
*/
|
|
647
|
-
declare type AudioResponseFormatDelivery = "inline" | "uri" | (string & {});
|
|
648
|
-
|
|
649
722
|
/**
|
|
650
723
|
* @license
|
|
651
724
|
* Copyright 2026 Google LLC
|
|
@@ -653,6 +726,11 @@ declare type AudioResponseFormatDelivery = "inline" | "uri" | (string & {});
|
|
|
653
726
|
*
|
|
654
727
|
* g3-prettier-ignore-file
|
|
655
728
|
*/
|
|
729
|
+
/**
|
|
730
|
+
* The delivery mode for the audio output.
|
|
731
|
+
*/
|
|
732
|
+
declare type AudioResponseFormatDelivery = "inline" | "uri" | (string & {});
|
|
733
|
+
|
|
656
734
|
/**
|
|
657
735
|
* The MIME type of the audio output.
|
|
658
736
|
*/
|
|
@@ -1103,7 +1181,7 @@ export declare interface BatchJobSource {
|
|
|
1103
1181
|
|
|
1104
1182
|
export declare type BatchJobSourceUnion = BatchJobSource | InlinedRequest[] | string;
|
|
1105
1183
|
|
|
1106
|
-
/** Specifies the function Behavior.
|
|
1184
|
+
/** 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
1185
|
export declare enum Behavior {
|
|
1108
1186
|
/**
|
|
1109
1187
|
* This value is unspecified.
|
|
@@ -1618,18 +1696,17 @@ declare type CodeExecutionCallArguments$ = CodeExecutionCallArguments;
|
|
|
1618
1696
|
* The arguments to pass to the code execution.
|
|
1619
1697
|
*/
|
|
1620
1698
|
declare type CodeExecutionCallArguments = {
|
|
1621
|
-
/**
|
|
1622
|
-
* Programming language of the `code`.
|
|
1623
|
-
*/
|
|
1624
|
-
language?: Language_2 | undefined;
|
|
1625
1699
|
/**
|
|
1626
1700
|
* The code to be executed.
|
|
1627
1701
|
*/
|
|
1628
1702
|
code?: string | undefined;
|
|
1703
|
+
/**
|
|
1704
|
+
* Programming language of the `code`.
|
|
1705
|
+
*/
|
|
1706
|
+
language?: Language_2 | undefined;
|
|
1629
1707
|
};
|
|
1630
1708
|
|
|
1631
1709
|
declare type CodeExecutionCallDelta = {
|
|
1632
|
-
type: "code_execution_call";
|
|
1633
1710
|
/**
|
|
1634
1711
|
* The arguments to pass to the code execution.
|
|
1635
1712
|
*/
|
|
@@ -1638,6 +1715,7 @@ declare type CodeExecutionCallDelta = {
|
|
|
1638
1715
|
* A signature hash for backend validation.
|
|
1639
1716
|
*/
|
|
1640
1717
|
signature?: string | undefined;
|
|
1718
|
+
type: "code_execution_call";
|
|
1641
1719
|
};
|
|
1642
1720
|
|
|
1643
1721
|
declare type CodeExecutionCallStep$ = CodeExecutionCallStep;
|
|
@@ -1646,7 +1724,6 @@ declare type CodeExecutionCallStep$ = CodeExecutionCallStep;
|
|
|
1646
1724
|
* Code execution call step.
|
|
1647
1725
|
*/
|
|
1648
1726
|
declare type CodeExecutionCallStep = {
|
|
1649
|
-
type: "code_execution_call";
|
|
1650
1727
|
/**
|
|
1651
1728
|
* The arguments to pass to the code execution.
|
|
1652
1729
|
*/
|
|
@@ -1659,6 +1736,7 @@ declare type CodeExecutionCallStep = {
|
|
|
1659
1736
|
* A signature hash for backend validation.
|
|
1660
1737
|
*/
|
|
1661
1738
|
signature?: string | undefined;
|
|
1739
|
+
type: "code_execution_call";
|
|
1662
1740
|
};
|
|
1663
1741
|
|
|
1664
1742
|
declare type CodeExecutionResult$ = CodeExecutionResultDelta;
|
|
@@ -1681,13 +1759,13 @@ export declare interface CodeExecutionResult {
|
|
|
1681
1759
|
* g3-prettier-ignore-file
|
|
1682
1760
|
*/
|
|
1683
1761
|
declare type CodeExecutionResultDelta = {
|
|
1684
|
-
type: "code_execution_result";
|
|
1685
|
-
result: string;
|
|
1686
1762
|
is_error?: boolean | undefined;
|
|
1763
|
+
result: string;
|
|
1687
1764
|
/**
|
|
1688
1765
|
* A signature hash for backend validation.
|
|
1689
1766
|
*/
|
|
1690
1767
|
signature?: string | undefined;
|
|
1768
|
+
type: "code_execution_result";
|
|
1691
1769
|
};
|
|
1692
1770
|
|
|
1693
1771
|
declare type CodeExecutionResultStep$ = CodeExecutionResultStep;
|
|
@@ -1703,23 +1781,64 @@ declare type CodeExecutionResultStep$ = CodeExecutionResultStep;
|
|
|
1703
1781
|
* Code execution result step.
|
|
1704
1782
|
*/
|
|
1705
1783
|
declare type CodeExecutionResultStep = {
|
|
1706
|
-
type: "code_execution_result";
|
|
1707
1784
|
/**
|
|
1708
|
-
* Required.
|
|
1785
|
+
* Required. ID to match the ID from the function call block.
|
|
1709
1786
|
*/
|
|
1710
|
-
|
|
1787
|
+
call_id: string;
|
|
1711
1788
|
/**
|
|
1712
1789
|
* Whether the code execution resulted in an error.
|
|
1713
1790
|
*/
|
|
1714
1791
|
is_error?: boolean | undefined;
|
|
1715
1792
|
/**
|
|
1716
|
-
* Required.
|
|
1793
|
+
* Required. The output of the code execution.
|
|
1717
1794
|
*/
|
|
1718
|
-
|
|
1795
|
+
result: string;
|
|
1719
1796
|
/**
|
|
1720
1797
|
* A signature hash for backend validation.
|
|
1721
1798
|
*/
|
|
1722
1799
|
signature?: string | undefined;
|
|
1800
|
+
type: "code_execution_result";
|
|
1801
|
+
};
|
|
1802
|
+
|
|
1803
|
+
declare type CodeMenderAgentConfig$ = CodeMenderAgentConfig;
|
|
1804
|
+
|
|
1805
|
+
/**
|
|
1806
|
+
* Configuration for the CodeMender agent.
|
|
1807
|
+
*/
|
|
1808
|
+
declare type CodeMenderAgentConfig = {
|
|
1809
|
+
/**
|
|
1810
|
+
* Request parameters specific to FIND sessions, used for discovering
|
|
1811
|
+
*
|
|
1812
|
+
* @remarks
|
|
1813
|
+
* vulnerabilities in a codebase.
|
|
1814
|
+
*/
|
|
1815
|
+
find_request?: FindRequest | undefined;
|
|
1816
|
+
/**
|
|
1817
|
+
* Request parameters specific to FIX sessions, used for generating and
|
|
1818
|
+
*
|
|
1819
|
+
* @remarks
|
|
1820
|
+
* validating security patches.
|
|
1821
|
+
*/
|
|
1822
|
+
fix_request?: FixRequest | undefined;
|
|
1823
|
+
/**
|
|
1824
|
+
* The name of the model to use for the CodeMender agent. One
|
|
1825
|
+
*
|
|
1826
|
+
* @remarks
|
|
1827
|
+
* CodeMender session will only use one model.
|
|
1828
|
+
*/
|
|
1829
|
+
model?: string | undefined;
|
|
1830
|
+
/**
|
|
1831
|
+
* The configuration of CodeMender sessions.
|
|
1832
|
+
*/
|
|
1833
|
+
session_config?: SessionConfig | undefined;
|
|
1834
|
+
/**
|
|
1835
|
+
* Parameter for grouping multiple interactions that belong to
|
|
1836
|
+
*
|
|
1837
|
+
* @remarks
|
|
1838
|
+
* the same CodeMender session.
|
|
1839
|
+
*/
|
|
1840
|
+
session_id?: string | undefined;
|
|
1841
|
+
type: "code-mender";
|
|
1723
1842
|
};
|
|
1724
1843
|
|
|
1725
1844
|
/** 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 +1855,15 @@ export declare interface CompletionStats {
|
|
|
1736
1855
|
|
|
1737
1856
|
/** Composite reinforcement tuning reward config. */
|
|
1738
1857
|
export declare interface CompositeReinforcementTuningRewardConfig {
|
|
1858
|
+
/** List of reward function configurations with weights. */
|
|
1739
1859
|
weightedRewardConfigs?: CompositeReinforcementTuningRewardConfigWeightedRewardConfig[];
|
|
1740
1860
|
}
|
|
1741
1861
|
|
|
1742
1862
|
/** Composite reinforcement tuning reward config weighted reward config. */
|
|
1743
1863
|
export declare interface CompositeReinforcementTuningRewardConfigWeightedRewardConfig {
|
|
1864
|
+
/** Single reward configuration. */
|
|
1744
1865
|
rewardConfig?: SingleReinforcementTuningRewardConfig;
|
|
1745
|
-
/** How much this single reward contributes to the total overall reward. */
|
|
1866
|
+
/** 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
1867
|
weight?: number;
|
|
1747
1868
|
}
|
|
1748
1869
|
|
|
@@ -1764,15 +1885,10 @@ export declare interface ComputerUse {
|
|
|
1764
1885
|
* A tool that can be used by the model to interact with the computer.
|
|
1765
1886
|
*/
|
|
1766
1887
|
declare type ComputerUse_2 = {
|
|
1767
|
-
type: "computer_use";
|
|
1768
|
-
/**
|
|
1769
|
-
* The environment being operated.
|
|
1770
|
-
*/
|
|
1771
|
-
environment?: EnvironmentEnum | undefined;
|
|
1772
1888
|
/**
|
|
1773
|
-
*
|
|
1889
|
+
* Optional. Disabled safety policies for computer use.
|
|
1774
1890
|
*/
|
|
1775
|
-
|
|
1891
|
+
disabled_safety_policies?: Array<DisabledSafetyPolicy> | undefined;
|
|
1776
1892
|
/**
|
|
1777
1893
|
* Whether enable the prompt injection detection check on computer-use
|
|
1778
1894
|
*
|
|
@@ -1781,9 +1897,14 @@ declare type ComputerUse_2 = {
|
|
|
1781
1897
|
*/
|
|
1782
1898
|
enable_prompt_injection_detection?: boolean | undefined;
|
|
1783
1899
|
/**
|
|
1784
|
-
*
|
|
1900
|
+
* The environment being operated.
|
|
1785
1901
|
*/
|
|
1786
|
-
|
|
1902
|
+
environment?: EnvironmentEnum | undefined;
|
|
1903
|
+
/**
|
|
1904
|
+
* The list of predefined functions that are excluded from the model call.
|
|
1905
|
+
*/
|
|
1906
|
+
excluded_predefined_functions?: Array<string> | undefined;
|
|
1907
|
+
type: "computer_use";
|
|
1787
1908
|
};
|
|
1788
1909
|
|
|
1789
1910
|
/** Optional parameters for computing tokens. */
|
|
@@ -1861,6 +1982,9 @@ export declare interface ContentEmbeddingStatistics {
|
|
|
1861
1982
|
/** Gemini Enterprise Agent Platform only. Number of tokens of the input text.
|
|
1862
1983
|
*/
|
|
1863
1984
|
tokenCount?: number;
|
|
1985
|
+
/** Gemini Enterprise Agent Platform only. List of modalities and their token count for the input content.
|
|
1986
|
+
*/
|
|
1987
|
+
tokensDetails?: ModalityTokenCount[];
|
|
1864
1988
|
}
|
|
1865
1989
|
|
|
1866
1990
|
export declare type ContentListUnion = Content | Content[] | PartUnion | PartUnion[];
|
|
@@ -2032,7 +2156,7 @@ declare type CreateAgentInteraction = {
|
|
|
2032
2156
|
/**
|
|
2033
2157
|
* Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
|
|
2034
2158
|
*/
|
|
2035
|
-
response_format?: Array<
|
|
2159
|
+
response_format?: Array<ResponseFormat_2> | ResponseFormat_2 | undefined;
|
|
2036
2160
|
/**
|
|
2037
2161
|
* The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.
|
|
2038
2162
|
*/
|
|
@@ -2040,7 +2164,17 @@ declare type CreateAgentInteraction = {
|
|
|
2040
2164
|
/**
|
|
2041
2165
|
* Configuration parameters for the agent interaction.
|
|
2042
2166
|
*/
|
|
2043
|
-
agent_config?: DynamicAgentConfig | DeepResearchAgentConfig | undefined;
|
|
2167
|
+
agent_config?: DynamicAgentConfig | DeepResearchAgentConfig | CodeMenderAgentConfig | AntigravityAgentConfig | undefined;
|
|
2168
|
+
/**
|
|
2169
|
+
* Safety settings for the interaction.
|
|
2170
|
+
*/
|
|
2171
|
+
safety_settings?: Array<SafetySetting_2> | undefined;
|
|
2172
|
+
/**
|
|
2173
|
+
* The labels with user-defined metadata for the request.
|
|
2174
|
+
*/
|
|
2175
|
+
labels?: {
|
|
2176
|
+
[k: string]: string;
|
|
2177
|
+
} | undefined;
|
|
2044
2178
|
/**
|
|
2045
2179
|
* The input for the interaction.
|
|
2046
2180
|
*/
|
|
@@ -2050,7 +2184,7 @@ declare type CreateAgentInteraction = {
|
|
|
2050
2184
|
/**
|
|
2051
2185
|
* Configuration parameters for the agent interaction.
|
|
2052
2186
|
*/
|
|
2053
|
-
declare type CreateAgentInteractionAgentConfig = DynamicAgentConfig | DeepResearchAgentConfig;
|
|
2187
|
+
declare type CreateAgentInteractionAgentConfig = DynamicAgentConfig | DeepResearchAgentConfig | CodeMenderAgentConfig | AntigravityAgentConfig;
|
|
2054
2188
|
|
|
2055
2189
|
/**
|
|
2056
2190
|
* The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.
|
|
@@ -2074,7 +2208,7 @@ declare type CreateAgentInteractionParamsStreaming = CreateAgentInteractionParam
|
|
|
2074
2208
|
/**
|
|
2075
2209
|
* Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
|
|
2076
2210
|
*/
|
|
2077
|
-
declare type CreateAgentInteractionResponseFormat = Array<
|
|
2211
|
+
declare type CreateAgentInteractionResponseFormat = Array<ResponseFormat_2> | ResponseFormat_2;
|
|
2078
2212
|
|
|
2079
2213
|
declare type CreateAgentParams = Omit<CreateAgentRequest, "body"> & CreateAgentRequest["body"];
|
|
2080
2214
|
|
|
@@ -2418,7 +2552,7 @@ declare type CreateModelInteraction = {
|
|
|
2418
2552
|
/**
|
|
2419
2553
|
* Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
|
|
2420
2554
|
*/
|
|
2421
|
-
response_format?: Array<
|
|
2555
|
+
response_format?: Array<ResponseFormat_2> | ResponseFormat_2 | undefined;
|
|
2422
2556
|
/**
|
|
2423
2557
|
* The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.
|
|
2424
2558
|
*/
|
|
@@ -2428,15 +2562,15 @@ declare type CreateModelInteraction = {
|
|
|
2428
2562
|
*/
|
|
2429
2563
|
generation_config?: GenerationConfig_2 | undefined;
|
|
2430
2564
|
/**
|
|
2431
|
-
*
|
|
2432
|
-
|
|
2433
|
-
|
|
2434
|
-
|
|
2435
|
-
*
|
|
2436
|
-
* Format:
|
|
2437
|
-
* `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
|
|
2565
|
+
* Safety settings for the interaction.
|
|
2566
|
+
*/
|
|
2567
|
+
safety_settings?: Array<SafetySetting_2> | undefined;
|
|
2568
|
+
/**
|
|
2569
|
+
* The labels with user-defined metadata for the request.
|
|
2438
2570
|
*/
|
|
2439
|
-
|
|
2571
|
+
labels?: {
|
|
2572
|
+
[k: string]: string;
|
|
2573
|
+
} | undefined;
|
|
2440
2574
|
/**
|
|
2441
2575
|
* The input for the interaction.
|
|
2442
2576
|
*/
|
|
@@ -2465,7 +2599,7 @@ declare type CreateModelInteractionParamsStreaming = CreateModelInteractionParam
|
|
|
2465
2599
|
/**
|
|
2466
2600
|
* Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
|
|
2467
2601
|
*/
|
|
2468
|
-
declare type CreateModelInteractionResponseFormat = Array<
|
|
2602
|
+
declare type CreateModelInteractionResponseFormat = Array<ResponseFormat_2> | ResponseFormat_2;
|
|
2469
2603
|
|
|
2470
2604
|
/**
|
|
2471
2605
|
* Creates a `Part` object from a `base64` encoded `string`.
|
|
@@ -2502,6 +2636,16 @@ export declare function createPartFromText(text: string): Part;
|
|
|
2502
2636
|
*/
|
|
2503
2637
|
export declare function createPartFromUri(uri: string, mimeType: string, mediaResolution?: PartMediaResolutionLevel): Part;
|
|
2504
2638
|
|
|
2639
|
+
declare type CreateTriggerParams = Omit<CreateTriggerRequest, "body"> & CreateTriggerRequest["body"];
|
|
2640
|
+
|
|
2641
|
+
declare type CreateTriggerRequest = {
|
|
2642
|
+
/**
|
|
2643
|
+
* Which version of the API to use.
|
|
2644
|
+
*/
|
|
2645
|
+
api_version?: string | undefined;
|
|
2646
|
+
body: triggers.TriggerCreateParams;
|
|
2647
|
+
};
|
|
2648
|
+
|
|
2505
2649
|
/** Fine-tuning job creation request - optional fields. */
|
|
2506
2650
|
export declare interface CreateTuningJobConfig {
|
|
2507
2651
|
/** Used to override HTTP request options. */
|
|
@@ -2697,6 +2841,12 @@ export declare interface DatasetStats {
|
|
|
2697
2841
|
userMessagePerExampleDistribution?: DatasetDistribution;
|
|
2698
2842
|
/** Output only. Dataset distributions for the user output tokens. */
|
|
2699
2843
|
userOutputTokenDistribution?: DatasetDistribution;
|
|
2844
|
+
/** Output only. Dataset distributions for the number of contents per example. */
|
|
2845
|
+
contentsPerExampleDistribution?: DatasetDistribution;
|
|
2846
|
+
/** Output only. Sample user dataset examples in the training dataset uri for Reinforcement Tuning. */
|
|
2847
|
+
reinforcementTuningUserDatasetExamples?: ReinforcementTuningUserDatasetExamples;
|
|
2848
|
+
/** Output only. Number of billable tokens in the tuning dataset. */
|
|
2849
|
+
totalBillableTokenCount?: string;
|
|
2700
2850
|
}
|
|
2701
2851
|
|
|
2702
2852
|
declare type DeepResearchAgentConfig$ = DeepResearchAgentConfig;
|
|
@@ -2705,12 +2855,6 @@ declare type DeepResearchAgentConfig$ = DeepResearchAgentConfig;
|
|
|
2705
2855
|
* Configuration for the Deep Research agent.
|
|
2706
2856
|
*/
|
|
2707
2857
|
declare type DeepResearchAgentConfig = {
|
|
2708
|
-
type: "deep-research";
|
|
2709
|
-
thinking_summaries?: ThinkingSummaries | undefined;
|
|
2710
|
-
/**
|
|
2711
|
-
* Whether to include visualizations in the response.
|
|
2712
|
-
*/
|
|
2713
|
-
visualization?: Visualization | undefined;
|
|
2714
2858
|
/**
|
|
2715
2859
|
* Enables human-in-the-loop planning for the Deep Research agent. If set to
|
|
2716
2860
|
*
|
|
@@ -2724,8 +2868,14 @@ declare type DeepResearchAgentConfig = {
|
|
|
2724
2868
|
* Enables bigquery tool for the Deep Research agent.
|
|
2725
2869
|
*/
|
|
2726
2870
|
enable_bigquery_tool?: boolean | undefined;
|
|
2727
|
-
|
|
2728
|
-
|
|
2871
|
+
thinking_summaries?: ThinkingSummaries | undefined;
|
|
2872
|
+
type: "deep-research";
|
|
2873
|
+
/**
|
|
2874
|
+
* Whether to include visualizations in the response.
|
|
2875
|
+
*/
|
|
2876
|
+
visualization?: Visualization | undefined;
|
|
2877
|
+
};
|
|
2878
|
+
|
|
2729
2879
|
declare type DeleteAgentParams = Omit<DeleteAgentRequest, "id">;
|
|
2730
2880
|
|
|
2731
2881
|
declare type DeleteAgentRequest = {
|
|
@@ -2915,6 +3065,19 @@ export declare interface DeleteResourceJob {
|
|
|
2915
3065
|
error?: JobError;
|
|
2916
3066
|
}
|
|
2917
3067
|
|
|
3068
|
+
declare type DeleteTriggerParams = Omit<DeleteTriggerRequest, "id">;
|
|
3069
|
+
|
|
3070
|
+
declare type DeleteTriggerRequest = {
|
|
3071
|
+
/**
|
|
3072
|
+
* Which version of the API to use.
|
|
3073
|
+
*/
|
|
3074
|
+
api_version?: string | undefined;
|
|
3075
|
+
/**
|
|
3076
|
+
* Resource name of the trigger.
|
|
3077
|
+
*/
|
|
3078
|
+
id: string;
|
|
3079
|
+
};
|
|
3080
|
+
|
|
2918
3081
|
declare type DeleteWebhookParams = Omit<DeleteWebhookRequest, "id">;
|
|
2919
3082
|
|
|
2920
3083
|
declare type DeleteWebhookRequest = {
|
|
@@ -2931,11 +3094,34 @@ declare type DeleteWebhookRequest = {
|
|
|
2931
3094
|
id: string;
|
|
2932
3095
|
};
|
|
2933
3096
|
|
|
3097
|
+
/** Delivery mode for the generated content. */
|
|
3098
|
+
export declare enum Delivery {
|
|
3099
|
+
/**
|
|
3100
|
+
* Default value. This value is unused.
|
|
3101
|
+
*/
|
|
3102
|
+
DELIVERY_UNSPECIFIED = "DELIVERY_UNSPECIFIED",
|
|
3103
|
+
/**
|
|
3104
|
+
* Generated bytes are returned inline in the response.
|
|
3105
|
+
*/
|
|
3106
|
+
INLINE = "INLINE",
|
|
3107
|
+
/**
|
|
3108
|
+
* Generated content is stored and a URI is returned.
|
|
3109
|
+
*/
|
|
3110
|
+
URI = "URI"
|
|
3111
|
+
}
|
|
3112
|
+
|
|
2934
3113
|
/**
|
|
2935
3114
|
* Turns all network off.
|
|
2936
3115
|
*/
|
|
2937
3116
|
declare type Disabled = "disabled";
|
|
2938
3117
|
|
|
3118
|
+
/**
|
|
3119
|
+
* @license
|
|
3120
|
+
* Copyright 2026 Google LLC
|
|
3121
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
3122
|
+
*
|
|
3123
|
+
* g3-prettier-ignore-file
|
|
3124
|
+
*/
|
|
2939
3125
|
declare type DisabledSafetyPolicy = "financial_transactions" | "sensitive_data_modification" | "communication_tool" | "account_creation" | "data_modification" | "user_consent_management" | "legal_terms_and_agreements" | (string & {});
|
|
2940
3126
|
|
|
2941
3127
|
/** 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. */
|
|
@@ -3037,19 +3223,19 @@ declare type DocumentContent$ = DocumentContent;
|
|
|
3037
3223
|
* A document content block.
|
|
3038
3224
|
*/
|
|
3039
3225
|
declare type DocumentContent = {
|
|
3040
|
-
type: "document";
|
|
3041
3226
|
/**
|
|
3042
3227
|
* The document content.
|
|
3043
3228
|
*/
|
|
3044
3229
|
data?: string | undefined;
|
|
3045
|
-
/**
|
|
3046
|
-
* The URI of the document.
|
|
3047
|
-
*/
|
|
3048
|
-
uri?: string | undefined;
|
|
3049
3230
|
/**
|
|
3050
3231
|
* The mime type of the document.
|
|
3051
3232
|
*/
|
|
3052
3233
|
mime_type?: DocumentContentMimeType | undefined;
|
|
3234
|
+
type: "document";
|
|
3235
|
+
/**
|
|
3236
|
+
* The URI of the document.
|
|
3237
|
+
*/
|
|
3238
|
+
uri?: string | undefined;
|
|
3053
3239
|
};
|
|
3054
3240
|
|
|
3055
3241
|
/**
|
|
@@ -3065,10 +3251,10 @@ declare type DocumentContent = {
|
|
|
3065
3251
|
declare type DocumentContentMimeType = "application/pdf" | "text/csv" | (string & {});
|
|
3066
3252
|
|
|
3067
3253
|
declare type DocumentDelta = {
|
|
3068
|
-
type: "document";
|
|
3069
3254
|
data?: string | undefined;
|
|
3070
|
-
uri?: string | undefined;
|
|
3071
3255
|
mime_type?: DocumentDeltaMimeType | undefined;
|
|
3256
|
+
type: "document";
|
|
3257
|
+
uri?: string | undefined;
|
|
3072
3258
|
};
|
|
3073
3259
|
|
|
3074
3260
|
/**
|
|
@@ -3526,21 +3712,21 @@ export declare enum Environment {
|
|
|
3526
3712
|
* Configuration for a custom environment.
|
|
3527
3713
|
*/
|
|
3528
3714
|
declare type Environment_2 = {
|
|
3529
|
-
|
|
3530
|
-
|
|
3715
|
+
/**
|
|
3716
|
+
* Optional. The environment ID for the interaction. If specified, the request will
|
|
3717
|
+
*
|
|
3718
|
+
* @remarks
|
|
3719
|
+
* update the existing environment instead of creating a new one.
|
|
3720
|
+
*/
|
|
3721
|
+
environment_id?: string | undefined;
|
|
3531
3722
|
/**
|
|
3532
3723
|
* Network configuration for the environment.
|
|
3533
3724
|
*/
|
|
3534
3725
|
network?: EnvironmentNetworkEgressAllowlist | NetworkEnum | undefined;
|
|
3726
|
+
sources?: Array<Source> | undefined;
|
|
3727
|
+
type: "remote";
|
|
3535
3728
|
};
|
|
3536
3729
|
|
|
3537
|
-
/**
|
|
3538
|
-
* @license
|
|
3539
|
-
* Copyright 2026 Google LLC
|
|
3540
|
-
* SPDX-License-Identifier: Apache-2.0
|
|
3541
|
-
*
|
|
3542
|
-
* g3-prettier-ignore-file
|
|
3543
|
-
*/
|
|
3544
3730
|
/**
|
|
3545
3731
|
* The environment being operated.
|
|
3546
3732
|
*/
|
|
@@ -3558,7 +3744,6 @@ declare type Error$2 = Status;
|
|
|
3558
3744
|
declare type ErrorEvent$ = ErrorEvent_2;
|
|
3559
3745
|
|
|
3560
3746
|
declare type ErrorEvent_2 = {
|
|
3561
|
-
event_type: "error";
|
|
3562
3747
|
/**
|
|
3563
3748
|
* Error message from an interaction.
|
|
3564
3749
|
*/
|
|
@@ -3570,6 +3755,7 @@ declare type ErrorEvent_2 = {
|
|
|
3570
3755
|
* this event.
|
|
3571
3756
|
*/
|
|
3572
3757
|
event_id?: string | undefined;
|
|
3758
|
+
event_type: "error";
|
|
3573
3759
|
metadata?: StreamMetadata | undefined;
|
|
3574
3760
|
};
|
|
3575
3761
|
|
|
@@ -3768,33 +3954,36 @@ declare type FileCitation$ = FileCitation;
|
|
|
3768
3954
|
* A file citation annotation.
|
|
3769
3955
|
*/
|
|
3770
3956
|
declare type FileCitation = {
|
|
3771
|
-
|
|
3957
|
+
/**
|
|
3958
|
+
* User provided metadata about the retrieved context.
|
|
3959
|
+
*/
|
|
3960
|
+
custom_metadata?: {
|
|
3961
|
+
[k: string]: any;
|
|
3962
|
+
} | undefined;
|
|
3772
3963
|
/**
|
|
3773
3964
|
* The URI of the file.
|
|
3774
3965
|
*/
|
|
3775
3966
|
document_uri?: string | undefined;
|
|
3776
3967
|
/**
|
|
3777
|
-
*
|
|
3968
|
+
* End of the attributed segment, exclusive.
|
|
3778
3969
|
*/
|
|
3779
|
-
|
|
3970
|
+
end_index?: number | undefined;
|
|
3780
3971
|
/**
|
|
3781
|
-
*
|
|
3972
|
+
* The name of the file.
|
|
3782
3973
|
*/
|
|
3783
|
-
|
|
3974
|
+
file_name?: string | undefined;
|
|
3784
3975
|
/**
|
|
3785
|
-
*
|
|
3976
|
+
* Media ID in-case of image citations, if applicable.
|
|
3786
3977
|
*/
|
|
3787
|
-
|
|
3788
|
-
[k: string]: any;
|
|
3789
|
-
} | undefined;
|
|
3978
|
+
media_id?: string | undefined;
|
|
3790
3979
|
/**
|
|
3791
3980
|
* Page number of the cited document, if applicable.
|
|
3792
3981
|
*/
|
|
3793
3982
|
page_number?: number | undefined;
|
|
3794
3983
|
/**
|
|
3795
|
-
*
|
|
3984
|
+
* Source attributed for a portion of the text.
|
|
3796
3985
|
*/
|
|
3797
|
-
|
|
3986
|
+
source?: string | undefined;
|
|
3798
3987
|
/**
|
|
3799
3988
|
* Start of segment of the response that is attributed to this source.
|
|
3800
3989
|
*
|
|
@@ -3803,10 +3992,28 @@ declare type FileCitation = {
|
|
|
3803
3992
|
* Index indicates the start of the segment, measured in bytes.
|
|
3804
3993
|
*/
|
|
3805
3994
|
start_index?: number | undefined;
|
|
3995
|
+
type: "file_citation";
|
|
3996
|
+
};
|
|
3997
|
+
|
|
3998
|
+
/**
|
|
3999
|
+
* @license
|
|
4000
|
+
* Copyright 2026 Google LLC
|
|
4001
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
4002
|
+
*
|
|
4003
|
+
* g3-prettier-ignore-file
|
|
4004
|
+
*/
|
|
4005
|
+
/**
|
|
4006
|
+
* Content of a single file in the codebase.
|
|
4007
|
+
*/
|
|
4008
|
+
declare type FileContent = {
|
|
3806
4009
|
/**
|
|
3807
|
-
*
|
|
4010
|
+
* The UTF-8 encoded text content of the file.
|
|
3808
4011
|
*/
|
|
3809
|
-
|
|
4012
|
+
content?: string | undefined;
|
|
4013
|
+
/**
|
|
4014
|
+
* The relative path of the file from the project root.
|
|
4015
|
+
*/
|
|
4016
|
+
path?: string | undefined;
|
|
3810
4017
|
};
|
|
3811
4018
|
|
|
3812
4019
|
/** 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. */
|
|
@@ -3962,19 +4169,19 @@ export declare interface FileSearch {
|
|
|
3962
4169
|
* A tool that can be used by the model to search files.
|
|
3963
4170
|
*/
|
|
3964
4171
|
declare type FileSearch_2 = {
|
|
3965
|
-
type: "file_search";
|
|
3966
4172
|
/**
|
|
3967
4173
|
* The file search store names to search.
|
|
3968
4174
|
*/
|
|
3969
4175
|
file_search_store_names?: Array<string> | undefined;
|
|
3970
|
-
/**
|
|
3971
|
-
* The number of semantic retrieval chunks to retrieve.
|
|
3972
|
-
*/
|
|
3973
|
-
top_k?: number | undefined;
|
|
3974
4176
|
/**
|
|
3975
4177
|
* Metadata filter to apply to the semantic retrieval documents and chunks.
|
|
3976
4178
|
*/
|
|
3977
4179
|
metadata_filter?: string | undefined;
|
|
4180
|
+
/**
|
|
4181
|
+
* The number of semantic retrieval chunks to retrieve.
|
|
4182
|
+
*/
|
|
4183
|
+
top_k?: number | undefined;
|
|
4184
|
+
type: "file_search";
|
|
3978
4185
|
};
|
|
3979
4186
|
|
|
3980
4187
|
declare type FileSearchCall$ = FileSearchCallDelta;
|
|
@@ -3987,11 +4194,11 @@ declare type FileSearchCall$ = FileSearchCallDelta;
|
|
|
3987
4194
|
* g3-prettier-ignore-file
|
|
3988
4195
|
*/
|
|
3989
4196
|
declare type FileSearchCallDelta = {
|
|
3990
|
-
type: "file_search_call";
|
|
3991
4197
|
/**
|
|
3992
4198
|
* A signature hash for backend validation.
|
|
3993
4199
|
*/
|
|
3994
4200
|
signature?: string | undefined;
|
|
4201
|
+
type: "file_search_call";
|
|
3995
4202
|
};
|
|
3996
4203
|
|
|
3997
4204
|
declare type FileSearchCallStep$ = FileSearchCallStep;
|
|
@@ -4007,7 +4214,6 @@ declare type FileSearchCallStep$ = FileSearchCallStep;
|
|
|
4007
4214
|
* File Search call step.
|
|
4008
4215
|
*/
|
|
4009
4216
|
declare type FileSearchCallStep = {
|
|
4010
|
-
type: "file_search_call";
|
|
4011
4217
|
/**
|
|
4012
4218
|
* Required. A unique ID for this specific tool call.
|
|
4013
4219
|
*/
|
|
@@ -4016,6 +4222,7 @@ declare type FileSearchCallStep = {
|
|
|
4016
4222
|
* A signature hash for backend validation.
|
|
4017
4223
|
*/
|
|
4018
4224
|
signature?: string | undefined;
|
|
4225
|
+
type: "file_search_call";
|
|
4019
4226
|
};
|
|
4020
4227
|
|
|
4021
4228
|
declare type FileSearchResult$ = FileSearchResultDelta;
|
|
@@ -4033,12 +4240,12 @@ declare type FileSearchResult$ = FileSearchResultDelta;
|
|
|
4033
4240
|
declare type FileSearchResult = {};
|
|
4034
4241
|
|
|
4035
4242
|
declare type FileSearchResultDelta = {
|
|
4036
|
-
type: "file_search_result";
|
|
4037
4243
|
result: Array<FileSearchResult>;
|
|
4038
4244
|
/**
|
|
4039
4245
|
* A signature hash for backend validation.
|
|
4040
4246
|
*/
|
|
4041
4247
|
signature?: string | undefined;
|
|
4248
|
+
type: "file_search_result";
|
|
4042
4249
|
};
|
|
4043
4250
|
|
|
4044
4251
|
declare type FileSearchResultStep$ = FileSearchResultStep;
|
|
@@ -4054,7 +4261,6 @@ declare type FileSearchResultStep$ = FileSearchResultStep;
|
|
|
4054
4261
|
* File Search result step.
|
|
4055
4262
|
*/
|
|
4056
4263
|
declare type FileSearchResultStep = {
|
|
4057
|
-
type: "file_search_result";
|
|
4058
4264
|
/**
|
|
4059
4265
|
* Required. ID to match the ID from the function call block.
|
|
4060
4266
|
*/
|
|
@@ -4063,6 +4269,7 @@ declare type FileSearchResultStep = {
|
|
|
4063
4269
|
* A signature hash for backend validation.
|
|
4064
4270
|
*/
|
|
4065
4271
|
signature?: string | undefined;
|
|
4272
|
+
type: "file_search_result";
|
|
4066
4273
|
};
|
|
4067
4274
|
|
|
4068
4275
|
/** A collection of Documents. */
|
|
@@ -4239,6 +4446,10 @@ export declare interface FileStatus {
|
|
|
4239
4446
|
* Config for filters.
|
|
4240
4447
|
*/
|
|
4241
4448
|
declare type Filter = {
|
|
4449
|
+
/**
|
|
4450
|
+
* Optional. String for metadata filtering.
|
|
4451
|
+
*/
|
|
4452
|
+
metadata_filter?: string | undefined;
|
|
4242
4453
|
/**
|
|
4243
4454
|
* Optional. Only returns contexts with vector distance smaller than the
|
|
4244
4455
|
*
|
|
@@ -4253,10 +4464,40 @@ declare type Filter = {
|
|
|
4253
4464
|
* threshold.
|
|
4254
4465
|
*/
|
|
4255
4466
|
vector_similarity_threshold?: number | undefined;
|
|
4467
|
+
};
|
|
4468
|
+
|
|
4469
|
+
declare type FindRequest$ = FindRequest;
|
|
4470
|
+
|
|
4471
|
+
/**
|
|
4472
|
+
* Request parameters specific to FIND sessions, used for discovering
|
|
4473
|
+
*
|
|
4474
|
+
* @remarks
|
|
4475
|
+
* vulnerabilities in a codebase.
|
|
4476
|
+
*/
|
|
4477
|
+
declare type FindRequest = {
|
|
4256
4478
|
/**
|
|
4257
|
-
*
|
|
4479
|
+
* Additional context or custom instructions provided by the user to guide
|
|
4480
|
+
*
|
|
4481
|
+
* @remarks
|
|
4482
|
+
* the vulnerability analysis.
|
|
4258
4483
|
*/
|
|
4259
|
-
|
|
4484
|
+
description?: string | undefined;
|
|
4485
|
+
/**
|
|
4486
|
+
* The identifier of a specific finding to verify. This is primarily used in
|
|
4487
|
+
*
|
|
4488
|
+
* @remarks
|
|
4489
|
+
* VERIFY mode to focus the agent's execution-based validation on a single
|
|
4490
|
+
* vulnerability.
|
|
4491
|
+
*/
|
|
4492
|
+
finding_id?: string | undefined;
|
|
4493
|
+
/**
|
|
4494
|
+
* The mode of the find session.
|
|
4495
|
+
*/
|
|
4496
|
+
mode?: Mode | undefined;
|
|
4497
|
+
/**
|
|
4498
|
+
* A list of source files to provide as context for the scan.
|
|
4499
|
+
*/
|
|
4500
|
+
source_files?: Array<FileContent> | undefined;
|
|
4260
4501
|
};
|
|
4261
4502
|
|
|
4262
4503
|
/** Output only. The reason why the model stopped generating tokens.
|
|
@@ -4333,6 +4574,38 @@ export declare enum FinishReason {
|
|
|
4333
4574
|
IMAGE_OTHER = "IMAGE_OTHER"
|
|
4334
4575
|
}
|
|
4335
4576
|
|
|
4577
|
+
declare type FixRequest$ = FixRequest;
|
|
4578
|
+
|
|
4579
|
+
/**
|
|
4580
|
+
* Request parameters specific to FIX sessions, used for generating and
|
|
4581
|
+
*
|
|
4582
|
+
* @remarks
|
|
4583
|
+
* validating security patches.
|
|
4584
|
+
*/
|
|
4585
|
+
declare type FixRequest = {
|
|
4586
|
+
/**
|
|
4587
|
+
* Additional context or custom instructions provided by the user to guide
|
|
4588
|
+
*
|
|
4589
|
+
* @remarks
|
|
4590
|
+
* the patch generation process.
|
|
4591
|
+
*/
|
|
4592
|
+
description?: string | undefined;
|
|
4593
|
+
/**
|
|
4594
|
+
* The identifier of the specific security finding to be remediated. This ID
|
|
4595
|
+
*
|
|
4596
|
+
* @remarks
|
|
4597
|
+
* maps to a previously discovered vulnerability.
|
|
4598
|
+
*/
|
|
4599
|
+
finding_id?: string | undefined;
|
|
4600
|
+
/**
|
|
4601
|
+
* A list of source files providing context for the remediation. These files
|
|
4602
|
+
*
|
|
4603
|
+
* @remarks
|
|
4604
|
+
* are typically the ones containing the identified vulnerability.
|
|
4605
|
+
*/
|
|
4606
|
+
source_files?: Array<FileContent> | undefined;
|
|
4607
|
+
};
|
|
4608
|
+
|
|
4336
4609
|
/** Tuning Spec for Full Fine Tuning. This data type is not supported in Gemini API. */
|
|
4337
4610
|
export declare interface FullFineTuningSpec {
|
|
4338
4611
|
/** Optional. Hyperparameters for Full Fine Tuning. */
|
|
@@ -4406,11 +4679,6 @@ declare type FunctionCallStep$ = FunctionCallStep;
|
|
|
4406
4679
|
* A function tool call step.
|
|
4407
4680
|
*/
|
|
4408
4681
|
declare type FunctionCallStep = {
|
|
4409
|
-
type: "function_call";
|
|
4410
|
-
/**
|
|
4411
|
-
* Required. The name of the tool to call.
|
|
4412
|
-
*/
|
|
4413
|
-
name: string;
|
|
4414
4682
|
/**
|
|
4415
4683
|
* Required. The arguments to pass to the function.
|
|
4416
4684
|
*/
|
|
@@ -4421,6 +4689,11 @@ declare type FunctionCallStep = {
|
|
|
4421
4689
|
* Required. A unique ID for this specific tool call.
|
|
4422
4690
|
*/
|
|
4423
4691
|
id: string;
|
|
4692
|
+
/**
|
|
4693
|
+
* Required. The name of the tool to call.
|
|
4694
|
+
*/
|
|
4695
|
+
name: string;
|
|
4696
|
+
type: "function_call";
|
|
4424
4697
|
};
|
|
4425
4698
|
|
|
4426
4699
|
/** 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. */
|
|
@@ -4437,7 +4710,7 @@ export declare interface FunctionDeclaration {
|
|
|
4437
4710
|
response?: Schema;
|
|
4438
4711
|
/** 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`. */
|
|
4439
4712
|
responseJsonSchema?: unknown;
|
|
4440
|
-
/** Optional. Specifies the function Behavior.
|
|
4713
|
+
/** 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. */
|
|
4441
4714
|
behavior?: Behavior;
|
|
4442
4715
|
}
|
|
4443
4716
|
|
|
@@ -4509,14 +4782,14 @@ export declare enum FunctionResponseScheduling {
|
|
|
4509
4782
|
declare type FunctionResult$ = FunctionResultDelta;
|
|
4510
4783
|
|
|
4511
4784
|
declare type FunctionResultDelta = {
|
|
4512
|
-
type: "function_result";
|
|
4513
|
-
name?: string | undefined;
|
|
4514
|
-
is_error?: boolean | undefined;
|
|
4515
4785
|
/**
|
|
4516
4786
|
* Required. ID to match the ID from the function call block.
|
|
4517
4787
|
*/
|
|
4518
4788
|
call_id: string;
|
|
4789
|
+
is_error?: boolean | undefined;
|
|
4790
|
+
name?: string | undefined;
|
|
4519
4791
|
result: FunctionResultDeltaResult | Array<FunctionResultSubcontent> | string;
|
|
4792
|
+
type: "function_result";
|
|
4520
4793
|
};
|
|
4521
4794
|
|
|
4522
4795
|
declare type FunctionResultDeltaResult = {};
|
|
@@ -4529,23 +4802,23 @@ declare type FunctionResultStep$ = FunctionResultStep;
|
|
|
4529
4802
|
* Result of a function tool call.
|
|
4530
4803
|
*/
|
|
4531
4804
|
declare type FunctionResultStep = {
|
|
4532
|
-
type: "function_result";
|
|
4533
4805
|
/**
|
|
4534
|
-
*
|
|
4806
|
+
* Required. ID to match the ID from the function call block.
|
|
4535
4807
|
*/
|
|
4536
|
-
|
|
4808
|
+
call_id: string;
|
|
4537
4809
|
/**
|
|
4538
4810
|
* Whether the tool call resulted in an error.
|
|
4539
4811
|
*/
|
|
4540
4812
|
is_error?: boolean | undefined;
|
|
4541
4813
|
/**
|
|
4542
|
-
*
|
|
4814
|
+
* The name of the tool that was called.
|
|
4543
4815
|
*/
|
|
4544
|
-
|
|
4816
|
+
name?: string | undefined;
|
|
4545
4817
|
/**
|
|
4546
4818
|
* The result of the tool call.
|
|
4547
4819
|
*/
|
|
4548
4820
|
result: FunctionResultStepResult | Array<FunctionResultSubcontent> | string;
|
|
4821
|
+
type: "function_result";
|
|
4549
4822
|
};
|
|
4550
4823
|
|
|
4551
4824
|
declare type FunctionResultStepResult = {};
|
|
@@ -4568,19 +4841,19 @@ declare type FunctionResultSubcontent = TextContent | ImageContent;
|
|
|
4568
4841
|
* A tool that can be used by the model.
|
|
4569
4842
|
*/
|
|
4570
4843
|
declare type FunctionT = {
|
|
4571
|
-
type: "function";
|
|
4572
|
-
/**
|
|
4573
|
-
* The name of the function.
|
|
4574
|
-
*/
|
|
4575
|
-
name?: string | undefined;
|
|
4576
4844
|
/**
|
|
4577
4845
|
* A description of the function.
|
|
4578
4846
|
*/
|
|
4579
4847
|
description?: string | undefined;
|
|
4848
|
+
/**
|
|
4849
|
+
* The name of the function.
|
|
4850
|
+
*/
|
|
4851
|
+
name?: string | undefined;
|
|
4580
4852
|
/**
|
|
4581
4853
|
* The JSON Schema for the function's parameters.
|
|
4582
4854
|
*/
|
|
4583
4855
|
parameters?: any | undefined;
|
|
4856
|
+
type: "function";
|
|
4584
4857
|
};
|
|
4585
4858
|
|
|
4586
4859
|
/** The Google Cloud Storage location for the input content. This data type is not supported in Gemini API. */
|
|
@@ -4623,6 +4896,20 @@ declare class GeminiNextGenInteractions {
|
|
|
4623
4896
|
private getClient;
|
|
4624
4897
|
}
|
|
4625
4898
|
|
|
4899
|
+
declare class GeminiNextGenTriggers {
|
|
4900
|
+
private readonly parentClient;
|
|
4901
|
+
private sdk;
|
|
4902
|
+
constructor(parentClient: GoogleGenAIParentClient);
|
|
4903
|
+
create(params: CreateTriggerParams, options?: GoogleGenAIRequestOptions): Promise<triggers.Trigger>;
|
|
4904
|
+
list(params?: ListTriggersParams_2 | null | undefined, options?: GoogleGenAIRequestOptions): Promise<triggers.ListTriggersResponse>;
|
|
4905
|
+
get(id: string, params?: GetTriggerParams | null | undefined, options?: GoogleGenAIRequestOptions): Promise<triggers.Trigger>;
|
|
4906
|
+
update(id: string, params: UpdateTriggerParams, options?: GoogleGenAIRequestOptions): Promise<triggers.Trigger>;
|
|
4907
|
+
delete(id: string, params?: DeleteTriggerParams | null | undefined, options?: GoogleGenAIRequestOptions): Promise<interactions.Empty>;
|
|
4908
|
+
run(trigger_id: string, params?: RunTriggerParams | null | undefined, options?: GoogleGenAIRequestOptions): Promise<triggers.TriggerExecution>;
|
|
4909
|
+
listExecutions(trigger_id: string, params?: ListTriggerExecutionsParams_2 | null | undefined, options?: GoogleGenAIRequestOptions): Promise<triggers.ListTriggerExecutionsResponse>;
|
|
4910
|
+
private getClient;
|
|
4911
|
+
}
|
|
4912
|
+
|
|
4626
4913
|
declare class GeminiNextGenWebhooks {
|
|
4627
4914
|
private readonly parentClient;
|
|
4628
4915
|
private sdk;
|
|
@@ -5287,11 +5574,11 @@ export declare interface GenerationConfig {
|
|
|
5287
5574
|
presencePenalty?: number;
|
|
5288
5575
|
/** 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. */
|
|
5289
5576
|
responseLogprobs?: boolean;
|
|
5290
|
-
/** 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. */
|
|
5577
|
+
/** 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. */
|
|
5291
5578
|
responseMimeType?: string;
|
|
5292
5579
|
/** 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. */
|
|
5293
5580
|
responseModalities?: Modality[];
|
|
5294
|
-
/** 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`. */
|
|
5581
|
+
/** 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. */
|
|
5295
5582
|
responseSchema?: Schema;
|
|
5296
5583
|
/** Optional. Routing configuration. This field is not supported in Gemini API. */
|
|
5297
5584
|
routingConfig?: GenerationConfigRoutingConfig;
|
|
@@ -5311,6 +5598,10 @@ export declare interface GenerationConfig {
|
|
|
5311
5598
|
topP?: number;
|
|
5312
5599
|
/** Optional. Enables enhanced civic answers. It may not be available for all models. This field is not supported in Vertex AI. */
|
|
5313
5600
|
enableEnhancedCivicAnswers?: boolean;
|
|
5601
|
+
/** Optional. New response format field for the model to configure output formatting and delivery. */
|
|
5602
|
+
responseFormat?: ResponseFormat[];
|
|
5603
|
+
/** Optional. Config for translation. This field is not supported in Vertex AI. */
|
|
5604
|
+
translationConfig?: TranslationConfig;
|
|
5314
5605
|
}
|
|
5315
5606
|
|
|
5316
5607
|
/**
|
|
@@ -5318,61 +5609,45 @@ export declare interface GenerationConfig {
|
|
|
5318
5609
|
*/
|
|
5319
5610
|
declare type GenerationConfig_2 = {
|
|
5320
5611
|
/**
|
|
5321
|
-
*
|
|
5612
|
+
* The configuration for image interaction.
|
|
5613
|
+
*
|
|
5614
|
+
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
5322
5615
|
*/
|
|
5323
|
-
|
|
5616
|
+
image_config?: ImageConfig_2 | undefined;
|
|
5324
5617
|
/**
|
|
5325
|
-
* The maximum
|
|
5618
|
+
* The maximum number of tokens to include in the response.
|
|
5326
5619
|
*/
|
|
5327
|
-
|
|
5620
|
+
max_output_tokens?: number | undefined;
|
|
5328
5621
|
/**
|
|
5329
5622
|
* Seed used in decoding for reproducibility.
|
|
5330
5623
|
*/
|
|
5331
5624
|
seed?: number | undefined;
|
|
5332
|
-
/**
|
|
5333
|
-
* A list of character sequences that will stop output interaction.
|
|
5334
|
-
*/
|
|
5335
|
-
stop_sequences?: Array<string> | undefined;
|
|
5336
|
-
thinking_level?: ThinkingLevel_2 | undefined;
|
|
5337
|
-
thinking_summaries?: ThinkingSummaries | undefined;
|
|
5338
|
-
/**
|
|
5339
|
-
* The maximum number of tokens to include in the response.
|
|
5340
|
-
*/
|
|
5341
|
-
max_output_tokens?: number | undefined;
|
|
5342
5625
|
/**
|
|
5343
5626
|
* Configuration for speech interaction.
|
|
5344
5627
|
*/
|
|
5345
5628
|
speech_config?: Array<SpeechConfig_2> | undefined;
|
|
5346
5629
|
/**
|
|
5347
|
-
*
|
|
5348
|
-
*
|
|
5349
|
-
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
5630
|
+
* A list of character sequences that will stop output interaction.
|
|
5350
5631
|
*/
|
|
5351
|
-
|
|
5632
|
+
stop_sequences?: Array<string> | undefined;
|
|
5352
5633
|
/**
|
|
5353
|
-
*
|
|
5634
|
+
* Controls the randomness of the output.
|
|
5354
5635
|
*/
|
|
5355
|
-
|
|
5636
|
+
temperature?: number | undefined;
|
|
5637
|
+
thinking_level?: ThinkingLevel_2 | undefined;
|
|
5638
|
+
thinking_summaries?: ThinkingSummaries | undefined;
|
|
5356
5639
|
/**
|
|
5357
|
-
*
|
|
5358
|
-
*
|
|
5359
|
-
* @remarks
|
|
5360
|
-
* text. A positive value encourages the model to generate more diverse and
|
|
5361
|
-
* less repetitive text. Valid values can range from [-2.0, 2.0].
|
|
5640
|
+
* The tool choice configuration.
|
|
5362
5641
|
*/
|
|
5363
|
-
|
|
5642
|
+
tool_choice?: ToolChoiceType | ToolChoiceConfig | undefined;
|
|
5364
5643
|
/**
|
|
5365
|
-
*
|
|
5366
|
-
*
|
|
5367
|
-
* @remarks
|
|
5368
|
-
* A positive value helps to reduce the repetition of words and phrases.
|
|
5369
|
-
* Valid values can range from [-2.0, 2.0].
|
|
5644
|
+
* The maximum cumulative probability of tokens to consider when sampling.
|
|
5370
5645
|
*/
|
|
5371
|
-
|
|
5646
|
+
top_p?: number | undefined;
|
|
5372
5647
|
/**
|
|
5373
|
-
*
|
|
5648
|
+
* Configuration options for video generation.
|
|
5374
5649
|
*/
|
|
5375
|
-
|
|
5650
|
+
video_config?: VideoConfig | undefined;
|
|
5376
5651
|
};
|
|
5377
5652
|
|
|
5378
5653
|
/** 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. */
|
|
@@ -5598,6 +5873,19 @@ export declare interface GetOperationParameters {
|
|
|
5598
5873
|
config?: GetOperationConfig;
|
|
5599
5874
|
}
|
|
5600
5875
|
|
|
5876
|
+
declare type GetTriggerParams = Omit<GetTriggerRequest, "id">;
|
|
5877
|
+
|
|
5878
|
+
declare type GetTriggerRequest = {
|
|
5879
|
+
/**
|
|
5880
|
+
* Which version of the API to use.
|
|
5881
|
+
*/
|
|
5882
|
+
api_version?: string | undefined;
|
|
5883
|
+
/**
|
|
5884
|
+
* Resource name of the trigger.
|
|
5885
|
+
*/
|
|
5886
|
+
id: string;
|
|
5887
|
+
};
|
|
5888
|
+
|
|
5601
5889
|
/** Optional parameters for tunings.get method. */
|
|
5602
5890
|
export declare interface GetTuningJobConfig {
|
|
5603
5891
|
/** Used to override HTTP request options. */
|
|
@@ -5687,10 +5975,12 @@ export declare class GoogleGenAI {
|
|
|
5687
5975
|
private _webhooks;
|
|
5688
5976
|
private _agents;
|
|
5689
5977
|
private _nextGenClient;
|
|
5978
|
+
private _triggers;
|
|
5690
5979
|
private getNextGenClient;
|
|
5691
5980
|
get interactions(): GeminiNextGenInteractions;
|
|
5692
5981
|
get webhooks(): GeminiNextGenWebhooks;
|
|
5693
5982
|
get agents(): GeminiNextGenAgents;
|
|
5983
|
+
get triggers(): GeminiNextGenTriggers;
|
|
5694
5984
|
constructor(options: GoogleGenAIOptions);
|
|
5695
5985
|
}
|
|
5696
5986
|
|
|
@@ -5785,6 +6075,7 @@ declare interface GoogleGenAIParentClient {
|
|
|
5785
6075
|
getBaseUrl(): string;
|
|
5786
6076
|
getApiVersion(): string;
|
|
5787
6077
|
getDefaultHeaders?(): Record<string, string>;
|
|
6078
|
+
getHeaders?(): Record<string, string> | undefined;
|
|
5788
6079
|
getAuthHeaders(url?: string): Headers | Promise<Headers>;
|
|
5789
6080
|
}
|
|
5790
6081
|
|
|
@@ -5828,7 +6119,6 @@ export declare interface GoogleMaps {
|
|
|
5828
6119
|
* A tool that can be used by the model to call Google Maps.
|
|
5829
6120
|
*/
|
|
5830
6121
|
declare type GoogleMaps_2 = {
|
|
5831
|
-
type: "google_maps";
|
|
5832
6122
|
/**
|
|
5833
6123
|
* Whether to return a widget context token in the tool call result of the
|
|
5834
6124
|
*
|
|
@@ -5844,6 +6134,7 @@ declare type GoogleMaps_2 = {
|
|
|
5844
6134
|
* The longitude of the user's location.
|
|
5845
6135
|
*/
|
|
5846
6136
|
longitude?: number | undefined;
|
|
6137
|
+
type: "google_maps";
|
|
5847
6138
|
};
|
|
5848
6139
|
|
|
5849
6140
|
declare type GoogleMapsCall$ = GoogleMapsCallDelta;
|
|
@@ -5868,7 +6159,6 @@ declare type GoogleMapsCallArguments = {
|
|
|
5868
6159
|
};
|
|
5869
6160
|
|
|
5870
6161
|
declare type GoogleMapsCallDelta = {
|
|
5871
|
-
type: "google_maps_call";
|
|
5872
6162
|
/**
|
|
5873
6163
|
* The arguments to pass to the Google Maps tool.
|
|
5874
6164
|
*/
|
|
@@ -5877,6 +6167,7 @@ declare type GoogleMapsCallDelta = {
|
|
|
5877
6167
|
* A signature hash for backend validation.
|
|
5878
6168
|
*/
|
|
5879
6169
|
signature?: string | undefined;
|
|
6170
|
+
type: "google_maps_call";
|
|
5880
6171
|
};
|
|
5881
6172
|
|
|
5882
6173
|
declare type GoogleMapsCallStep$ = GoogleMapsCallStep;
|
|
@@ -5885,7 +6176,6 @@ declare type GoogleMapsCallStep$ = GoogleMapsCallStep;
|
|
|
5885
6176
|
* Google Maps call step.
|
|
5886
6177
|
*/
|
|
5887
6178
|
declare type GoogleMapsCallStep = {
|
|
5888
|
-
type: "google_maps_call";
|
|
5889
6179
|
/**
|
|
5890
6180
|
* The arguments to pass to the Google Maps tool.
|
|
5891
6181
|
*/
|
|
@@ -5898,6 +6188,7 @@ declare type GoogleMapsCallStep = {
|
|
|
5898
6188
|
* A signature hash for backend validation.
|
|
5899
6189
|
*/
|
|
5900
6190
|
signature?: string | undefined;
|
|
6191
|
+
type: "google_maps_call";
|
|
5901
6192
|
};
|
|
5902
6193
|
|
|
5903
6194
|
declare type GoogleMapsResult$ = GoogleMapsResult;
|
|
@@ -5913,7 +6204,6 @@ declare type GoogleMapsResult = {
|
|
|
5913
6204
|
};
|
|
5914
6205
|
|
|
5915
6206
|
declare type GoogleMapsResultDelta = {
|
|
5916
|
-
type: "google_maps_result";
|
|
5917
6207
|
/**
|
|
5918
6208
|
* The results of the Google Maps.
|
|
5919
6209
|
*/
|
|
@@ -5922,13 +6212,14 @@ declare type GoogleMapsResultDelta = {
|
|
|
5922
6212
|
* A signature hash for backend validation.
|
|
5923
6213
|
*/
|
|
5924
6214
|
signature?: string | undefined;
|
|
6215
|
+
type: "google_maps_result";
|
|
5925
6216
|
};
|
|
5926
6217
|
|
|
5927
6218
|
declare type GoogleMapsResultPlaces = {
|
|
5928
|
-
place_id?: string | undefined;
|
|
5929
6219
|
name?: string | undefined;
|
|
5930
|
-
|
|
6220
|
+
place_id?: string | undefined;
|
|
5931
6221
|
review_snippets?: Array<ReviewSnippet> | undefined;
|
|
6222
|
+
url?: string | undefined;
|
|
5932
6223
|
};
|
|
5933
6224
|
|
|
5934
6225
|
declare type GoogleMapsResultStep$ = GoogleMapsResultStep;
|
|
@@ -5937,16 +6228,16 @@ declare type GoogleMapsResultStep$ = GoogleMapsResultStep;
|
|
|
5937
6228
|
* Google Maps result step.
|
|
5938
6229
|
*/
|
|
5939
6230
|
declare type GoogleMapsResultStep = {
|
|
5940
|
-
type: "google_maps_result";
|
|
5941
|
-
result: Array<GoogleMapsResult>;
|
|
5942
6231
|
/**
|
|
5943
6232
|
* Required. ID to match the ID from the function call block.
|
|
5944
6233
|
*/
|
|
5945
6234
|
call_id: string;
|
|
6235
|
+
result: Array<GoogleMapsResult>;
|
|
5946
6236
|
/**
|
|
5947
6237
|
* A signature hash for backend validation.
|
|
5948
6238
|
*/
|
|
5949
6239
|
signature?: string | undefined;
|
|
6240
|
+
type: "google_maps_result";
|
|
5950
6241
|
};
|
|
5951
6242
|
|
|
5952
6243
|
/** 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. */
|
|
@@ -5977,11 +6268,11 @@ export declare interface GoogleSearch {
|
|
|
5977
6268
|
* A tool that can be used by the model to search Google.
|
|
5978
6269
|
*/
|
|
5979
6270
|
declare type GoogleSearch_2 = {
|
|
5980
|
-
type: "google_search";
|
|
5981
6271
|
/**
|
|
5982
6272
|
* The types of search grounding to enable.
|
|
5983
6273
|
*/
|
|
5984
6274
|
search_types?: Array<GoogleSearchSearchType> | undefined;
|
|
6275
|
+
type: "google_search";
|
|
5985
6276
|
};
|
|
5986
6277
|
|
|
5987
6278
|
declare type GoogleSearchCall$ = GoogleSearchCallDelta;
|
|
@@ -6006,7 +6297,6 @@ declare type GoogleSearchCallArguments = {
|
|
|
6006
6297
|
};
|
|
6007
6298
|
|
|
6008
6299
|
declare type GoogleSearchCallDelta = {
|
|
6009
|
-
type: "google_search_call";
|
|
6010
6300
|
/**
|
|
6011
6301
|
* The arguments to pass to Google Search.
|
|
6012
6302
|
*/
|
|
@@ -6015,6 +6305,7 @@ declare type GoogleSearchCallDelta = {
|
|
|
6015
6305
|
* A signature hash for backend validation.
|
|
6016
6306
|
*/
|
|
6017
6307
|
signature?: string | undefined;
|
|
6308
|
+
type: "google_search_call";
|
|
6018
6309
|
};
|
|
6019
6310
|
|
|
6020
6311
|
declare type GoogleSearchCallStep$ = GoogleSearchCallStep;
|
|
@@ -6023,23 +6314,23 @@ declare type GoogleSearchCallStep$ = GoogleSearchCallStep;
|
|
|
6023
6314
|
* Google Search call step.
|
|
6024
6315
|
*/
|
|
6025
6316
|
declare type GoogleSearchCallStep = {
|
|
6026
|
-
type: "google_search_call";
|
|
6027
6317
|
/**
|
|
6028
6318
|
* The arguments to pass to Google Search.
|
|
6029
6319
|
*/
|
|
6030
6320
|
arguments: GoogleSearchCallArguments;
|
|
6031
|
-
/**
|
|
6032
|
-
* The type of search grounding enabled.
|
|
6033
|
-
*/
|
|
6034
|
-
search_type?: GoogleSearchCallStepSearchType | undefined;
|
|
6035
6321
|
/**
|
|
6036
6322
|
* Required. A unique ID for this specific tool call.
|
|
6037
6323
|
*/
|
|
6038
6324
|
id: string;
|
|
6325
|
+
/**
|
|
6326
|
+
* The type of search grounding enabled.
|
|
6327
|
+
*/
|
|
6328
|
+
search_type?: GoogleSearchCallStepSearchType | undefined;
|
|
6039
6329
|
/**
|
|
6040
6330
|
* A signature hash for backend validation.
|
|
6041
6331
|
*/
|
|
6042
6332
|
signature?: string | undefined;
|
|
6333
|
+
type: "google_search_call";
|
|
6043
6334
|
};
|
|
6044
6335
|
|
|
6045
6336
|
/**
|
|
@@ -6069,13 +6360,13 @@ declare type GoogleSearchResult = {
|
|
|
6069
6360
|
};
|
|
6070
6361
|
|
|
6071
6362
|
declare type GoogleSearchResultDelta = {
|
|
6072
|
-
type: "google_search_result";
|
|
6073
|
-
result: Array<GoogleSearchResult>;
|
|
6074
6363
|
is_error?: boolean | undefined;
|
|
6364
|
+
result: Array<GoogleSearchResult>;
|
|
6075
6365
|
/**
|
|
6076
6366
|
* A signature hash for backend validation.
|
|
6077
6367
|
*/
|
|
6078
6368
|
signature?: string | undefined;
|
|
6369
|
+
type: "google_search_result";
|
|
6079
6370
|
};
|
|
6080
6371
|
|
|
6081
6372
|
declare type GoogleSearchResultStep$ = GoogleSearchResultStep;
|
|
@@ -6084,23 +6375,23 @@ declare type GoogleSearchResultStep$ = GoogleSearchResultStep;
|
|
|
6084
6375
|
* Google Search result step.
|
|
6085
6376
|
*/
|
|
6086
6377
|
declare type GoogleSearchResultStep = {
|
|
6087
|
-
type: "google_search_result";
|
|
6088
6378
|
/**
|
|
6089
|
-
* Required.
|
|
6379
|
+
* Required. ID to match the ID from the function call block.
|
|
6090
6380
|
*/
|
|
6091
|
-
|
|
6381
|
+
call_id: string;
|
|
6092
6382
|
/**
|
|
6093
6383
|
* Whether the Google Search resulted in an error.
|
|
6094
6384
|
*/
|
|
6095
6385
|
is_error?: boolean | undefined;
|
|
6096
6386
|
/**
|
|
6097
|
-
* Required.
|
|
6387
|
+
* Required. The results of the Google Search.
|
|
6098
6388
|
*/
|
|
6099
|
-
|
|
6389
|
+
result: Array<GoogleSearchResult>;
|
|
6100
6390
|
/**
|
|
6101
6391
|
* A signature hash for backend validation.
|
|
6102
6392
|
*/
|
|
6103
6393
|
signature?: string | undefined;
|
|
6394
|
+
type: "google_search_result";
|
|
6104
6395
|
};
|
|
6105
6396
|
|
|
6106
6397
|
/** Tool to retrieve public web data for grounding, powered by Google. */
|
|
@@ -6303,7 +6594,7 @@ export declare interface GroundingMetadata {
|
|
|
6303
6594
|
searchEntryPoint?: SearchEntryPoint;
|
|
6304
6595
|
/** Web search queries for the following-up web search. */
|
|
6305
6596
|
webSearchQueries?: string[];
|
|
6306
|
-
/** 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. */
|
|
6597
|
+
/** 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. */
|
|
6307
6598
|
googleMapsWidgetContextToken?: string;
|
|
6308
6599
|
/** 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. */
|
|
6309
6600
|
retrievalQueries?: string[];
|
|
@@ -6343,14 +6634,14 @@ declare type GroundingToolCount$ = GroundingToolCount;
|
|
|
6343
6634
|
* The number of grounding tool counts.
|
|
6344
6635
|
*/
|
|
6345
6636
|
declare type GroundingToolCount = {
|
|
6346
|
-
/**
|
|
6347
|
-
* The grounding tool type associated with the count.
|
|
6348
|
-
*/
|
|
6349
|
-
type?: GroundingToolCountType | undefined;
|
|
6350
6637
|
/**
|
|
6351
6638
|
* The number of grounding tool counts.
|
|
6352
6639
|
*/
|
|
6353
6640
|
count?: number | undefined;
|
|
6641
|
+
/**
|
|
6642
|
+
* The grounding tool type associated with the count.
|
|
6643
|
+
*/
|
|
6644
|
+
type?: GroundingToolCountType | undefined;
|
|
6354
6645
|
};
|
|
6355
6646
|
|
|
6356
6647
|
/**
|
|
@@ -6409,6 +6700,8 @@ export declare enum HarmBlockThreshold {
|
|
|
6409
6700
|
OFF = "OFF"
|
|
6410
6701
|
}
|
|
6411
6702
|
|
|
6703
|
+
declare type HarmCategory$ = HarmCategory_2;
|
|
6704
|
+
|
|
6412
6705
|
/** The harm category to be blocked. */
|
|
6413
6706
|
export declare enum HarmCategory {
|
|
6414
6707
|
/**
|
|
@@ -6457,6 +6750,15 @@ export declare enum HarmCategory {
|
|
|
6457
6750
|
HARM_CATEGORY_JAILBREAK = "HARM_CATEGORY_JAILBREAK"
|
|
6458
6751
|
}
|
|
6459
6752
|
|
|
6753
|
+
/**
|
|
6754
|
+
* @license
|
|
6755
|
+
* Copyright 2026 Google LLC
|
|
6756
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
6757
|
+
*
|
|
6758
|
+
* g3-prettier-ignore-file
|
|
6759
|
+
*/
|
|
6760
|
+
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 & {});
|
|
6761
|
+
|
|
6460
6762
|
/** Output only. The probability of harm for this category. */
|
|
6461
6763
|
export declare enum HarmProbability {
|
|
6462
6764
|
/**
|
|
@@ -6505,6 +6807,16 @@ export declare enum HarmSeverity {
|
|
|
6505
6807
|
HARM_SEVERITY_HIGH = "HARM_SEVERITY_HIGH"
|
|
6506
6808
|
}
|
|
6507
6809
|
|
|
6810
|
+
/** Configuration for history exchange between client and server. */
|
|
6811
|
+
export declare interface HistoryConfig {
|
|
6812
|
+
/** If true, after sending `setup_complete`, the server will wait
|
|
6813
|
+
and at first process `client_content` messages until `turn_complete` is
|
|
6814
|
+
`true`. This initial history will not trigger a model call and
|
|
6815
|
+
may end with model content. After `turn_complete` is `true`, the client
|
|
6816
|
+
can start the realtime conversation via `realtime_input`. */
|
|
6817
|
+
initialHistoryInClientContent?: boolean;
|
|
6818
|
+
}
|
|
6819
|
+
|
|
6508
6820
|
/** The location of the API key. This enum is not supported in Gemini API. */
|
|
6509
6821
|
export declare enum HttpElementLocation {
|
|
6510
6822
|
HTTP_IN_UNSPECIFIED = "HTTP_IN_UNSPECIFIED",
|
|
@@ -6716,20 +7028,20 @@ declare type ImageContent$ = ImageContent;
|
|
|
6716
7028
|
* An image content block.
|
|
6717
7029
|
*/
|
|
6718
7030
|
declare type ImageContent = {
|
|
6719
|
-
type: "image";
|
|
6720
7031
|
/**
|
|
6721
7032
|
* The image content.
|
|
6722
7033
|
*/
|
|
6723
7034
|
data?: string | undefined;
|
|
6724
|
-
/**
|
|
6725
|
-
* The URI of the image.
|
|
6726
|
-
*/
|
|
6727
|
-
uri?: string | undefined;
|
|
6728
7035
|
/**
|
|
6729
7036
|
* The mime type of the image.
|
|
6730
7037
|
*/
|
|
6731
7038
|
mime_type?: ImageContentMimeType | undefined;
|
|
6732
7039
|
resolution?: MediaResolution_2 | undefined;
|
|
7040
|
+
type: "image";
|
|
7041
|
+
/**
|
|
7042
|
+
* The URI of the image.
|
|
7043
|
+
*/
|
|
7044
|
+
uri?: string | undefined;
|
|
6733
7045
|
};
|
|
6734
7046
|
|
|
6735
7047
|
/**
|
|
@@ -6738,11 +7050,11 @@ declare type ImageContent = {
|
|
|
6738
7050
|
declare type ImageContentMimeType = "image/png" | "image/jpeg" | "image/webp" | "image/heic" | "image/heif" | "image/gif" | "image/bmp" | "image/tiff" | (string & {});
|
|
6739
7051
|
|
|
6740
7052
|
declare type ImageDelta = {
|
|
6741
|
-
type: "image";
|
|
6742
7053
|
data?: string | undefined;
|
|
6743
|
-
uri?: string | undefined;
|
|
6744
7054
|
mime_type?: ImageDeltaMimeType | undefined;
|
|
6745
7055
|
resolution?: MediaResolution_2 | undefined;
|
|
7056
|
+
type: "image";
|
|
7057
|
+
uri?: string | undefined;
|
|
6746
7058
|
};
|
|
6747
7059
|
|
|
6748
7060
|
declare type ImageDeltaMimeType = "image/png" | "image/jpeg" | "image/webp" | "image/heic" | "image/heif" | "image/gif" | "image/bmp" | "image/tiff" | (string & {});
|
|
@@ -6797,31 +7109,50 @@ export declare enum ImageResizeMode {
|
|
|
6797
7109
|
PAD = "PAD"
|
|
6798
7110
|
}
|
|
6799
7111
|
|
|
6800
|
-
declare type ImageResponseFormat$ =
|
|
7112
|
+
declare type ImageResponseFormat$ = ImageResponseFormat_2;
|
|
7113
|
+
|
|
7114
|
+
/** Configuration for image-specific output formatting. */
|
|
7115
|
+
export declare class ImageResponseFormat {
|
|
7116
|
+
/** Optional. The aspect ratio for the image output. */
|
|
7117
|
+
aspectRatio?: AspectRatio;
|
|
7118
|
+
/** Optional. Delivery mode for the generated content. */
|
|
7119
|
+
delivery?: Delivery;
|
|
7120
|
+
/** Optional. The size of the image output. */
|
|
7121
|
+
imageSize?: ImageSize;
|
|
7122
|
+
/** Optional. The MIME type of the image output. */
|
|
7123
|
+
mimeType?: string;
|
|
7124
|
+
}
|
|
6801
7125
|
|
|
6802
7126
|
/**
|
|
6803
7127
|
* Configuration for image output format.
|
|
6804
7128
|
*/
|
|
6805
|
-
declare type
|
|
6806
|
-
type: "image";
|
|
7129
|
+
declare type ImageResponseFormat_2 = {
|
|
6807
7130
|
/**
|
|
6808
|
-
* The
|
|
7131
|
+
* The aspect ratio for the image output.
|
|
6809
7132
|
*/
|
|
6810
|
-
|
|
7133
|
+
aspect_ratio?: ImageResponseFormatAspectRatio | undefined;
|
|
6811
7134
|
/**
|
|
6812
7135
|
* The delivery mode for the image output.
|
|
6813
7136
|
*/
|
|
6814
7137
|
delivery?: ImageResponseFormatDelivery | undefined;
|
|
6815
|
-
/**
|
|
6816
|
-
* The aspect ratio for the image output.
|
|
6817
|
-
*/
|
|
6818
|
-
aspect_ratio?: ImageResponseFormatAspectRatio | undefined;
|
|
6819
7138
|
/**
|
|
6820
7139
|
* The size of the image output.
|
|
6821
7140
|
*/
|
|
6822
7141
|
image_size?: ImageResponseFormatImageSize | undefined;
|
|
7142
|
+
/**
|
|
7143
|
+
* The MIME type of the image output.
|
|
7144
|
+
*/
|
|
7145
|
+
mime_type?: ImageResponseFormatMimeType | undefined;
|
|
7146
|
+
type: "image";
|
|
6823
7147
|
};
|
|
6824
7148
|
|
|
7149
|
+
/**
|
|
7150
|
+
* @license
|
|
7151
|
+
* Copyright 2026 Google LLC
|
|
7152
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
7153
|
+
*
|
|
7154
|
+
* g3-prettier-ignore-file
|
|
7155
|
+
*/
|
|
6825
7156
|
/**
|
|
6826
7157
|
* The aspect ratio for the image output.
|
|
6827
7158
|
*/
|
|
@@ -6837,13 +7168,6 @@ declare type ImageResponseFormatDelivery = "inline" | "uri" | (string & {});
|
|
|
6837
7168
|
*/
|
|
6838
7169
|
declare type ImageResponseFormatImageSize = "512" | "1K" | "2K" | "4K" | (string & {});
|
|
6839
7170
|
|
|
6840
|
-
/**
|
|
6841
|
-
* @license
|
|
6842
|
-
* Copyright 2026 Google LLC
|
|
6843
|
-
* SPDX-License-Identifier: Apache-2.0
|
|
6844
|
-
*
|
|
6845
|
-
* g3-prettier-ignore-file
|
|
6846
|
-
*/
|
|
6847
7171
|
/**
|
|
6848
7172
|
* The MIME type of the image output.
|
|
6849
7173
|
*/
|
|
@@ -6853,6 +7177,30 @@ declare type ImageResponseFormatMimeType = "image/jpeg";
|
|
|
6853
7177
|
export declare interface ImageSearch {
|
|
6854
7178
|
}
|
|
6855
7179
|
|
|
7180
|
+
/** The size of the image output. */
|
|
7181
|
+
export declare enum ImageSize {
|
|
7182
|
+
/**
|
|
7183
|
+
* Default value. This value is unused.
|
|
7184
|
+
*/
|
|
7185
|
+
IMAGE_SIZE_UNSPECIFIED = "IMAGE_SIZE_UNSPECIFIED",
|
|
7186
|
+
/**
|
|
7187
|
+
* 512px image size.
|
|
7188
|
+
*/
|
|
7189
|
+
IMAGE_SIZE_FIVE_TWELVE = "IMAGE_SIZE_FIVE_TWELVE",
|
|
7190
|
+
/**
|
|
7191
|
+
* 1K image size.
|
|
7192
|
+
*/
|
|
7193
|
+
IMAGE_SIZE_ONE_K = "IMAGE_SIZE_ONE_K",
|
|
7194
|
+
/**
|
|
7195
|
+
* 2K image size.
|
|
7196
|
+
*/
|
|
7197
|
+
IMAGE_SIZE_TWO_K = "IMAGE_SIZE_TWO_K",
|
|
7198
|
+
/**
|
|
7199
|
+
* 4K image size.
|
|
7200
|
+
*/
|
|
7201
|
+
IMAGE_SIZE_FOUR_K = "IMAGE_SIZE_FOUR_K"
|
|
7202
|
+
}
|
|
7203
|
+
|
|
6856
7204
|
/** Optional parameters for importing a file. */
|
|
6857
7205
|
export declare interface ImportFileConfig {
|
|
6858
7206
|
/** Used to override HTTP request options. */
|
|
@@ -7030,7 +7378,7 @@ declare type Interaction = {
|
|
|
7030
7378
|
/**
|
|
7031
7379
|
* Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
|
|
7032
7380
|
*/
|
|
7033
|
-
response_format?: Array<
|
|
7381
|
+
response_format?: Array<ResponseFormat_2> | ResponseFormat_2 | undefined;
|
|
7034
7382
|
/**
|
|
7035
7383
|
* The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.
|
|
7036
7384
|
*/
|
|
@@ -7040,19 +7388,19 @@ declare type Interaction = {
|
|
|
7040
7388
|
*/
|
|
7041
7389
|
generation_config?: GenerationConfig_2 | undefined;
|
|
7042
7390
|
/**
|
|
7043
|
-
*
|
|
7044
|
-
*
|
|
7045
|
-
* @remarks
|
|
7046
|
-
* Note: only used in explicit caching, where users can have control over
|
|
7047
|
-
* caching (e.g. what content to cache) and enjoy guaranteed cost savings.
|
|
7048
|
-
* Format:
|
|
7049
|
-
* `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
|
|
7391
|
+
* Configuration parameters for the agent interaction.
|
|
7050
7392
|
*/
|
|
7051
|
-
|
|
7393
|
+
agent_config?: DynamicAgentConfig | DeepResearchAgentConfig | CodeMenderAgentConfig | AntigravityAgentConfig | undefined;
|
|
7052
7394
|
/**
|
|
7053
|
-
*
|
|
7395
|
+
* Safety settings for the interaction.
|
|
7054
7396
|
*/
|
|
7055
|
-
|
|
7397
|
+
safety_settings?: Array<SafetySetting_2> | undefined;
|
|
7398
|
+
/**
|
|
7399
|
+
* The labels with user-defined metadata for the request.
|
|
7400
|
+
*/
|
|
7401
|
+
labels?: {
|
|
7402
|
+
[k: string]: string;
|
|
7403
|
+
} | undefined;
|
|
7056
7404
|
/**
|
|
7057
7405
|
* The input for the interaction.
|
|
7058
7406
|
*/
|
|
@@ -7079,10 +7427,15 @@ declare type Interaction = {
|
|
|
7079
7427
|
output_video?: VideoContent | undefined;
|
|
7080
7428
|
};
|
|
7081
7429
|
|
|
7430
|
+
/**
|
|
7431
|
+
* Required. The interaction request template to be executed.
|
|
7432
|
+
*/
|
|
7433
|
+
declare type Interaction_2 = interactions.CreateAgentInteraction | interactions.CreateModelInteraction;
|
|
7434
|
+
|
|
7082
7435
|
/**
|
|
7083
7436
|
* Configuration parameters for the agent interaction.
|
|
7084
7437
|
*/
|
|
7085
|
-
declare type InteractionAgentConfig = DynamicAgentConfig | DeepResearchAgentConfig;
|
|
7438
|
+
declare type InteractionAgentConfig = DynamicAgentConfig | DeepResearchAgentConfig | CodeMenderAgentConfig | AntigravityAgentConfig;
|
|
7086
7439
|
|
|
7087
7440
|
declare type InteractionCancelParams$ = CancelInteractionByIdParams;
|
|
7088
7441
|
|
|
@@ -7166,17 +7519,20 @@ declare type InteractionGetParamsStreaming = GetInteractionByIdParamsStreaming;
|
|
|
7166
7519
|
/**
|
|
7167
7520
|
* Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
|
|
7168
7521
|
*/
|
|
7169
|
-
declare type InteractionResponseFormat = Array<
|
|
7522
|
+
declare type InteractionResponseFormat = Array<ResponseFormat_2> | ResponseFormat_2;
|
|
7170
7523
|
|
|
7171
7524
|
export declare namespace Interactions {
|
|
7172
7525
|
export type AllowedTools = AllowedTools$;
|
|
7173
7526
|
export type Annotation = Annotation$;
|
|
7527
|
+
export type AntigravityAgentConfig = AntigravityAgentConfig$;
|
|
7174
7528
|
export type AudioContent = AudioContent$;
|
|
7175
7529
|
export type AudioResponseFormat = AudioResponseFormat$;
|
|
7176
7530
|
export type CodeExecutionCallArguments = CodeExecutionCallArguments$;
|
|
7177
7531
|
export interface CodeExecutionCallStep extends CodeExecutionCallStep$ {
|
|
7178
7532
|
}
|
|
7179
7533
|
export type CodeExecutionResultStep = CodeExecutionResultStep$;
|
|
7534
|
+
export interface CodeMenderAgentConfig extends CodeMenderAgentConfig$ {
|
|
7535
|
+
}
|
|
7180
7536
|
export type Content = Content$;
|
|
7181
7537
|
export type CreateAgentInteractionParamsNonStreaming = CreateAgentInteractionParamsNonStreaming$;
|
|
7182
7538
|
export type CreateAgentInteractionParamsStreaming = CreateAgentInteractionParamsStreaming$;
|
|
@@ -7209,6 +7565,7 @@ export declare namespace Interactions {
|
|
|
7209
7565
|
export type GoogleSearchResult = GoogleSearchResult$;
|
|
7210
7566
|
export interface GoogleSearchResultStep extends GoogleSearchResultStep$ {
|
|
7211
7567
|
}
|
|
7568
|
+
export type HarmCategory = HarmCategory$;
|
|
7212
7569
|
export type ImageConfig = ImageConfig$;
|
|
7213
7570
|
export type ImageContent = ImageContent$;
|
|
7214
7571
|
export type ImageResponseFormat = ImageResponseFormat$;
|
|
@@ -7234,6 +7591,11 @@ export declare namespace Interactions {
|
|
|
7234
7591
|
}
|
|
7235
7592
|
export interface PlaceCitation extends PlaceCitation$ {
|
|
7236
7593
|
}
|
|
7594
|
+
export type RetrievalCallArguments = RetrievalCallArguments$;
|
|
7595
|
+
export interface RetrievalCallDelta extends RetrievalCallDelta$ {
|
|
7596
|
+
}
|
|
7597
|
+
export type RetrievalResultDelta = RetrievalResultDelta$;
|
|
7598
|
+
export type SafetySetting = SafetySetting$;
|
|
7237
7599
|
export type SpeechConfig = SpeechConfig$;
|
|
7238
7600
|
export type Step = Step$;
|
|
7239
7601
|
export interface StepDelta extends StepDelta$ {
|
|
@@ -7266,13 +7628,22 @@ export declare namespace Interactions {
|
|
|
7266
7628
|
export namespace CodeExecutionCallStep {
|
|
7267
7629
|
export type Arguments = Arguments$;
|
|
7268
7630
|
}
|
|
7269
|
-
export namespace
|
|
7270
|
-
export interface
|
|
7631
|
+
export namespace CodeMenderAgentConfig {
|
|
7632
|
+
export interface FindRequest extends FindRequest$ {
|
|
7271
7633
|
}
|
|
7272
|
-
export
|
|
7273
|
-
|
|
7274
|
-
|
|
7634
|
+
export interface FixRequest extends FixRequest$ {
|
|
7635
|
+
}
|
|
7636
|
+
export type SessionConfig = SessionConfig$;
|
|
7637
|
+
export namespace FindRequest {
|
|
7638
|
+
export type SourceFile = SourceFile$;
|
|
7275
7639
|
}
|
|
7640
|
+
export namespace FixRequest {
|
|
7641
|
+
export type SourceFile = SourceFile$2;
|
|
7642
|
+
}
|
|
7643
|
+
}
|
|
7644
|
+
export namespace Environment {
|
|
7645
|
+
export type Allowlist = Allowlist$;
|
|
7646
|
+
export type Source = Source$;
|
|
7276
7647
|
}
|
|
7277
7648
|
export namespace ErrorEvent {
|
|
7278
7649
|
export type Error = Error$;
|
|
@@ -7324,6 +7695,9 @@ export declare namespace Interactions {
|
|
|
7324
7695
|
export namespace PlaceCitation {
|
|
7325
7696
|
export type ReviewSnippet = ReviewSnippet$3;
|
|
7326
7697
|
}
|
|
7698
|
+
export namespace RetrievalCallDelta {
|
|
7699
|
+
export type Arguments = Arguments$4;
|
|
7700
|
+
}
|
|
7327
7701
|
export namespace StepDelta {
|
|
7328
7702
|
export type ArgumentsDelta = ArgumentsDelta$;
|
|
7329
7703
|
export type Audio = Audio$;
|
|
@@ -7370,7 +7744,7 @@ export declare namespace Interactions {
|
|
|
7370
7744
|
}
|
|
7371
7745
|
}
|
|
7372
7746
|
export namespace URLContextCallStep {
|
|
7373
|
-
export type Arguments = Arguments$
|
|
7747
|
+
export type Arguments = Arguments$5;
|
|
7374
7748
|
}
|
|
7375
7749
|
export namespace URLContextResultStep {
|
|
7376
7750
|
export type Result = Result$3;
|
|
@@ -7388,16 +7762,18 @@ declare namespace interactions {
|
|
|
7388
7762
|
export {
|
|
7389
7763
|
AgentOption,
|
|
7390
7764
|
AllowedTools,
|
|
7765
|
+
Transform,
|
|
7391
7766
|
AllowlistEntry,
|
|
7392
7767
|
Annotation,
|
|
7768
|
+
AntigravityAgentConfig,
|
|
7393
7769
|
ArgumentsDelta,
|
|
7394
7770
|
AudioContentMimeType,
|
|
7395
7771
|
AudioContent,
|
|
7396
7772
|
AudioDeltaMimeType,
|
|
7397
7773
|
AudioDelta,
|
|
7398
|
-
AudioResponseFormatMimeType,
|
|
7399
7774
|
AudioResponseFormatDelivery,
|
|
7400
|
-
|
|
7775
|
+
AudioResponseFormatMimeType,
|
|
7776
|
+
AudioResponseFormat_2 as AudioResponseFormat,
|
|
7401
7777
|
Language_2 as Language,
|
|
7402
7778
|
CodeExecutionCallArguments,
|
|
7403
7779
|
CodeExecutionCallDelta,
|
|
@@ -7405,8 +7781,9 @@ declare namespace interactions {
|
|
|
7405
7781
|
CodeExecutionResultDelta,
|
|
7406
7782
|
CodeExecutionResultStep,
|
|
7407
7783
|
CodeExecution,
|
|
7408
|
-
|
|
7784
|
+
CodeMenderAgentConfig,
|
|
7409
7785
|
DisabledSafetyPolicy,
|
|
7786
|
+
EnvironmentEnum,
|
|
7410
7787
|
ComputerUse_2 as ComputerUse,
|
|
7411
7788
|
Content_2 as Content,
|
|
7412
7789
|
CreateAgentInteractionResponseFormat,
|
|
@@ -7434,6 +7811,7 @@ declare namespace interactions {
|
|
|
7434
7811
|
ErrorT,
|
|
7435
7812
|
ExaAISearchConfig,
|
|
7436
7813
|
FileCitation,
|
|
7814
|
+
FileContent,
|
|
7437
7815
|
FileSearchCallDelta,
|
|
7438
7816
|
FileSearchCallStep,
|
|
7439
7817
|
FileSearchResultDelta,
|
|
@@ -7441,6 +7819,9 @@ declare namespace interactions {
|
|
|
7441
7819
|
FileSearchResult,
|
|
7442
7820
|
FileSearch_2 as FileSearch,
|
|
7443
7821
|
Filter,
|
|
7822
|
+
Mode,
|
|
7823
|
+
FindRequest,
|
|
7824
|
+
FixRequest,
|
|
7444
7825
|
FunctionCallStep,
|
|
7445
7826
|
FunctionResultDeltaResult,
|
|
7446
7827
|
FunctionResultDeltaResultUnion,
|
|
@@ -7471,6 +7852,7 @@ declare namespace interactions {
|
|
|
7471
7852
|
GoogleSearch_2 as GoogleSearch,
|
|
7472
7853
|
GroundingToolCountType,
|
|
7473
7854
|
GroundingToolCount,
|
|
7855
|
+
HarmCategory_2 as HarmCategory,
|
|
7474
7856
|
HybridSearch,
|
|
7475
7857
|
ImageConfigAspectRatio,
|
|
7476
7858
|
ImageConfigImageSize,
|
|
@@ -7479,11 +7861,11 @@ declare namespace interactions {
|
|
|
7479
7861
|
ImageContent,
|
|
7480
7862
|
ImageDeltaMimeType,
|
|
7481
7863
|
ImageDelta,
|
|
7482
|
-
ImageResponseFormatMimeType,
|
|
7483
|
-
ImageResponseFormatDelivery,
|
|
7484
7864
|
ImageResponseFormatAspectRatio,
|
|
7865
|
+
ImageResponseFormatDelivery,
|
|
7485
7866
|
ImageResponseFormatImageSize,
|
|
7486
|
-
|
|
7867
|
+
ImageResponseFormatMimeType,
|
|
7868
|
+
ImageResponseFormat_2 as ImageResponseFormat,
|
|
7487
7869
|
InteractionCompletedEvent,
|
|
7488
7870
|
InteractionCreatedEvent,
|
|
7489
7871
|
InteractionSseEventInteractionStatus,
|
|
@@ -7517,12 +7899,20 @@ declare namespace interactions {
|
|
|
7517
7899
|
RagRetrievalConfig_2 as RagRetrievalConfig,
|
|
7518
7900
|
RagStoreConfig,
|
|
7519
7901
|
Ranking,
|
|
7520
|
-
ResponseFormat,
|
|
7902
|
+
ResponseFormat_2 as ResponseFormat,
|
|
7521
7903
|
ResponseModality,
|
|
7522
|
-
|
|
7904
|
+
RetrievalCallArguments,
|
|
7905
|
+
RetrievalCallDeltaRetrievalType,
|
|
7906
|
+
RetrievalCallDelta,
|
|
7907
|
+
RetrievalResultDelta,
|
|
7908
|
+
RetrievalRetrievalType,
|
|
7523
7909
|
Retrieval_2 as Retrieval,
|
|
7524
7910
|
ReviewSnippet,
|
|
7911
|
+
Method,
|
|
7912
|
+
Threshold,
|
|
7913
|
+
SafetySetting_2 as SafetySetting,
|
|
7525
7914
|
ServiceTier_2 as ServiceTier,
|
|
7915
|
+
SessionConfig,
|
|
7526
7916
|
SourceType,
|
|
7527
7917
|
Source,
|
|
7528
7918
|
SpeechConfig_2 as SpeechConfig,
|
|
@@ -7538,7 +7928,7 @@ declare namespace interactions {
|
|
|
7538
7928
|
TextContent,
|
|
7539
7929
|
TextDelta,
|
|
7540
7930
|
TextResponseFormatMimeType,
|
|
7541
|
-
TextResponseFormat,
|
|
7931
|
+
TextResponseFormat_2 as TextResponseFormat,
|
|
7542
7932
|
ThinkingLevel_2 as ThinkingLevel,
|
|
7543
7933
|
ThinkingSummaries,
|
|
7544
7934
|
ThoughtSignatureDelta,
|
|
@@ -7553,7 +7943,6 @@ declare namespace interactions {
|
|
|
7553
7943
|
URLCitation,
|
|
7554
7944
|
URLContextCallArguments,
|
|
7555
7945
|
URLContextCallDelta,
|
|
7556
|
-
Arguments,
|
|
7557
7946
|
URLContextCallStep,
|
|
7558
7947
|
URLContextResultDelta,
|
|
7559
7948
|
URLContextResultStep,
|
|
@@ -7569,9 +7958,9 @@ declare namespace interactions {
|
|
|
7569
7958
|
VideoContent,
|
|
7570
7959
|
VideoDeltaMimeType,
|
|
7571
7960
|
VideoDelta,
|
|
7572
|
-
VideoResponseFormatDelivery,
|
|
7573
7961
|
VideoResponseFormatAspectRatio,
|
|
7574
|
-
|
|
7962
|
+
VideoResponseFormatDelivery,
|
|
7963
|
+
VideoResponseFormat_2 as VideoResponseFormat,
|
|
7575
7964
|
WebhookConfig_2 as WebhookConfig
|
|
7576
7965
|
}
|
|
7577
7966
|
}
|
|
@@ -7649,9 +8038,6 @@ declare type InteractionStatus = "in_progress" | "requires_action" | "completed"
|
|
|
7649
8038
|
declare type InteractionStatusUpdate$ = InteractionStatusUpdate;
|
|
7650
8039
|
|
|
7651
8040
|
declare type InteractionStatusUpdate = {
|
|
7652
|
-
event_type: "interaction.status_update";
|
|
7653
|
-
interaction_id: string;
|
|
7654
|
-
status: InteractionStatusUpdateStatus;
|
|
7655
8041
|
/**
|
|
7656
8042
|
* The event_id token to be used to resume the interaction stream, from
|
|
7657
8043
|
*
|
|
@@ -7659,7 +8045,10 @@ declare type InteractionStatusUpdate = {
|
|
|
7659
8045
|
* this event.
|
|
7660
8046
|
*/
|
|
7661
8047
|
event_id?: string | undefined;
|
|
8048
|
+
event_type: "interaction.status_update";
|
|
8049
|
+
interaction_id: string;
|
|
7662
8050
|
metadata?: StreamMetadata | undefined;
|
|
8051
|
+
status: InteractionStatusUpdateStatus;
|
|
7663
8052
|
};
|
|
7664
8053
|
|
|
7665
8054
|
declare type InteractionStatusUpdateStatus = "in_progress" | "requires_action" | "completed" | "failed" | "cancelled" | "incomplete" | "budget_exceeded" | (string & {});
|
|
@@ -7984,6 +8373,99 @@ export declare class ListModelsResponse {
|
|
|
7984
8373
|
models?: Model[];
|
|
7985
8374
|
}
|
|
7986
8375
|
|
|
8376
|
+
declare type ListTriggerExecutionsParams = Omit<ListTriggerExecutionsRequest, "trigger_id">;
|
|
8377
|
+
|
|
8378
|
+
declare type ListTriggerExecutionsParams_2 = {
|
|
8379
|
+
api_version?: string;
|
|
8380
|
+
pageSize?: number;
|
|
8381
|
+
pageToken?: string;
|
|
8382
|
+
};
|
|
8383
|
+
|
|
8384
|
+
declare type ListTriggerExecutionsRequest = {
|
|
8385
|
+
/**
|
|
8386
|
+
* Which version of the API to use.
|
|
8387
|
+
*/
|
|
8388
|
+
api_version?: string | undefined;
|
|
8389
|
+
/**
|
|
8390
|
+
* Resource name of the trigger.
|
|
8391
|
+
*/
|
|
8392
|
+
trigger_id: string;
|
|
8393
|
+
/**
|
|
8394
|
+
* Optional. The maximum number of executions to return per page.
|
|
8395
|
+
*/
|
|
8396
|
+
page_size?: number | undefined;
|
|
8397
|
+
/**
|
|
8398
|
+
* Optional. A page token from a previous ListTriggerExecutions call.
|
|
8399
|
+
*/
|
|
8400
|
+
page_token?: string | undefined;
|
|
8401
|
+
};
|
|
8402
|
+
|
|
8403
|
+
declare type ListTriggerExecutionsResponse$ = ListTriggerExecutionsResponse;
|
|
8404
|
+
|
|
8405
|
+
/**
|
|
8406
|
+
* Response message for TriggerService.ListTriggerExecutions.
|
|
8407
|
+
*/
|
|
8408
|
+
declare type ListTriggerExecutionsResponse = {
|
|
8409
|
+
/**
|
|
8410
|
+
* A page token, received from a previous `ListTriggerExecutions` call.
|
|
8411
|
+
*
|
|
8412
|
+
* @remarks
|
|
8413
|
+
* Provide this to retrieve the subsequent page.
|
|
8414
|
+
*/
|
|
8415
|
+
next_page_token?: string | undefined;
|
|
8416
|
+
/**
|
|
8417
|
+
* The list of trigger executions.
|
|
8418
|
+
*/
|
|
8419
|
+
trigger_executions?: Array<TriggerExecution> | undefined;
|
|
8420
|
+
};
|
|
8421
|
+
|
|
8422
|
+
declare type ListTriggersParams = ListTriggersRequest;
|
|
8423
|
+
|
|
8424
|
+
declare type ListTriggersParams_2 = {
|
|
8425
|
+
api_version?: string;
|
|
8426
|
+
filter?: string;
|
|
8427
|
+
pageSize?: number;
|
|
8428
|
+
pageToken?: string;
|
|
8429
|
+
};
|
|
8430
|
+
|
|
8431
|
+
declare type ListTriggersRequest = {
|
|
8432
|
+
/**
|
|
8433
|
+
* Which version of the API to use.
|
|
8434
|
+
*/
|
|
8435
|
+
api_version?: string | undefined;
|
|
8436
|
+
/**
|
|
8437
|
+
* Optional. Filter expression (e.g., by state).
|
|
8438
|
+
*/
|
|
8439
|
+
filter?: string | undefined;
|
|
8440
|
+
/**
|
|
8441
|
+
* Optional. The maximum number of triggers to return per page.
|
|
8442
|
+
*/
|
|
8443
|
+
page_size?: number | undefined;
|
|
8444
|
+
/**
|
|
8445
|
+
* Optional. A page token from a previous ListTriggers call.
|
|
8446
|
+
*/
|
|
8447
|
+
page_token?: string | undefined;
|
|
8448
|
+
};
|
|
8449
|
+
|
|
8450
|
+
declare type ListTriggersResponse$ = ListTriggersResponse;
|
|
8451
|
+
|
|
8452
|
+
/**
|
|
8453
|
+
* Response message for TriggerService.ListTriggers.
|
|
8454
|
+
*/
|
|
8455
|
+
declare type ListTriggersResponse = {
|
|
8456
|
+
/**
|
|
8457
|
+
* A page token, received from a previous `ListTriggers` call.
|
|
8458
|
+
*
|
|
8459
|
+
* @remarks
|
|
8460
|
+
* Provide this to retrieve the subsequent page.
|
|
8461
|
+
*/
|
|
8462
|
+
next_page_token?: string | undefined;
|
|
8463
|
+
/**
|
|
8464
|
+
* The list of triggers.
|
|
8465
|
+
*/
|
|
8466
|
+
triggers?: Array<Trigger> | undefined;
|
|
8467
|
+
};
|
|
8468
|
+
|
|
7987
8469
|
/** Configuration for the list tuning jobs method. */
|
|
7988
8470
|
export declare interface ListTuningJobsConfig {
|
|
7989
8471
|
/** Used to override HTTP request options. */
|
|
@@ -8239,6 +8721,8 @@ export declare interface LiveClientSetup {
|
|
|
8239
8721
|
response.
|
|
8240
8722
|
*/
|
|
8241
8723
|
safetySettings?: SafetySetting[];
|
|
8724
|
+
/** Configures the exchange of history between the client and the server. */
|
|
8725
|
+
historyConfig?: HistoryConfig;
|
|
8242
8726
|
}
|
|
8243
8727
|
|
|
8244
8728
|
/** Client generated response to a `ToolCall` received from the server.
|
|
@@ -8808,6 +9292,11 @@ export declare interface LiveServerSessionResumptionUpdate {
|
|
|
8808
9292
|
export declare interface LiveServerSetupComplete {
|
|
8809
9293
|
/** The session id of the live session. */
|
|
8810
9294
|
sessionId?: string;
|
|
9295
|
+
/** Signature of the verified consent audio. This is populated when the
|
|
9296
|
+
request has a ReplicatedVoiceConfig with consent_audio set, if the consent
|
|
9297
|
+
verification was successful. This may be used in a subsequent request
|
|
9298
|
+
instead of the consent_audio to verify the same consent. */
|
|
9299
|
+
voiceConsentSignature?: VoiceConsentSignature;
|
|
8811
9300
|
}
|
|
8812
9301
|
|
|
8813
9302
|
/** Request for the client to execute the `function_calls` and return the responses with the matching `id`s. */
|
|
@@ -8896,22 +9385,22 @@ export declare enum MaskReferenceMode {
|
|
|
8896
9385
|
MASK_MODE_SEMANTIC = "MASK_MODE_SEMANTIC"
|
|
8897
9386
|
}
|
|
8898
9387
|
|
|
8899
|
-
/** Match operation to use for
|
|
9388
|
+
/** Match operation to use for evaluating rewards. This enum is not supported in Gemini API. */
|
|
8900
9389
|
export declare enum MatchOperation {
|
|
8901
9390
|
/**
|
|
8902
|
-
* Default value.
|
|
9391
|
+
* Default value. A user error will be returned if not set.
|
|
8903
9392
|
*/
|
|
8904
9393
|
MATCH_OPERATION_UNSPECIFIED = "MATCH_OPERATION_UNSPECIFIED",
|
|
8905
9394
|
/**
|
|
8906
|
-
* Equivalent to GoogleSQL `REGEX_CONTAINS(target, expression)`.
|
|
9395
|
+
* Equivalent to [GoogleSQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/string_functions#regexp_contains) `REGEX_CONTAINS(target, expression)`.
|
|
8907
9396
|
*/
|
|
8908
9397
|
REGEX_CONTAINS = "REGEX_CONTAINS",
|
|
8909
9398
|
/**
|
|
8910
|
-
* `
|
|
9399
|
+
* The match operation returns `true` if expression is a substring of the target.
|
|
8911
9400
|
*/
|
|
8912
9401
|
PARTIAL_MATCH = "PARTIAL_MATCH",
|
|
8913
9402
|
/**
|
|
8914
|
-
* `
|
|
9403
|
+
* The match operation returns `true` expression is an exact match of the target.
|
|
8915
9404
|
*/
|
|
8916
9405
|
EXACT_MATCH = "EXACT_MATCH"
|
|
8917
9406
|
}
|
|
@@ -8922,11 +9411,21 @@ declare type MCPServer$ = MCPServer;
|
|
|
8922
9411
|
* A MCPServer is a server that can be called by the model to perform actions.
|
|
8923
9412
|
*/
|
|
8924
9413
|
declare type MCPServer = {
|
|
8925
|
-
|
|
9414
|
+
/**
|
|
9415
|
+
* The allowed tools.
|
|
9416
|
+
*/
|
|
9417
|
+
allowed_tools?: Array<AllowedTools> | undefined;
|
|
9418
|
+
/**
|
|
9419
|
+
* Optional: Fields for authentication headers, timeouts, etc., if needed.
|
|
9420
|
+
*/
|
|
9421
|
+
headers?: {
|
|
9422
|
+
[k: string]: string;
|
|
9423
|
+
} | undefined;
|
|
8926
9424
|
/**
|
|
8927
9425
|
* The name of the MCPServer.
|
|
8928
9426
|
*/
|
|
8929
9427
|
name?: string | undefined;
|
|
9428
|
+
type: "mcp_server";
|
|
8930
9429
|
/**
|
|
8931
9430
|
* The full URL for the MCPServer endpoint.
|
|
8932
9431
|
*
|
|
@@ -8934,16 +9433,6 @@ declare type MCPServer = {
|
|
|
8934
9433
|
* Example: "https://api.example.com/mcp"
|
|
8935
9434
|
*/
|
|
8936
9435
|
url?: string | undefined;
|
|
8937
|
-
/**
|
|
8938
|
-
* Optional: Fields for authentication headers, timeouts, etc., if needed.
|
|
8939
|
-
*/
|
|
8940
|
-
headers?: {
|
|
8941
|
-
[k: string]: string;
|
|
8942
|
-
} | undefined;
|
|
8943
|
-
/**
|
|
8944
|
-
* The allowed tools.
|
|
8945
|
-
*/
|
|
8946
|
-
allowed_tools?: Array<AllowedTools> | undefined;
|
|
8947
9436
|
};
|
|
8948
9437
|
|
|
8949
9438
|
/** 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. */
|
|
@@ -8964,12 +9453,12 @@ declare type MCPServerToolCall$ = MCPServerToolCallDelta;
|
|
|
8964
9453
|
* g3-prettier-ignore-file
|
|
8965
9454
|
*/
|
|
8966
9455
|
declare type MCPServerToolCallDelta = {
|
|
8967
|
-
type: "mcp_server_tool_call";
|
|
8968
|
-
name: string;
|
|
8969
|
-
server_name: string;
|
|
8970
9456
|
arguments: {
|
|
8971
9457
|
[k: string]: any;
|
|
8972
9458
|
};
|
|
9459
|
+
name: string;
|
|
9460
|
+
server_name: string;
|
|
9461
|
+
type: "mcp_server_tool_call";
|
|
8973
9462
|
};
|
|
8974
9463
|
|
|
8975
9464
|
declare type MCPServerToolCallStep$ = MCPServerToolCallStep;
|
|
@@ -8985,15 +9474,6 @@ declare type MCPServerToolCallStep$ = MCPServerToolCallStep;
|
|
|
8985
9474
|
* MCPServer tool call step.
|
|
8986
9475
|
*/
|
|
8987
9476
|
declare type MCPServerToolCallStep = {
|
|
8988
|
-
type: "mcp_server_tool_call";
|
|
8989
|
-
/**
|
|
8990
|
-
* Required. The name of the tool which was called.
|
|
8991
|
-
*/
|
|
8992
|
-
name: string;
|
|
8993
|
-
/**
|
|
8994
|
-
* Required. The name of the used MCP server.
|
|
8995
|
-
*/
|
|
8996
|
-
server_name: string;
|
|
8997
9477
|
/**
|
|
8998
9478
|
* Required. The JSON object of arguments for the function.
|
|
8999
9479
|
*/
|
|
@@ -9004,15 +9484,24 @@ declare type MCPServerToolCallStep = {
|
|
|
9004
9484
|
* Required. A unique ID for this specific tool call.
|
|
9005
9485
|
*/
|
|
9006
9486
|
id: string;
|
|
9487
|
+
/**
|
|
9488
|
+
* Required. The name of the tool which was called.
|
|
9489
|
+
*/
|
|
9490
|
+
name: string;
|
|
9491
|
+
/**
|
|
9492
|
+
* Required. The name of the used MCP server.
|
|
9493
|
+
*/
|
|
9494
|
+
server_name: string;
|
|
9495
|
+
type: "mcp_server_tool_call";
|
|
9007
9496
|
};
|
|
9008
9497
|
|
|
9009
9498
|
declare type MCPServerToolResult$ = MCPServerToolResultDelta;
|
|
9010
9499
|
|
|
9011
9500
|
declare type MCPServerToolResultDelta = {
|
|
9012
|
-
type: "mcp_server_tool_result";
|
|
9013
9501
|
name?: string | undefined;
|
|
9014
|
-
server_name?: string | undefined;
|
|
9015
9502
|
result: MCPServerToolResultDeltaResult | Array<FunctionResultSubcontent> | string;
|
|
9503
|
+
server_name?: string | undefined;
|
|
9504
|
+
type: "mcp_server_tool_result";
|
|
9016
9505
|
};
|
|
9017
9506
|
|
|
9018
9507
|
declare type MCPServerToolResultDeltaResult = {};
|
|
@@ -9025,23 +9514,23 @@ declare type MCPServerToolResultStep$ = MCPServerToolResultStep;
|
|
|
9025
9514
|
* MCPServer tool result step.
|
|
9026
9515
|
*/
|
|
9027
9516
|
declare type MCPServerToolResultStep = {
|
|
9028
|
-
type: "mcp_server_tool_result";
|
|
9029
|
-
/**
|
|
9030
|
-
* Name of the tool which is called for this specific tool call.
|
|
9031
|
-
*/
|
|
9032
|
-
name?: string | undefined;
|
|
9033
|
-
/**
|
|
9034
|
-
* The name of the used MCP server.
|
|
9035
|
-
*/
|
|
9036
|
-
server_name?: string | undefined;
|
|
9037
9517
|
/**
|
|
9038
9518
|
* Required. ID to match the ID from the function call block.
|
|
9039
9519
|
*/
|
|
9040
9520
|
call_id: string;
|
|
9521
|
+
/**
|
|
9522
|
+
* Name of the tool which is called for this specific tool call.
|
|
9523
|
+
*/
|
|
9524
|
+
name?: string | undefined;
|
|
9041
9525
|
/**
|
|
9042
9526
|
* The output from the MCP server call. Can be simple text or rich content.
|
|
9043
9527
|
*/
|
|
9044
9528
|
result: MCPServerToolResultStepResult | string | Array<FunctionResultSubcontent>;
|
|
9529
|
+
/**
|
|
9530
|
+
* The name of the used MCP server.
|
|
9531
|
+
*/
|
|
9532
|
+
server_name?: string | undefined;
|
|
9533
|
+
type: "mcp_server_tool_result";
|
|
9045
9534
|
};
|
|
9046
9535
|
|
|
9047
9536
|
declare type MCPServerToolResultStepResult = {};
|
|
@@ -9134,6 +9623,14 @@ declare type Metadata$6 = StreamMetadata;
|
|
|
9134
9623
|
|
|
9135
9624
|
declare type Metadata$7 = StreamMetadata;
|
|
9136
9625
|
|
|
9626
|
+
/**
|
|
9627
|
+
* Optional. The method for blocking content. If not specified, the default
|
|
9628
|
+
*
|
|
9629
|
+
* @remarks
|
|
9630
|
+
* behavior is to use the probability score.
|
|
9631
|
+
*/
|
|
9632
|
+
declare type Method = "severity" | "probability" | (string & {});
|
|
9633
|
+
|
|
9137
9634
|
/** Server content modalities. */
|
|
9138
9635
|
export declare enum Modality {
|
|
9139
9636
|
/**
|
|
@@ -9177,6 +9674,11 @@ declare type ModalityTokens = {
|
|
|
9177
9674
|
tokens?: number | undefined;
|
|
9178
9675
|
};
|
|
9179
9676
|
|
|
9677
|
+
/**
|
|
9678
|
+
* The mode of the find session.
|
|
9679
|
+
*/
|
|
9680
|
+
declare type Mode = "scan" | "verify" | (string & {});
|
|
9681
|
+
|
|
9180
9682
|
declare type Model$ = Model_2;
|
|
9181
9683
|
|
|
9182
9684
|
/** A trained machine learning model. */
|
|
@@ -9244,7 +9746,7 @@ export declare interface Model {
|
|
|
9244
9746
|
/**
|
|
9245
9747
|
* The model that will complete your prompt.\n\nSee [models](https://ai.google.dev/gemini-api/docs/models) for additional details.
|
|
9246
9748
|
*/
|
|
9247
|
-
declare type Model_2 = "gemini-2.5-
|
|
9749
|
+
declare type Model_2 = "gemini-2.5-flash" | "gemini-2.5-pro" | "gemma-4-26b-a4b-it" | "gemma-4-31b-it" | "gemini-flash-latest" | "gemini-flash-lite-latest" | "gemini-pro-latest" | "gemini-2.5-flash-lite" | "gemini-2.5-flash-image" | "gemini-3-flash-preview" | "gemini-3.1-pro-preview" | "gemini-3.1-pro-preview-customtools" | "gemini-3.1-flash-lite" | "gemini-3-pro-image" | "nano-banana-pro-preview" | "gemini-3.1-flash-image" | "gemini-3.5-flash" | "lyria-3-clip-preview" | "lyria-3-pro-preview" | "gemini-robotics-er-1.6-preview" | (string & {});
|
|
9248
9750
|
|
|
9249
9751
|
/** Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. This data type is not supported in Gemini API. */
|
|
9250
9752
|
export declare interface ModelArmorConfig {
|
|
@@ -9260,7 +9762,6 @@ declare type ModelOutputStep$ = ModelOutputStep;
|
|
|
9260
9762
|
* Output generated by the model.
|
|
9261
9763
|
*/
|
|
9262
9764
|
declare type ModelOutputStep = {
|
|
9263
|
-
type: "model_output";
|
|
9264
9765
|
content?: Array<Content_2> | undefined;
|
|
9265
9766
|
/**
|
|
9266
9767
|
* The `Status` type defines a logical error model that is suitable for
|
|
@@ -9274,6 +9775,7 @@ declare type ModelOutputStep = {
|
|
|
9274
9775
|
* [API Design Guide](https://cloud.google.com/apis/design/errors).
|
|
9275
9776
|
*/
|
|
9276
9777
|
error?: Status | undefined;
|
|
9778
|
+
type: "model_output";
|
|
9277
9779
|
};
|
|
9278
9780
|
|
|
9279
9781
|
export declare class Models extends BaseModule {
|
|
@@ -10182,19 +10684,18 @@ declare type PlaceCitation$ = PlaceCitation;
|
|
|
10182
10684
|
* A place citation annotation.
|
|
10183
10685
|
*/
|
|
10184
10686
|
declare type PlaceCitation = {
|
|
10185
|
-
type: "place_citation";
|
|
10186
10687
|
/**
|
|
10187
|
-
*
|
|
10688
|
+
* End of the attributed segment, exclusive.
|
|
10188
10689
|
*/
|
|
10189
|
-
|
|
10690
|
+
end_index?: number | undefined;
|
|
10190
10691
|
/**
|
|
10191
10692
|
* Title of the place.
|
|
10192
10693
|
*/
|
|
10193
10694
|
name?: string | undefined;
|
|
10194
10695
|
/**
|
|
10195
|
-
*
|
|
10696
|
+
* The ID of the place, in `places/{place_id}` format.
|
|
10196
10697
|
*/
|
|
10197
|
-
|
|
10698
|
+
place_id?: string | undefined;
|
|
10198
10699
|
/**
|
|
10199
10700
|
* Snippets of reviews that are used to generate answers about the
|
|
10200
10701
|
*
|
|
@@ -10210,10 +10711,11 @@ declare type PlaceCitation = {
|
|
|
10210
10711
|
* Index indicates the start of the segment, measured in bytes.
|
|
10211
10712
|
*/
|
|
10212
10713
|
start_index?: number | undefined;
|
|
10714
|
+
type: "place_citation";
|
|
10213
10715
|
/**
|
|
10214
|
-
*
|
|
10716
|
+
* URI reference of the place.
|
|
10215
10717
|
*/
|
|
10216
|
-
|
|
10718
|
+
url?: string | undefined;
|
|
10217
10719
|
};
|
|
10218
10720
|
|
|
10219
10721
|
/** Spec for pointwise metric result. This data type is not supported in Gemini API. */
|
|
@@ -10381,21 +10883,21 @@ export declare interface RagRetrievalConfig {
|
|
|
10381
10883
|
*/
|
|
10382
10884
|
declare type RagRetrievalConfig_2 = {
|
|
10383
10885
|
/**
|
|
10384
|
-
*
|
|
10886
|
+
* Config for filters.
|
|
10385
10887
|
*/
|
|
10386
|
-
|
|
10888
|
+
filter?: Filter | undefined;
|
|
10387
10889
|
/**
|
|
10388
10890
|
* Config for Hybrid Search.
|
|
10389
10891
|
*/
|
|
10390
10892
|
hybrid_search?: HybridSearch | undefined;
|
|
10391
|
-
/**
|
|
10392
|
-
* Config for filters.
|
|
10393
|
-
*/
|
|
10394
|
-
filter?: Filter | undefined;
|
|
10395
10893
|
/**
|
|
10396
10894
|
* Config for Rank Service.
|
|
10397
10895
|
*/
|
|
10398
10896
|
ranking?: Ranking | undefined;
|
|
10897
|
+
/**
|
|
10898
|
+
* Optional. The number of contexts to retrieve.
|
|
10899
|
+
*/
|
|
10900
|
+
top_k?: number | undefined;
|
|
10399
10901
|
};
|
|
10400
10902
|
|
|
10401
10903
|
/** Config for filters. This data type is not supported in Gemini API. */
|
|
@@ -10442,6 +10944,10 @@ declare type RagStoreConfig = {
|
|
|
10442
10944
|
* Optional. The representation of the rag source.
|
|
10443
10945
|
*/
|
|
10444
10946
|
rag_resources?: Array<RagResource> | undefined;
|
|
10947
|
+
/**
|
|
10948
|
+
* Specifies the context retrieval config.
|
|
10949
|
+
*/
|
|
10950
|
+
rag_retrieval_config?: RagRetrievalConfig_2 | undefined;
|
|
10445
10951
|
/**
|
|
10446
10952
|
* Optional. Number of top k results to return from the selected corpora.
|
|
10447
10953
|
*
|
|
@@ -10454,10 +10960,6 @@ declare type RagStoreConfig = {
|
|
|
10454
10960
|
* @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
10455
10961
|
*/
|
|
10456
10962
|
vector_distance_threshold?: number | undefined;
|
|
10457
|
-
/**
|
|
10458
|
-
* Specifies the context retrieval config.
|
|
10459
|
-
*/
|
|
10460
|
-
rag_retrieval_config?: RagRetrievalConfig_2 | undefined;
|
|
10461
10963
|
};
|
|
10462
10964
|
|
|
10463
10965
|
/**
|
|
@@ -10471,11 +10973,11 @@ declare type RagStoreConfig = {
|
|
|
10471
10973
|
* Config for Rank Service.
|
|
10472
10974
|
*/
|
|
10473
10975
|
declare type Ranking = {
|
|
10474
|
-
ranking_config: "rank_service";
|
|
10475
10976
|
/**
|
|
10476
10977
|
* Optional. The model name of the rank service.
|
|
10477
10978
|
*/
|
|
10478
10979
|
model_name?: string | undefined;
|
|
10980
|
+
ranking_config: "rank_service";
|
|
10479
10981
|
};
|
|
10480
10982
|
|
|
10481
10983
|
/** Raw output. This data type is not supported in Gemini API. */
|
|
@@ -10639,39 +11141,39 @@ export declare class RegisterFilesResponse {
|
|
|
10639
11141
|
export declare interface ReinforcementTuningAutoraterScorer {
|
|
10640
11142
|
/** Autorater config for evaluation. */
|
|
10641
11143
|
autoraterConfig?: AutoraterConfig;
|
|
10642
|
-
/**
|
|
11144
|
+
/** 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}} */
|
|
10643
11145
|
autoraterPrompt?: string;
|
|
10644
|
-
/** Parses autorater returned response. */
|
|
11146
|
+
/** 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"`. */
|
|
10645
11147
|
autoraterResponseParseConfig?: ReinforcementTuningParseResponseConfig;
|
|
10646
|
-
/** Scores autorater responses by directly converting parsed autorater response to float reward. */
|
|
11148
|
+
/** 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)`. */
|
|
10647
11149
|
parsedResponseConversionScorer?: ReinforcementTuningAutoraterScorerParsedResponseConversionScorer;
|
|
10648
|
-
/** Scores autorater responses by using
|
|
11150
|
+
/** Scores autorater responses by using string match reward scorer. */
|
|
10649
11151
|
exactMatchScorer?: ReinforcementTuningAutoraterScorerExactMatchScorer;
|
|
10650
11152
|
}
|
|
10651
11153
|
|
|
10652
|
-
/** Scores autorater responses by using exact string match reward scorer. */
|
|
11154
|
+
/** Scores autorater responses by using exact string match reward scorer. This data type is not supported in Gemini API. */
|
|
10653
11155
|
export declare interface ReinforcementTuningAutoraterScorerExactMatchScorer {
|
|
10654
|
-
/** Assigns this reward score if parsed response string equals the expression. */
|
|
11156
|
+
/** Assigns this reward score if the parsed response string equals the expression. */
|
|
10655
11157
|
correctAnswerReward?: number;
|
|
10656
|
-
/** Assigns this reward score if parsed reward value does not equal the expression. */
|
|
11158
|
+
/** Assigns this reward score if the parsed reward value does not equal the expression. */
|
|
10657
11159
|
wrongAnswerReward?: number;
|
|
10658
|
-
/** The string expression to match against.
|
|
11160
|
+
/** 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`. */
|
|
10659
11161
|
expression?: string;
|
|
10660
11162
|
}
|
|
10661
11163
|
|
|
10662
|
-
/** Scores responses by directly converting parsed autorater response to float reward
|
|
11164
|
+
/** 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. */
|
|
10663
11165
|
export declare class ReinforcementTuningAutoraterScorerParsedResponseConversionScorer {
|
|
10664
11166
|
}
|
|
10665
11167
|
|
|
10666
|
-
/**
|
|
11168
|
+
/** 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. */
|
|
10667
11169
|
export declare interface ReinforcementTuningCloudRunRewardScorer {
|
|
10668
|
-
/** URI of the Cloud Run service that will be used to compute the reward. The Vertex AI Secure Fine Tuning Service Agent (`service
|
|
11170
|
+
/** 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. */
|
|
10669
11171
|
cloudRunUri?: string;
|
|
10670
11172
|
}
|
|
10671
11173
|
|
|
10672
|
-
/**
|
|
11174
|
+
/** 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. */
|
|
10673
11175
|
export declare interface ReinforcementTuningCodeExecutionRewardScorer {
|
|
10674
|
-
/**
|
|
11176
|
+
/** 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)`. */
|
|
10675
11177
|
pythonCodeSnippet?: string;
|
|
10676
11178
|
}
|
|
10677
11179
|
|
|
@@ -10681,37 +11183,39 @@ export declare interface ReinforcementTuningExample {
|
|
|
10681
11183
|
contents?: Content[];
|
|
10682
11184
|
/** References for the given prompt. The key is the name of the reference, and the value is the reference itself. */
|
|
10683
11185
|
references?: Record<string, string>;
|
|
10684
|
-
/** Corresponds to
|
|
11186
|
+
/** Corresponds to system_instruction in user-facing GenerateContentRequest. */
|
|
10685
11187
|
systemInstruction?: Content;
|
|
10686
11188
|
}
|
|
10687
11189
|
|
|
10688
11190
|
/** Hyperparameters for Reinforcement Tuning. */
|
|
10689
11191
|
export declare interface ReinforcementTuningHyperParameters {
|
|
10690
|
-
/** Number of training
|
|
11192
|
+
/** Optional. Number of training epoches for the tuning job. */
|
|
10691
11193
|
epochCount?: string;
|
|
10692
11194
|
/** Learning rate multiplier for Reinforcement Learning. */
|
|
10693
11195
|
learningRateMultiplier?: number;
|
|
10694
|
-
/** Adapter size for Reinforcement Tuning. */
|
|
11196
|
+
/** Optional. Adapter size for Reinforcement Tuning. */
|
|
10695
11197
|
adapterSize?: AdapterSize;
|
|
10696
|
-
/** Number of different responses to generate per prompt during tuning. */
|
|
11198
|
+
/** Optional. Number of different responses to generate per prompt during tuning. */
|
|
10697
11199
|
samplesPerPrompt?: number;
|
|
10698
|
-
/** 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. */
|
|
11200
|
+
/** 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. */
|
|
10699
11201
|
batchSize?: number;
|
|
10700
|
-
/** How often
|
|
11202
|
+
/** 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` */
|
|
10701
11203
|
evaluateInterval?: number;
|
|
10702
|
-
/** How often
|
|
11204
|
+
/** 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``` */
|
|
10703
11205
|
checkpointInterval?: number;
|
|
10704
|
-
/** The maximum number of tokens to generate per prompt.
|
|
11206
|
+
/** Optional. The maximum number of tokens to generate per prompt. Default to 32768. */
|
|
10705
11207
|
maxOutputTokens?: number;
|
|
10706
|
-
/** Indicates the maximum thinking depth.
|
|
11208
|
+
/** 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. */
|
|
10707
11209
|
thinkingLevel?: ReinforcementTuningThinkingLevel;
|
|
11210
|
+
/** 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). */
|
|
11211
|
+
thinkingBudget?: number;
|
|
10708
11212
|
}
|
|
10709
11213
|
|
|
10710
|
-
/** Defines how to parse sample response for reinforcement tuning. */
|
|
11214
|
+
/** 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. */
|
|
10711
11215
|
export declare class ReinforcementTuningParseResponseConfig {
|
|
10712
|
-
/** Defines
|
|
11216
|
+
/** Defines the type for parsing sample response. */
|
|
10713
11217
|
parseType?: ResponseParseType;
|
|
10714
|
-
/** Defines the regex
|
|
11218
|
+
/** Defines the regex for extracting the important part of sample response. This field is only used when parse_type is ResponseParseType.REGEX_EXTRACT. */
|
|
10715
11219
|
regexExtractExpression?: string;
|
|
10716
11220
|
}
|
|
10717
11221
|
|
|
@@ -10719,16 +11223,17 @@ export declare class ReinforcementTuningParseResponseConfig {
|
|
|
10719
11223
|
export declare interface ReinforcementTuningRewardInfo {
|
|
10720
11224
|
/** Output only. The calculated reward for the reward function. */
|
|
10721
11225
|
reward?: number;
|
|
10722
|
-
/** Output only. The user-requested auxiliary info for the reward function. */
|
|
11226
|
+
/** 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. */
|
|
10723
11227
|
userRequestedAuxInfo?: string;
|
|
10724
11228
|
}
|
|
10725
11229
|
|
|
10726
11230
|
/** Reinforcement tuning spec for tuning. */
|
|
10727
11231
|
export declare interface ReinforcementTuningSpec {
|
|
11232
|
+
/** Composite reward function configuration for reinforcement tuning. */
|
|
10728
11233
|
compositeRewardConfig?: CompositeReinforcementTuningRewardConfig;
|
|
10729
|
-
/** Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. */
|
|
11234
|
+
/** Cloud Storage path to the file containing training dataset for tuning. The dataset must be formatted as a JSONL file. */
|
|
10730
11235
|
trainingDatasetUri?: string;
|
|
10731
|
-
/** Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.
|
|
11236
|
+
/** Cloud Storage path to the file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. */
|
|
10732
11237
|
validationDatasetUri?: string;
|
|
10733
11238
|
/** Additional hyper-parameters to use during tuning. */
|
|
10734
11239
|
hyperParameters?: ReinforcementTuningHyperParameters;
|
|
@@ -10736,11 +11241,11 @@ export declare interface ReinforcementTuningSpec {
|
|
|
10736
11241
|
singleRewardConfig?: SingleReinforcementTuningRewardConfig;
|
|
10737
11242
|
}
|
|
10738
11243
|
|
|
10739
|
-
/**
|
|
11244
|
+
/** 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. */
|
|
10740
11245
|
export declare interface ReinforcementTuningStringMatchRewardScorer {
|
|
10741
|
-
/** Wrong answer reward is returned if
|
|
11246
|
+
/** Wrong answer reward is returned if the parsed response is evaluated as `false`. All wrong answers get the same reward. */
|
|
10742
11247
|
wrongAnswerReward?: number;
|
|
10743
|
-
/** Correct answer
|
|
11248
|
+
/** Correct answer rewawrd is returned if the parsed response is evaluated as `true`. All correct answers get the same reward. */
|
|
10744
11249
|
correctAnswerReward?: number;
|
|
10745
11250
|
/** Uses string match expression to evaluate parsed response. */
|
|
10746
11251
|
stringMatchExpression?: ReinforcementTuningStringMatchRewardScorerStringMatchExpression;
|
|
@@ -10748,19 +11253,19 @@ export declare interface ReinforcementTuningStringMatchRewardScorer {
|
|
|
10748
11253
|
jsonMatchExpression?: ReinforcementTuningStringMatchRewardScorerJsonMatchExpression;
|
|
10749
11254
|
}
|
|
10750
11255
|
|
|
10751
|
-
/**
|
|
11256
|
+
/** 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. */
|
|
10752
11257
|
export declare interface ReinforcementTuningStringMatchRewardScorerJsonMatchExpression {
|
|
10753
|
-
/**
|
|
11258
|
+
/** The key name to find the value in the parsed response that's in JSON format. Only first-level key matching is supported. */
|
|
10754
11259
|
keyName?: string;
|
|
10755
|
-
/** String match expression to match against the value of
|
|
11260
|
+
/** String match expression to match against the extracted value from the JSON representation of the parsed response. */
|
|
10756
11261
|
valueStringMatchExpression?: ReinforcementTuningStringMatchRewardScorerStringMatchExpression;
|
|
10757
11262
|
}
|
|
10758
11263
|
|
|
10759
|
-
/** Evaluates parsed response using match type against expression. */
|
|
11264
|
+
/** 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. */
|
|
10760
11265
|
export declare interface ReinforcementTuningStringMatchRewardScorerStringMatchExpression {
|
|
10761
|
-
/** Match operation to use for
|
|
11266
|
+
/** Match operation to use for evaluating rewards. */
|
|
10762
11267
|
matchOperation?: MatchOperation;
|
|
10763
|
-
/**
|
|
11268
|
+
/** 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.*" } ``` */
|
|
10764
11269
|
expression?: string;
|
|
10765
11270
|
}
|
|
10766
11271
|
|
|
@@ -10780,6 +11285,12 @@ export declare enum ReinforcementTuningThinkingLevel {
|
|
|
10780
11285
|
HIGH = "HIGH"
|
|
10781
11286
|
}
|
|
10782
11287
|
|
|
11288
|
+
/** 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. */
|
|
11289
|
+
export declare interface ReinforcementTuningUserDatasetExamples {
|
|
11290
|
+
/** List of user datasset examples showing to user. */
|
|
11291
|
+
userDatasetExamples?: ReinforcementTuningExample[];
|
|
11292
|
+
}
|
|
11293
|
+
|
|
10783
11294
|
/** Represents a recorded session. */
|
|
10784
11295
|
export declare interface ReplayFile {
|
|
10785
11296
|
replayId?: string;
|
|
@@ -10819,6 +11330,17 @@ export declare interface ReplicatedVoiceConfig {
|
|
|
10819
11330
|
|
|
10820
11331
|
* @remarks Encoded as base64 string. */
|
|
10821
11332
|
voiceSampleAudio?: string;
|
|
11333
|
+
/** Recorded consent verifying ownership of the voice. This
|
|
11334
|
+
represents 16-bit signed little-endian wav data, with a 24kHz sampling
|
|
11335
|
+
rate.
|
|
11336
|
+
* @remarks Encoded as base64 string. */
|
|
11337
|
+
consentAudio?: string;
|
|
11338
|
+
/** Signature of a previously verified consent audio. This should be
|
|
11339
|
+
populated with a signature generated by the server for a previous
|
|
11340
|
+
request containing the consent_audio field. When provided, the
|
|
11341
|
+
signature is verified instead of the consent_audio field to reduce
|
|
11342
|
+
latency. Requests will fail if the signature is invalid or expired. */
|
|
11343
|
+
voiceConsentSignature?: VoiceConsentSignature;
|
|
10822
11344
|
}
|
|
10823
11345
|
|
|
10824
11346
|
declare type RequestOptions = {
|
|
@@ -10875,7 +11397,19 @@ export declare enum ResourceScope {
|
|
|
10875
11397
|
COLLECTION = "COLLECTION"
|
|
10876
11398
|
}
|
|
10877
11399
|
|
|
10878
|
-
|
|
11400
|
+
/** Configuration for the model to configure output formatting and delivery. This data type is not supported in Gemini API. */
|
|
11401
|
+
export declare class ResponseFormat {
|
|
11402
|
+
/** Audio output format. */
|
|
11403
|
+
audio?: AudioResponseFormat;
|
|
11404
|
+
/** Image output format. */
|
|
11405
|
+
image?: ImageResponseFormat;
|
|
11406
|
+
/** Text output format. */
|
|
11407
|
+
text?: TextResponseFormat;
|
|
11408
|
+
/** Video output format. */
|
|
11409
|
+
video?: VideoResponseFormat;
|
|
11410
|
+
}
|
|
11411
|
+
|
|
11412
|
+
declare type ResponseFormat_2 = AudioResponseFormat_2 | TextResponseFormat_2 | ImageResponseFormat_2 | VideoResponseFormat_2 | {
|
|
10879
11413
|
[k: string]: any;
|
|
10880
11414
|
};
|
|
10881
11415
|
|
|
@@ -10888,18 +11422,18 @@ declare type ResponseFormat = AudioResponseFormat | TextResponseFormat | ImageRe
|
|
|
10888
11422
|
*/
|
|
10889
11423
|
declare type ResponseModality = "text" | "image" | "audio" | "video" | "document" | (string & {});
|
|
10890
11424
|
|
|
10891
|
-
/** Defines
|
|
11425
|
+
/** Defines the type for parsing sample response. This enum is not supported in Gemini API. */
|
|
10892
11426
|
export declare enum ResponseParseType {
|
|
10893
11427
|
/**
|
|
10894
|
-
* Default value.
|
|
11428
|
+
* Default value. Fallback to IDENTITY
|
|
10895
11429
|
*/
|
|
10896
11430
|
RESPONSE_PARSE_TYPE_UNSPECIFIED = "RESPONSE_PARSE_TYPE_UNSPECIFIED",
|
|
10897
11431
|
/**
|
|
10898
|
-
*
|
|
11432
|
+
* Returns the sample response as is.
|
|
10899
11433
|
*/
|
|
10900
11434
|
IDENTITY = "IDENTITY",
|
|
10901
11435
|
/**
|
|
10902
|
-
*
|
|
11436
|
+
* 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.
|
|
10903
11437
|
*/
|
|
10904
11438
|
REGEX_EXTRACT = "REGEX_EXTRACT"
|
|
10905
11439
|
}
|
|
@@ -10928,29 +11462,77 @@ export declare interface Retrieval {
|
|
|
10928
11462
|
* A tool that can be used by the model to retrieve files.
|
|
10929
11463
|
*/
|
|
10930
11464
|
declare type Retrieval_2 = {
|
|
10931
|
-
|
|
11465
|
+
/**
|
|
11466
|
+
* Used to specify configuration for ExaAISearch.
|
|
11467
|
+
*/
|
|
11468
|
+
exa_ai_search_config?: ExaAISearchConfig | undefined;
|
|
11469
|
+
/**
|
|
11470
|
+
* Used to specify configuration for ParallelAISearch.
|
|
11471
|
+
*/
|
|
11472
|
+
parallel_ai_search_config?: ParallelAISearchConfig | undefined;
|
|
11473
|
+
/**
|
|
11474
|
+
* Use to specify configuration for RAG Store.
|
|
11475
|
+
*/
|
|
11476
|
+
rag_store_config?: RagStoreConfig | undefined;
|
|
10932
11477
|
/**
|
|
10933
11478
|
* The types of file retrieval to enable.
|
|
10934
11479
|
*/
|
|
10935
|
-
retrieval_types?: Array<
|
|
11480
|
+
retrieval_types?: Array<RetrievalRetrievalType> | undefined;
|
|
11481
|
+
type: "retrieval";
|
|
10936
11482
|
/**
|
|
10937
11483
|
* Used to specify configuration for VertexAISearch.
|
|
10938
11484
|
*/
|
|
10939
11485
|
vertex_ai_search_config?: VertexAISearchConfig | undefined;
|
|
11486
|
+
};
|
|
11487
|
+
|
|
11488
|
+
declare type RetrievalCallArguments$ = RetrievalCallArguments;
|
|
11489
|
+
|
|
11490
|
+
/**
|
|
11491
|
+
* @license
|
|
11492
|
+
* Copyright 2026 Google LLC
|
|
11493
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
11494
|
+
*
|
|
11495
|
+
* g3-prettier-ignore-file
|
|
11496
|
+
*/
|
|
11497
|
+
/**
|
|
11498
|
+
* The arguments to pass to Retrieval tools.
|
|
11499
|
+
*/
|
|
11500
|
+
declare type RetrievalCallArguments = {
|
|
10940
11501
|
/**
|
|
10941
|
-
*
|
|
11502
|
+
* Queries for Retrieval information.
|
|
10942
11503
|
*/
|
|
10943
|
-
|
|
11504
|
+
queries?: Array<string> | undefined;
|
|
11505
|
+
};
|
|
11506
|
+
|
|
11507
|
+
declare type RetrievalCallDelta$ = RetrievalCallDelta;
|
|
11508
|
+
|
|
11509
|
+
/**
|
|
11510
|
+
* Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search,
|
|
11511
|
+
*
|
|
11512
|
+
* @remarks
|
|
11513
|
+
* etc. RetrievalType decides which tool is used.
|
|
11514
|
+
*/
|
|
11515
|
+
declare type RetrievalCallDelta = {
|
|
10944
11516
|
/**
|
|
10945
|
-
*
|
|
11517
|
+
* The arguments to pass to Retrieval tools.
|
|
10946
11518
|
*/
|
|
10947
|
-
|
|
11519
|
+
arguments: RetrievalCallArguments;
|
|
10948
11520
|
/**
|
|
10949
|
-
*
|
|
11521
|
+
* The type of retrieval tools.
|
|
10950
11522
|
*/
|
|
10951
|
-
|
|
11523
|
+
retrieval_type?: RetrievalCallDeltaRetrievalType | undefined;
|
|
11524
|
+
/**
|
|
11525
|
+
* A signature hash for backend validation.
|
|
11526
|
+
*/
|
|
11527
|
+
signature?: string | undefined;
|
|
11528
|
+
type: "retrieval_call";
|
|
10952
11529
|
};
|
|
10953
11530
|
|
|
11531
|
+
/**
|
|
11532
|
+
* The type of retrieval tools.
|
|
11533
|
+
*/
|
|
11534
|
+
declare type RetrievalCallDeltaRetrievalType = "vertex_ai_search" | "rag_store" | "exa_ai_search" | "parallel_ai_search" | (string & {});
|
|
11535
|
+
|
|
10954
11536
|
/** Retrieval config. */
|
|
10955
11537
|
export declare interface RetrievalConfig {
|
|
10956
11538
|
/** The location of the user. */
|
|
@@ -10970,7 +11552,35 @@ export declare interface RetrievalMetadata {
|
|
|
10970
11552
|
googleSearchDynamicRetrievalScore?: number;
|
|
10971
11553
|
}
|
|
10972
11554
|
|
|
10973
|
-
declare type
|
|
11555
|
+
declare type RetrievalResultDelta$ = RetrievalResultDelta;
|
|
11556
|
+
|
|
11557
|
+
/**
|
|
11558
|
+
* @license
|
|
11559
|
+
* Copyright 2026 Google LLC
|
|
11560
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
11561
|
+
*
|
|
11562
|
+
* g3-prettier-ignore-file
|
|
11563
|
+
*/
|
|
11564
|
+
/**
|
|
11565
|
+
* Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search,
|
|
11566
|
+
*
|
|
11567
|
+
* @remarks
|
|
11568
|
+
* etc.
|
|
11569
|
+
* ToolResultDelta.type
|
|
11570
|
+
*/
|
|
11571
|
+
declare type RetrievalResultDelta = {
|
|
11572
|
+
/**
|
|
11573
|
+
* Whether the retrieval resulted in an error.
|
|
11574
|
+
*/
|
|
11575
|
+
is_error?: boolean | undefined;
|
|
11576
|
+
/**
|
|
11577
|
+
* A signature hash for backend validation.
|
|
11578
|
+
*/
|
|
11579
|
+
signature?: string | undefined;
|
|
11580
|
+
type: "retrieval_result";
|
|
11581
|
+
};
|
|
11582
|
+
|
|
11583
|
+
declare type RetrievalRetrievalType = "vertex_ai_search" | "rag_store" | "exa_ai_search" | "parallel_ai_search" | (string & {});
|
|
10974
11584
|
|
|
10975
11585
|
declare type RetryConfig = {
|
|
10976
11586
|
strategy: "none";
|
|
@@ -11005,6 +11615,10 @@ declare type ReviewSnippet$3 = ReviewSnippet;
|
|
|
11005
11615
|
* the features of a specific place in Google Maps.
|
|
11006
11616
|
*/
|
|
11007
11617
|
declare type ReviewSnippet = {
|
|
11618
|
+
/**
|
|
11619
|
+
* The ID of the review snippet.
|
|
11620
|
+
*/
|
|
11621
|
+
review_id?: string | undefined;
|
|
11008
11622
|
/**
|
|
11009
11623
|
* Title of the review.
|
|
11010
11624
|
*/
|
|
@@ -11013,10 +11627,6 @@ declare type ReviewSnippet = {
|
|
|
11013
11627
|
* A link that corresponds to the user review on Google Maps.
|
|
11014
11628
|
*/
|
|
11015
11629
|
url?: string | undefined;
|
|
11016
|
-
/**
|
|
11017
|
-
* The ID of the review snippet.
|
|
11018
|
-
*/
|
|
11019
|
-
review_id?: string | undefined;
|
|
11020
11630
|
};
|
|
11021
11631
|
|
|
11022
11632
|
/**
|
|
@@ -11049,6 +11659,19 @@ export declare interface RougeMetricValue {
|
|
|
11049
11659
|
score?: number;
|
|
11050
11660
|
}
|
|
11051
11661
|
|
|
11662
|
+
declare type RunTriggerParams = Omit<RunTriggerRequest, "trigger_id">;
|
|
11663
|
+
|
|
11664
|
+
declare type RunTriggerRequest = {
|
|
11665
|
+
/**
|
|
11666
|
+
* Which version of the API to use.
|
|
11667
|
+
*/
|
|
11668
|
+
api_version?: string | undefined;
|
|
11669
|
+
/**
|
|
11670
|
+
* Resource name of the trigger.
|
|
11671
|
+
*/
|
|
11672
|
+
trigger_id: string;
|
|
11673
|
+
};
|
|
11674
|
+
|
|
11052
11675
|
/** Safety attributes of a GeneratedImage or the user-provided prompt. */
|
|
11053
11676
|
export declare interface SafetyAttributes {
|
|
11054
11677
|
/** List of RAI categories. */
|
|
@@ -11121,6 +11744,8 @@ export declare interface SafetyRating {
|
|
|
11121
11744
|
severityScore?: number;
|
|
11122
11745
|
}
|
|
11123
11746
|
|
|
11747
|
+
declare type SafetySetting$ = SafetySetting_2;
|
|
11748
|
+
|
|
11124
11749
|
/** A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. */
|
|
11125
11750
|
export declare interface SafetySetting {
|
|
11126
11751
|
/** Required. The harm category to be blocked. */
|
|
@@ -11131,6 +11756,34 @@ export declare interface SafetySetting {
|
|
|
11131
11756
|
threshold?: HarmBlockThreshold;
|
|
11132
11757
|
}
|
|
11133
11758
|
|
|
11759
|
+
/**
|
|
11760
|
+
* A safety setting that affects the safety-blocking behavior.
|
|
11761
|
+
*
|
|
11762
|
+
* @remarks
|
|
11763
|
+
*
|
|
11764
|
+
* A SafetySetting consists of a
|
|
11765
|
+
* harm category and a
|
|
11766
|
+
* threshold for that
|
|
11767
|
+
* category.
|
|
11768
|
+
*/
|
|
11769
|
+
declare type SafetySetting_2 = {
|
|
11770
|
+
/**
|
|
11771
|
+
* Optional. The method for blocking content. If not specified, the default
|
|
11772
|
+
*
|
|
11773
|
+
* @remarks
|
|
11774
|
+
* behavior is to use the probability score.
|
|
11775
|
+
*/
|
|
11776
|
+
method?: Method | undefined;
|
|
11777
|
+
/**
|
|
11778
|
+
* Required. The threshold for blocking content. If the harm probability
|
|
11779
|
+
*
|
|
11780
|
+
* @remarks
|
|
11781
|
+
* exceeds this threshold, the content will be blocked.
|
|
11782
|
+
*/
|
|
11783
|
+
threshold: Threshold;
|
|
11784
|
+
type: HarmCategory_2;
|
|
11785
|
+
};
|
|
11786
|
+
|
|
11134
11787
|
/** Scale of the generated music. */
|
|
11135
11788
|
export declare enum Scale {
|
|
11136
11789
|
/**
|
|
@@ -11411,6 +12064,7 @@ declare type ServiceTier_2 = "flex" | "standard" | "priority" | (string & {});
|
|
|
11411
12064
|
export declare class Session {
|
|
11412
12065
|
readonly conn: WebSocket_2;
|
|
11413
12066
|
private readonly apiClient;
|
|
12067
|
+
setupComplete?: types.LiveServerSetupComplete;
|
|
11414
12068
|
constructor(conn: WebSocket_2, apiClient: ApiClient);
|
|
11415
12069
|
private tLiveClientContent;
|
|
11416
12070
|
private tLiveClienttToolResponse;
|
|
@@ -11528,6 +12182,28 @@ export declare class Session {
|
|
|
11528
12182
|
close(): void;
|
|
11529
12183
|
}
|
|
11530
12184
|
|
|
12185
|
+
declare type SessionConfig$ = SessionConfig;
|
|
12186
|
+
|
|
12187
|
+
/**
|
|
12188
|
+
* @license
|
|
12189
|
+
* Copyright 2026 Google LLC
|
|
12190
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
12191
|
+
*
|
|
12192
|
+
* g3-prettier-ignore-file
|
|
12193
|
+
*/
|
|
12194
|
+
/**
|
|
12195
|
+
* The configuration of CodeMender sessions.
|
|
12196
|
+
*/
|
|
12197
|
+
declare type SessionConfig = {
|
|
12198
|
+
/**
|
|
12199
|
+
* The maximum number of interaction rounds the agent is allowed to perform
|
|
12200
|
+
*
|
|
12201
|
+
* @remarks
|
|
12202
|
+
* before reaching a timeout.
|
|
12203
|
+
*/
|
|
12204
|
+
max_rounds?: number | undefined;
|
|
12205
|
+
};
|
|
12206
|
+
|
|
11531
12207
|
/** Configuration of session resumption mechanism.
|
|
11532
12208
|
|
|
11533
12209
|
Included in `LiveConnectConfig.session_resumption`. If included server
|
|
@@ -11576,14 +12252,14 @@ declare type SigningSecret$ = SigningSecret;
|
|
|
11576
12252
|
* Represents a signing secret used to verify webhook payloads.
|
|
11577
12253
|
*/
|
|
11578
12254
|
declare type SigningSecret = {
|
|
11579
|
-
/**
|
|
11580
|
-
* Output only. The truncated version of the signing secret.
|
|
11581
|
-
*/
|
|
11582
|
-
truncated_secret?: string | undefined;
|
|
11583
12255
|
/**
|
|
11584
12256
|
* Output only. The expiration date of the signing secret.
|
|
11585
12257
|
*/
|
|
11586
12258
|
expire_time?: string | undefined;
|
|
12259
|
+
/**
|
|
12260
|
+
* Output only. The truncated version of the signing secret.
|
|
12261
|
+
*/
|
|
12262
|
+
truncated_secret?: string | undefined;
|
|
11587
12263
|
};
|
|
11588
12264
|
|
|
11589
12265
|
/** Config for `response` parameter. */
|
|
@@ -11600,15 +12276,15 @@ export declare class SingleEmbedContentResponse {
|
|
|
11600
12276
|
export declare interface SingleReinforcementTuningRewardConfig {
|
|
11601
12277
|
/** Scores parsed responses for autorater use cases by using a model to compute the reward. */
|
|
11602
12278
|
autoraterScorer?: ReinforcementTuningAutoraterScorer;
|
|
11603
|
-
/** A unique reward name
|
|
12279
|
+
/** A unique reward name for identifying each single reinforcement tuning reward. */
|
|
11604
12280
|
rewardName?: string;
|
|
11605
|
-
/** Defines how to parse sample response. */
|
|
12281
|
+
/** 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. */
|
|
11606
12282
|
parseResponseConfig?: ReinforcementTuningParseResponseConfig;
|
|
11607
|
-
/**
|
|
12283
|
+
/** ReinforcementTuningCodeExecutionRewardScorer is used to score parsed responses for code execution use cases. */
|
|
11608
12284
|
codeExecutionRewardScorer?: ReinforcementTuningCodeExecutionRewardScorer;
|
|
11609
|
-
/**
|
|
12285
|
+
/** ReinforcementTuningStringMatchRewardScorer is used to score parsed responses for simple string matching use cases against reference answers. */
|
|
11610
12286
|
stringMatchRewardScorer?: ReinforcementTuningStringMatchRewardScorer;
|
|
11611
|
-
/**
|
|
12287
|
+
/** ReinforcementTuningCloudRunRewardScorer is used to score parsed responses by calling a Cloud Run service. */
|
|
11612
12288
|
cloudRunRewardScorer?: ReinforcementTuningCloudRunRewardScorer;
|
|
11613
12289
|
}
|
|
11614
12290
|
|
|
@@ -11629,7 +12305,14 @@ declare type Source$ = Source;
|
|
|
11629
12305
|
* A source to be mounted into the environment.
|
|
11630
12306
|
*/
|
|
11631
12307
|
declare type Source = {
|
|
11632
|
-
|
|
12308
|
+
/**
|
|
12309
|
+
* The inline content if `type` is `INLINE`.
|
|
12310
|
+
*/
|
|
12311
|
+
content?: string | undefined;
|
|
12312
|
+
/**
|
|
12313
|
+
* Optional encoding for inline content (e.g. `base64`).
|
|
12314
|
+
*/
|
|
12315
|
+
encoding?: string | undefined;
|
|
11633
12316
|
/**
|
|
11634
12317
|
* The source of the environment.
|
|
11635
12318
|
*
|
|
@@ -11642,16 +12325,13 @@ declare type Source = {
|
|
|
11642
12325
|
* Where the source should appear in the environment.
|
|
11643
12326
|
*/
|
|
11644
12327
|
target?: string | undefined;
|
|
11645
|
-
|
|
11646
|
-
* The inline content if `type` is `INLINE`.
|
|
11647
|
-
*/
|
|
11648
|
-
content?: string | undefined;
|
|
11649
|
-
/**
|
|
11650
|
-
* Optional encoding for inline content (e.g. `base64`).
|
|
11651
|
-
*/
|
|
11652
|
-
encoding?: string | undefined;
|
|
12328
|
+
type?: SourceType | undefined;
|
|
11653
12329
|
};
|
|
11654
12330
|
|
|
12331
|
+
declare type SourceFile$ = FileContent;
|
|
12332
|
+
|
|
12333
|
+
declare type SourceFile$2 = FileContent;
|
|
12334
|
+
|
|
11655
12335
|
/**
|
|
11656
12336
|
* @license
|
|
11657
12337
|
* Copyright 2026 Google LLC
|
|
@@ -11692,10 +12372,6 @@ export declare interface SpeechConfig {
|
|
|
11692
12372
|
* The configuration for speech interaction.
|
|
11693
12373
|
*/
|
|
11694
12374
|
declare type SpeechConfig_2 = {
|
|
11695
|
-
/**
|
|
11696
|
-
* The voice of the speaker.
|
|
11697
|
-
*/
|
|
11698
|
-
voice?: string | undefined;
|
|
11699
12375
|
/**
|
|
11700
12376
|
* The language of the speech.
|
|
11701
12377
|
*/
|
|
@@ -11704,6 +12380,10 @@ declare type SpeechConfig_2 = {
|
|
|
11704
12380
|
* The speaker's name, it should match the speaker name given in the prompt.
|
|
11705
12381
|
*/
|
|
11706
12382
|
speaker?: string | undefined;
|
|
12383
|
+
/**
|
|
12384
|
+
* The voice of the speaker.
|
|
12385
|
+
*/
|
|
12386
|
+
voice?: string | undefined;
|
|
11707
12387
|
};
|
|
11708
12388
|
|
|
11709
12389
|
export declare type SpeechConfigUnion = SpeechConfig | string;
|
|
@@ -11754,14 +12434,6 @@ declare type Status = {
|
|
|
11754
12434
|
* The status code, which should be an enum value of google.rpc.Code.
|
|
11755
12435
|
*/
|
|
11756
12436
|
code?: number | undefined;
|
|
11757
|
-
/**
|
|
11758
|
-
* A developer-facing error message, which should be in English. Any
|
|
11759
|
-
*
|
|
11760
|
-
* @remarks
|
|
11761
|
-
* user-facing error message should be localized and sent in the
|
|
11762
|
-
* google.rpc.Status.details field, or localized by the client.
|
|
11763
|
-
*/
|
|
11764
|
-
message?: string | undefined;
|
|
11765
12437
|
/**
|
|
11766
12438
|
* A list of messages that carry the error details. There is a common set of
|
|
11767
12439
|
*
|
|
@@ -11771,6 +12443,14 @@ declare type Status = {
|
|
|
11771
12443
|
details?: Array<{
|
|
11772
12444
|
[k: string]: any;
|
|
11773
12445
|
}> | undefined;
|
|
12446
|
+
/**
|
|
12447
|
+
* A developer-facing error message, which should be in English. Any
|
|
12448
|
+
*
|
|
12449
|
+
* @remarks
|
|
12450
|
+
* user-facing error message should be localized and sent in the
|
|
12451
|
+
* google.rpc.Status.details field, or localized by the client.
|
|
12452
|
+
*/
|
|
12453
|
+
message?: string | undefined;
|
|
11774
12454
|
};
|
|
11775
12455
|
|
|
11776
12456
|
declare type Step$ = Step;
|
|
@@ -11783,8 +12463,6 @@ declare type Step = UserInputStep | ModelOutputStep | ThoughtStep | FunctionCall
|
|
|
11783
12463
|
declare type StepDelta$ = StepDelta;
|
|
11784
12464
|
|
|
11785
12465
|
declare type StepDelta = {
|
|
11786
|
-
event_type: "step.delta";
|
|
11787
|
-
index: number;
|
|
11788
12466
|
delta: StepDeltaData;
|
|
11789
12467
|
/**
|
|
11790
12468
|
* The event_id token to be used to resume the interaction stream, from
|
|
@@ -11793,13 +12471,15 @@ declare type StepDelta = {
|
|
|
11793
12471
|
* this event.
|
|
11794
12472
|
*/
|
|
11795
12473
|
event_id?: string | undefined;
|
|
12474
|
+
event_type: "step.delta";
|
|
12475
|
+
index: number;
|
|
11796
12476
|
/**
|
|
11797
12477
|
* Optional metadata accompanying ANY streamed event.
|
|
11798
12478
|
*/
|
|
11799
12479
|
metadata?: StepDeltaMetadata | undefined;
|
|
11800
12480
|
};
|
|
11801
12481
|
|
|
11802
|
-
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;
|
|
12482
|
+
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;
|
|
11803
12483
|
|
|
11804
12484
|
/**
|
|
11805
12485
|
* Optional metadata accompanying ANY streamed event.
|
|
@@ -11814,12 +12494,6 @@ declare type StepDeltaMetadata = {
|
|
|
11814
12494
|
declare type StepStart$ = StepStart;
|
|
11815
12495
|
|
|
11816
12496
|
declare type StepStart = {
|
|
11817
|
-
event_type: "step.start";
|
|
11818
|
-
index: number;
|
|
11819
|
-
/**
|
|
11820
|
-
* A step in the interaction.
|
|
11821
|
-
*/
|
|
11822
|
-
step: Step;
|
|
11823
12497
|
/**
|
|
11824
12498
|
* The event_id token to be used to resume the interaction stream, from
|
|
11825
12499
|
*
|
|
@@ -11827,22 +12501,18 @@ declare type StepStart = {
|
|
|
11827
12501
|
* this event.
|
|
11828
12502
|
*/
|
|
11829
12503
|
event_id?: string | undefined;
|
|
12504
|
+
event_type: "step.start";
|
|
12505
|
+
index: number;
|
|
11830
12506
|
metadata?: StreamMetadata | undefined;
|
|
12507
|
+
/**
|
|
12508
|
+
* A step in the interaction.
|
|
12509
|
+
*/
|
|
12510
|
+
step: Step;
|
|
11831
12511
|
};
|
|
11832
12512
|
|
|
11833
12513
|
declare type StepStop$ = StepStop;
|
|
11834
12514
|
|
|
11835
12515
|
declare type StepStop = {
|
|
11836
|
-
event_type: "step.stop";
|
|
11837
|
-
index: number;
|
|
11838
|
-
/**
|
|
11839
|
-
* Statistics on the interaction request's token usage.
|
|
11840
|
-
*/
|
|
11841
|
-
usage?: Usage | undefined;
|
|
11842
|
-
/**
|
|
11843
|
-
* Statistics on the interaction request's token usage.
|
|
11844
|
-
*/
|
|
11845
|
-
step_usage?: Usage | undefined;
|
|
11846
12516
|
/**
|
|
11847
12517
|
* The event_id token to be used to resume the interaction stream, from
|
|
11848
12518
|
*
|
|
@@ -11850,7 +12520,17 @@ declare type StepStop = {
|
|
|
11850
12520
|
* this event.
|
|
11851
12521
|
*/
|
|
11852
12522
|
event_id?: string | undefined;
|
|
12523
|
+
event_type: "step.stop";
|
|
12524
|
+
index: number;
|
|
11853
12525
|
metadata?: StreamMetadata | undefined;
|
|
12526
|
+
/**
|
|
12527
|
+
* Statistics on the interaction request's token usage.
|
|
12528
|
+
*/
|
|
12529
|
+
step_usage?: Usage | undefined;
|
|
12530
|
+
/**
|
|
12531
|
+
* Statistics on the interaction request's token usage.
|
|
12532
|
+
*/
|
|
12533
|
+
usage?: Usage | undefined;
|
|
11854
12534
|
};
|
|
11855
12535
|
|
|
11856
12536
|
export declare class Stream<T> extends ReadableStream<T> {
|
|
@@ -12102,11 +12782,11 @@ declare type Text$ = TextDelta;
|
|
|
12102
12782
|
declare type TextAnnotationDelta$ = TextAnnotationDelta;
|
|
12103
12783
|
|
|
12104
12784
|
declare type TextAnnotationDelta = {
|
|
12105
|
-
type: "text_annotation_delta";
|
|
12106
12785
|
/**
|
|
12107
12786
|
* Citation information for model-generated content.
|
|
12108
12787
|
*/
|
|
12109
12788
|
annotations?: Array<Annotation> | undefined;
|
|
12789
|
+
type: "text_annotation_delta";
|
|
12110
12790
|
};
|
|
12111
12791
|
|
|
12112
12792
|
declare type TextContent$ = TextContent;
|
|
@@ -12115,15 +12795,15 @@ declare type TextContent$ = TextContent;
|
|
|
12115
12795
|
* A text content block.
|
|
12116
12796
|
*/
|
|
12117
12797
|
declare type TextContent = {
|
|
12118
|
-
type: "text";
|
|
12119
|
-
/**
|
|
12120
|
-
* Required. The text content.
|
|
12121
|
-
*/
|
|
12122
|
-
text: string;
|
|
12123
12798
|
/**
|
|
12124
12799
|
* Citation information for model-generated content.
|
|
12125
12800
|
*/
|
|
12126
12801
|
annotations?: Array<Annotation> | undefined;
|
|
12802
|
+
/**
|
|
12803
|
+
* Required. The text content.
|
|
12804
|
+
*/
|
|
12805
|
+
text: string;
|
|
12806
|
+
type: "text";
|
|
12127
12807
|
};
|
|
12128
12808
|
|
|
12129
12809
|
/**
|
|
@@ -12134,17 +12814,24 @@ declare type TextContent = {
|
|
|
12134
12814
|
* g3-prettier-ignore-file
|
|
12135
12815
|
*/
|
|
12136
12816
|
declare type TextDelta = {
|
|
12137
|
-
type: "text";
|
|
12138
12817
|
text: string;
|
|
12818
|
+
type: "text";
|
|
12139
12819
|
};
|
|
12140
12820
|
|
|
12141
|
-
declare type TextResponseFormat$ =
|
|
12821
|
+
declare type TextResponseFormat$ = TextResponseFormat_2;
|
|
12822
|
+
|
|
12823
|
+
/** Configuration for text-specific output formatting. */
|
|
12824
|
+
export declare class TextResponseFormat {
|
|
12825
|
+
/** Optional. The IANA standard MIME type of the response. */
|
|
12826
|
+
mimeType?: string;
|
|
12827
|
+
/** Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON. */
|
|
12828
|
+
schema?: unknown;
|
|
12829
|
+
}
|
|
12142
12830
|
|
|
12143
12831
|
/**
|
|
12144
12832
|
* Configuration for text output format.
|
|
12145
12833
|
*/
|
|
12146
|
-
declare type
|
|
12147
|
-
type: "text";
|
|
12834
|
+
declare type TextResponseFormat_2 = {
|
|
12148
12835
|
/**
|
|
12149
12836
|
* The MIME type of the text output.
|
|
12150
12837
|
*/
|
|
@@ -12158,6 +12845,7 @@ declare type TextResponseFormat = {
|
|
|
12158
12845
|
schema?: {
|
|
12159
12846
|
[k: string]: any;
|
|
12160
12847
|
} | undefined;
|
|
12848
|
+
type: "text";
|
|
12161
12849
|
};
|
|
12162
12850
|
|
|
12163
12851
|
/**
|
|
@@ -12238,11 +12926,11 @@ declare type ThoughtSignature$ = ThoughtSignatureDelta;
|
|
|
12238
12926
|
* g3-prettier-ignore-file
|
|
12239
12927
|
*/
|
|
12240
12928
|
declare type ThoughtSignatureDelta = {
|
|
12241
|
-
type: "thought_signature";
|
|
12242
12929
|
/**
|
|
12243
12930
|
* Signature to match the backend source to be part of the generation.
|
|
12244
12931
|
*/
|
|
12245
12932
|
signature?: string | undefined;
|
|
12933
|
+
type: "thought_signature";
|
|
12246
12934
|
};
|
|
12247
12935
|
|
|
12248
12936
|
declare type ThoughtStep$ = ThoughtStep;
|
|
@@ -12251,7 +12939,6 @@ declare type ThoughtStep$ = ThoughtStep;
|
|
|
12251
12939
|
* A thought step.
|
|
12252
12940
|
*/
|
|
12253
12941
|
declare type ThoughtStep = {
|
|
12254
|
-
type: "thought";
|
|
12255
12942
|
/**
|
|
12256
12943
|
* A signature hash for backend validation.
|
|
12257
12944
|
*/
|
|
@@ -12260,6 +12947,7 @@ declare type ThoughtStep = {
|
|
|
12260
12947
|
* A summary of the thought.
|
|
12261
12948
|
*/
|
|
12262
12949
|
summary?: Array<ThoughtSummaryContent> | undefined;
|
|
12950
|
+
type: "thought";
|
|
12263
12951
|
};
|
|
12264
12952
|
|
|
12265
12953
|
declare type ThoughtSummary$ = ThoughtSummaryDelta;
|
|
@@ -12267,13 +12955,21 @@ declare type ThoughtSummary$ = ThoughtSummaryDelta;
|
|
|
12267
12955
|
declare type ThoughtSummaryContent = TextContent | ImageContent;
|
|
12268
12956
|
|
|
12269
12957
|
declare type ThoughtSummaryDelta = {
|
|
12270
|
-
type: "thought_summary";
|
|
12271
12958
|
/**
|
|
12272
12959
|
* The content of the response.
|
|
12273
12960
|
*/
|
|
12274
12961
|
content?: Content_2 | undefined;
|
|
12962
|
+
type: "thought_summary";
|
|
12275
12963
|
};
|
|
12276
12964
|
|
|
12965
|
+
/**
|
|
12966
|
+
* Required. The threshold for blocking content. If the harm probability
|
|
12967
|
+
*
|
|
12968
|
+
* @remarks
|
|
12969
|
+
* exceeds this threshold, the content will be blocked.
|
|
12970
|
+
*/
|
|
12971
|
+
declare type Threshold = "block_low_and_above" | "block_medium_and_above" | "block_only_high" | "block_none" | "off" | (string & {});
|
|
12972
|
+
|
|
12277
12973
|
export declare class Tokens extends BaseModule {
|
|
12278
12974
|
private readonly apiClient;
|
|
12279
12975
|
constructor(apiClient: ApiClient);
|
|
@@ -12403,6 +13099,8 @@ export declare interface Tool {
|
|
|
12403
13099
|
urlContext?: UrlContext;
|
|
12404
13100
|
/** Optional. MCP Servers to connect to. This field is not supported in Vertex AI. */
|
|
12405
13101
|
mcpServers?: McpServer[];
|
|
13102
|
+
/** 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. */
|
|
13103
|
+
exaAiSearch?: ToolExaAiSearch;
|
|
12406
13104
|
}
|
|
12407
13105
|
|
|
12408
13106
|
/**
|
|
@@ -12467,6 +13165,14 @@ export declare interface ToolConfig {
|
|
|
12467
13165
|
includeServerSideToolInvocations?: boolean;
|
|
12468
13166
|
}
|
|
12469
13167
|
|
|
13168
|
+
/** ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. This data type is not supported in Gemini API. */
|
|
13169
|
+
export declare interface ToolExaAiSearch {
|
|
13170
|
+
/** Required. The API key for ExaAiSearch. */
|
|
13171
|
+
apiKey?: string;
|
|
13172
|
+
/** Optional. This field can be used to pass any parameter from the Exa.ai Search API. */
|
|
13173
|
+
customConfigs?: Record<string, unknown>;
|
|
13174
|
+
}
|
|
13175
|
+
|
|
12470
13176
|
export declare type ToolListUnion = ToolUnion[];
|
|
12471
13177
|
|
|
12472
13178
|
/** ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. This data type is not supported in Gemini API. */
|
|
@@ -12558,17 +13264,291 @@ export declare interface Transcription {
|
|
|
12558
13264
|
languageCode?: string;
|
|
12559
13265
|
}
|
|
12560
13266
|
|
|
13267
|
+
/**
|
|
13268
|
+
* @license
|
|
13269
|
+
* Copyright 2026 Google LLC
|
|
13270
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
13271
|
+
*
|
|
13272
|
+
* g3-prettier-ignore-file
|
|
13273
|
+
*/
|
|
13274
|
+
/**
|
|
13275
|
+
* 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.
|
|
13276
|
+
*/
|
|
13277
|
+
declare type Transform = {
|
|
13278
|
+
[k: string]: string;
|
|
13279
|
+
} | Array<{
|
|
13280
|
+
[k: string]: string;
|
|
13281
|
+
}>;
|
|
13282
|
+
|
|
12561
13283
|
/** Config for stream translation. */
|
|
12562
13284
|
export declare interface TranslationConfig {
|
|
12563
|
-
/** If true, the model will generate audio when the target language is
|
|
12564
|
-
spoken, essentially it will parrot the input. If false, we will not produce
|
|
12565
|
-
audio for the target language. */
|
|
13285
|
+
/** 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. */
|
|
12566
13286
|
echoTargetLanguage?: boolean;
|
|
12567
|
-
/** The target language for translation. Supported values are BCP-47
|
|
12568
|
-
language codes (e.g. "en", "es", "fr"). */
|
|
13287
|
+
/** Required. The target language for translation. Supported values are BCP-47 language codes (e.g. "en", "es", "fr"). */
|
|
12569
13288
|
targetLanguageCode?: string;
|
|
12570
13289
|
}
|
|
12571
13290
|
|
|
13291
|
+
declare type Trigger$ = Trigger;
|
|
13292
|
+
|
|
13293
|
+
/**
|
|
13294
|
+
* A trigger configuration that is scheduled to run an agent.
|
|
13295
|
+
*/
|
|
13296
|
+
declare type Trigger = {
|
|
13297
|
+
/**
|
|
13298
|
+
* Output only. The number of consecutive failures that have occurred
|
|
13299
|
+
*
|
|
13300
|
+
* @remarks
|
|
13301
|
+
* since the last successful execution.
|
|
13302
|
+
*/
|
|
13303
|
+
consecutive_failure_count?: number | undefined;
|
|
13304
|
+
/**
|
|
13305
|
+
* Output only. The time when the trigger was created.
|
|
13306
|
+
*/
|
|
13307
|
+
create_time?: string | undefined;
|
|
13308
|
+
/**
|
|
13309
|
+
* Optional. The display name of the trigger.
|
|
13310
|
+
*/
|
|
13311
|
+
display_name?: string | undefined;
|
|
13312
|
+
/**
|
|
13313
|
+
* Optional. The environment ID for the trigger execution.
|
|
13314
|
+
*/
|
|
13315
|
+
environment_id?: string | undefined;
|
|
13316
|
+
/**
|
|
13317
|
+
* Optional. The execution timeout for the triggered interaction.
|
|
13318
|
+
*/
|
|
13319
|
+
execution_timeout_seconds?: number | undefined;
|
|
13320
|
+
/**
|
|
13321
|
+
* Required. Output only. Identifier. The ID of the trigger.
|
|
13322
|
+
*/
|
|
13323
|
+
id: string;
|
|
13324
|
+
/**
|
|
13325
|
+
* The Interaction resource.
|
|
13326
|
+
*/
|
|
13327
|
+
interaction: interactions.Interaction;
|
|
13328
|
+
/**
|
|
13329
|
+
* Output only. The time when the trigger was last paused.
|
|
13330
|
+
*/
|
|
13331
|
+
last_pause_time?: string | undefined;
|
|
13332
|
+
/**
|
|
13333
|
+
* Output only. The time when the trigger was last resumed.
|
|
13334
|
+
*/
|
|
13335
|
+
last_resume_time?: string | undefined;
|
|
13336
|
+
/**
|
|
13337
|
+
* Output only. The time when the trigger was last run.
|
|
13338
|
+
*/
|
|
13339
|
+
last_run_time?: string | undefined;
|
|
13340
|
+
/**
|
|
13341
|
+
* Optional. The maximum number of consecutive failures allowed before
|
|
13342
|
+
*
|
|
13343
|
+
* @remarks
|
|
13344
|
+
* the trigger is automatically paused (status becomes ERROR).
|
|
13345
|
+
*/
|
|
13346
|
+
max_consecutive_failures?: number | undefined;
|
|
13347
|
+
/**
|
|
13348
|
+
* Output only. The time when the trigger is scheduled to run next.
|
|
13349
|
+
*/
|
|
13350
|
+
next_run_time?: string | undefined;
|
|
13351
|
+
/**
|
|
13352
|
+
* Output only. The ID of the last interaction created by this trigger.
|
|
13353
|
+
*/
|
|
13354
|
+
previous_interaction_id?: string | undefined;
|
|
13355
|
+
/**
|
|
13356
|
+
* Required. The cron schedule on which the trigger should run.
|
|
13357
|
+
*
|
|
13358
|
+
* @remarks
|
|
13359
|
+
* Standard cron format.
|
|
13360
|
+
*/
|
|
13361
|
+
schedule: string;
|
|
13362
|
+
/**
|
|
13363
|
+
* Output only. The current status of the trigger.
|
|
13364
|
+
*/
|
|
13365
|
+
status?: TriggerStatus | undefined;
|
|
13366
|
+
/**
|
|
13367
|
+
* Required. Time zone in which the schedule should be interpreted.
|
|
13368
|
+
*/
|
|
13369
|
+
time_zone: string;
|
|
13370
|
+
/**
|
|
13371
|
+
* Output only. The time when the trigger was last updated.
|
|
13372
|
+
*/
|
|
13373
|
+
update_time?: string | undefined;
|
|
13374
|
+
};
|
|
13375
|
+
|
|
13376
|
+
declare type TriggerCreateParams$ = TriggerCreateParams;
|
|
13377
|
+
|
|
13378
|
+
/**
|
|
13379
|
+
* Parameters for creating a trigger.
|
|
13380
|
+
*/
|
|
13381
|
+
declare type TriggerCreateParams = {
|
|
13382
|
+
/**
|
|
13383
|
+
* Required. The cron schedule on which the trigger should run. Standard cron format.
|
|
13384
|
+
*/
|
|
13385
|
+
schedule: string;
|
|
13386
|
+
/**
|
|
13387
|
+
* Required. Time zone in which the schedule should be interpreted.
|
|
13388
|
+
*/
|
|
13389
|
+
time_zone: string;
|
|
13390
|
+
/**
|
|
13391
|
+
* Optional. The display name of the trigger.
|
|
13392
|
+
*/
|
|
13393
|
+
display_name?: string | undefined;
|
|
13394
|
+
/**
|
|
13395
|
+
* Optional. The environment ID for the trigger execution.
|
|
13396
|
+
*/
|
|
13397
|
+
environment_id?: string | undefined;
|
|
13398
|
+
/**
|
|
13399
|
+
* Optional. The maximum number of consecutive failures allowed before the trigger is automatically paused (status becomes ERROR).
|
|
13400
|
+
*/
|
|
13401
|
+
max_consecutive_failures?: number | undefined;
|
|
13402
|
+
/**
|
|
13403
|
+
* Optional. The execution timeout for the triggered interaction.
|
|
13404
|
+
*/
|
|
13405
|
+
execution_timeout_seconds?: number | undefined;
|
|
13406
|
+
/**
|
|
13407
|
+
* Required. The interaction request template to be executed.
|
|
13408
|
+
*/
|
|
13409
|
+
interaction: interactions.CreateAgentInteraction | interactions.CreateModelInteraction;
|
|
13410
|
+
};
|
|
13411
|
+
|
|
13412
|
+
declare type TriggerDeleteParams$ = DeleteTriggerParams;
|
|
13413
|
+
|
|
13414
|
+
declare type TriggerDeleteResponse$ = Empty;
|
|
13415
|
+
|
|
13416
|
+
declare type TriggerExecution$ = TriggerExecution;
|
|
13417
|
+
|
|
13418
|
+
/**
|
|
13419
|
+
* An execution instance of a trigger.
|
|
13420
|
+
*/
|
|
13421
|
+
declare type TriggerExecution = {
|
|
13422
|
+
/**
|
|
13423
|
+
* Output only. The time when the execution finished.
|
|
13424
|
+
*/
|
|
13425
|
+
end_time?: string | undefined;
|
|
13426
|
+
/**
|
|
13427
|
+
* Output only. The environment ID used for the execution.
|
|
13428
|
+
*/
|
|
13429
|
+
environment_id?: string | undefined;
|
|
13430
|
+
/**
|
|
13431
|
+
* Output only. The error message if the execution failed.
|
|
13432
|
+
*/
|
|
13433
|
+
error?: string | undefined;
|
|
13434
|
+
/**
|
|
13435
|
+
* Required. Output only. Identifier. The ID of the trigger execution.
|
|
13436
|
+
*/
|
|
13437
|
+
id: string;
|
|
13438
|
+
/**
|
|
13439
|
+
* Output only. The ID of the interaction created by this execution, if any.
|
|
13440
|
+
*/
|
|
13441
|
+
interaction_id?: string | undefined;
|
|
13442
|
+
/**
|
|
13443
|
+
* Output only. The time when the execution was scheduled to run.
|
|
13444
|
+
*/
|
|
13445
|
+
scheduled_time?: string | undefined;
|
|
13446
|
+
/**
|
|
13447
|
+
* Output only. The time when the execution started.
|
|
13448
|
+
*/
|
|
13449
|
+
start_time?: string | undefined;
|
|
13450
|
+
/**
|
|
13451
|
+
* Output only. The status of the execution.
|
|
13452
|
+
*/
|
|
13453
|
+
status?: TriggerExecutionStatus | undefined;
|
|
13454
|
+
/**
|
|
13455
|
+
* Required. Output only. Identifier. The ID of the trigger that created this execution.
|
|
13456
|
+
*/
|
|
13457
|
+
trigger_id: string;
|
|
13458
|
+
};
|
|
13459
|
+
|
|
13460
|
+
/**
|
|
13461
|
+
* @license
|
|
13462
|
+
* Copyright 2026 Google LLC
|
|
13463
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
13464
|
+
*
|
|
13465
|
+
* g3-prettier-ignore-file
|
|
13466
|
+
*/
|
|
13467
|
+
/**
|
|
13468
|
+
* Output only. The status of the execution.
|
|
13469
|
+
*/
|
|
13470
|
+
declare type TriggerExecutionStatus = "in_progress" | "completed" | "failed" | "skipped" | "timed_out" | (string & {});
|
|
13471
|
+
|
|
13472
|
+
declare type TriggerGetParams$ = GetTriggerParams;
|
|
13473
|
+
|
|
13474
|
+
declare type TriggerListExecutionsParams$ = ListTriggerExecutionsParams;
|
|
13475
|
+
|
|
13476
|
+
declare type TriggerListExecutionsResponse$ = ListTriggerExecutionsResponse;
|
|
13477
|
+
|
|
13478
|
+
declare type TriggerListParams$ = ListTriggersParams;
|
|
13479
|
+
|
|
13480
|
+
declare type TriggerListResponse$ = ListTriggersResponse;
|
|
13481
|
+
|
|
13482
|
+
declare type TriggerRunParams$ = RunTriggerParams;
|
|
13483
|
+
|
|
13484
|
+
export declare namespace Triggers {
|
|
13485
|
+
export type ListTriggerExecutionsResponse = ListTriggerExecutionsResponse$;
|
|
13486
|
+
export type ListTriggersResponse = ListTriggersResponse$;
|
|
13487
|
+
export type Trigger = Trigger$;
|
|
13488
|
+
export type TriggerCreateParams = TriggerCreateParams$;
|
|
13489
|
+
export type TriggerDeleteParams = TriggerDeleteParams$;
|
|
13490
|
+
export type TriggerDeleteResponse = TriggerDeleteResponse$;
|
|
13491
|
+
export type TriggerExecution = TriggerExecution$;
|
|
13492
|
+
export type TriggerGetParams = TriggerGetParams$;
|
|
13493
|
+
export type TriggerListExecutionsParams = TriggerListExecutionsParams$;
|
|
13494
|
+
export type TriggerListExecutionsResponse = TriggerListExecutionsResponse$;
|
|
13495
|
+
export type TriggerListParams = TriggerListParams$;
|
|
13496
|
+
export type TriggerListResponse = TriggerListResponse$;
|
|
13497
|
+
export type TriggerRunParams = TriggerRunParams$;
|
|
13498
|
+
export type TriggerUpdate = TriggerUpdate$;
|
|
13499
|
+
export type TriggerUpdateParams = TriggerUpdateParams$;
|
|
13500
|
+
}
|
|
13501
|
+
|
|
13502
|
+
declare namespace triggers {
|
|
13503
|
+
export {
|
|
13504
|
+
ListTriggerExecutionsResponse,
|
|
13505
|
+
ListTriggersResponse,
|
|
13506
|
+
Interaction_2 as Interaction,
|
|
13507
|
+
TriggerCreateParams,
|
|
13508
|
+
TriggerExecutionStatus,
|
|
13509
|
+
TriggerExecution,
|
|
13510
|
+
TriggerUpdateStatus,
|
|
13511
|
+
TriggerUpdate,
|
|
13512
|
+
TriggerStatus,
|
|
13513
|
+
Trigger
|
|
13514
|
+
}
|
|
13515
|
+
}
|
|
13516
|
+
|
|
13517
|
+
/**
|
|
13518
|
+
* Output only. The current status of the trigger.
|
|
13519
|
+
*/
|
|
13520
|
+
declare type TriggerStatus = "active" | "paused" | "error" | (string & {});
|
|
13521
|
+
|
|
13522
|
+
declare type TriggerUpdate$ = TriggerUpdate;
|
|
13523
|
+
|
|
13524
|
+
/**
|
|
13525
|
+
* Represents the fields of a Trigger that can be updated.
|
|
13526
|
+
*/
|
|
13527
|
+
declare type TriggerUpdate = {
|
|
13528
|
+
/**
|
|
13529
|
+
* Optional. The display name of the trigger.
|
|
13530
|
+
*/
|
|
13531
|
+
display_name?: string | undefined;
|
|
13532
|
+
/**
|
|
13533
|
+
* Optional. The status of the trigger.
|
|
13534
|
+
*/
|
|
13535
|
+
status?: TriggerUpdateStatus | undefined;
|
|
13536
|
+
};
|
|
13537
|
+
|
|
13538
|
+
declare type TriggerUpdateParams$ = UpdateTriggerParams;
|
|
13539
|
+
|
|
13540
|
+
/**
|
|
13541
|
+
* @license
|
|
13542
|
+
* Copyright 2026 Google LLC
|
|
13543
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
13544
|
+
*
|
|
13545
|
+
* g3-prettier-ignore-file
|
|
13546
|
+
*/
|
|
13547
|
+
/**
|
|
13548
|
+
* Optional. The status of the trigger.
|
|
13549
|
+
*/
|
|
13550
|
+
declare type TriggerUpdateStatus = "active" | "paused" | "error";
|
|
13551
|
+
|
|
12572
13552
|
/** TunedModel for the Tuned Model of a Tuning Job. */
|
|
12573
13553
|
export declare interface TunedModel {
|
|
12574
13554
|
/** Output only. The resource name of the TunedModel.
|
|
@@ -12633,6 +13613,8 @@ export declare interface TuningDataStats {
|
|
|
12633
13613
|
preferenceOptimizationDataStats?: PreferenceOptimizationDataStats;
|
|
12634
13614
|
/** The SFT Tuning data stats. */
|
|
12635
13615
|
supervisedTuningDataStats?: SupervisedTuningDataStats;
|
|
13616
|
+
/** Output only. Statistics for reinforcement tuning. */
|
|
13617
|
+
reinforcementTuningDataStats?: DatasetStats;
|
|
12636
13618
|
}
|
|
12637
13619
|
|
|
12638
13620
|
/** A single example for tuning. This data type is not supported in Vertex AI. */
|
|
@@ -12675,6 +13657,7 @@ export declare interface TuningJob {
|
|
|
12675
13657
|
preferenceOptimizationSpec?: PreferenceOptimizationSpec;
|
|
12676
13658
|
/** Tuning Spec for Distillation. */
|
|
12677
13659
|
distillationSpec?: DistillationSpec;
|
|
13660
|
+
/** Tuning Spec for Reinforcement Tuning. */
|
|
12678
13661
|
reinforcementTuningSpec?: ReinforcementTuningSpec;
|
|
12679
13662
|
/** Output only. The tuning data statistics associated with this TuningJob. */
|
|
12680
13663
|
tuningDataStats?: TuningDataStats;
|
|
@@ -12901,6 +13884,7 @@ export declare interface TuningValidationDataset {
|
|
|
12901
13884
|
* @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
12902
13885
|
*/
|
|
12903
13886
|
declare type Turn = {
|
|
13887
|
+
content?: Array<Content_2> | string | undefined;
|
|
12904
13888
|
/**
|
|
12905
13889
|
* The originator of this turn. Must be user for input or model for
|
|
12906
13890
|
*
|
|
@@ -12908,7 +13892,6 @@ declare type Turn = {
|
|
|
12908
13892
|
* model output.
|
|
12909
13893
|
*/
|
|
12910
13894
|
role?: string | undefined;
|
|
12911
|
-
content?: Array<Content_2> | string | undefined;
|
|
12912
13895
|
};
|
|
12913
13896
|
|
|
12914
13897
|
/** The reason why the turn is complete. */
|
|
@@ -13127,8 +14110,14 @@ declare namespace types {
|
|
|
13127
14110
|
ModelStage,
|
|
13128
14111
|
MediaResolution,
|
|
13129
14112
|
Modality,
|
|
14113
|
+
Delivery,
|
|
14114
|
+
AspectRatio,
|
|
14115
|
+
ImageSize,
|
|
13130
14116
|
TuningMode,
|
|
13131
14117
|
AdapterSize,
|
|
14118
|
+
ResponseParseType,
|
|
14119
|
+
MatchOperation,
|
|
14120
|
+
ReinforcementTuningThinkingLevel,
|
|
13132
14121
|
JobState,
|
|
13133
14122
|
TuningJobState,
|
|
13134
14123
|
AggregationMetric,
|
|
@@ -13154,9 +14143,6 @@ declare namespace types {
|
|
|
13154
14143
|
VideoGenerationMaskMode,
|
|
13155
14144
|
VideoCompressionQuality,
|
|
13156
14145
|
ImageResizeMode,
|
|
13157
|
-
ResponseParseType,
|
|
13158
|
-
MatchOperation,
|
|
13159
|
-
ReinforcementTuningThinkingLevel,
|
|
13160
14146
|
TuningMethod,
|
|
13161
14147
|
FileState,
|
|
13162
14148
|
FileSource,
|
|
@@ -13229,7 +14215,9 @@ declare namespace types {
|
|
|
13229
14215
|
UrlContext,
|
|
13230
14216
|
StreamableHttpTransport,
|
|
13231
14217
|
McpServer,
|
|
14218
|
+
ToolExaAiSearch,
|
|
13232
14219
|
Tool,
|
|
14220
|
+
VoiceConsentSignature,
|
|
13233
14221
|
ReplicatedVoiceConfig,
|
|
13234
14222
|
PrebuiltVoiceConfig,
|
|
13235
14223
|
VoiceConfig,
|
|
@@ -13334,6 +14322,12 @@ declare namespace types {
|
|
|
13334
14322
|
DeleteModelConfig,
|
|
13335
14323
|
DeleteModelParameters,
|
|
13336
14324
|
DeleteModelResponse,
|
|
14325
|
+
AudioResponseFormat,
|
|
14326
|
+
ImageResponseFormat,
|
|
14327
|
+
TextResponseFormat,
|
|
14328
|
+
VideoResponseFormat,
|
|
14329
|
+
ResponseFormat,
|
|
14330
|
+
TranslationConfig,
|
|
13337
14331
|
GenerationConfig,
|
|
13338
14332
|
CountTokensConfig,
|
|
13339
14333
|
CountTokensParameters,
|
|
@@ -13383,6 +14377,8 @@ declare namespace types {
|
|
|
13383
14377
|
PreTunedModel,
|
|
13384
14378
|
DatasetDistributionDistributionBucket,
|
|
13385
14379
|
DatasetDistribution,
|
|
14380
|
+
ReinforcementTuningExample,
|
|
14381
|
+
ReinforcementTuningUserDatasetExamples,
|
|
13386
14382
|
DatasetStats,
|
|
13387
14383
|
DistillationDataStats,
|
|
13388
14384
|
GeminiPreferenceExampleCompletion,
|
|
@@ -13428,7 +14424,6 @@ declare namespace types {
|
|
|
13428
14424
|
CreateTuningJobConfig,
|
|
13429
14425
|
CreateTuningJobParametersPrivate,
|
|
13430
14426
|
TuningOperation,
|
|
13431
|
-
ReinforcementTuningExample,
|
|
13432
14427
|
ValidateRewardConfig,
|
|
13433
14428
|
ValidateRewardParameters,
|
|
13434
14429
|
ReinforcementTuningRewardInfo,
|
|
@@ -13563,6 +14558,7 @@ declare namespace types {
|
|
|
13563
14558
|
LanguageHints,
|
|
13564
14559
|
AudioTranscriptionConfig,
|
|
13565
14560
|
ProactivityConfig,
|
|
14561
|
+
HistoryConfig,
|
|
13566
14562
|
CustomizedAvatar,
|
|
13567
14563
|
AvatarConfig,
|
|
13568
14564
|
LiveClientSetup,
|
|
@@ -13572,7 +14568,6 @@ declare namespace types {
|
|
|
13572
14568
|
LiveClientRealtimeInput,
|
|
13573
14569
|
LiveClientToolResponse,
|
|
13574
14570
|
LiveClientMessage,
|
|
13575
|
-
TranslationConfig,
|
|
13576
14571
|
LiveConnectConfig,
|
|
13577
14572
|
LiveConnectParameters,
|
|
13578
14573
|
CreateChatParameters,
|
|
@@ -13673,6 +14668,20 @@ export declare interface UpdateModelParameters {
|
|
|
13673
14668
|
config?: UpdateModelConfig;
|
|
13674
14669
|
}
|
|
13675
14670
|
|
|
14671
|
+
declare type UpdateTriggerParams = Omit<UpdateTriggerRequest, "id" | "body"> & UpdateTriggerRequest["body"];
|
|
14672
|
+
|
|
14673
|
+
declare type UpdateTriggerRequest = {
|
|
14674
|
+
/**
|
|
14675
|
+
* Which version of the API to use.
|
|
14676
|
+
*/
|
|
14677
|
+
api_version?: string | undefined;
|
|
14678
|
+
/**
|
|
14679
|
+
* Resource name of the trigger.
|
|
14680
|
+
*/
|
|
14681
|
+
id: string;
|
|
14682
|
+
body: triggers.TriggerUpdate;
|
|
14683
|
+
};
|
|
14684
|
+
|
|
13676
14685
|
declare interface Uploader {
|
|
13677
14686
|
/**
|
|
13678
14687
|
* Uploads a file to the given upload url.
|
|
@@ -13884,15 +14893,10 @@ declare type URLCitation$ = URLCitation;
|
|
|
13884
14893
|
* A URL citation annotation.
|
|
13885
14894
|
*/
|
|
13886
14895
|
declare type URLCitation = {
|
|
13887
|
-
type: "url_citation";
|
|
13888
14896
|
/**
|
|
13889
|
-
*
|
|
13890
|
-
*/
|
|
13891
|
-
url?: string | undefined;
|
|
13892
|
-
/**
|
|
13893
|
-
* The title of the URL.
|
|
14897
|
+
* End of the attributed segment, exclusive.
|
|
13894
14898
|
*/
|
|
13895
|
-
|
|
14899
|
+
end_index?: number | undefined;
|
|
13896
14900
|
/**
|
|
13897
14901
|
* Start of segment of the response that is attributed to this source.
|
|
13898
14902
|
*
|
|
@@ -13902,9 +14906,14 @@ declare type URLCitation = {
|
|
|
13902
14906
|
*/
|
|
13903
14907
|
start_index?: number | undefined;
|
|
13904
14908
|
/**
|
|
13905
|
-
*
|
|
14909
|
+
* The title of the URL.
|
|
13906
14910
|
*/
|
|
13907
|
-
|
|
14911
|
+
title?: string | undefined;
|
|
14912
|
+
type: "url_citation";
|
|
14913
|
+
/**
|
|
14914
|
+
* The URL.
|
|
14915
|
+
*/
|
|
14916
|
+
url?: string | undefined;
|
|
13908
14917
|
};
|
|
13909
14918
|
|
|
13910
14919
|
declare type URLContext$ = URLContext;
|
|
@@ -13949,7 +14958,6 @@ declare type URLContextCallArguments = {
|
|
|
13949
14958
|
};
|
|
13950
14959
|
|
|
13951
14960
|
declare type URLContextCallDelta = {
|
|
13952
|
-
type: "url_context_call";
|
|
13953
14961
|
/**
|
|
13954
14962
|
* The arguments to pass to the URL context.
|
|
13955
14963
|
*/
|
|
@@ -13958,6 +14966,7 @@ declare type URLContextCallDelta = {
|
|
|
13958
14966
|
* A signature hash for backend validation.
|
|
13959
14967
|
*/
|
|
13960
14968
|
signature?: string | undefined;
|
|
14969
|
+
type: "url_context_call";
|
|
13961
14970
|
};
|
|
13962
14971
|
|
|
13963
14972
|
declare type URLContextCallStep$ = URLContextCallStep;
|
|
@@ -13966,7 +14975,10 @@ declare type URLContextCallStep$ = URLContextCallStep;
|
|
|
13966
14975
|
* URL context call step.
|
|
13967
14976
|
*/
|
|
13968
14977
|
declare type URLContextCallStep = {
|
|
13969
|
-
|
|
14978
|
+
/**
|
|
14979
|
+
* The arguments to pass to the URL context.
|
|
14980
|
+
*/
|
|
14981
|
+
arguments: URLContextCallArguments;
|
|
13970
14982
|
/**
|
|
13971
14983
|
* Required. A unique ID for this specific tool call.
|
|
13972
14984
|
*/
|
|
@@ -13975,10 +14987,7 @@ declare type URLContextCallStep = {
|
|
|
13975
14987
|
* A signature hash for backend validation.
|
|
13976
14988
|
*/
|
|
13977
14989
|
signature?: string | undefined;
|
|
13978
|
-
|
|
13979
|
-
* The arguments to pass to the URL context.
|
|
13980
|
-
*/
|
|
13981
|
-
arguments: Arguments;
|
|
14990
|
+
type: "url_context_call";
|
|
13982
14991
|
};
|
|
13983
14992
|
|
|
13984
14993
|
/** Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */
|
|
@@ -13995,24 +15004,24 @@ declare type URLContextResult$2 = URLContextResultDelta;
|
|
|
13995
15004
|
* The result of the URL context.
|
|
13996
15005
|
*/
|
|
13997
15006
|
declare type URLContextResult = {
|
|
13998
|
-
/**
|
|
13999
|
-
* The URL that was fetched.
|
|
14000
|
-
*/
|
|
14001
|
-
url?: string | undefined;
|
|
14002
15007
|
/**
|
|
14003
15008
|
* The status of the URL retrieval.
|
|
14004
15009
|
*/
|
|
14005
15010
|
status?: URLContextResultStatus | undefined;
|
|
15011
|
+
/**
|
|
15012
|
+
* The URL that was fetched.
|
|
15013
|
+
*/
|
|
15014
|
+
url?: string | undefined;
|
|
14006
15015
|
};
|
|
14007
15016
|
|
|
14008
15017
|
declare type URLContextResultDelta = {
|
|
14009
|
-
type: "url_context_result";
|
|
14010
|
-
result: Array<URLContextResult>;
|
|
14011
15018
|
is_error?: boolean | undefined;
|
|
15019
|
+
result: Array<URLContextResult>;
|
|
14012
15020
|
/**
|
|
14013
15021
|
* A signature hash for backend validation.
|
|
14014
15022
|
*/
|
|
14015
15023
|
signature?: string | undefined;
|
|
15024
|
+
type: "url_context_result";
|
|
14016
15025
|
};
|
|
14017
15026
|
|
|
14018
15027
|
/**
|
|
@@ -14033,23 +15042,23 @@ declare type URLContextResultStep$ = URLContextResultStep;
|
|
|
14033
15042
|
* URL context result step.
|
|
14034
15043
|
*/
|
|
14035
15044
|
declare type URLContextResultStep = {
|
|
14036
|
-
type: "url_context_result";
|
|
14037
15045
|
/**
|
|
14038
|
-
* Required.
|
|
15046
|
+
* Required. ID to match the ID from the function call block.
|
|
14039
15047
|
*/
|
|
14040
|
-
|
|
15048
|
+
call_id: string;
|
|
14041
15049
|
/**
|
|
14042
15050
|
* Whether the URL context resulted in an error.
|
|
14043
15051
|
*/
|
|
14044
15052
|
is_error?: boolean | undefined;
|
|
14045
15053
|
/**
|
|
14046
|
-
* Required.
|
|
15054
|
+
* Required. The results of the URL context.
|
|
14047
15055
|
*/
|
|
14048
|
-
|
|
15056
|
+
result: Array<URLContextResult>;
|
|
14049
15057
|
/**
|
|
14050
15058
|
* A signature hash for backend validation.
|
|
14051
15059
|
*/
|
|
14052
15060
|
signature?: string | undefined;
|
|
15061
|
+
type: "url_context_result";
|
|
14053
15062
|
};
|
|
14054
15063
|
|
|
14055
15064
|
/** The metadata for a single URL retrieval. */
|
|
@@ -14091,37 +15100,37 @@ declare type Usage$ = Usage;
|
|
|
14091
15100
|
*/
|
|
14092
15101
|
declare type Usage = {
|
|
14093
15102
|
/**
|
|
14094
|
-
*
|
|
15103
|
+
* A breakdown of cached token usage by modality.
|
|
14095
15104
|
*/
|
|
14096
|
-
|
|
15105
|
+
cached_tokens_by_modality?: Array<ModalityTokens> | undefined;
|
|
14097
15106
|
/**
|
|
14098
|
-
*
|
|
15107
|
+
* Grounding tool count.
|
|
14099
15108
|
*/
|
|
14100
|
-
|
|
15109
|
+
grounding_tool_count?: Array<GroundingToolCount> | undefined;
|
|
14101
15110
|
/**
|
|
14102
|
-
*
|
|
15111
|
+
* A breakdown of input token usage by modality.
|
|
14103
15112
|
*/
|
|
14104
|
-
|
|
15113
|
+
input_tokens_by_modality?: Array<ModalityTokens> | undefined;
|
|
14105
15114
|
/**
|
|
14106
|
-
* A breakdown of
|
|
15115
|
+
* A breakdown of output token usage by modality.
|
|
14107
15116
|
*/
|
|
14108
|
-
|
|
15117
|
+
output_tokens_by_modality?: Array<ModalityTokens> | undefined;
|
|
14109
15118
|
/**
|
|
14110
|
-
*
|
|
15119
|
+
* A breakdown of tool-use token usage by modality.
|
|
14111
15120
|
*/
|
|
14112
|
-
|
|
15121
|
+
tool_use_tokens_by_modality?: Array<ModalityTokens> | undefined;
|
|
14113
15122
|
/**
|
|
14114
|
-
*
|
|
15123
|
+
* Number of tokens in the cached part of the prompt (the cached content).
|
|
14115
15124
|
*/
|
|
14116
|
-
|
|
15125
|
+
total_cached_tokens?: number | undefined;
|
|
14117
15126
|
/**
|
|
14118
|
-
* Number of tokens
|
|
15127
|
+
* Number of tokens in the prompt (context).
|
|
14119
15128
|
*/
|
|
14120
|
-
|
|
15129
|
+
total_input_tokens?: number | undefined;
|
|
14121
15130
|
/**
|
|
14122
|
-
*
|
|
15131
|
+
* Total number of tokens across all the generated responses.
|
|
14123
15132
|
*/
|
|
14124
|
-
|
|
15133
|
+
total_output_tokens?: number | undefined;
|
|
14125
15134
|
/**
|
|
14126
15135
|
* Number of tokens of thoughts for thinking models.
|
|
14127
15136
|
*/
|
|
@@ -14134,9 +15143,9 @@ declare type Usage = {
|
|
|
14134
15143
|
*/
|
|
14135
15144
|
total_tokens?: number | undefined;
|
|
14136
15145
|
/**
|
|
14137
|
-
*
|
|
15146
|
+
* Number of tokens present in tool-use prompt(s).
|
|
14138
15147
|
*/
|
|
14139
|
-
|
|
15148
|
+
total_tool_use_tokens?: number | undefined;
|
|
14140
15149
|
};
|
|
14141
15150
|
|
|
14142
15151
|
/** Usage metadata about response(s). */
|
|
@@ -14305,14 +15314,14 @@ declare type VertexAISearchConfig$ = VertexAISearchConfig;
|
|
|
14305
15314
|
* Used to specify configuration for VertexAISearch.
|
|
14306
15315
|
*/
|
|
14307
15316
|
declare type VertexAISearchConfig = {
|
|
14308
|
-
/**
|
|
14309
|
-
* Optional. Used to specify Vertex AI Search engine.
|
|
14310
|
-
*/
|
|
14311
|
-
engine?: string | undefined;
|
|
14312
15317
|
/**
|
|
14313
15318
|
* Optional. Used to specify Vertex AI Search datastores.
|
|
14314
15319
|
*/
|
|
14315
15320
|
datastores?: Array<string> | undefined;
|
|
15321
|
+
/**
|
|
15322
|
+
* Optional. Used to specify Vertex AI Search engine.
|
|
15323
|
+
*/
|
|
15324
|
+
engine?: string | undefined;
|
|
14316
15325
|
};
|
|
14317
15326
|
|
|
14318
15327
|
/** 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. */
|
|
@@ -14406,20 +15415,20 @@ declare type VideoContent$ = VideoContent;
|
|
|
14406
15415
|
* A video content block.
|
|
14407
15416
|
*/
|
|
14408
15417
|
declare type VideoContent = {
|
|
14409
|
-
type: "video";
|
|
14410
15418
|
/**
|
|
14411
15419
|
* The video content.
|
|
14412
15420
|
*/
|
|
14413
15421
|
data?: string | undefined;
|
|
14414
|
-
/**
|
|
14415
|
-
* The URI of the video.
|
|
14416
|
-
*/
|
|
14417
|
-
uri?: string | undefined;
|
|
14418
15422
|
/**
|
|
14419
15423
|
* The mime type of the video.
|
|
14420
15424
|
*/
|
|
14421
15425
|
mime_type?: VideoContentMimeType | undefined;
|
|
14422
15426
|
resolution?: MediaResolution_2 | undefined;
|
|
15427
|
+
type: "video";
|
|
15428
|
+
/**
|
|
15429
|
+
* The URI of the video.
|
|
15430
|
+
*/
|
|
15431
|
+
uri?: string | undefined;
|
|
14423
15432
|
};
|
|
14424
15433
|
|
|
14425
15434
|
/**
|
|
@@ -14428,11 +15437,11 @@ declare type VideoContent = {
|
|
|
14428
15437
|
declare type VideoContentMimeType = "video/mp4" | "video/mpeg" | "video/mpg" | "video/mov" | "video/avi" | "video/x-flv" | "video/webm" | "video/wmv" | "video/3gpp" | (string & {});
|
|
14429
15438
|
|
|
14430
15439
|
declare type VideoDelta = {
|
|
14431
|
-
type: "video";
|
|
14432
15440
|
data?: string | undefined;
|
|
14433
|
-
uri?: string | undefined;
|
|
14434
15441
|
mime_type?: VideoDeltaMimeType | undefined;
|
|
14435
15442
|
resolution?: MediaResolution_2 | undefined;
|
|
15443
|
+
type: "video";
|
|
15444
|
+
uri?: string | undefined;
|
|
14436
15445
|
};
|
|
14437
15446
|
|
|
14438
15447
|
declare type VideoDeltaMimeType = "video/mp4" | "video/mpeg" | "video/mpg" | "video/mov" | "video/avi" | "video/x-flv" | "video/webm" | "video/wmv" | "video/3gpp" | (string & {});
|
|
@@ -14524,17 +15533,36 @@ export declare enum VideoOrientation {
|
|
|
14524
15533
|
PORTRAIT = "PORTRAIT"
|
|
14525
15534
|
}
|
|
14526
15535
|
|
|
14527
|
-
declare type VideoResponseFormat$ =
|
|
15536
|
+
declare type VideoResponseFormat$ = VideoResponseFormat_2;
|
|
15537
|
+
|
|
15538
|
+
/** Configuration for video-specific output formatting. This data type is not supported in Gemini API. */
|
|
15539
|
+
export declare class VideoResponseFormat {
|
|
15540
|
+
/** The aspect ratio for the video output. */
|
|
15541
|
+
aspectRatio?: AspectRatio;
|
|
15542
|
+
/** Optional. Delivery mode for the generated content. */
|
|
15543
|
+
delivery?: Delivery;
|
|
15544
|
+
/** Optional. The duration for the video output. */
|
|
15545
|
+
duration?: string;
|
|
15546
|
+
/** Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI. */
|
|
15547
|
+
gcsUri?: string;
|
|
15548
|
+
}
|
|
14528
15549
|
|
|
14529
15550
|
/**
|
|
14530
15551
|
* Configuration for video output format.
|
|
14531
15552
|
*/
|
|
14532
|
-
declare type
|
|
14533
|
-
|
|
15553
|
+
declare type VideoResponseFormat_2 = {
|
|
15554
|
+
/**
|
|
15555
|
+
* The aspect ratio for the video output.
|
|
15556
|
+
*/
|
|
15557
|
+
aspect_ratio?: VideoResponseFormatAspectRatio | undefined;
|
|
14534
15558
|
/**
|
|
14535
15559
|
* The delivery mode for the video output.
|
|
14536
15560
|
*/
|
|
14537
15561
|
delivery?: VideoResponseFormatDelivery | undefined;
|
|
15562
|
+
/**
|
|
15563
|
+
* The duration for the video output.
|
|
15564
|
+
*/
|
|
15565
|
+
duration?: string | undefined;
|
|
14538
15566
|
/**
|
|
14539
15567
|
* The GCS URI to store the video output. Required for Vertex if delivery mode
|
|
14540
15568
|
*
|
|
@@ -14542,21 +15570,9 @@ declare type VideoResponseFormat = {
|
|
|
14542
15570
|
* is URI.
|
|
14543
15571
|
*/
|
|
14544
15572
|
gcs_uri?: string | undefined;
|
|
14545
|
-
|
|
14546
|
-
* The aspect ratio for the video output.
|
|
14547
|
-
*/
|
|
14548
|
-
aspect_ratio?: VideoResponseFormatAspectRatio | undefined;
|
|
14549
|
-
/**
|
|
14550
|
-
* The duration for the video output.
|
|
14551
|
-
*/
|
|
14552
|
-
duration?: string | undefined;
|
|
15573
|
+
type: "video";
|
|
14553
15574
|
};
|
|
14554
15575
|
|
|
14555
|
-
/**
|
|
14556
|
-
* The aspect ratio for the video output.
|
|
14557
|
-
*/
|
|
14558
|
-
declare type VideoResponseFormatAspectRatio = "16:9" | "9:16" | (string & {});
|
|
14559
|
-
|
|
14560
15576
|
/**
|
|
14561
15577
|
* @license
|
|
14562
15578
|
* Copyright 2026 Google LLC
|
|
@@ -14564,6 +15580,11 @@ declare type VideoResponseFormatAspectRatio = "16:9" | "9:16" | (string & {});
|
|
|
14564
15580
|
*
|
|
14565
15581
|
* g3-prettier-ignore-file
|
|
14566
15582
|
*/
|
|
15583
|
+
/**
|
|
15584
|
+
* The aspect ratio for the video output.
|
|
15585
|
+
*/
|
|
15586
|
+
declare type VideoResponseFormatAspectRatio = "16:9" | "9:16" | (string & {});
|
|
15587
|
+
|
|
14567
15588
|
/**
|
|
14568
15589
|
* The delivery mode for the video output.
|
|
14569
15590
|
*/
|
|
@@ -14613,20 +15634,43 @@ export declare interface VoiceConfig {
|
|
|
14613
15634
|
prebuiltVoiceConfig?: PrebuiltVoiceConfig;
|
|
14614
15635
|
}
|
|
14615
15636
|
|
|
15637
|
+
/** The signature of the voice consent check. */
|
|
15638
|
+
export declare interface VoiceConsentSignature {
|
|
15639
|
+
/** The signature string.
|
|
15640
|
+
*/
|
|
15641
|
+
signature?: string;
|
|
15642
|
+
}
|
|
15643
|
+
|
|
14616
15644
|
declare type Webhook$ = Webhook;
|
|
14617
15645
|
|
|
14618
15646
|
/**
|
|
14619
15647
|
* A Webhook resource.
|
|
14620
15648
|
*/
|
|
14621
15649
|
declare type Webhook = {
|
|
15650
|
+
/**
|
|
15651
|
+
* Output only. The timestamp when the webhook was created.
|
|
15652
|
+
*/
|
|
15653
|
+
create_time?: string | undefined;
|
|
15654
|
+
/**
|
|
15655
|
+
* Output only. The ID of the webhook.
|
|
15656
|
+
*/
|
|
15657
|
+
id?: string | undefined;
|
|
14622
15658
|
/**
|
|
14623
15659
|
* Optional. The user-provided name of the webhook.
|
|
14624
15660
|
*/
|
|
14625
15661
|
name?: string | undefined;
|
|
14626
15662
|
/**
|
|
14627
|
-
*
|
|
15663
|
+
* Output only. The new signing secret for the webhook. Only populated on create.
|
|
14628
15664
|
*/
|
|
14629
|
-
|
|
15665
|
+
new_signing_secret?: string | undefined;
|
|
15666
|
+
/**
|
|
15667
|
+
* Output only. The signing secrets associated with this webhook.
|
|
15668
|
+
*/
|
|
15669
|
+
signing_secrets?: Array<SigningSecret> | undefined;
|
|
15670
|
+
/**
|
|
15671
|
+
* Output only. The state of the webhook.
|
|
15672
|
+
*/
|
|
15673
|
+
state?: WebhookState | undefined;
|
|
14630
15674
|
/**
|
|
14631
15675
|
* Required. The events that the webhook is subscribed to.
|
|
14632
15676
|
*
|
|
@@ -14641,30 +15685,14 @@ declare type Webhook = {
|
|
|
14641
15685
|
* - video.generated
|
|
14642
15686
|
*/
|
|
14643
15687
|
subscribed_events: Array<WebhookSubscribedEvent>;
|
|
14644
|
-
/**
|
|
14645
|
-
* Output only. The timestamp when the webhook was created.
|
|
14646
|
-
*/
|
|
14647
|
-
create_time?: string | undefined;
|
|
14648
15688
|
/**
|
|
14649
15689
|
* Output only. The timestamp when the webhook was last updated.
|
|
14650
15690
|
*/
|
|
14651
15691
|
update_time?: string | undefined;
|
|
14652
15692
|
/**
|
|
14653
|
-
*
|
|
14654
|
-
*/
|
|
14655
|
-
signing_secrets?: Array<SigningSecret> | undefined;
|
|
14656
|
-
/**
|
|
14657
|
-
* Output only. The state of the webhook.
|
|
14658
|
-
*/
|
|
14659
|
-
state?: WebhookState | undefined;
|
|
14660
|
-
/**
|
|
14661
|
-
* Output only. The new signing secret for the webhook. Only populated on create.
|
|
14662
|
-
*/
|
|
14663
|
-
new_signing_secret?: string | undefined;
|
|
14664
|
-
/**
|
|
14665
|
-
* Output only. The ID of the webhook.
|
|
15693
|
+
* Required. The URI to which webhook events will be sent.
|
|
14666
15694
|
*/
|
|
14667
|
-
|
|
15695
|
+
uri: string;
|
|
14668
15696
|
};
|
|
14669
15697
|
|
|
14670
15698
|
declare type WebhookConfig$ = WebhookConfig_2;
|
|
@@ -14730,10 +15758,6 @@ declare type WebhookInput = {
|
|
|
14730
15758
|
* Optional. The user-provided name of the webhook.
|
|
14731
15759
|
*/
|
|
14732
15760
|
name?: string | undefined;
|
|
14733
|
-
/**
|
|
14734
|
-
* Required. The URI to which webhook events will be sent.
|
|
14735
|
-
*/
|
|
14736
|
-
uri: string;
|
|
14737
15761
|
/**
|
|
14738
15762
|
* Required. The events that the webhook is subscribed to.
|
|
14739
15763
|
*
|
|
@@ -14748,6 +15772,10 @@ declare type WebhookInput = {
|
|
|
14748
15772
|
* - video.generated
|
|
14749
15773
|
*/
|
|
14750
15774
|
subscribed_events: Array<WebhookSubscribedEvent>;
|
|
15775
|
+
/**
|
|
15776
|
+
* Required. The URI to which webhook events will be sent.
|
|
15777
|
+
*/
|
|
15778
|
+
uri: string;
|
|
14751
15779
|
};
|
|
14752
15780
|
|
|
14753
15781
|
declare type WebhookListParams$ = ListWebhooksParams;
|
|
@@ -14764,10 +15792,6 @@ declare type WebhookListResponse$ = WebhookListResponse;
|
|
|
14764
15792
|
* Response message for WebhookService.ListWebhooks.
|
|
14765
15793
|
*/
|
|
14766
15794
|
declare type WebhookListResponse = {
|
|
14767
|
-
/**
|
|
14768
|
-
* The webhooks.
|
|
14769
|
-
*/
|
|
14770
|
-
webhooks?: Array<Webhook> | undefined;
|
|
14771
15795
|
/**
|
|
14772
15796
|
* A token, which can be sent as `page_token` to retrieve the next page.
|
|
14773
15797
|
*
|
|
@@ -14775,6 +15799,10 @@ declare type WebhookListResponse = {
|
|
|
14775
15799
|
* If this field is omitted, there are no subsequent pages.
|
|
14776
15800
|
*/
|
|
14777
15801
|
next_page_token?: string | undefined;
|
|
15802
|
+
/**
|
|
15803
|
+
* The webhooks.
|
|
15804
|
+
*/
|
|
15805
|
+
webhooks?: Array<Webhook> | undefined;
|
|
14778
15806
|
};
|
|
14779
15807
|
|
|
14780
15808
|
declare type WebhookPingParams$ = PingWebhookRequest;
|
|
@@ -14852,11 +15880,11 @@ declare namespace webhooks {
|
|
|
14852
15880
|
WebhookListResponse,
|
|
14853
15881
|
WebhookPingResponse,
|
|
14854
15882
|
WebhookRotateSigningSecretResponse,
|
|
14855
|
-
WebhookUpdateSubscribedEvent,
|
|
14856
15883
|
WebhookUpdateState,
|
|
15884
|
+
WebhookUpdateSubscribedEvent,
|
|
14857
15885
|
WebhookUpdate,
|
|
14858
|
-
WebhookSubscribedEvent,
|
|
14859
15886
|
WebhookState,
|
|
15887
|
+
WebhookSubscribedEvent,
|
|
14860
15888
|
Webhook,
|
|
14861
15889
|
WebhookInput
|
|
14862
15890
|
}
|
|
@@ -14877,9 +15905,9 @@ declare type WebhookUpdate = {
|
|
|
14877
15905
|
*/
|
|
14878
15906
|
name?: string | undefined;
|
|
14879
15907
|
/**
|
|
14880
|
-
* Optional. The
|
|
15908
|
+
* Optional. The state of the webhook.
|
|
14881
15909
|
*/
|
|
14882
|
-
|
|
15910
|
+
state?: WebhookUpdateState | undefined;
|
|
14883
15911
|
/**
|
|
14884
15912
|
* Optional. The events that the webhook is subscribed to.
|
|
14885
15913
|
*
|
|
@@ -14895,9 +15923,9 @@ declare type WebhookUpdate = {
|
|
|
14895
15923
|
*/
|
|
14896
15924
|
subscribed_events?: Array<WebhookUpdateSubscribedEvent> | undefined;
|
|
14897
15925
|
/**
|
|
14898
|
-
* Optional. The
|
|
15926
|
+
* Optional. The URI to which webhook events will be sent.
|
|
14899
15927
|
*/
|
|
14900
|
-
|
|
15928
|
+
uri?: string | undefined;
|
|
14901
15929
|
};
|
|
14902
15930
|
|
|
14903
15931
|
declare type WebhookUpdateParams$ = WebhookUpdate;
|
|
@@ -14907,11 +15935,6 @@ declare type WebhookUpdateParams = {
|
|
|
14907
15935
|
update_mask?: string;
|
|
14908
15936
|
} & webhooks.WebhookUpdate;
|
|
14909
15937
|
|
|
14910
|
-
/**
|
|
14911
|
-
* Optional. The state of the webhook.
|
|
14912
|
-
*/
|
|
14913
|
-
declare type WebhookUpdateState = "enabled" | "disabled" | "disabled_due_to_failed_deliveries";
|
|
14914
|
-
|
|
14915
15938
|
/**
|
|
14916
15939
|
* @license
|
|
14917
15940
|
* Copyright 2026 Google LLC
|
|
@@ -14919,6 +15942,11 @@ declare type WebhookUpdateState = "enabled" | "disabled" | "disabled_due_to_fail
|
|
|
14919
15942
|
*
|
|
14920
15943
|
* g3-prettier-ignore-file
|
|
14921
15944
|
*/
|
|
15945
|
+
/**
|
|
15946
|
+
* Optional. The state of the webhook.
|
|
15947
|
+
*/
|
|
15948
|
+
declare type WebhookUpdateState = "enabled" | "disabled" | "disabled_due_to_failed_deliveries";
|
|
15949
|
+
|
|
14922
15950
|
declare type WebhookUpdateSubscribedEvent = "batch.succeeded" | "batch.expired" | "batch.failed" | "interaction.requires_action" | "interaction.completed" | "interaction.failed" | "video.generated" | (string & {});
|
|
14923
15951
|
|
|
14924
15952
|
/** Standard web search for grounding and related configurations. Only text results are returned. */
|