@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/genai.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
|
*/
|
|
@@ -5508,9 +5240,9 @@ declare interface GoogleMapsCallArguments {
|
|
|
5508
5240
|
}
|
|
5509
5241
|
|
|
5510
5242
|
/**
|
|
5511
|
-
* Google Maps
|
|
5243
|
+
* Google Maps call step.
|
|
5512
5244
|
*/
|
|
5513
|
-
declare interface
|
|
5245
|
+
declare interface GoogleMapsCallStep {
|
|
5514
5246
|
/**
|
|
5515
5247
|
* Required. A unique ID for this specific tool call.
|
|
5516
5248
|
*/
|
|
@@ -5519,13 +5251,25 @@ declare interface GoogleMapsCallContent {
|
|
|
5519
5251
|
/**
|
|
5520
5252
|
* The arguments to pass to the Google Maps tool.
|
|
5521
5253
|
*/
|
|
5522
|
-
arguments?:
|
|
5254
|
+
arguments?: GoogleMapsCallStep.Arguments;
|
|
5523
5255
|
/**
|
|
5524
5256
|
* A signature hash for backend validation.
|
|
5525
5257
|
*/
|
|
5526
5258
|
signature?: string;
|
|
5527
5259
|
}
|
|
5528
5260
|
|
|
5261
|
+
declare namespace GoogleMapsCallStep {
|
|
5262
|
+
/**
|
|
5263
|
+
* The arguments to pass to the Google Maps tool.
|
|
5264
|
+
*/
|
|
5265
|
+
interface Arguments {
|
|
5266
|
+
/**
|
|
5267
|
+
* The queries to be executed.
|
|
5268
|
+
*/
|
|
5269
|
+
queries?: Array<string>;
|
|
5270
|
+
}
|
|
5271
|
+
}
|
|
5272
|
+
|
|
5529
5273
|
/**
|
|
5530
5274
|
* The result of the Google Maps.
|
|
5531
5275
|
*/
|
|
@@ -5583,17 +5327,14 @@ declare namespace GoogleMapsResult {
|
|
|
5583
5327
|
}
|
|
5584
5328
|
|
|
5585
5329
|
/**
|
|
5586
|
-
* Google Maps result
|
|
5330
|
+
* Google Maps result step.
|
|
5587
5331
|
*/
|
|
5588
|
-
declare interface
|
|
5332
|
+
declare interface GoogleMapsResultStep {
|
|
5589
5333
|
/**
|
|
5590
5334
|
* Required. ID to match the ID from the function call block.
|
|
5591
5335
|
*/
|
|
5592
5336
|
call_id: string;
|
|
5593
|
-
|
|
5594
|
-
* Required. The results of the Google Maps.
|
|
5595
|
-
*/
|
|
5596
|
-
result: Array<GoogleMapsResult>;
|
|
5337
|
+
result: Array<GoogleMapsResultStep.Result>;
|
|
5597
5338
|
type: 'google_maps_result';
|
|
5598
5339
|
/**
|
|
5599
5340
|
* A signature hash for backend validation.
|
|
@@ -5601,6 +5342,44 @@ declare interface GoogleMapsResultContent {
|
|
|
5601
5342
|
signature?: string;
|
|
5602
5343
|
}
|
|
5603
5344
|
|
|
5345
|
+
declare namespace GoogleMapsResultStep {
|
|
5346
|
+
/**
|
|
5347
|
+
* The result of the Google Maps.
|
|
5348
|
+
*/
|
|
5349
|
+
interface Result {
|
|
5350
|
+
places?: Array<Result.Place>;
|
|
5351
|
+
widget_context_token?: string;
|
|
5352
|
+
}
|
|
5353
|
+
namespace Result {
|
|
5354
|
+
interface Place {
|
|
5355
|
+
name?: string;
|
|
5356
|
+
place_id?: string;
|
|
5357
|
+
review_snippets?: Array<Place.ReviewSnippet>;
|
|
5358
|
+
url?: string;
|
|
5359
|
+
}
|
|
5360
|
+
namespace Place {
|
|
5361
|
+
/**
|
|
5362
|
+
* Encapsulates a snippet of a user review that answers a question about the
|
|
5363
|
+
* features of a specific place in Google Maps.
|
|
5364
|
+
*/
|
|
5365
|
+
interface ReviewSnippet {
|
|
5366
|
+
/**
|
|
5367
|
+
* The ID of the review snippet.
|
|
5368
|
+
*/
|
|
5369
|
+
review_id?: string;
|
|
5370
|
+
/**
|
|
5371
|
+
* Title of the review.
|
|
5372
|
+
*/
|
|
5373
|
+
title?: string;
|
|
5374
|
+
/**
|
|
5375
|
+
* A link that corresponds to the user review on Google Maps.
|
|
5376
|
+
*/
|
|
5377
|
+
url?: string;
|
|
5378
|
+
}
|
|
5379
|
+
}
|
|
5380
|
+
}
|
|
5381
|
+
}
|
|
5382
|
+
|
|
5604
5383
|
/** 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. */
|
|
5605
5384
|
export declare interface GoogleRpcStatus {
|
|
5606
5385
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
@@ -5634,9 +5413,9 @@ declare interface GoogleSearchCallArguments {
|
|
|
5634
5413
|
}
|
|
5635
5414
|
|
|
5636
5415
|
/**
|
|
5637
|
-
* Google Search
|
|
5416
|
+
* Google Search call step.
|
|
5638
5417
|
*/
|
|
5639
|
-
declare interface
|
|
5418
|
+
declare interface GoogleSearchCallStep {
|
|
5640
5419
|
/**
|
|
5641
5420
|
* Required. A unique ID for this specific tool call.
|
|
5642
5421
|
*/
|
|
@@ -5644,7 +5423,7 @@ declare interface GoogleSearchCallContent {
|
|
|
5644
5423
|
/**
|
|
5645
5424
|
* Required. The arguments to pass to Google Search.
|
|
5646
5425
|
*/
|
|
5647
|
-
arguments:
|
|
5426
|
+
arguments: GoogleSearchCallStep.Arguments;
|
|
5648
5427
|
type: 'google_search_call';
|
|
5649
5428
|
/**
|
|
5650
5429
|
* The type of search grounding enabled.
|
|
@@ -5656,6 +5435,18 @@ declare interface GoogleSearchCallContent {
|
|
|
5656
5435
|
signature?: string;
|
|
5657
5436
|
}
|
|
5658
5437
|
|
|
5438
|
+
declare namespace GoogleSearchCallStep {
|
|
5439
|
+
/**
|
|
5440
|
+
* Required. The arguments to pass to Google Search.
|
|
5441
|
+
*/
|
|
5442
|
+
interface Arguments {
|
|
5443
|
+
/**
|
|
5444
|
+
* Web search queries for the following-up web search.
|
|
5445
|
+
*/
|
|
5446
|
+
queries?: Array<string>;
|
|
5447
|
+
}
|
|
5448
|
+
}
|
|
5449
|
+
|
|
5659
5450
|
/**
|
|
5660
5451
|
* The result of the Google Search.
|
|
5661
5452
|
*/
|
|
@@ -5667,9 +5458,9 @@ declare interface GoogleSearchResult {
|
|
|
5667
5458
|
}
|
|
5668
5459
|
|
|
5669
5460
|
/**
|
|
5670
|
-
* Google Search result
|
|
5461
|
+
* Google Search result step.
|
|
5671
5462
|
*/
|
|
5672
|
-
declare interface
|
|
5463
|
+
declare interface GoogleSearchResultStep {
|
|
5673
5464
|
/**
|
|
5674
5465
|
* Required. ID to match the ID from the function call block.
|
|
5675
5466
|
*/
|
|
@@ -5677,7 +5468,7 @@ declare interface GoogleSearchResultContent {
|
|
|
5677
5468
|
/**
|
|
5678
5469
|
* Required. The results of the Google Search.
|
|
5679
5470
|
*/
|
|
5680
|
-
result: Array<
|
|
5471
|
+
result: Array<GoogleSearchResultStep.Result>;
|
|
5681
5472
|
type: 'google_search_result';
|
|
5682
5473
|
/**
|
|
5683
5474
|
* Whether the Google Search resulted in an error.
|
|
@@ -5689,6 +5480,18 @@ declare interface GoogleSearchResultContent {
|
|
|
5689
5480
|
signature?: string;
|
|
5690
5481
|
}
|
|
5691
5482
|
|
|
5483
|
+
declare namespace GoogleSearchResultStep {
|
|
5484
|
+
/**
|
|
5485
|
+
* The result of the Google Search.
|
|
5486
|
+
*/
|
|
5487
|
+
interface Result {
|
|
5488
|
+
/**
|
|
5489
|
+
* Web content snippet that can be embedded in a web page or an app webview.
|
|
5490
|
+
*/
|
|
5491
|
+
search_suggestions?: string;
|
|
5492
|
+
}
|
|
5493
|
+
}
|
|
5494
|
+
|
|
5692
5495
|
/** Tool to retrieve public web data for grounding, powered by Google. */
|
|
5693
5496
|
export declare interface GoogleSearchRetrieval {
|
|
5694
5497
|
/** Specifies the dynamic retrieval configuration for the given source. */
|
|
@@ -6306,6 +6109,29 @@ export declare enum ImageResizeMode {
|
|
|
6306
6109
|
PAD = "PAD"
|
|
6307
6110
|
}
|
|
6308
6111
|
|
|
6112
|
+
/**
|
|
6113
|
+
* Configuration for image output format.
|
|
6114
|
+
*/
|
|
6115
|
+
declare interface ImageResponseFormat {
|
|
6116
|
+
type: 'image';
|
|
6117
|
+
/**
|
|
6118
|
+
* The aspect ratio for the image output.
|
|
6119
|
+
*/
|
|
6120
|
+
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';
|
|
6121
|
+
/**
|
|
6122
|
+
* The delivery mode for the image output.
|
|
6123
|
+
*/
|
|
6124
|
+
delivery?: 'inline' | 'url';
|
|
6125
|
+
/**
|
|
6126
|
+
* The size of the image output.
|
|
6127
|
+
*/
|
|
6128
|
+
image_size?: '512' | '1K' | '2K' | '4K';
|
|
6129
|
+
/**
|
|
6130
|
+
* The MIME type of the image output.
|
|
6131
|
+
*/
|
|
6132
|
+
mime_type?: 'image/jpeg';
|
|
6133
|
+
}
|
|
6134
|
+
|
|
6309
6135
|
/** Image search for grounding and related configurations. */
|
|
6310
6136
|
export declare interface ImageSearch {
|
|
6311
6137
|
}
|
|
@@ -6437,15 +6263,11 @@ declare interface Interaction {
|
|
|
6437
6263
|
/**
|
|
6438
6264
|
* The input for the interaction.
|
|
6439
6265
|
*/
|
|
6440
|
-
input?: Array<
|
|
6266
|
+
input?: string | Array<Step> | Array<Content_2> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent;
|
|
6441
6267
|
/**
|
|
6442
6268
|
* The name of the `Model` used for generating the interaction.
|
|
6443
6269
|
*/
|
|
6444
6270
|
model?: Model_2;
|
|
6445
|
-
/**
|
|
6446
|
-
* Output only. Responses from the model.
|
|
6447
|
-
*/
|
|
6448
|
-
outputs?: Array<Content_2>;
|
|
6449
6271
|
/**
|
|
6450
6272
|
* The ID of the previous interaction, if any.
|
|
6451
6273
|
*/
|
|
@@ -6454,7 +6276,7 @@ declare interface Interaction {
|
|
|
6454
6276
|
* Enforces that the generated response is a JSON object that complies with the
|
|
6455
6277
|
* JSON schema specified in this field.
|
|
6456
6278
|
*/
|
|
6457
|
-
response_format?: unknown;
|
|
6279
|
+
response_format?: Array<AudioResponseFormat | TextResponseFormat | ImageResponseFormat | VideoResponseFormat | unknown> | AudioResponseFormat | TextResponseFormat | ImageResponseFormat | VideoResponseFormat | unknown;
|
|
6458
6280
|
/**
|
|
6459
6281
|
* The mime type of the response. This is required if response_format is set.
|
|
6460
6282
|
*/
|
|
@@ -6464,13 +6286,17 @@ declare interface Interaction {
|
|
|
6464
6286
|
*/
|
|
6465
6287
|
response_modalities?: Array<'text' | 'image' | 'audio' | 'video' | 'document'>;
|
|
6466
6288
|
/**
|
|
6467
|
-
* Output only. The role of the interaction.
|
|
6289
|
+
* @deprecated Output only. The role of the interaction.
|
|
6468
6290
|
*/
|
|
6469
6291
|
role?: string;
|
|
6470
6292
|
/**
|
|
6471
6293
|
* The service tier for the interaction.
|
|
6472
6294
|
*/
|
|
6473
6295
|
service_tier?: 'flex' | 'standard' | 'priority';
|
|
6296
|
+
/**
|
|
6297
|
+
* Output only. The steps that make up the interaction.
|
|
6298
|
+
*/
|
|
6299
|
+
steps?: Array<Step>;
|
|
6474
6300
|
/**
|
|
6475
6301
|
* System instruction for the interaction.
|
|
6476
6302
|
*/
|
|
@@ -6497,8 +6323,8 @@ declare interface InteractionCancelParams {
|
|
|
6497
6323
|
api_version?: string;
|
|
6498
6324
|
}
|
|
6499
6325
|
|
|
6500
|
-
declare interface
|
|
6501
|
-
event_type: 'interaction.
|
|
6326
|
+
declare interface InteractionCompletedEvent {
|
|
6327
|
+
event_type: 'interaction.completed';
|
|
6502
6328
|
/**
|
|
6503
6329
|
* Required. The completed interaction with empty outputs to reduce the payload
|
|
6504
6330
|
* size. Use the preceding ContentDelta events for the actual output.
|
|
@@ -6510,6 +6336,18 @@ declare interface InteractionCompleteEvent {
|
|
|
6510
6336
|
event_id?: string;
|
|
6511
6337
|
}
|
|
6512
6338
|
|
|
6339
|
+
declare interface InteractionCreatedEvent {
|
|
6340
|
+
event_type: 'interaction.created';
|
|
6341
|
+
/**
|
|
6342
|
+
* The Interaction resource.
|
|
6343
|
+
*/
|
|
6344
|
+
interaction: Interaction;
|
|
6345
|
+
/**
|
|
6346
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
6347
|
+
*/
|
|
6348
|
+
event_id?: string;
|
|
6349
|
+
}
|
|
6350
|
+
|
|
6513
6351
|
declare type InteractionCreateParams = CreateModelInteractionParamsNonStreaming | CreateModelInteractionParamsStreaming | CreateAgentInteractionParamsNonStreaming | CreateAgentInteractionParamsStreaming;
|
|
6514
6352
|
|
|
6515
6353
|
declare interface InteractionDeleteParams {
|
|
@@ -6570,7 +6408,7 @@ export declare class Interactions extends BaseInteractions {
|
|
|
6570
6408
|
}
|
|
6571
6409
|
|
|
6572
6410
|
export declare namespace Interactions {
|
|
6573
|
-
export { type AllowedTools as AllowedTools, type Annotation as Annotation, type AudioContent as AudioContent, type
|
|
6411
|
+
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, };
|
|
6574
6412
|
}
|
|
6575
6413
|
|
|
6576
6414
|
declare namespace InteractionsAPI {
|
|
@@ -6580,58 +6418,64 @@ declare namespace InteractionsAPI {
|
|
|
6580
6418
|
AllowedTools,
|
|
6581
6419
|
Annotation,
|
|
6582
6420
|
AudioContent,
|
|
6421
|
+
AudioResponseFormat,
|
|
6583
6422
|
CodeExecutionCallArguments,
|
|
6584
|
-
|
|
6585
|
-
|
|
6423
|
+
CodeExecutionCallStep,
|
|
6424
|
+
CodeExecutionResultStep,
|
|
6586
6425
|
Content_2 as Content,
|
|
6587
|
-
ContentDelta,
|
|
6588
|
-
ContentStart,
|
|
6589
|
-
ContentStop,
|
|
6590
6426
|
DeepResearchAgentConfig,
|
|
6591
6427
|
DocumentContent,
|
|
6592
6428
|
DynamicAgentConfig,
|
|
6593
6429
|
ErrorEvent_2 as ErrorEvent,
|
|
6594
6430
|
FileCitation,
|
|
6595
|
-
|
|
6596
|
-
|
|
6431
|
+
FileSearchCallStep,
|
|
6432
|
+
FileSearchResultStep,
|
|
6597
6433
|
Function_2 as Function,
|
|
6598
|
-
|
|
6599
|
-
|
|
6434
|
+
FunctionCallStep,
|
|
6435
|
+
FunctionResultStep,
|
|
6600
6436
|
GenerationConfig_2 as GenerationConfig,
|
|
6601
6437
|
GoogleMapsCallArguments,
|
|
6602
|
-
|
|
6438
|
+
GoogleMapsCallStep,
|
|
6603
6439
|
GoogleMapsResult,
|
|
6604
|
-
|
|
6440
|
+
GoogleMapsResultStep,
|
|
6605
6441
|
GoogleSearchCallArguments,
|
|
6606
|
-
|
|
6442
|
+
GoogleSearchCallStep,
|
|
6607
6443
|
GoogleSearchResult,
|
|
6608
|
-
|
|
6444
|
+
GoogleSearchResultStep,
|
|
6609
6445
|
ImageConfig_2 as ImageConfig,
|
|
6610
6446
|
ImageContent,
|
|
6447
|
+
ImageResponseFormat,
|
|
6611
6448
|
Interaction,
|
|
6612
|
-
|
|
6449
|
+
InteractionCompletedEvent,
|
|
6450
|
+
InteractionCreatedEvent,
|
|
6613
6451
|
InteractionSSEEvent,
|
|
6614
|
-
InteractionStartEvent,
|
|
6615
6452
|
InteractionStatusUpdate,
|
|
6616
|
-
|
|
6617
|
-
|
|
6453
|
+
MCPServerToolCallStep,
|
|
6454
|
+
MCPServerToolResultStep,
|
|
6618
6455
|
Model_2 as Model,
|
|
6456
|
+
ModelOutputStep,
|
|
6619
6457
|
PlaceCitation,
|
|
6620
6458
|
SpeechConfig_2 as SpeechConfig,
|
|
6459
|
+
Step,
|
|
6460
|
+
StepDelta,
|
|
6461
|
+
StepStart,
|
|
6462
|
+
StepStop,
|
|
6621
6463
|
TextContent,
|
|
6464
|
+
TextResponseFormat,
|
|
6622
6465
|
ThinkingLevel_2 as ThinkingLevel,
|
|
6623
|
-
|
|
6466
|
+
ThoughtStep,
|
|
6624
6467
|
Tool_2 as Tool,
|
|
6625
6468
|
ToolChoiceConfig,
|
|
6626
6469
|
ToolChoiceType,
|
|
6627
|
-
Turn,
|
|
6628
6470
|
URLCitation,
|
|
6629
6471
|
URLContextCallArguments,
|
|
6630
|
-
|
|
6472
|
+
URLContextCallStep,
|
|
6631
6473
|
URLContextResult,
|
|
6632
|
-
|
|
6474
|
+
URLContextResultStep,
|
|
6633
6475
|
Usage,
|
|
6476
|
+
UserInputStep,
|
|
6634
6477
|
VideoContent,
|
|
6478
|
+
VideoResponseFormat,
|
|
6635
6479
|
WebhookConfig_2 as WebhookConfig,
|
|
6636
6480
|
InteractionDeleteResponse,
|
|
6637
6481
|
InteractionCreateParams,
|
|
@@ -6650,19 +6494,7 @@ declare namespace InteractionsAPI {
|
|
|
6650
6494
|
}
|
|
6651
6495
|
}
|
|
6652
6496
|
|
|
6653
|
-
declare type InteractionSSEEvent =
|
|
6654
|
-
|
|
6655
|
-
declare interface InteractionStartEvent {
|
|
6656
|
-
event_type: 'interaction.start';
|
|
6657
|
-
/**
|
|
6658
|
-
* The Interaction resource.
|
|
6659
|
-
*/
|
|
6660
|
-
interaction: Interaction;
|
|
6661
|
-
/**
|
|
6662
|
-
* The event_id token to be used to resume the interaction stream, from this event.
|
|
6663
|
-
*/
|
|
6664
|
-
event_id?: string;
|
|
6665
|
-
}
|
|
6497
|
+
declare type InteractionSSEEvent = InteractionCreatedEvent | InteractionCompletedEvent | InteractionStatusUpdate | ErrorEvent_2 | StepStart | StepDelta | StepStop;
|
|
6666
6498
|
|
|
6667
6499
|
declare interface InteractionStatusUpdate {
|
|
6668
6500
|
event_type: 'interaction.status_update';
|
|
@@ -7865,9 +7697,9 @@ export declare interface McpServer {
|
|
|
7865
7697
|
}
|
|
7866
7698
|
|
|
7867
7699
|
/**
|
|
7868
|
-
* MCPServer tool call
|
|
7700
|
+
* MCPServer tool call step.
|
|
7869
7701
|
*/
|
|
7870
|
-
declare interface
|
|
7702
|
+
declare interface MCPServerToolCallStep {
|
|
7871
7703
|
/**
|
|
7872
7704
|
* Required. A unique ID for this specific tool call.
|
|
7873
7705
|
*/
|
|
@@ -7894,9 +7726,9 @@ declare interface MCPServerToolCallContent {
|
|
|
7894
7726
|
}
|
|
7895
7727
|
|
|
7896
7728
|
/**
|
|
7897
|
-
* MCPServer tool result
|
|
7729
|
+
* MCPServer tool result step.
|
|
7898
7730
|
*/
|
|
7899
|
-
declare interface
|
|
7731
|
+
declare interface MCPServerToolResultStep {
|
|
7900
7732
|
/**
|
|
7901
7733
|
* Required. ID to match the ID from the function call block.
|
|
7902
7734
|
*/
|
|
@@ -7904,7 +7736,7 @@ declare interface MCPServerToolResultContent {
|
|
|
7904
7736
|
/**
|
|
7905
7737
|
* The output from the MCP server call. Can be simple text or rich content.
|
|
7906
7738
|
*/
|
|
7907
|
-
result: unknown | Array<TextContent | ImageContent
|
|
7739
|
+
result: unknown | string | Array<TextContent | ImageContent>;
|
|
7908
7740
|
type: 'mcp_server_tool_result';
|
|
7909
7741
|
/**
|
|
7910
7742
|
* Name of the tool which is called for this specific tool call.
|
|
@@ -8089,6 +7921,14 @@ export declare interface ModelArmorConfig {
|
|
|
8089
7921
|
responseTemplateName?: string;
|
|
8090
7922
|
}
|
|
8091
7923
|
|
|
7924
|
+
/**
|
|
7925
|
+
* Output generated by the model.
|
|
7926
|
+
*/
|
|
7927
|
+
declare interface ModelOutputStep {
|
|
7928
|
+
type: 'model_output';
|
|
7929
|
+
content?: Array<Content_2>;
|
|
7930
|
+
}
|
|
7931
|
+
|
|
8092
7932
|
export declare class Models extends BaseModule {
|
|
8093
7933
|
private readonly apiClient;
|
|
8094
7934
|
constructor(apiClient: ApiClient);
|
|
@@ -10116,6 +9956,119 @@ export declare enum StartSensitivity {
|
|
|
10116
9956
|
START_SENSITIVITY_LOW = "START_SENSITIVITY_LOW"
|
|
10117
9957
|
}
|
|
10118
9958
|
|
|
9959
|
+
/**
|
|
9960
|
+
* A step in the interaction.
|
|
9961
|
+
*/
|
|
9962
|
+
declare type Step = UserInputStep | ModelOutputStep | ThoughtStep | FunctionCallStep | CodeExecutionCallStep | URLContextCallStep | MCPServerToolCallStep | GoogleSearchCallStep | FileSearchCallStep | GoogleMapsCallStep | FunctionResultStep | CodeExecutionResultStep | URLContextResultStep | GoogleSearchResultStep | MCPServerToolResultStep | FileSearchResultStep | GoogleMapsResultStep;
|
|
9963
|
+
|
|
9964
|
+
declare interface StepDelta {
|
|
9965
|
+
delta: StepDelta.Text | StepDelta.Image | StepDelta.Audio | StepDelta.Document | StepDelta.Video | StepDelta.ThoughtSummary | StepDelta.ThoughtSignature | StepDelta.TextAnnotationDelta | StepDelta.ArgumentsDelta;
|
|
9966
|
+
event_type: 'step.delta';
|
|
9967
|
+
index: number;
|
|
9968
|
+
/**
|
|
9969
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
9970
|
+
*/
|
|
9971
|
+
event_id?: string;
|
|
9972
|
+
}
|
|
9973
|
+
|
|
9974
|
+
declare namespace StepDelta {
|
|
9975
|
+
interface Text {
|
|
9976
|
+
text: string;
|
|
9977
|
+
type: 'text';
|
|
9978
|
+
}
|
|
9979
|
+
interface Image {
|
|
9980
|
+
type: 'image';
|
|
9981
|
+
data?: string;
|
|
9982
|
+
mime_type?: 'image/png' | 'image/jpeg' | 'image/webp' | 'image/heic' | 'image/heif' | 'image/gif' | 'image/bmp' | 'image/tiff';
|
|
9983
|
+
/**
|
|
9984
|
+
* The resolution of the media.
|
|
9985
|
+
*/
|
|
9986
|
+
resolution?: 'low' | 'medium' | 'high' | 'ultra_high';
|
|
9987
|
+
uri?: string;
|
|
9988
|
+
}
|
|
9989
|
+
interface Audio {
|
|
9990
|
+
type: 'audio';
|
|
9991
|
+
/**
|
|
9992
|
+
* The number of audio channels.
|
|
9993
|
+
*/
|
|
9994
|
+
channels?: number;
|
|
9995
|
+
data?: string;
|
|
9996
|
+
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';
|
|
9997
|
+
/**
|
|
9998
|
+
* @deprecated Deprecated. Use sample_rate instead. The value is ignored.
|
|
9999
|
+
*/
|
|
10000
|
+
rate?: number;
|
|
10001
|
+
/**
|
|
10002
|
+
* The sample rate of the audio.
|
|
10003
|
+
*/
|
|
10004
|
+
sample_rate?: number;
|
|
10005
|
+
uri?: string;
|
|
10006
|
+
}
|
|
10007
|
+
interface Document {
|
|
10008
|
+
type: 'document';
|
|
10009
|
+
data?: string;
|
|
10010
|
+
mime_type?: 'application/pdf';
|
|
10011
|
+
uri?: string;
|
|
10012
|
+
}
|
|
10013
|
+
interface Video {
|
|
10014
|
+
type: 'video';
|
|
10015
|
+
data?: string;
|
|
10016
|
+
mime_type?: 'video/mp4' | 'video/mpeg' | 'video/mpg' | 'video/mov' | 'video/avi' | 'video/x-flv' | 'video/webm' | 'video/wmv' | 'video/3gpp';
|
|
10017
|
+
/**
|
|
10018
|
+
* The resolution of the media.
|
|
10019
|
+
*/
|
|
10020
|
+
resolution?: 'low' | 'medium' | 'high' | 'ultra_high';
|
|
10021
|
+
uri?: string;
|
|
10022
|
+
}
|
|
10023
|
+
interface ThoughtSummary {
|
|
10024
|
+
type: 'thought_summary';
|
|
10025
|
+
/**
|
|
10026
|
+
* A new summary item to be added to the thought.
|
|
10027
|
+
*/
|
|
10028
|
+
content?: InteractionsAPI.TextContent | InteractionsAPI.ImageContent;
|
|
10029
|
+
}
|
|
10030
|
+
interface ThoughtSignature {
|
|
10031
|
+
type: 'thought_signature';
|
|
10032
|
+
/**
|
|
10033
|
+
* Signature to match the backend source to be part of the generation.
|
|
10034
|
+
*/
|
|
10035
|
+
signature?: string;
|
|
10036
|
+
}
|
|
10037
|
+
interface TextAnnotationDelta {
|
|
10038
|
+
type: 'text_annotation_delta';
|
|
10039
|
+
/**
|
|
10040
|
+
* Citation information for model-generated content.
|
|
10041
|
+
*/
|
|
10042
|
+
annotations?: Array<InteractionsAPI.Annotation>;
|
|
10043
|
+
}
|
|
10044
|
+
interface ArgumentsDelta {
|
|
10045
|
+
type: 'arguments_delta';
|
|
10046
|
+
partial_arguments?: string;
|
|
10047
|
+
}
|
|
10048
|
+
}
|
|
10049
|
+
|
|
10050
|
+
declare interface StepStart {
|
|
10051
|
+
event_type: 'step.start';
|
|
10052
|
+
index: number;
|
|
10053
|
+
/**
|
|
10054
|
+
* A step in the interaction.
|
|
10055
|
+
*/
|
|
10056
|
+
step: Step;
|
|
10057
|
+
/**
|
|
10058
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
10059
|
+
*/
|
|
10060
|
+
event_id?: string;
|
|
10061
|
+
}
|
|
10062
|
+
|
|
10063
|
+
declare interface StepStop {
|
|
10064
|
+
event_type: 'step.stop';
|
|
10065
|
+
index: number;
|
|
10066
|
+
/**
|
|
10067
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
10068
|
+
*/
|
|
10069
|
+
event_id?: string;
|
|
10070
|
+
}
|
|
10071
|
+
|
|
10119
10072
|
declare class Stream<Item> implements AsyncIterable<Item> {
|
|
10120
10073
|
private iterator;
|
|
10121
10074
|
controller: AbortController;
|
|
@@ -10351,6 +10304,24 @@ declare interface TextContent {
|
|
|
10351
10304
|
annotations?: Array<Annotation>;
|
|
10352
10305
|
}
|
|
10353
10306
|
|
|
10307
|
+
/**
|
|
10308
|
+
* Configuration for text output format.
|
|
10309
|
+
*/
|
|
10310
|
+
declare interface TextResponseFormat {
|
|
10311
|
+
type: 'text';
|
|
10312
|
+
/**
|
|
10313
|
+
* The MIME type of the text output.
|
|
10314
|
+
*/
|
|
10315
|
+
mime_type?: 'application/json' | 'text/plain';
|
|
10316
|
+
/**
|
|
10317
|
+
* The JSON schema that the output should conform to. Only applicable when
|
|
10318
|
+
* mime_type is application/json.
|
|
10319
|
+
*/
|
|
10320
|
+
schema?: {
|
|
10321
|
+
[key: string]: unknown;
|
|
10322
|
+
};
|
|
10323
|
+
}
|
|
10324
|
+
|
|
10354
10325
|
/** The thinking features configuration. */
|
|
10355
10326
|
export declare interface ThinkingConfig {
|
|
10356
10327
|
/** Indicates whether to include thoughts in the response. If true, thoughts are returned only if the model supports thought and thoughts are available.
|
|
@@ -10390,12 +10361,12 @@ export declare enum ThinkingLevel {
|
|
|
10390
10361
|
declare type ThinkingLevel_2 = 'minimal' | 'low' | 'medium' | 'high';
|
|
10391
10362
|
|
|
10392
10363
|
/**
|
|
10393
|
-
* A thought
|
|
10364
|
+
* A thought step.
|
|
10394
10365
|
*/
|
|
10395
|
-
declare interface
|
|
10366
|
+
declare interface ThoughtStep {
|
|
10396
10367
|
type: 'thought';
|
|
10397
10368
|
/**
|
|
10398
|
-
*
|
|
10369
|
+
* A signature hash for backend validation.
|
|
10399
10370
|
*/
|
|
10400
10371
|
signature?: string;
|
|
10401
10372
|
/**
|
|
@@ -10565,7 +10536,7 @@ declare namespace Tool_2 {
|
|
|
10565
10536
|
/**
|
|
10566
10537
|
* The list of predefined functions that are excluded from the model call.
|
|
10567
10538
|
*/
|
|
10568
|
-
|
|
10539
|
+
excluded_predefined_functions?: Array<string>;
|
|
10569
10540
|
}
|
|
10570
10541
|
/**
|
|
10571
10542
|
* A MCPServer is a server that can be called by the model to perform actions.
|
|
@@ -11104,14 +11075,6 @@ export declare interface TuningValidationDataset {
|
|
|
11104
11075
|
vertexDatasetResource?: string;
|
|
11105
11076
|
}
|
|
11106
11077
|
|
|
11107
|
-
declare interface Turn {
|
|
11108
|
-
content?: Array<Content_2> | string;
|
|
11109
|
-
/**
|
|
11110
|
-
* The originator of this turn. Must be user for input or model for model output.
|
|
11111
|
-
*/
|
|
11112
|
-
role?: string;
|
|
11113
|
-
}
|
|
11114
|
-
|
|
11115
11078
|
/** The reason why the turn is complete. */
|
|
11116
11079
|
export declare enum TurnCompleteReason {
|
|
11117
11080
|
/**
|
|
@@ -12111,9 +12074,9 @@ declare interface URLContextCallArguments {
|
|
|
12111
12074
|
}
|
|
12112
12075
|
|
|
12113
12076
|
/**
|
|
12114
|
-
* URL context
|
|
12077
|
+
* URL context call step.
|
|
12115
12078
|
*/
|
|
12116
|
-
declare interface
|
|
12079
|
+
declare interface URLContextCallStep {
|
|
12117
12080
|
/**
|
|
12118
12081
|
* Required. A unique ID for this specific tool call.
|
|
12119
12082
|
*/
|
|
@@ -12121,7 +12084,7 @@ declare interface URLContextCallContent {
|
|
|
12121
12084
|
/**
|
|
12122
12085
|
* Required. The arguments to pass to the URL context.
|
|
12123
12086
|
*/
|
|
12124
|
-
arguments:
|
|
12087
|
+
arguments: URLContextCallStep.Arguments;
|
|
12125
12088
|
type: 'url_context_call';
|
|
12126
12089
|
/**
|
|
12127
12090
|
* A signature hash for backend validation.
|
|
@@ -12129,6 +12092,18 @@ declare interface URLContextCallContent {
|
|
|
12129
12092
|
signature?: string;
|
|
12130
12093
|
}
|
|
12131
12094
|
|
|
12095
|
+
declare namespace URLContextCallStep {
|
|
12096
|
+
/**
|
|
12097
|
+
* Required. The arguments to pass to the URL context.
|
|
12098
|
+
*/
|
|
12099
|
+
interface Arguments {
|
|
12100
|
+
/**
|
|
12101
|
+
* The URLs to fetch.
|
|
12102
|
+
*/
|
|
12103
|
+
urls?: Array<string>;
|
|
12104
|
+
}
|
|
12105
|
+
}
|
|
12106
|
+
|
|
12132
12107
|
/** Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */
|
|
12133
12108
|
export declare interface UrlContextMetadata {
|
|
12134
12109
|
/** Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. */
|
|
@@ -12150,9 +12125,9 @@ declare interface URLContextResult {
|
|
|
12150
12125
|
}
|
|
12151
12126
|
|
|
12152
12127
|
/**
|
|
12153
|
-
* URL context result
|
|
12128
|
+
* URL context result step.
|
|
12154
12129
|
*/
|
|
12155
|
-
declare interface
|
|
12130
|
+
declare interface URLContextResultStep {
|
|
12156
12131
|
/**
|
|
12157
12132
|
* Required. ID to match the ID from the function call block.
|
|
12158
12133
|
*/
|
|
@@ -12160,7 +12135,7 @@ declare interface URLContextResultContent {
|
|
|
12160
12135
|
/**
|
|
12161
12136
|
* Required. The results of the URL context.
|
|
12162
12137
|
*/
|
|
12163
|
-
result: Array<
|
|
12138
|
+
result: Array<URLContextResultStep.Result>;
|
|
12164
12139
|
type: 'url_context_result';
|
|
12165
12140
|
/**
|
|
12166
12141
|
* Whether the URL context resulted in an error.
|
|
@@ -12172,6 +12147,22 @@ declare interface URLContextResultContent {
|
|
|
12172
12147
|
signature?: string;
|
|
12173
12148
|
}
|
|
12174
12149
|
|
|
12150
|
+
declare namespace URLContextResultStep {
|
|
12151
|
+
/**
|
|
12152
|
+
* The result of the URL context.
|
|
12153
|
+
*/
|
|
12154
|
+
interface Result {
|
|
12155
|
+
/**
|
|
12156
|
+
* The status of the URL retrieval.
|
|
12157
|
+
*/
|
|
12158
|
+
status?: 'success' | 'error' | 'paywall' | 'unsafe';
|
|
12159
|
+
/**
|
|
12160
|
+
* The URL that was fetched.
|
|
12161
|
+
*/
|
|
12162
|
+
url?: string;
|
|
12163
|
+
}
|
|
12164
|
+
}
|
|
12165
|
+
|
|
12175
12166
|
/** The metadata for a single URL retrieval. */
|
|
12176
12167
|
export declare interface UrlMetadata {
|
|
12177
12168
|
/** The URL retrieved by the tool. */
|
|
@@ -12350,6 +12341,14 @@ export declare interface UsageMetadata {
|
|
|
12350
12341
|
trafficType?: TrafficType;
|
|
12351
12342
|
}
|
|
12352
12343
|
|
|
12344
|
+
/**
|
|
12345
|
+
* Input provided by the user.
|
|
12346
|
+
*/
|
|
12347
|
+
declare interface UserInputStep {
|
|
12348
|
+
type: 'user_input';
|
|
12349
|
+
content?: Array<Content_2>;
|
|
12350
|
+
}
|
|
12351
|
+
|
|
12353
12352
|
/** The type of the VAD signal. */
|
|
12354
12353
|
export declare enum VadSignalType {
|
|
12355
12354
|
/**
|
|
@@ -12563,6 +12562,13 @@ export declare interface VideoMetadata {
|
|
|
12563
12562
|
startOffset?: string;
|
|
12564
12563
|
}
|
|
12565
12564
|
|
|
12565
|
+
/**
|
|
12566
|
+
* Configuration for video output format.
|
|
12567
|
+
*/
|
|
12568
|
+
declare interface VideoResponseFormat {
|
|
12569
|
+
type: 'video';
|
|
12570
|
+
}
|
|
12571
|
+
|
|
12566
12572
|
/** Voice activity signal. */
|
|
12567
12573
|
export declare interface VoiceActivity {
|
|
12568
12574
|
/** The type of the voice activity signal. */
|