@google/genai 1.52.0 → 2.0.1
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/README.md +1 -4
- package/dist/genai.d.ts +438 -432
- package/dist/index.cjs +30 -10
- package/dist/index.mjs +30 -10
- package/dist/index.mjs.map +1 -1
- package/dist/node/index.cjs +30 -10
- package/dist/node/index.mjs +30 -10
- package/dist/node/index.mjs.map +1 -1
- package/dist/node/node.d.ts +438 -432
- package/dist/vertex_internal/index.cjs +29 -8
- package/dist/vertex_internal/index.cjs.map +1 -1
- package/dist/vertex_internal/index.js +29 -8
- package/dist/vertex_internal/index.js.map +1 -1
- package/dist/web/index.mjs +30 -10
- package/dist/web/index.mjs.map +1 -1
- package/dist/web/web.d.ts +438 -432
- package/package.json +2 -2
package/dist/node/node.d.ts
CHANGED
|
@@ -487,6 +487,30 @@ declare interface AudioContent {
|
|
|
487
487
|
uri?: string;
|
|
488
488
|
}
|
|
489
489
|
|
|
490
|
+
/**
|
|
491
|
+
* Configuration for audio output format.
|
|
492
|
+
*/
|
|
493
|
+
declare interface AudioResponseFormat {
|
|
494
|
+
type: 'audio';
|
|
495
|
+
/**
|
|
496
|
+
* Bit rate in bits per second (bps). Only applicable for compressed formats (MP3,
|
|
497
|
+
* Opus).
|
|
498
|
+
*/
|
|
499
|
+
bit_rate?: number;
|
|
500
|
+
/**
|
|
501
|
+
* The delivery mode for the audio output.
|
|
502
|
+
*/
|
|
503
|
+
delivery?: 'inline' | 'url';
|
|
504
|
+
/**
|
|
505
|
+
* The MIME type of the audio output.
|
|
506
|
+
*/
|
|
507
|
+
mime_type?: 'audio/mp3' | 'audio/ogg_opus' | 'audio/l16' | 'audio/wav' | 'audio/alaw' | 'audio/mulaw';
|
|
508
|
+
/**
|
|
509
|
+
* Sample rate in Hz.
|
|
510
|
+
*/
|
|
511
|
+
sample_rate?: number;
|
|
512
|
+
}
|
|
513
|
+
|
|
490
514
|
/** The audio transcription configuration in Setup. */
|
|
491
515
|
export declare interface AudioTranscriptionConfig {
|
|
492
516
|
/** The language codes of the audio. BCP-47 language code. If not set, the transcription will be in the language detected by the model. If set, the server will use the language code specified in the model config as a hint for the language of the audio
|
|
@@ -659,7 +683,7 @@ declare interface BaseCreateAgentInteractionParams {
|
|
|
659
683
|
/**
|
|
660
684
|
* Body param: The input for the interaction.
|
|
661
685
|
*/
|
|
662
|
-
input: Array<
|
|
686
|
+
input: string | Array<Step> | Array<Content_2> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent;
|
|
663
687
|
/**
|
|
664
688
|
* Body param: Configuration parameters for the agent interaction.
|
|
665
689
|
*/
|
|
@@ -676,7 +700,7 @@ declare interface BaseCreateAgentInteractionParams {
|
|
|
676
700
|
* Body param: Enforces that the generated response is a JSON object that complies
|
|
677
701
|
* with the JSON schema specified in this field.
|
|
678
702
|
*/
|
|
679
|
-
response_format?: unknown;
|
|
703
|
+
response_format?: Array<AudioResponseFormat | TextResponseFormat | ImageResponseFormat | VideoResponseFormat | unknown> | AudioResponseFormat | TextResponseFormat | ImageResponseFormat | VideoResponseFormat | unknown;
|
|
680
704
|
/**
|
|
681
705
|
* Body param: The mime type of the response. This is required if response_format
|
|
682
706
|
* is set.
|
|
@@ -722,7 +746,7 @@ declare interface BaseCreateModelInteractionParams {
|
|
|
722
746
|
/**
|
|
723
747
|
* Body param: The input for the interaction.
|
|
724
748
|
*/
|
|
725
|
-
input: Array<
|
|
749
|
+
input: string | Array<Step> | Array<Content_2> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent;
|
|
726
750
|
/**
|
|
727
751
|
* Body param: The name of the `Model` used for generating the interaction.
|
|
728
752
|
*/
|
|
@@ -743,7 +767,7 @@ declare interface BaseCreateModelInteractionParams {
|
|
|
743
767
|
* Body param: Enforces that the generated response is a JSON object that complies
|
|
744
768
|
* with the JSON schema specified in this field.
|
|
745
769
|
*/
|
|
746
|
-
response_format?: unknown;
|
|
770
|
+
response_format?: Array<AudioResponseFormat | TextResponseFormat | ImageResponseFormat | VideoResponseFormat | unknown> | AudioResponseFormat | TextResponseFormat | ImageResponseFormat | VideoResponseFormat | unknown;
|
|
747
771
|
/**
|
|
748
772
|
* Body param: The mime type of the response. This is required if response_format
|
|
749
773
|
* is set.
|
|
@@ -1770,9 +1794,9 @@ declare interface CodeExecutionCallArguments {
|
|
|
1770
1794
|
}
|
|
1771
1795
|
|
|
1772
1796
|
/**
|
|
1773
|
-
* Code execution
|
|
1797
|
+
* Code execution call step.
|
|
1774
1798
|
*/
|
|
1775
|
-
declare interface
|
|
1799
|
+
declare interface CodeExecutionCallStep {
|
|
1776
1800
|
/**
|
|
1777
1801
|
* Required. A unique ID for this specific tool call.
|
|
1778
1802
|
*/
|
|
@@ -1780,7 +1804,7 @@ declare interface CodeExecutionCallContent {
|
|
|
1780
1804
|
/**
|
|
1781
1805
|
* Required. The arguments to pass to the code execution.
|
|
1782
1806
|
*/
|
|
1783
|
-
arguments:
|
|
1807
|
+
arguments: CodeExecutionCallStep.Arguments;
|
|
1784
1808
|
type: 'code_execution_call';
|
|
1785
1809
|
/**
|
|
1786
1810
|
* A signature hash for backend validation.
|
|
@@ -1788,6 +1812,22 @@ declare interface CodeExecutionCallContent {
|
|
|
1788
1812
|
signature?: string;
|
|
1789
1813
|
}
|
|
1790
1814
|
|
|
1815
|
+
declare namespace CodeExecutionCallStep {
|
|
1816
|
+
/**
|
|
1817
|
+
* Required. The arguments to pass to the code execution.
|
|
1818
|
+
*/
|
|
1819
|
+
interface Arguments {
|
|
1820
|
+
/**
|
|
1821
|
+
* The code to be executed.
|
|
1822
|
+
*/
|
|
1823
|
+
code?: string;
|
|
1824
|
+
/**
|
|
1825
|
+
* Programming language of the `code`.
|
|
1826
|
+
*/
|
|
1827
|
+
language?: 'python';
|
|
1828
|
+
}
|
|
1829
|
+
}
|
|
1830
|
+
|
|
1791
1831
|
/** Result of executing the `ExecutableCode`.
|
|
1792
1832
|
|
|
1793
1833
|
Generated only when the `CodeExecution` tool is used. */
|
|
@@ -1801,9 +1841,9 @@ export declare interface CodeExecutionResult {
|
|
|
1801
1841
|
}
|
|
1802
1842
|
|
|
1803
1843
|
/**
|
|
1804
|
-
* Code execution result
|
|
1844
|
+
* Code execution result step.
|
|
1805
1845
|
*/
|
|
1806
|
-
declare interface
|
|
1846
|
+
declare interface CodeExecutionResultStep {
|
|
1807
1847
|
/**
|
|
1808
1848
|
* Required. ID to match the ID from the function call block.
|
|
1809
1849
|
*/
|
|
@@ -1905,288 +1945,7 @@ export declare interface Content {
|
|
|
1905
1945
|
/**
|
|
1906
1946
|
* The content of the response.
|
|
1907
1947
|
*/
|
|
1908
|
-
declare type Content_2 = TextContent | ImageContent | AudioContent | DocumentContent | VideoContent
|
|
1909
|
-
|
|
1910
|
-
declare interface ContentDelta {
|
|
1911
|
-
/**
|
|
1912
|
-
* The delta content data for a content block.
|
|
1913
|
-
*/
|
|
1914
|
-
delta: ContentDelta.Text | ContentDelta.Image | ContentDelta.Audio | ContentDelta.Document | ContentDelta.Video | ContentDelta.ThoughtSummary | ContentDelta.ThoughtSignature | ContentDelta.FunctionCall | ContentDelta.CodeExecutionCall | ContentDelta.URLContextCall | ContentDelta.GoogleSearchCall | ContentDelta.MCPServerToolCall | ContentDelta.FileSearchCall | ContentDelta.GoogleMapsCall | ContentDelta.FunctionResult | ContentDelta.CodeExecutionResult | ContentDelta.URLContextResult | ContentDelta.GoogleSearchResult | ContentDelta.MCPServerToolResult | ContentDelta.FileSearchResult | ContentDelta.GoogleMapsResult | ContentDelta.TextAnnotation;
|
|
1915
|
-
event_type: 'content.delta';
|
|
1916
|
-
index: number;
|
|
1917
|
-
/**
|
|
1918
|
-
* The event_id token to be used to resume the interaction stream, from this event.
|
|
1919
|
-
*/
|
|
1920
|
-
event_id?: string;
|
|
1921
|
-
}
|
|
1922
|
-
|
|
1923
|
-
declare namespace ContentDelta {
|
|
1924
|
-
interface Text {
|
|
1925
|
-
text: string;
|
|
1926
|
-
type: 'text';
|
|
1927
|
-
}
|
|
1928
|
-
interface Image {
|
|
1929
|
-
type: 'image';
|
|
1930
|
-
data?: string;
|
|
1931
|
-
mime_type?: 'image/png' | 'image/jpeg' | 'image/webp' | 'image/heic' | 'image/heif' | 'image/gif' | 'image/bmp' | 'image/tiff';
|
|
1932
|
-
/**
|
|
1933
|
-
* The resolution of the media.
|
|
1934
|
-
*/
|
|
1935
|
-
resolution?: 'low' | 'medium' | 'high' | 'ultra_high';
|
|
1936
|
-
uri?: string;
|
|
1937
|
-
}
|
|
1938
|
-
interface Audio {
|
|
1939
|
-
type: 'audio';
|
|
1940
|
-
/**
|
|
1941
|
-
* The number of audio channels.
|
|
1942
|
-
*/
|
|
1943
|
-
channels?: number;
|
|
1944
|
-
data?: string;
|
|
1945
|
-
mime_type?: 'audio/wav' | 'audio/mp3' | 'audio/aiff' | 'audio/aac' | 'audio/ogg' | 'audio/flac' | 'audio/mpeg' | 'audio/m4a' | 'audio/l16' | 'audio/opus' | 'audio/alaw' | 'audio/mulaw';
|
|
1946
|
-
/**
|
|
1947
|
-
* @deprecated Deprecated. Use sample_rate instead. The value is ignored.
|
|
1948
|
-
*/
|
|
1949
|
-
rate?: number;
|
|
1950
|
-
/**
|
|
1951
|
-
* The sample rate of the audio.
|
|
1952
|
-
*/
|
|
1953
|
-
sample_rate?: number;
|
|
1954
|
-
uri?: string;
|
|
1955
|
-
}
|
|
1956
|
-
interface Document {
|
|
1957
|
-
type: 'document';
|
|
1958
|
-
data?: string;
|
|
1959
|
-
mime_type?: 'application/pdf';
|
|
1960
|
-
uri?: string;
|
|
1961
|
-
}
|
|
1962
|
-
interface Video {
|
|
1963
|
-
type: 'video';
|
|
1964
|
-
data?: string;
|
|
1965
|
-
mime_type?: 'video/mp4' | 'video/mpeg' | 'video/mpg' | 'video/mov' | 'video/avi' | 'video/x-flv' | 'video/webm' | 'video/wmv' | 'video/3gpp';
|
|
1966
|
-
/**
|
|
1967
|
-
* The resolution of the media.
|
|
1968
|
-
*/
|
|
1969
|
-
resolution?: 'low' | 'medium' | 'high' | 'ultra_high';
|
|
1970
|
-
uri?: string;
|
|
1971
|
-
}
|
|
1972
|
-
interface ThoughtSummary {
|
|
1973
|
-
type: 'thought_summary';
|
|
1974
|
-
/**
|
|
1975
|
-
* A new summary item to be added to the thought.
|
|
1976
|
-
*/
|
|
1977
|
-
content?: InteractionsAPI.TextContent | InteractionsAPI.ImageContent;
|
|
1978
|
-
}
|
|
1979
|
-
interface ThoughtSignature {
|
|
1980
|
-
type: 'thought_signature';
|
|
1981
|
-
/**
|
|
1982
|
-
* Signature to match the backend source to be part of the generation.
|
|
1983
|
-
*/
|
|
1984
|
-
signature?: string;
|
|
1985
|
-
}
|
|
1986
|
-
interface FunctionCall {
|
|
1987
|
-
/**
|
|
1988
|
-
* Required. A unique ID for this specific tool call.
|
|
1989
|
-
*/
|
|
1990
|
-
id: string;
|
|
1991
|
-
arguments: {
|
|
1992
|
-
[key: string]: unknown;
|
|
1993
|
-
};
|
|
1994
|
-
name: string;
|
|
1995
|
-
type: 'function_call';
|
|
1996
|
-
/**
|
|
1997
|
-
* A signature hash for backend validation.
|
|
1998
|
-
*/
|
|
1999
|
-
signature?: string;
|
|
2000
|
-
}
|
|
2001
|
-
interface CodeExecutionCall {
|
|
2002
|
-
/**
|
|
2003
|
-
* Required. A unique ID for this specific tool call.
|
|
2004
|
-
*/
|
|
2005
|
-
id: string;
|
|
2006
|
-
/**
|
|
2007
|
-
* The arguments to pass to the code execution.
|
|
2008
|
-
*/
|
|
2009
|
-
arguments: InteractionsAPI.CodeExecutionCallArguments;
|
|
2010
|
-
type: 'code_execution_call';
|
|
2011
|
-
/**
|
|
2012
|
-
* A signature hash for backend validation.
|
|
2013
|
-
*/
|
|
2014
|
-
signature?: string;
|
|
2015
|
-
}
|
|
2016
|
-
interface URLContextCall {
|
|
2017
|
-
/**
|
|
2018
|
-
* Required. A unique ID for this specific tool call.
|
|
2019
|
-
*/
|
|
2020
|
-
id: string;
|
|
2021
|
-
/**
|
|
2022
|
-
* The arguments to pass to the URL context.
|
|
2023
|
-
*/
|
|
2024
|
-
arguments: InteractionsAPI.URLContextCallArguments;
|
|
2025
|
-
type: 'url_context_call';
|
|
2026
|
-
/**
|
|
2027
|
-
* A signature hash for backend validation.
|
|
2028
|
-
*/
|
|
2029
|
-
signature?: string;
|
|
2030
|
-
}
|
|
2031
|
-
interface GoogleSearchCall {
|
|
2032
|
-
/**
|
|
2033
|
-
* Required. A unique ID for this specific tool call.
|
|
2034
|
-
*/
|
|
2035
|
-
id: string;
|
|
2036
|
-
/**
|
|
2037
|
-
* The arguments to pass to Google Search.
|
|
2038
|
-
*/
|
|
2039
|
-
arguments: InteractionsAPI.GoogleSearchCallArguments;
|
|
2040
|
-
type: 'google_search_call';
|
|
2041
|
-
/**
|
|
2042
|
-
* A signature hash for backend validation.
|
|
2043
|
-
*/
|
|
2044
|
-
signature?: string;
|
|
2045
|
-
}
|
|
2046
|
-
interface MCPServerToolCall {
|
|
2047
|
-
/**
|
|
2048
|
-
* Required. A unique ID for this specific tool call.
|
|
2049
|
-
*/
|
|
2050
|
-
id: string;
|
|
2051
|
-
arguments: {
|
|
2052
|
-
[key: string]: unknown;
|
|
2053
|
-
};
|
|
2054
|
-
name: string;
|
|
2055
|
-
server_name: string;
|
|
2056
|
-
type: 'mcp_server_tool_call';
|
|
2057
|
-
/**
|
|
2058
|
-
* A signature hash for backend validation.
|
|
2059
|
-
*/
|
|
2060
|
-
signature?: string;
|
|
2061
|
-
}
|
|
2062
|
-
interface FileSearchCall {
|
|
2063
|
-
/**
|
|
2064
|
-
* Required. A unique ID for this specific tool call.
|
|
2065
|
-
*/
|
|
2066
|
-
id: string;
|
|
2067
|
-
type: 'file_search_call';
|
|
2068
|
-
/**
|
|
2069
|
-
* A signature hash for backend validation.
|
|
2070
|
-
*/
|
|
2071
|
-
signature?: string;
|
|
2072
|
-
}
|
|
2073
|
-
interface GoogleMapsCall {
|
|
2074
|
-
/**
|
|
2075
|
-
* Required. A unique ID for this specific tool call.
|
|
2076
|
-
*/
|
|
2077
|
-
id: string;
|
|
2078
|
-
type: 'google_maps_call';
|
|
2079
|
-
/**
|
|
2080
|
-
* The arguments to pass to the Google Maps tool.
|
|
2081
|
-
*/
|
|
2082
|
-
arguments?: InteractionsAPI.GoogleMapsCallArguments;
|
|
2083
|
-
/**
|
|
2084
|
-
* A signature hash for backend validation.
|
|
2085
|
-
*/
|
|
2086
|
-
signature?: string;
|
|
2087
|
-
}
|
|
2088
|
-
interface FunctionResult {
|
|
2089
|
-
/**
|
|
2090
|
-
* Required. ID to match the ID from the function call block.
|
|
2091
|
-
*/
|
|
2092
|
-
call_id: string;
|
|
2093
|
-
result: unknown | Array<InteractionsAPI.TextContent | InteractionsAPI.ImageContent> | string;
|
|
2094
|
-
type: 'function_result';
|
|
2095
|
-
is_error?: boolean;
|
|
2096
|
-
name?: string;
|
|
2097
|
-
/**
|
|
2098
|
-
* A signature hash for backend validation.
|
|
2099
|
-
*/
|
|
2100
|
-
signature?: string;
|
|
2101
|
-
}
|
|
2102
|
-
interface CodeExecutionResult {
|
|
2103
|
-
/**
|
|
2104
|
-
* Required. ID to match the ID from the function call block.
|
|
2105
|
-
*/
|
|
2106
|
-
call_id: string;
|
|
2107
|
-
result: string;
|
|
2108
|
-
type: 'code_execution_result';
|
|
2109
|
-
is_error?: boolean;
|
|
2110
|
-
/**
|
|
2111
|
-
* A signature hash for backend validation.
|
|
2112
|
-
*/
|
|
2113
|
-
signature?: string;
|
|
2114
|
-
}
|
|
2115
|
-
interface URLContextResult {
|
|
2116
|
-
/**
|
|
2117
|
-
* Required. ID to match the ID from the function call block.
|
|
2118
|
-
*/
|
|
2119
|
-
call_id: string;
|
|
2120
|
-
result: Array<InteractionsAPI.URLContextResult>;
|
|
2121
|
-
type: 'url_context_result';
|
|
2122
|
-
is_error?: boolean;
|
|
2123
|
-
/**
|
|
2124
|
-
* A signature hash for backend validation.
|
|
2125
|
-
*/
|
|
2126
|
-
signature?: string;
|
|
2127
|
-
}
|
|
2128
|
-
interface GoogleSearchResult {
|
|
2129
|
-
/**
|
|
2130
|
-
* Required. ID to match the ID from the function call block.
|
|
2131
|
-
*/
|
|
2132
|
-
call_id: string;
|
|
2133
|
-
result: Array<InteractionsAPI.GoogleSearchResult>;
|
|
2134
|
-
type: 'google_search_result';
|
|
2135
|
-
is_error?: boolean;
|
|
2136
|
-
/**
|
|
2137
|
-
* A signature hash for backend validation.
|
|
2138
|
-
*/
|
|
2139
|
-
signature?: string;
|
|
2140
|
-
}
|
|
2141
|
-
interface MCPServerToolResult {
|
|
2142
|
-
/**
|
|
2143
|
-
* Required. ID to match the ID from the function call block.
|
|
2144
|
-
*/
|
|
2145
|
-
call_id: string;
|
|
2146
|
-
result: unknown | Array<InteractionsAPI.TextContent | InteractionsAPI.ImageContent> | string;
|
|
2147
|
-
type: 'mcp_server_tool_result';
|
|
2148
|
-
name?: string;
|
|
2149
|
-
server_name?: string;
|
|
2150
|
-
/**
|
|
2151
|
-
* A signature hash for backend validation.
|
|
2152
|
-
*/
|
|
2153
|
-
signature?: string;
|
|
2154
|
-
}
|
|
2155
|
-
interface FileSearchResult {
|
|
2156
|
-
/**
|
|
2157
|
-
* Required. ID to match the ID from the function call block.
|
|
2158
|
-
*/
|
|
2159
|
-
call_id: string;
|
|
2160
|
-
result: Array<unknown>;
|
|
2161
|
-
type: 'file_search_result';
|
|
2162
|
-
/**
|
|
2163
|
-
* A signature hash for backend validation.
|
|
2164
|
-
*/
|
|
2165
|
-
signature?: string;
|
|
2166
|
-
}
|
|
2167
|
-
interface GoogleMapsResult {
|
|
2168
|
-
/**
|
|
2169
|
-
* Required. ID to match the ID from the function call block.
|
|
2170
|
-
*/
|
|
2171
|
-
call_id: string;
|
|
2172
|
-
type: 'google_maps_result';
|
|
2173
|
-
/**
|
|
2174
|
-
* The results of the Google Maps.
|
|
2175
|
-
*/
|
|
2176
|
-
result?: Array<InteractionsAPI.GoogleMapsResult>;
|
|
2177
|
-
/**
|
|
2178
|
-
* A signature hash for backend validation.
|
|
2179
|
-
*/
|
|
2180
|
-
signature?: string;
|
|
2181
|
-
}
|
|
2182
|
-
interface TextAnnotation {
|
|
2183
|
-
type: 'text_annotation';
|
|
2184
|
-
/**
|
|
2185
|
-
* Citation information for model-generated content.
|
|
2186
|
-
*/
|
|
2187
|
-
annotations?: Array<InteractionsAPI.Annotation>;
|
|
2188
|
-
}
|
|
2189
|
-
}
|
|
1948
|
+
declare type Content_2 = TextContent | ImageContent | AudioContent | DocumentContent | VideoContent;
|
|
2190
1949
|
|
|
2191
1950
|
/** The embedding generated from an input content. */
|
|
2192
1951
|
export declare interface ContentEmbedding {
|
|
@@ -2228,28 +1987,6 @@ export declare class ContentReferenceImage {
|
|
|
2228
1987
|
toReferenceImageAPI(): ReferenceImageAPIInternal;
|
|
2229
1988
|
}
|
|
2230
1989
|
|
|
2231
|
-
declare interface ContentStart {
|
|
2232
|
-
/**
|
|
2233
|
-
* The content of the response.
|
|
2234
|
-
*/
|
|
2235
|
-
content: Content_2;
|
|
2236
|
-
event_type: 'content.start';
|
|
2237
|
-
index: number;
|
|
2238
|
-
/**
|
|
2239
|
-
* The event_id token to be used to resume the interaction stream, from this event.
|
|
2240
|
-
*/
|
|
2241
|
-
event_id?: string;
|
|
2242
|
-
}
|
|
2243
|
-
|
|
2244
|
-
declare interface ContentStop {
|
|
2245
|
-
event_type: 'content.stop';
|
|
2246
|
-
index: number;
|
|
2247
|
-
/**
|
|
2248
|
-
* The event_id token to be used to resume the interaction stream, from this event.
|
|
2249
|
-
*/
|
|
2250
|
-
event_id?: string;
|
|
2251
|
-
}
|
|
2252
|
-
|
|
2253
1990
|
export declare type ContentUnion = Content | PartUnion[] | PartUnion;
|
|
2254
1991
|
|
|
2255
1992
|
/** Enables context window compression -- mechanism managing model context window so it does not exceed given length. */
|
|
@@ -2848,8 +2585,7 @@ declare interface DeepResearchAgentConfig {
|
|
|
2848
2585
|
/**
|
|
2849
2586
|
* Enables human-in-the-loop planning for the Deep Research agent. If set to true,
|
|
2850
2587
|
* the Deep Research agent will provide a research plan in its response. The agent
|
|
2851
|
-
* will then proceed only if the user confirms the plan in the next turn.
|
|
2852
|
-
* issue: b/482352502.
|
|
2588
|
+
* will then proceed only if the user confirms the plan in the next turn.
|
|
2853
2589
|
*/
|
|
2854
2590
|
collaborative_planning?: boolean;
|
|
2855
2591
|
/**
|
|
@@ -3910,9 +3646,9 @@ export declare interface FileSearch {
|
|
|
3910
3646
|
}
|
|
3911
3647
|
|
|
3912
3648
|
/**
|
|
3913
|
-
* File Search
|
|
3649
|
+
* File Search call step.
|
|
3914
3650
|
*/
|
|
3915
|
-
declare interface
|
|
3651
|
+
declare interface FileSearchCallStep {
|
|
3916
3652
|
/**
|
|
3917
3653
|
* Required. A unique ID for this specific tool call.
|
|
3918
3654
|
*/
|
|
@@ -3925,18 +3661,14 @@ declare interface FileSearchCallContent {
|
|
|
3925
3661
|
}
|
|
3926
3662
|
|
|
3927
3663
|
/**
|
|
3928
|
-
* File Search result
|
|
3664
|
+
* File Search result step.
|
|
3929
3665
|
*/
|
|
3930
|
-
declare interface
|
|
3666
|
+
declare interface FileSearchResultStep {
|
|
3931
3667
|
/**
|
|
3932
3668
|
* Required. ID to match the ID from the function call block.
|
|
3933
3669
|
*/
|
|
3934
3670
|
call_id: string;
|
|
3935
3671
|
type: 'file_search_result';
|
|
3936
|
-
/**
|
|
3937
|
-
* Optional. The results of the File Search.
|
|
3938
|
-
*/
|
|
3939
|
-
result?: Array<unknown>;
|
|
3940
3672
|
/**
|
|
3941
3673
|
* A signature hash for backend validation.
|
|
3942
3674
|
*/
|
|
@@ -4234,31 +3966,6 @@ export declare interface FunctionCall {
|
|
|
4234
3966
|
willContinue?: boolean;
|
|
4235
3967
|
}
|
|
4236
3968
|
|
|
4237
|
-
/**
|
|
4238
|
-
* A function tool call content block.
|
|
4239
|
-
*/
|
|
4240
|
-
declare interface FunctionCallContent {
|
|
4241
|
-
/**
|
|
4242
|
-
* Required. A unique ID for this specific tool call.
|
|
4243
|
-
*/
|
|
4244
|
-
id: string;
|
|
4245
|
-
/**
|
|
4246
|
-
* Required. The arguments to pass to the function.
|
|
4247
|
-
*/
|
|
4248
|
-
arguments: {
|
|
4249
|
-
[key: string]: unknown;
|
|
4250
|
-
};
|
|
4251
|
-
/**
|
|
4252
|
-
* Required. The name of the tool to call.
|
|
4253
|
-
*/
|
|
4254
|
-
name: string;
|
|
4255
|
-
type: 'function_call';
|
|
4256
|
-
/**
|
|
4257
|
-
* A signature hash for backend validation.
|
|
4258
|
-
*/
|
|
4259
|
-
signature?: string;
|
|
4260
|
-
}
|
|
4261
|
-
|
|
4262
3969
|
/** Function calling config. */
|
|
4263
3970
|
export declare interface FunctionCallingConfig {
|
|
4264
3971
|
/** Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided. */
|
|
@@ -4293,6 +4000,31 @@ export declare enum FunctionCallingConfigMode {
|
|
|
4293
4000
|
VALIDATED = "VALIDATED"
|
|
4294
4001
|
}
|
|
4295
4002
|
|
|
4003
|
+
/**
|
|
4004
|
+
* A function tool call step.
|
|
4005
|
+
*/
|
|
4006
|
+
declare interface FunctionCallStep {
|
|
4007
|
+
/**
|
|
4008
|
+
* Required. A unique ID for this specific tool call.
|
|
4009
|
+
*/
|
|
4010
|
+
id: string;
|
|
4011
|
+
/**
|
|
4012
|
+
* Required. The arguments to pass to the function.
|
|
4013
|
+
*/
|
|
4014
|
+
arguments: {
|
|
4015
|
+
[key: string]: unknown;
|
|
4016
|
+
};
|
|
4017
|
+
/**
|
|
4018
|
+
* Required. The name of the tool to call.
|
|
4019
|
+
*/
|
|
4020
|
+
name: string;
|
|
4021
|
+
type: 'function_call';
|
|
4022
|
+
/**
|
|
4023
|
+
* A signature hash for backend validation.
|
|
4024
|
+
*/
|
|
4025
|
+
signature?: string;
|
|
4026
|
+
}
|
|
4027
|
+
|
|
4296
4028
|
/** 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. */
|
|
4297
4029
|
export declare interface FunctionDeclaration {
|
|
4298
4030
|
/** Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. */
|
|
@@ -4391,9 +4123,9 @@ export declare enum FunctionResponseScheduling {
|
|
|
4391
4123
|
}
|
|
4392
4124
|
|
|
4393
4125
|
/**
|
|
4394
|
-
*
|
|
4126
|
+
* Result of a function tool call.
|
|
4395
4127
|
*/
|
|
4396
|
-
declare interface
|
|
4128
|
+
declare interface FunctionResultStep {
|
|
4397
4129
|
/**
|
|
4398
4130
|
* Required. ID to match the ID from the function call block.
|
|
4399
4131
|
*/
|
|
@@ -5520,9 +5252,9 @@ declare interface GoogleMapsCallArguments {
|
|
|
5520
5252
|
}
|
|
5521
5253
|
|
|
5522
5254
|
/**
|
|
5523
|
-
* Google Maps
|
|
5255
|
+
* Google Maps call step.
|
|
5524
5256
|
*/
|
|
5525
|
-
declare interface
|
|
5257
|
+
declare interface GoogleMapsCallStep {
|
|
5526
5258
|
/**
|
|
5527
5259
|
* Required. A unique ID for this specific tool call.
|
|
5528
5260
|
*/
|
|
@@ -5531,13 +5263,25 @@ declare interface GoogleMapsCallContent {
|
|
|
5531
5263
|
/**
|
|
5532
5264
|
* The arguments to pass to the Google Maps tool.
|
|
5533
5265
|
*/
|
|
5534
|
-
arguments?:
|
|
5266
|
+
arguments?: GoogleMapsCallStep.Arguments;
|
|
5535
5267
|
/**
|
|
5536
5268
|
* A signature hash for backend validation.
|
|
5537
5269
|
*/
|
|
5538
5270
|
signature?: string;
|
|
5539
5271
|
}
|
|
5540
5272
|
|
|
5273
|
+
declare namespace GoogleMapsCallStep {
|
|
5274
|
+
/**
|
|
5275
|
+
* The arguments to pass to the Google Maps tool.
|
|
5276
|
+
*/
|
|
5277
|
+
interface Arguments {
|
|
5278
|
+
/**
|
|
5279
|
+
* The queries to be executed.
|
|
5280
|
+
*/
|
|
5281
|
+
queries?: Array<string>;
|
|
5282
|
+
}
|
|
5283
|
+
}
|
|
5284
|
+
|
|
5541
5285
|
/**
|
|
5542
5286
|
* The result of the Google Maps.
|
|
5543
5287
|
*/
|
|
@@ -5595,17 +5339,14 @@ declare namespace GoogleMapsResult {
|
|
|
5595
5339
|
}
|
|
5596
5340
|
|
|
5597
5341
|
/**
|
|
5598
|
-
* Google Maps result
|
|
5342
|
+
* Google Maps result step.
|
|
5599
5343
|
*/
|
|
5600
|
-
declare interface
|
|
5344
|
+
declare interface GoogleMapsResultStep {
|
|
5601
5345
|
/**
|
|
5602
5346
|
* Required. ID to match the ID from the function call block.
|
|
5603
5347
|
*/
|
|
5604
5348
|
call_id: string;
|
|
5605
|
-
|
|
5606
|
-
* Required. The results of the Google Maps.
|
|
5607
|
-
*/
|
|
5608
|
-
result: Array<GoogleMapsResult>;
|
|
5349
|
+
result: Array<GoogleMapsResultStep.Result>;
|
|
5609
5350
|
type: 'google_maps_result';
|
|
5610
5351
|
/**
|
|
5611
5352
|
* A signature hash for backend validation.
|
|
@@ -5613,6 +5354,44 @@ declare interface GoogleMapsResultContent {
|
|
|
5613
5354
|
signature?: string;
|
|
5614
5355
|
}
|
|
5615
5356
|
|
|
5357
|
+
declare namespace GoogleMapsResultStep {
|
|
5358
|
+
/**
|
|
5359
|
+
* The result of the Google Maps.
|
|
5360
|
+
*/
|
|
5361
|
+
interface Result {
|
|
5362
|
+
places?: Array<Result.Place>;
|
|
5363
|
+
widget_context_token?: string;
|
|
5364
|
+
}
|
|
5365
|
+
namespace Result {
|
|
5366
|
+
interface Place {
|
|
5367
|
+
name?: string;
|
|
5368
|
+
place_id?: string;
|
|
5369
|
+
review_snippets?: Array<Place.ReviewSnippet>;
|
|
5370
|
+
url?: string;
|
|
5371
|
+
}
|
|
5372
|
+
namespace Place {
|
|
5373
|
+
/**
|
|
5374
|
+
* Encapsulates a snippet of a user review that answers a question about the
|
|
5375
|
+
* features of a specific place in Google Maps.
|
|
5376
|
+
*/
|
|
5377
|
+
interface ReviewSnippet {
|
|
5378
|
+
/**
|
|
5379
|
+
* The ID of the review snippet.
|
|
5380
|
+
*/
|
|
5381
|
+
review_id?: string;
|
|
5382
|
+
/**
|
|
5383
|
+
* Title of the review.
|
|
5384
|
+
*/
|
|
5385
|
+
title?: string;
|
|
5386
|
+
/**
|
|
5387
|
+
* A link that corresponds to the user review on Google Maps.
|
|
5388
|
+
*/
|
|
5389
|
+
url?: string;
|
|
5390
|
+
}
|
|
5391
|
+
}
|
|
5392
|
+
}
|
|
5393
|
+
}
|
|
5394
|
+
|
|
5616
5395
|
/** 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. */
|
|
5617
5396
|
export declare interface GoogleRpcStatus {
|
|
5618
5397
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
@@ -5646,9 +5425,9 @@ declare interface GoogleSearchCallArguments {
|
|
|
5646
5425
|
}
|
|
5647
5426
|
|
|
5648
5427
|
/**
|
|
5649
|
-
* Google Search
|
|
5428
|
+
* Google Search call step.
|
|
5650
5429
|
*/
|
|
5651
|
-
declare interface
|
|
5430
|
+
declare interface GoogleSearchCallStep {
|
|
5652
5431
|
/**
|
|
5653
5432
|
* Required. A unique ID for this specific tool call.
|
|
5654
5433
|
*/
|
|
@@ -5656,7 +5435,7 @@ declare interface GoogleSearchCallContent {
|
|
|
5656
5435
|
/**
|
|
5657
5436
|
* Required. The arguments to pass to Google Search.
|
|
5658
5437
|
*/
|
|
5659
|
-
arguments:
|
|
5438
|
+
arguments: GoogleSearchCallStep.Arguments;
|
|
5660
5439
|
type: 'google_search_call';
|
|
5661
5440
|
/**
|
|
5662
5441
|
* The type of search grounding enabled.
|
|
@@ -5668,6 +5447,18 @@ declare interface GoogleSearchCallContent {
|
|
|
5668
5447
|
signature?: string;
|
|
5669
5448
|
}
|
|
5670
5449
|
|
|
5450
|
+
declare namespace GoogleSearchCallStep {
|
|
5451
|
+
/**
|
|
5452
|
+
* Required. The arguments to pass to Google Search.
|
|
5453
|
+
*/
|
|
5454
|
+
interface Arguments {
|
|
5455
|
+
/**
|
|
5456
|
+
* Web search queries for the following-up web search.
|
|
5457
|
+
*/
|
|
5458
|
+
queries?: Array<string>;
|
|
5459
|
+
}
|
|
5460
|
+
}
|
|
5461
|
+
|
|
5671
5462
|
/**
|
|
5672
5463
|
* The result of the Google Search.
|
|
5673
5464
|
*/
|
|
@@ -5679,9 +5470,9 @@ declare interface GoogleSearchResult {
|
|
|
5679
5470
|
}
|
|
5680
5471
|
|
|
5681
5472
|
/**
|
|
5682
|
-
* Google Search result
|
|
5473
|
+
* Google Search result step.
|
|
5683
5474
|
*/
|
|
5684
|
-
declare interface
|
|
5475
|
+
declare interface GoogleSearchResultStep {
|
|
5685
5476
|
/**
|
|
5686
5477
|
* Required. ID to match the ID from the function call block.
|
|
5687
5478
|
*/
|
|
@@ -5689,7 +5480,7 @@ declare interface GoogleSearchResultContent {
|
|
|
5689
5480
|
/**
|
|
5690
5481
|
* Required. The results of the Google Search.
|
|
5691
5482
|
*/
|
|
5692
|
-
result: Array<
|
|
5483
|
+
result: Array<GoogleSearchResultStep.Result>;
|
|
5693
5484
|
type: 'google_search_result';
|
|
5694
5485
|
/**
|
|
5695
5486
|
* Whether the Google Search resulted in an error.
|
|
@@ -5701,6 +5492,18 @@ declare interface GoogleSearchResultContent {
|
|
|
5701
5492
|
signature?: string;
|
|
5702
5493
|
}
|
|
5703
5494
|
|
|
5495
|
+
declare namespace GoogleSearchResultStep {
|
|
5496
|
+
/**
|
|
5497
|
+
* The result of the Google Search.
|
|
5498
|
+
*/
|
|
5499
|
+
interface Result {
|
|
5500
|
+
/**
|
|
5501
|
+
* Web content snippet that can be embedded in a web page or an app webview.
|
|
5502
|
+
*/
|
|
5503
|
+
search_suggestions?: string;
|
|
5504
|
+
}
|
|
5505
|
+
}
|
|
5506
|
+
|
|
5704
5507
|
/** Tool to retrieve public web data for grounding, powered by Google. */
|
|
5705
5508
|
export declare interface GoogleSearchRetrieval {
|
|
5706
5509
|
/** Specifies the dynamic retrieval configuration for the given source. */
|
|
@@ -6318,6 +6121,29 @@ export declare enum ImageResizeMode {
|
|
|
6318
6121
|
PAD = "PAD"
|
|
6319
6122
|
}
|
|
6320
6123
|
|
|
6124
|
+
/**
|
|
6125
|
+
* Configuration for image output format.
|
|
6126
|
+
*/
|
|
6127
|
+
declare interface ImageResponseFormat {
|
|
6128
|
+
type: 'image';
|
|
6129
|
+
/**
|
|
6130
|
+
* The aspect ratio for the image output.
|
|
6131
|
+
*/
|
|
6132
|
+
aspect_ratio?: '1:1' | '2:3' | '3:2' | '3:4' | '4:3' | '4:5' | '5:4' | '9:16' | '16:9' | '21:9' | '1:8' | '8:1' | '1:4' | '4:1';
|
|
6133
|
+
/**
|
|
6134
|
+
* The delivery mode for the image output.
|
|
6135
|
+
*/
|
|
6136
|
+
delivery?: 'inline' | 'url';
|
|
6137
|
+
/**
|
|
6138
|
+
* The size of the image output.
|
|
6139
|
+
*/
|
|
6140
|
+
image_size?: '512' | '1K' | '2K' | '4K';
|
|
6141
|
+
/**
|
|
6142
|
+
* The MIME type of the image output.
|
|
6143
|
+
*/
|
|
6144
|
+
mime_type?: 'image/jpeg';
|
|
6145
|
+
}
|
|
6146
|
+
|
|
6321
6147
|
/** Image search for grounding and related configurations. */
|
|
6322
6148
|
export declare interface ImageSearch {
|
|
6323
6149
|
}
|
|
@@ -6449,15 +6275,11 @@ declare interface Interaction {
|
|
|
6449
6275
|
/**
|
|
6450
6276
|
* The input for the interaction.
|
|
6451
6277
|
*/
|
|
6452
|
-
input?: Array<
|
|
6278
|
+
input?: string | Array<Step> | Array<Content_2> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent;
|
|
6453
6279
|
/**
|
|
6454
6280
|
* The name of the `Model` used for generating the interaction.
|
|
6455
6281
|
*/
|
|
6456
6282
|
model?: Model_2;
|
|
6457
|
-
/**
|
|
6458
|
-
* Output only. Responses from the model.
|
|
6459
|
-
*/
|
|
6460
|
-
outputs?: Array<Content_2>;
|
|
6461
6283
|
/**
|
|
6462
6284
|
* The ID of the previous interaction, if any.
|
|
6463
6285
|
*/
|
|
@@ -6466,7 +6288,7 @@ declare interface Interaction {
|
|
|
6466
6288
|
* Enforces that the generated response is a JSON object that complies with the
|
|
6467
6289
|
* JSON schema specified in this field.
|
|
6468
6290
|
*/
|
|
6469
|
-
response_format?: unknown;
|
|
6291
|
+
response_format?: Array<AudioResponseFormat | TextResponseFormat | ImageResponseFormat | VideoResponseFormat | unknown> | AudioResponseFormat | TextResponseFormat | ImageResponseFormat | VideoResponseFormat | unknown;
|
|
6470
6292
|
/**
|
|
6471
6293
|
* The mime type of the response. This is required if response_format is set.
|
|
6472
6294
|
*/
|
|
@@ -6476,13 +6298,17 @@ declare interface Interaction {
|
|
|
6476
6298
|
*/
|
|
6477
6299
|
response_modalities?: Array<'text' | 'image' | 'audio' | 'video' | 'document'>;
|
|
6478
6300
|
/**
|
|
6479
|
-
* Output only. The role of the interaction.
|
|
6301
|
+
* @deprecated Output only. The role of the interaction.
|
|
6480
6302
|
*/
|
|
6481
6303
|
role?: string;
|
|
6482
6304
|
/**
|
|
6483
6305
|
* The service tier for the interaction.
|
|
6484
6306
|
*/
|
|
6485
6307
|
service_tier?: 'flex' | 'standard' | 'priority';
|
|
6308
|
+
/**
|
|
6309
|
+
* Output only. The steps that make up the interaction.
|
|
6310
|
+
*/
|
|
6311
|
+
steps?: Array<Step>;
|
|
6486
6312
|
/**
|
|
6487
6313
|
* System instruction for the interaction.
|
|
6488
6314
|
*/
|
|
@@ -6509,8 +6335,8 @@ declare interface InteractionCancelParams {
|
|
|
6509
6335
|
api_version?: string;
|
|
6510
6336
|
}
|
|
6511
6337
|
|
|
6512
|
-
declare interface
|
|
6513
|
-
event_type: 'interaction.
|
|
6338
|
+
declare interface InteractionCompletedEvent {
|
|
6339
|
+
event_type: 'interaction.completed';
|
|
6514
6340
|
/**
|
|
6515
6341
|
* Required. The completed interaction with empty outputs to reduce the payload
|
|
6516
6342
|
* size. Use the preceding ContentDelta events for the actual output.
|
|
@@ -6522,6 +6348,18 @@ declare interface InteractionCompleteEvent {
|
|
|
6522
6348
|
event_id?: string;
|
|
6523
6349
|
}
|
|
6524
6350
|
|
|
6351
|
+
declare interface InteractionCreatedEvent {
|
|
6352
|
+
event_type: 'interaction.created';
|
|
6353
|
+
/**
|
|
6354
|
+
* The Interaction resource.
|
|
6355
|
+
*/
|
|
6356
|
+
interaction: Interaction;
|
|
6357
|
+
/**
|
|
6358
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
6359
|
+
*/
|
|
6360
|
+
event_id?: string;
|
|
6361
|
+
}
|
|
6362
|
+
|
|
6525
6363
|
declare type InteractionCreateParams = CreateModelInteractionParamsNonStreaming | CreateModelInteractionParamsStreaming | CreateAgentInteractionParamsNonStreaming | CreateAgentInteractionParamsStreaming;
|
|
6526
6364
|
|
|
6527
6365
|
declare interface InteractionDeleteParams {
|
|
@@ -6582,7 +6420,7 @@ export declare class Interactions extends BaseInteractions {
|
|
|
6582
6420
|
}
|
|
6583
6421
|
|
|
6584
6422
|
export declare namespace Interactions {
|
|
6585
|
-
export { type AllowedTools as AllowedTools, type Annotation as Annotation, type AudioContent as AudioContent, type
|
|
6423
|
+
export { type AllowedTools as AllowedTools, type Annotation as Annotation, type AudioContent as AudioContent, type AudioResponseFormat as AudioResponseFormat, type CodeExecutionCallArguments as CodeExecutionCallArguments, type CodeExecutionCallStep as CodeExecutionCallStep, type CodeExecutionResultStep as CodeExecutionResultStep, type Content_2 as Content, type DeepResearchAgentConfig as DeepResearchAgentConfig, type DocumentContent as DocumentContent, type DynamicAgentConfig as DynamicAgentConfig, type ErrorEvent_2 as ErrorEvent, type FileCitation as FileCitation, type FileSearchCallStep as FileSearchCallStep, type FileSearchResultStep as FileSearchResultStep, type Function_2 as Function, type FunctionCallStep as FunctionCallStep, type FunctionResultStep as FunctionResultStep, type GenerationConfig_2 as GenerationConfig, type GoogleMapsCallArguments as GoogleMapsCallArguments, type GoogleMapsCallStep as GoogleMapsCallStep, type GoogleMapsResult as GoogleMapsResult, type GoogleMapsResultStep as GoogleMapsResultStep, type GoogleSearchCallArguments as GoogleSearchCallArguments, type GoogleSearchCallStep as GoogleSearchCallStep, type GoogleSearchResult as GoogleSearchResult, type GoogleSearchResultStep as GoogleSearchResultStep, type ImageConfig_2 as ImageConfig, type ImageContent as ImageContent, type ImageResponseFormat as ImageResponseFormat, type Interaction as Interaction, type InteractionCompletedEvent as InteractionCompletedEvent, type InteractionCreatedEvent as InteractionCreatedEvent, type InteractionSSEEvent as InteractionSSEEvent, type InteractionStatusUpdate as InteractionStatusUpdate, type MCPServerToolCallStep as MCPServerToolCallStep, type MCPServerToolResultStep as MCPServerToolResultStep, type Model_2 as Model, type ModelOutputStep as ModelOutputStep, type PlaceCitation as PlaceCitation, type SpeechConfig_2 as SpeechConfig, type Step as Step, type StepDelta as StepDelta, type StepStart as StepStart, type StepStop as StepStop, type TextContent as TextContent, type TextResponseFormat as TextResponseFormat, type ThinkingLevel_2 as ThinkingLevel, type ThoughtStep as ThoughtStep, type Tool_2 as Tool, type ToolChoiceConfig as ToolChoiceConfig, type ToolChoiceType as ToolChoiceType, type URLCitation as URLCitation, type URLContextCallArguments as URLContextCallArguments, type URLContextCallStep as URLContextCallStep, type URLContextResult as URLContextResult, type URLContextResultStep as URLContextResultStep, type Usage as Usage, type UserInputStep as UserInputStep, type VideoContent as VideoContent, type VideoResponseFormat as VideoResponseFormat, type WebhookConfig_2 as WebhookConfig, type InteractionDeleteResponse as InteractionDeleteResponse, type InteractionCreateParams as InteractionCreateParams, type CreateModelInteractionParamsNonStreaming as CreateModelInteractionParamsNonStreaming, type CreateModelInteractionParamsStreaming as CreateModelInteractionParamsStreaming, type CreateAgentInteractionParamsNonStreaming as CreateAgentInteractionParamsNonStreaming, type CreateAgentInteractionParamsStreaming as CreateAgentInteractionParamsStreaming, type InteractionDeleteParams as InteractionDeleteParams, type InteractionCancelParams as InteractionCancelParams, type InteractionGetParams as InteractionGetParams, type InteractionGetParamsNonStreaming as InteractionGetParamsNonStreaming, type InteractionGetParamsStreaming as InteractionGetParamsStreaming, };
|
|
6586
6424
|
}
|
|
6587
6425
|
|
|
6588
6426
|
declare namespace InteractionsAPI {
|
|
@@ -6592,58 +6430,64 @@ declare namespace InteractionsAPI {
|
|
|
6592
6430
|
AllowedTools,
|
|
6593
6431
|
Annotation,
|
|
6594
6432
|
AudioContent,
|
|
6433
|
+
AudioResponseFormat,
|
|
6595
6434
|
CodeExecutionCallArguments,
|
|
6596
|
-
|
|
6597
|
-
|
|
6435
|
+
CodeExecutionCallStep,
|
|
6436
|
+
CodeExecutionResultStep,
|
|
6598
6437
|
Content_2 as Content,
|
|
6599
|
-
ContentDelta,
|
|
6600
|
-
ContentStart,
|
|
6601
|
-
ContentStop,
|
|
6602
6438
|
DeepResearchAgentConfig,
|
|
6603
6439
|
DocumentContent,
|
|
6604
6440
|
DynamicAgentConfig,
|
|
6605
6441
|
ErrorEvent_2 as ErrorEvent,
|
|
6606
6442
|
FileCitation,
|
|
6607
|
-
|
|
6608
|
-
|
|
6443
|
+
FileSearchCallStep,
|
|
6444
|
+
FileSearchResultStep,
|
|
6609
6445
|
Function_2 as Function,
|
|
6610
|
-
|
|
6611
|
-
|
|
6446
|
+
FunctionCallStep,
|
|
6447
|
+
FunctionResultStep,
|
|
6612
6448
|
GenerationConfig_2 as GenerationConfig,
|
|
6613
6449
|
GoogleMapsCallArguments,
|
|
6614
|
-
|
|
6450
|
+
GoogleMapsCallStep,
|
|
6615
6451
|
GoogleMapsResult,
|
|
6616
|
-
|
|
6452
|
+
GoogleMapsResultStep,
|
|
6617
6453
|
GoogleSearchCallArguments,
|
|
6618
|
-
|
|
6454
|
+
GoogleSearchCallStep,
|
|
6619
6455
|
GoogleSearchResult,
|
|
6620
|
-
|
|
6456
|
+
GoogleSearchResultStep,
|
|
6621
6457
|
ImageConfig_2 as ImageConfig,
|
|
6622
6458
|
ImageContent,
|
|
6459
|
+
ImageResponseFormat,
|
|
6623
6460
|
Interaction,
|
|
6624
|
-
|
|
6461
|
+
InteractionCompletedEvent,
|
|
6462
|
+
InteractionCreatedEvent,
|
|
6625
6463
|
InteractionSSEEvent,
|
|
6626
|
-
InteractionStartEvent,
|
|
6627
6464
|
InteractionStatusUpdate,
|
|
6628
|
-
|
|
6629
|
-
|
|
6465
|
+
MCPServerToolCallStep,
|
|
6466
|
+
MCPServerToolResultStep,
|
|
6630
6467
|
Model_2 as Model,
|
|
6468
|
+
ModelOutputStep,
|
|
6631
6469
|
PlaceCitation,
|
|
6632
6470
|
SpeechConfig_2 as SpeechConfig,
|
|
6471
|
+
Step,
|
|
6472
|
+
StepDelta,
|
|
6473
|
+
StepStart,
|
|
6474
|
+
StepStop,
|
|
6633
6475
|
TextContent,
|
|
6476
|
+
TextResponseFormat,
|
|
6634
6477
|
ThinkingLevel_2 as ThinkingLevel,
|
|
6635
|
-
|
|
6478
|
+
ThoughtStep,
|
|
6636
6479
|
Tool_2 as Tool,
|
|
6637
6480
|
ToolChoiceConfig,
|
|
6638
6481
|
ToolChoiceType,
|
|
6639
|
-
Turn,
|
|
6640
6482
|
URLCitation,
|
|
6641
6483
|
URLContextCallArguments,
|
|
6642
|
-
|
|
6484
|
+
URLContextCallStep,
|
|
6643
6485
|
URLContextResult,
|
|
6644
|
-
|
|
6486
|
+
URLContextResultStep,
|
|
6645
6487
|
Usage,
|
|
6488
|
+
UserInputStep,
|
|
6646
6489
|
VideoContent,
|
|
6490
|
+
VideoResponseFormat,
|
|
6647
6491
|
WebhookConfig_2 as WebhookConfig,
|
|
6648
6492
|
InteractionDeleteResponse,
|
|
6649
6493
|
InteractionCreateParams,
|
|
@@ -6662,19 +6506,7 @@ declare namespace InteractionsAPI {
|
|
|
6662
6506
|
}
|
|
6663
6507
|
}
|
|
6664
6508
|
|
|
6665
|
-
declare type InteractionSSEEvent =
|
|
6666
|
-
|
|
6667
|
-
declare interface InteractionStartEvent {
|
|
6668
|
-
event_type: 'interaction.start';
|
|
6669
|
-
/**
|
|
6670
|
-
* The Interaction resource.
|
|
6671
|
-
*/
|
|
6672
|
-
interaction: Interaction;
|
|
6673
|
-
/**
|
|
6674
|
-
* The event_id token to be used to resume the interaction stream, from this event.
|
|
6675
|
-
*/
|
|
6676
|
-
event_id?: string;
|
|
6677
|
-
}
|
|
6509
|
+
declare type InteractionSSEEvent = InteractionCreatedEvent | InteractionCompletedEvent | InteractionStatusUpdate | ErrorEvent_2 | StepStart | StepDelta | StepStop;
|
|
6678
6510
|
|
|
6679
6511
|
declare interface InteractionStatusUpdate {
|
|
6680
6512
|
event_type: 'interaction.status_update';
|
|
@@ -7877,9 +7709,9 @@ export declare interface McpServer {
|
|
|
7877
7709
|
}
|
|
7878
7710
|
|
|
7879
7711
|
/**
|
|
7880
|
-
* MCPServer tool call
|
|
7712
|
+
* MCPServer tool call step.
|
|
7881
7713
|
*/
|
|
7882
|
-
declare interface
|
|
7714
|
+
declare interface MCPServerToolCallStep {
|
|
7883
7715
|
/**
|
|
7884
7716
|
* Required. A unique ID for this specific tool call.
|
|
7885
7717
|
*/
|
|
@@ -7906,9 +7738,9 @@ declare interface MCPServerToolCallContent {
|
|
|
7906
7738
|
}
|
|
7907
7739
|
|
|
7908
7740
|
/**
|
|
7909
|
-
* MCPServer tool result
|
|
7741
|
+
* MCPServer tool result step.
|
|
7910
7742
|
*/
|
|
7911
|
-
declare interface
|
|
7743
|
+
declare interface MCPServerToolResultStep {
|
|
7912
7744
|
/**
|
|
7913
7745
|
* Required. ID to match the ID from the function call block.
|
|
7914
7746
|
*/
|
|
@@ -7916,7 +7748,7 @@ declare interface MCPServerToolResultContent {
|
|
|
7916
7748
|
/**
|
|
7917
7749
|
* The output from the MCP server call. Can be simple text or rich content.
|
|
7918
7750
|
*/
|
|
7919
|
-
result: unknown | Array<TextContent | ImageContent
|
|
7751
|
+
result: unknown | string | Array<TextContent | ImageContent>;
|
|
7920
7752
|
type: 'mcp_server_tool_result';
|
|
7921
7753
|
/**
|
|
7922
7754
|
* Name of the tool which is called for this specific tool call.
|
|
@@ -8101,6 +7933,14 @@ export declare interface ModelArmorConfig {
|
|
|
8101
7933
|
responseTemplateName?: string;
|
|
8102
7934
|
}
|
|
8103
7935
|
|
|
7936
|
+
/**
|
|
7937
|
+
* Output generated by the model.
|
|
7938
|
+
*/
|
|
7939
|
+
declare interface ModelOutputStep {
|
|
7940
|
+
type: 'model_output';
|
|
7941
|
+
content?: Array<Content_2>;
|
|
7942
|
+
}
|
|
7943
|
+
|
|
8104
7944
|
export declare class Models extends BaseModule {
|
|
8105
7945
|
private readonly apiClient;
|
|
8106
7946
|
constructor(apiClient: ApiClient);
|
|
@@ -10128,6 +9968,119 @@ export declare enum StartSensitivity {
|
|
|
10128
9968
|
START_SENSITIVITY_LOW = "START_SENSITIVITY_LOW"
|
|
10129
9969
|
}
|
|
10130
9970
|
|
|
9971
|
+
/**
|
|
9972
|
+
* A step in the interaction.
|
|
9973
|
+
*/
|
|
9974
|
+
declare type Step = UserInputStep | ModelOutputStep | ThoughtStep | FunctionCallStep | CodeExecutionCallStep | URLContextCallStep | MCPServerToolCallStep | GoogleSearchCallStep | FileSearchCallStep | GoogleMapsCallStep | FunctionResultStep | CodeExecutionResultStep | URLContextResultStep | GoogleSearchResultStep | MCPServerToolResultStep | FileSearchResultStep | GoogleMapsResultStep;
|
|
9975
|
+
|
|
9976
|
+
declare interface StepDelta {
|
|
9977
|
+
delta: StepDelta.Text | StepDelta.Image | StepDelta.Audio | StepDelta.Document | StepDelta.Video | StepDelta.ThoughtSummary | StepDelta.ThoughtSignature | StepDelta.TextAnnotationDelta | StepDelta.ArgumentsDelta;
|
|
9978
|
+
event_type: 'step.delta';
|
|
9979
|
+
index: number;
|
|
9980
|
+
/**
|
|
9981
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
9982
|
+
*/
|
|
9983
|
+
event_id?: string;
|
|
9984
|
+
}
|
|
9985
|
+
|
|
9986
|
+
declare namespace StepDelta {
|
|
9987
|
+
interface Text {
|
|
9988
|
+
text: string;
|
|
9989
|
+
type: 'text';
|
|
9990
|
+
}
|
|
9991
|
+
interface Image {
|
|
9992
|
+
type: 'image';
|
|
9993
|
+
data?: string;
|
|
9994
|
+
mime_type?: 'image/png' | 'image/jpeg' | 'image/webp' | 'image/heic' | 'image/heif' | 'image/gif' | 'image/bmp' | 'image/tiff';
|
|
9995
|
+
/**
|
|
9996
|
+
* The resolution of the media.
|
|
9997
|
+
*/
|
|
9998
|
+
resolution?: 'low' | 'medium' | 'high' | 'ultra_high';
|
|
9999
|
+
uri?: string;
|
|
10000
|
+
}
|
|
10001
|
+
interface Audio {
|
|
10002
|
+
type: 'audio';
|
|
10003
|
+
/**
|
|
10004
|
+
* The number of audio channels.
|
|
10005
|
+
*/
|
|
10006
|
+
channels?: number;
|
|
10007
|
+
data?: string;
|
|
10008
|
+
mime_type?: 'audio/wav' | 'audio/mp3' | 'audio/aiff' | 'audio/aac' | 'audio/ogg' | 'audio/flac' | 'audio/mpeg' | 'audio/m4a' | 'audio/l16' | 'audio/opus' | 'audio/alaw' | 'audio/mulaw';
|
|
10009
|
+
/**
|
|
10010
|
+
* @deprecated Deprecated. Use sample_rate instead. The value is ignored.
|
|
10011
|
+
*/
|
|
10012
|
+
rate?: number;
|
|
10013
|
+
/**
|
|
10014
|
+
* The sample rate of the audio.
|
|
10015
|
+
*/
|
|
10016
|
+
sample_rate?: number;
|
|
10017
|
+
uri?: string;
|
|
10018
|
+
}
|
|
10019
|
+
interface Document {
|
|
10020
|
+
type: 'document';
|
|
10021
|
+
data?: string;
|
|
10022
|
+
mime_type?: 'application/pdf';
|
|
10023
|
+
uri?: string;
|
|
10024
|
+
}
|
|
10025
|
+
interface Video {
|
|
10026
|
+
type: 'video';
|
|
10027
|
+
data?: string;
|
|
10028
|
+
mime_type?: 'video/mp4' | 'video/mpeg' | 'video/mpg' | 'video/mov' | 'video/avi' | 'video/x-flv' | 'video/webm' | 'video/wmv' | 'video/3gpp';
|
|
10029
|
+
/**
|
|
10030
|
+
* The resolution of the media.
|
|
10031
|
+
*/
|
|
10032
|
+
resolution?: 'low' | 'medium' | 'high' | 'ultra_high';
|
|
10033
|
+
uri?: string;
|
|
10034
|
+
}
|
|
10035
|
+
interface ThoughtSummary {
|
|
10036
|
+
type: 'thought_summary';
|
|
10037
|
+
/**
|
|
10038
|
+
* A new summary item to be added to the thought.
|
|
10039
|
+
*/
|
|
10040
|
+
content?: InteractionsAPI.TextContent | InteractionsAPI.ImageContent;
|
|
10041
|
+
}
|
|
10042
|
+
interface ThoughtSignature {
|
|
10043
|
+
type: 'thought_signature';
|
|
10044
|
+
/**
|
|
10045
|
+
* Signature to match the backend source to be part of the generation.
|
|
10046
|
+
*/
|
|
10047
|
+
signature?: string;
|
|
10048
|
+
}
|
|
10049
|
+
interface TextAnnotationDelta {
|
|
10050
|
+
type: 'text_annotation_delta';
|
|
10051
|
+
/**
|
|
10052
|
+
* Citation information for model-generated content.
|
|
10053
|
+
*/
|
|
10054
|
+
annotations?: Array<InteractionsAPI.Annotation>;
|
|
10055
|
+
}
|
|
10056
|
+
interface ArgumentsDelta {
|
|
10057
|
+
type: 'arguments_delta';
|
|
10058
|
+
partial_arguments?: string;
|
|
10059
|
+
}
|
|
10060
|
+
}
|
|
10061
|
+
|
|
10062
|
+
declare interface StepStart {
|
|
10063
|
+
event_type: 'step.start';
|
|
10064
|
+
index: number;
|
|
10065
|
+
/**
|
|
10066
|
+
* A step in the interaction.
|
|
10067
|
+
*/
|
|
10068
|
+
step: Step;
|
|
10069
|
+
/**
|
|
10070
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
10071
|
+
*/
|
|
10072
|
+
event_id?: string;
|
|
10073
|
+
}
|
|
10074
|
+
|
|
10075
|
+
declare interface StepStop {
|
|
10076
|
+
event_type: 'step.stop';
|
|
10077
|
+
index: number;
|
|
10078
|
+
/**
|
|
10079
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
10080
|
+
*/
|
|
10081
|
+
event_id?: string;
|
|
10082
|
+
}
|
|
10083
|
+
|
|
10131
10084
|
declare class Stream<Item> implements AsyncIterable<Item> {
|
|
10132
10085
|
private iterator;
|
|
10133
10086
|
controller: AbortController;
|
|
@@ -10363,6 +10316,24 @@ declare interface TextContent {
|
|
|
10363
10316
|
annotations?: Array<Annotation>;
|
|
10364
10317
|
}
|
|
10365
10318
|
|
|
10319
|
+
/**
|
|
10320
|
+
* Configuration for text output format.
|
|
10321
|
+
*/
|
|
10322
|
+
declare interface TextResponseFormat {
|
|
10323
|
+
type: 'text';
|
|
10324
|
+
/**
|
|
10325
|
+
* The MIME type of the text output.
|
|
10326
|
+
*/
|
|
10327
|
+
mime_type?: 'application/json' | 'text/plain';
|
|
10328
|
+
/**
|
|
10329
|
+
* The JSON schema that the output should conform to. Only applicable when
|
|
10330
|
+
* mime_type is application/json.
|
|
10331
|
+
*/
|
|
10332
|
+
schema?: {
|
|
10333
|
+
[key: string]: unknown;
|
|
10334
|
+
};
|
|
10335
|
+
}
|
|
10336
|
+
|
|
10366
10337
|
/** The thinking features configuration. */
|
|
10367
10338
|
export declare interface ThinkingConfig {
|
|
10368
10339
|
/** Indicates whether to include thoughts in the response. If true, thoughts are returned only if the model supports thought and thoughts are available.
|
|
@@ -10402,12 +10373,12 @@ export declare enum ThinkingLevel {
|
|
|
10402
10373
|
declare type ThinkingLevel_2 = 'minimal' | 'low' | 'medium' | 'high';
|
|
10403
10374
|
|
|
10404
10375
|
/**
|
|
10405
|
-
* A thought
|
|
10376
|
+
* A thought step.
|
|
10406
10377
|
*/
|
|
10407
|
-
declare interface
|
|
10378
|
+
declare interface ThoughtStep {
|
|
10408
10379
|
type: 'thought';
|
|
10409
10380
|
/**
|
|
10410
|
-
*
|
|
10381
|
+
* A signature hash for backend validation.
|
|
10411
10382
|
*/
|
|
10412
10383
|
signature?: string;
|
|
10413
10384
|
/**
|
|
@@ -10577,7 +10548,7 @@ declare namespace Tool_2 {
|
|
|
10577
10548
|
/**
|
|
10578
10549
|
* The list of predefined functions that are excluded from the model call.
|
|
10579
10550
|
*/
|
|
10580
|
-
|
|
10551
|
+
excluded_predefined_functions?: Array<string>;
|
|
10581
10552
|
}
|
|
10582
10553
|
/**
|
|
10583
10554
|
* A MCPServer is a server that can be called by the model to perform actions.
|
|
@@ -11116,14 +11087,6 @@ export declare interface TuningValidationDataset {
|
|
|
11116
11087
|
vertexDatasetResource?: string;
|
|
11117
11088
|
}
|
|
11118
11089
|
|
|
11119
|
-
declare interface Turn {
|
|
11120
|
-
content?: Array<Content_2> | string;
|
|
11121
|
-
/**
|
|
11122
|
-
* The originator of this turn. Must be user for input or model for model output.
|
|
11123
|
-
*/
|
|
11124
|
-
role?: string;
|
|
11125
|
-
}
|
|
11126
|
-
|
|
11127
11090
|
/** The reason why the turn is complete. */
|
|
11128
11091
|
export declare enum TurnCompleteReason {
|
|
11129
11092
|
/**
|
|
@@ -12123,9 +12086,9 @@ declare interface URLContextCallArguments {
|
|
|
12123
12086
|
}
|
|
12124
12087
|
|
|
12125
12088
|
/**
|
|
12126
|
-
* URL context
|
|
12089
|
+
* URL context call step.
|
|
12127
12090
|
*/
|
|
12128
|
-
declare interface
|
|
12091
|
+
declare interface URLContextCallStep {
|
|
12129
12092
|
/**
|
|
12130
12093
|
* Required. A unique ID for this specific tool call.
|
|
12131
12094
|
*/
|
|
@@ -12133,7 +12096,7 @@ declare interface URLContextCallContent {
|
|
|
12133
12096
|
/**
|
|
12134
12097
|
* Required. The arguments to pass to the URL context.
|
|
12135
12098
|
*/
|
|
12136
|
-
arguments:
|
|
12099
|
+
arguments: URLContextCallStep.Arguments;
|
|
12137
12100
|
type: 'url_context_call';
|
|
12138
12101
|
/**
|
|
12139
12102
|
* A signature hash for backend validation.
|
|
@@ -12141,6 +12104,18 @@ declare interface URLContextCallContent {
|
|
|
12141
12104
|
signature?: string;
|
|
12142
12105
|
}
|
|
12143
12106
|
|
|
12107
|
+
declare namespace URLContextCallStep {
|
|
12108
|
+
/**
|
|
12109
|
+
* Required. The arguments to pass to the URL context.
|
|
12110
|
+
*/
|
|
12111
|
+
interface Arguments {
|
|
12112
|
+
/**
|
|
12113
|
+
* The URLs to fetch.
|
|
12114
|
+
*/
|
|
12115
|
+
urls?: Array<string>;
|
|
12116
|
+
}
|
|
12117
|
+
}
|
|
12118
|
+
|
|
12144
12119
|
/** Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */
|
|
12145
12120
|
export declare interface UrlContextMetadata {
|
|
12146
12121
|
/** Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. */
|
|
@@ -12162,9 +12137,9 @@ declare interface URLContextResult {
|
|
|
12162
12137
|
}
|
|
12163
12138
|
|
|
12164
12139
|
/**
|
|
12165
|
-
* URL context result
|
|
12140
|
+
* URL context result step.
|
|
12166
12141
|
*/
|
|
12167
|
-
declare interface
|
|
12142
|
+
declare interface URLContextResultStep {
|
|
12168
12143
|
/**
|
|
12169
12144
|
* Required. ID to match the ID from the function call block.
|
|
12170
12145
|
*/
|
|
@@ -12172,7 +12147,7 @@ declare interface URLContextResultContent {
|
|
|
12172
12147
|
/**
|
|
12173
12148
|
* Required. The results of the URL context.
|
|
12174
12149
|
*/
|
|
12175
|
-
result: Array<
|
|
12150
|
+
result: Array<URLContextResultStep.Result>;
|
|
12176
12151
|
type: 'url_context_result';
|
|
12177
12152
|
/**
|
|
12178
12153
|
* Whether the URL context resulted in an error.
|
|
@@ -12184,6 +12159,22 @@ declare interface URLContextResultContent {
|
|
|
12184
12159
|
signature?: string;
|
|
12185
12160
|
}
|
|
12186
12161
|
|
|
12162
|
+
declare namespace URLContextResultStep {
|
|
12163
|
+
/**
|
|
12164
|
+
* The result of the URL context.
|
|
12165
|
+
*/
|
|
12166
|
+
interface Result {
|
|
12167
|
+
/**
|
|
12168
|
+
* The status of the URL retrieval.
|
|
12169
|
+
*/
|
|
12170
|
+
status?: 'success' | 'error' | 'paywall' | 'unsafe';
|
|
12171
|
+
/**
|
|
12172
|
+
* The URL that was fetched.
|
|
12173
|
+
*/
|
|
12174
|
+
url?: string;
|
|
12175
|
+
}
|
|
12176
|
+
}
|
|
12177
|
+
|
|
12187
12178
|
/** The metadata for a single URL retrieval. */
|
|
12188
12179
|
export declare interface UrlMetadata {
|
|
12189
12180
|
/** The URL retrieved by the tool. */
|
|
@@ -12362,6 +12353,14 @@ export declare interface UsageMetadata {
|
|
|
12362
12353
|
trafficType?: TrafficType;
|
|
12363
12354
|
}
|
|
12364
12355
|
|
|
12356
|
+
/**
|
|
12357
|
+
* Input provided by the user.
|
|
12358
|
+
*/
|
|
12359
|
+
declare interface UserInputStep {
|
|
12360
|
+
type: 'user_input';
|
|
12361
|
+
content?: Array<Content_2>;
|
|
12362
|
+
}
|
|
12363
|
+
|
|
12365
12364
|
/** The type of the VAD signal. */
|
|
12366
12365
|
export declare enum VadSignalType {
|
|
12367
12366
|
/**
|
|
@@ -12575,6 +12574,13 @@ export declare interface VideoMetadata {
|
|
|
12575
12574
|
startOffset?: string;
|
|
12576
12575
|
}
|
|
12577
12576
|
|
|
12577
|
+
/**
|
|
12578
|
+
* Configuration for video output format.
|
|
12579
|
+
*/
|
|
12580
|
+
declare interface VideoResponseFormat {
|
|
12581
|
+
type: 'video';
|
|
12582
|
+
}
|
|
12583
|
+
|
|
12578
12584
|
/** Voice activity signal. */
|
|
12579
12585
|
export declare interface VoiceActivity {
|
|
12580
12586
|
/** The type of the voice activity signal. */
|