@google/genai 1.52.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -4
- package/dist/genai.d.ts +436 -429
- 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 +436 -429
- 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 +436 -429
- package/package.json +2 -2
package/dist/web/web.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
|
+
bitRate?: 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
|
+
mimeType?: 'audio/mp3' | 'audio/ogg_opus' | 'audio/l16' | 'audio/wav' | 'audio/alaw' | 'audio/mulaw';
|
|
508
|
+
/**
|
|
509
|
+
* Sample rate in Hz.
|
|
510
|
+
*/
|
|
511
|
+
sampleRate?: 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. */
|
|
@@ -3910,9 +3647,9 @@ export declare interface FileSearch {
|
|
|
3910
3647
|
}
|
|
3911
3648
|
|
|
3912
3649
|
/**
|
|
3913
|
-
* File Search
|
|
3650
|
+
* File Search call step.
|
|
3914
3651
|
*/
|
|
3915
|
-
declare interface
|
|
3652
|
+
declare interface FileSearchCallStep {
|
|
3916
3653
|
/**
|
|
3917
3654
|
* Required. A unique ID for this specific tool call.
|
|
3918
3655
|
*/
|
|
@@ -3925,18 +3662,14 @@ declare interface FileSearchCallContent {
|
|
|
3925
3662
|
}
|
|
3926
3663
|
|
|
3927
3664
|
/**
|
|
3928
|
-
* File Search result
|
|
3665
|
+
* File Search result step.
|
|
3929
3666
|
*/
|
|
3930
|
-
declare interface
|
|
3667
|
+
declare interface FileSearchResultStep {
|
|
3931
3668
|
/**
|
|
3932
3669
|
* Required. ID to match the ID from the function call block.
|
|
3933
3670
|
*/
|
|
3934
3671
|
call_id: string;
|
|
3935
3672
|
type: 'file_search_result';
|
|
3936
|
-
/**
|
|
3937
|
-
* Optional. The results of the File Search.
|
|
3938
|
-
*/
|
|
3939
|
-
result?: Array<unknown>;
|
|
3940
3673
|
/**
|
|
3941
3674
|
* A signature hash for backend validation.
|
|
3942
3675
|
*/
|
|
@@ -4234,31 +3967,6 @@ export declare interface FunctionCall {
|
|
|
4234
3967
|
willContinue?: boolean;
|
|
4235
3968
|
}
|
|
4236
3969
|
|
|
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
3970
|
/** Function calling config. */
|
|
4263
3971
|
export declare interface FunctionCallingConfig {
|
|
4264
3972
|
/** 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 +4001,31 @@ export declare enum FunctionCallingConfigMode {
|
|
|
4293
4001
|
VALIDATED = "VALIDATED"
|
|
4294
4002
|
}
|
|
4295
4003
|
|
|
4004
|
+
/**
|
|
4005
|
+
* A function tool call step.
|
|
4006
|
+
*/
|
|
4007
|
+
declare interface FunctionCallStep {
|
|
4008
|
+
/**
|
|
4009
|
+
* Required. A unique ID for this specific tool call.
|
|
4010
|
+
*/
|
|
4011
|
+
id: string;
|
|
4012
|
+
/**
|
|
4013
|
+
* Required. The arguments to pass to the function.
|
|
4014
|
+
*/
|
|
4015
|
+
arguments: {
|
|
4016
|
+
[key: string]: unknown;
|
|
4017
|
+
};
|
|
4018
|
+
/**
|
|
4019
|
+
* Required. The name of the tool to call.
|
|
4020
|
+
*/
|
|
4021
|
+
name: string;
|
|
4022
|
+
type: 'function_call';
|
|
4023
|
+
/**
|
|
4024
|
+
* A signature hash for backend validation.
|
|
4025
|
+
*/
|
|
4026
|
+
signature?: string;
|
|
4027
|
+
}
|
|
4028
|
+
|
|
4296
4029
|
/** 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
4030
|
export declare interface FunctionDeclaration {
|
|
4298
4031
|
/** Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. */
|
|
@@ -4391,9 +4124,9 @@ export declare enum FunctionResponseScheduling {
|
|
|
4391
4124
|
}
|
|
4392
4125
|
|
|
4393
4126
|
/**
|
|
4394
|
-
*
|
|
4127
|
+
* Result of a function tool call.
|
|
4395
4128
|
*/
|
|
4396
|
-
declare interface
|
|
4129
|
+
declare interface FunctionResultStep {
|
|
4397
4130
|
/**
|
|
4398
4131
|
* Required. ID to match the ID from the function call block.
|
|
4399
4132
|
*/
|
|
@@ -5513,9 +5246,9 @@ declare interface GoogleMapsCallArguments {
|
|
|
5513
5246
|
}
|
|
5514
5247
|
|
|
5515
5248
|
/**
|
|
5516
|
-
* Google Maps
|
|
5249
|
+
* Google Maps call step.
|
|
5517
5250
|
*/
|
|
5518
|
-
declare interface
|
|
5251
|
+
declare interface GoogleMapsCallStep {
|
|
5519
5252
|
/**
|
|
5520
5253
|
* Required. A unique ID for this specific tool call.
|
|
5521
5254
|
*/
|
|
@@ -5524,13 +5257,25 @@ declare interface GoogleMapsCallContent {
|
|
|
5524
5257
|
/**
|
|
5525
5258
|
* The arguments to pass to the Google Maps tool.
|
|
5526
5259
|
*/
|
|
5527
|
-
arguments?:
|
|
5260
|
+
arguments?: GoogleMapsCallStep.Arguments;
|
|
5528
5261
|
/**
|
|
5529
5262
|
* A signature hash for backend validation.
|
|
5530
5263
|
*/
|
|
5531
5264
|
signature?: string;
|
|
5532
5265
|
}
|
|
5533
5266
|
|
|
5267
|
+
declare namespace GoogleMapsCallStep {
|
|
5268
|
+
/**
|
|
5269
|
+
* The arguments to pass to the Google Maps tool.
|
|
5270
|
+
*/
|
|
5271
|
+
interface Arguments {
|
|
5272
|
+
/**
|
|
5273
|
+
* The queries to be executed.
|
|
5274
|
+
*/
|
|
5275
|
+
queries?: Array<string>;
|
|
5276
|
+
}
|
|
5277
|
+
}
|
|
5278
|
+
|
|
5534
5279
|
/**
|
|
5535
5280
|
* The result of the Google Maps.
|
|
5536
5281
|
*/
|
|
@@ -5588,17 +5333,14 @@ declare namespace GoogleMapsResult {
|
|
|
5588
5333
|
}
|
|
5589
5334
|
|
|
5590
5335
|
/**
|
|
5591
|
-
* Google Maps result
|
|
5336
|
+
* Google Maps result step.
|
|
5592
5337
|
*/
|
|
5593
|
-
declare interface
|
|
5338
|
+
declare interface GoogleMapsResultStep {
|
|
5594
5339
|
/**
|
|
5595
5340
|
* Required. ID to match the ID from the function call block.
|
|
5596
5341
|
*/
|
|
5597
5342
|
call_id: string;
|
|
5598
|
-
|
|
5599
|
-
* Required. The results of the Google Maps.
|
|
5600
|
-
*/
|
|
5601
|
-
result: Array<GoogleMapsResult>;
|
|
5343
|
+
result: Array<GoogleMapsResultStep.Result>;
|
|
5602
5344
|
type: 'google_maps_result';
|
|
5603
5345
|
/**
|
|
5604
5346
|
* A signature hash for backend validation.
|
|
@@ -5606,6 +5348,44 @@ declare interface GoogleMapsResultContent {
|
|
|
5606
5348
|
signature?: string;
|
|
5607
5349
|
}
|
|
5608
5350
|
|
|
5351
|
+
declare namespace GoogleMapsResultStep {
|
|
5352
|
+
/**
|
|
5353
|
+
* The result of the Google Maps.
|
|
5354
|
+
*/
|
|
5355
|
+
interface Result {
|
|
5356
|
+
places?: Array<Result.Place>;
|
|
5357
|
+
widget_context_token?: string;
|
|
5358
|
+
}
|
|
5359
|
+
namespace Result {
|
|
5360
|
+
interface Place {
|
|
5361
|
+
name?: string;
|
|
5362
|
+
place_id?: string;
|
|
5363
|
+
review_snippets?: Array<Place.ReviewSnippet>;
|
|
5364
|
+
url?: string;
|
|
5365
|
+
}
|
|
5366
|
+
namespace Place {
|
|
5367
|
+
/**
|
|
5368
|
+
* Encapsulates a snippet of a user review that answers a question about the
|
|
5369
|
+
* features of a specific place in Google Maps.
|
|
5370
|
+
*/
|
|
5371
|
+
interface ReviewSnippet {
|
|
5372
|
+
/**
|
|
5373
|
+
* The ID of the review snippet.
|
|
5374
|
+
*/
|
|
5375
|
+
review_id?: string;
|
|
5376
|
+
/**
|
|
5377
|
+
* Title of the review.
|
|
5378
|
+
*/
|
|
5379
|
+
title?: string;
|
|
5380
|
+
/**
|
|
5381
|
+
* A link that corresponds to the user review on Google Maps.
|
|
5382
|
+
*/
|
|
5383
|
+
url?: string;
|
|
5384
|
+
}
|
|
5385
|
+
}
|
|
5386
|
+
}
|
|
5387
|
+
}
|
|
5388
|
+
|
|
5609
5389
|
/** 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. */
|
|
5610
5390
|
export declare interface GoogleRpcStatus {
|
|
5611
5391
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
@@ -5639,9 +5419,9 @@ declare interface GoogleSearchCallArguments {
|
|
|
5639
5419
|
}
|
|
5640
5420
|
|
|
5641
5421
|
/**
|
|
5642
|
-
* Google Search
|
|
5422
|
+
* Google Search call step.
|
|
5643
5423
|
*/
|
|
5644
|
-
declare interface
|
|
5424
|
+
declare interface GoogleSearchCallStep {
|
|
5645
5425
|
/**
|
|
5646
5426
|
* Required. A unique ID for this specific tool call.
|
|
5647
5427
|
*/
|
|
@@ -5649,7 +5429,7 @@ declare interface GoogleSearchCallContent {
|
|
|
5649
5429
|
/**
|
|
5650
5430
|
* Required. The arguments to pass to Google Search.
|
|
5651
5431
|
*/
|
|
5652
|
-
arguments:
|
|
5432
|
+
arguments: GoogleSearchCallStep.Arguments;
|
|
5653
5433
|
type: 'google_search_call';
|
|
5654
5434
|
/**
|
|
5655
5435
|
* The type of search grounding enabled.
|
|
@@ -5661,6 +5441,18 @@ declare interface GoogleSearchCallContent {
|
|
|
5661
5441
|
signature?: string;
|
|
5662
5442
|
}
|
|
5663
5443
|
|
|
5444
|
+
declare namespace GoogleSearchCallStep {
|
|
5445
|
+
/**
|
|
5446
|
+
* Required. The arguments to pass to Google Search.
|
|
5447
|
+
*/
|
|
5448
|
+
interface Arguments {
|
|
5449
|
+
/**
|
|
5450
|
+
* Web search queries for the following-up web search.
|
|
5451
|
+
*/
|
|
5452
|
+
queries?: Array<string>;
|
|
5453
|
+
}
|
|
5454
|
+
}
|
|
5455
|
+
|
|
5664
5456
|
/**
|
|
5665
5457
|
* The result of the Google Search.
|
|
5666
5458
|
*/
|
|
@@ -5672,9 +5464,9 @@ declare interface GoogleSearchResult {
|
|
|
5672
5464
|
}
|
|
5673
5465
|
|
|
5674
5466
|
/**
|
|
5675
|
-
* Google Search result
|
|
5467
|
+
* Google Search result step.
|
|
5676
5468
|
*/
|
|
5677
|
-
declare interface
|
|
5469
|
+
declare interface GoogleSearchResultStep {
|
|
5678
5470
|
/**
|
|
5679
5471
|
* Required. ID to match the ID from the function call block.
|
|
5680
5472
|
*/
|
|
@@ -5682,7 +5474,7 @@ declare interface GoogleSearchResultContent {
|
|
|
5682
5474
|
/**
|
|
5683
5475
|
* Required. The results of the Google Search.
|
|
5684
5476
|
*/
|
|
5685
|
-
result: Array<
|
|
5477
|
+
result: Array<GoogleSearchResultStep.Result>;
|
|
5686
5478
|
type: 'google_search_result';
|
|
5687
5479
|
/**
|
|
5688
5480
|
* Whether the Google Search resulted in an error.
|
|
@@ -5694,6 +5486,18 @@ declare interface GoogleSearchResultContent {
|
|
|
5694
5486
|
signature?: string;
|
|
5695
5487
|
}
|
|
5696
5488
|
|
|
5489
|
+
declare namespace GoogleSearchResultStep {
|
|
5490
|
+
/**
|
|
5491
|
+
* The result of the Google Search.
|
|
5492
|
+
*/
|
|
5493
|
+
interface Result {
|
|
5494
|
+
/**
|
|
5495
|
+
* Web content snippet that can be embedded in a web page or an app webview.
|
|
5496
|
+
*/
|
|
5497
|
+
search_suggestions?: string;
|
|
5498
|
+
}
|
|
5499
|
+
}
|
|
5500
|
+
|
|
5697
5501
|
/** Tool to retrieve public web data for grounding, powered by Google. */
|
|
5698
5502
|
export declare interface GoogleSearchRetrieval {
|
|
5699
5503
|
/** Specifies the dynamic retrieval configuration for the given source. */
|
|
@@ -6311,6 +6115,29 @@ export declare enum ImageResizeMode {
|
|
|
6311
6115
|
PAD = "PAD"
|
|
6312
6116
|
}
|
|
6313
6117
|
|
|
6118
|
+
/**
|
|
6119
|
+
* Configuration for image output format.
|
|
6120
|
+
*/
|
|
6121
|
+
declare interface ImageResponseFormat {
|
|
6122
|
+
type: 'image';
|
|
6123
|
+
/**
|
|
6124
|
+
* The aspect ratio for the image output.
|
|
6125
|
+
*/
|
|
6126
|
+
aspectRatio?: '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';
|
|
6127
|
+
/**
|
|
6128
|
+
* The delivery mode for the image output.
|
|
6129
|
+
*/
|
|
6130
|
+
delivery?: 'inline' | 'url';
|
|
6131
|
+
/**
|
|
6132
|
+
* The size of the image output.
|
|
6133
|
+
*/
|
|
6134
|
+
imageSize?: '512' | '1K' | '2K' | '4K';
|
|
6135
|
+
/**
|
|
6136
|
+
* The MIME type of the image output.
|
|
6137
|
+
*/
|
|
6138
|
+
mimeType?: 'image/jpeg';
|
|
6139
|
+
}
|
|
6140
|
+
|
|
6314
6141
|
/** Image search for grounding and related configurations. */
|
|
6315
6142
|
export declare interface ImageSearch {
|
|
6316
6143
|
}
|
|
@@ -6442,15 +6269,11 @@ declare interface Interaction {
|
|
|
6442
6269
|
/**
|
|
6443
6270
|
* The input for the interaction.
|
|
6444
6271
|
*/
|
|
6445
|
-
input?: Array<
|
|
6272
|
+
input?: string | Array<Step> | Array<Content_2> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent;
|
|
6446
6273
|
/**
|
|
6447
6274
|
* The name of the `Model` used for generating the interaction.
|
|
6448
6275
|
*/
|
|
6449
6276
|
model?: Model_2;
|
|
6450
|
-
/**
|
|
6451
|
-
* Output only. Responses from the model.
|
|
6452
|
-
*/
|
|
6453
|
-
outputs?: Array<Content_2>;
|
|
6454
6277
|
/**
|
|
6455
6278
|
* The ID of the previous interaction, if any.
|
|
6456
6279
|
*/
|
|
@@ -6459,7 +6282,7 @@ declare interface Interaction {
|
|
|
6459
6282
|
* Enforces that the generated response is a JSON object that complies with the
|
|
6460
6283
|
* JSON schema specified in this field.
|
|
6461
6284
|
*/
|
|
6462
|
-
response_format?: unknown;
|
|
6285
|
+
response_format?: Array<AudioResponseFormat | TextResponseFormat | ImageResponseFormat | VideoResponseFormat | unknown> | AudioResponseFormat | TextResponseFormat | ImageResponseFormat | VideoResponseFormat | unknown;
|
|
6463
6286
|
/**
|
|
6464
6287
|
* The mime type of the response. This is required if response_format is set.
|
|
6465
6288
|
*/
|
|
@@ -6469,13 +6292,17 @@ declare interface Interaction {
|
|
|
6469
6292
|
*/
|
|
6470
6293
|
response_modalities?: Array<'text' | 'image' | 'audio' | 'video' | 'document'>;
|
|
6471
6294
|
/**
|
|
6472
|
-
* Output only. The role of the interaction.
|
|
6295
|
+
* @deprecated Output only. The role of the interaction.
|
|
6473
6296
|
*/
|
|
6474
6297
|
role?: string;
|
|
6475
6298
|
/**
|
|
6476
6299
|
* The service tier for the interaction.
|
|
6477
6300
|
*/
|
|
6478
6301
|
service_tier?: 'flex' | 'standard' | 'priority';
|
|
6302
|
+
/**
|
|
6303
|
+
* Output only. The steps that make up the interaction.
|
|
6304
|
+
*/
|
|
6305
|
+
steps?: Array<Step>;
|
|
6479
6306
|
/**
|
|
6480
6307
|
* System instruction for the interaction.
|
|
6481
6308
|
*/
|
|
@@ -6502,8 +6329,8 @@ declare interface InteractionCancelParams {
|
|
|
6502
6329
|
api_version?: string;
|
|
6503
6330
|
}
|
|
6504
6331
|
|
|
6505
|
-
declare interface
|
|
6506
|
-
event_type: 'interaction.
|
|
6332
|
+
declare interface InteractionCompletedEvent {
|
|
6333
|
+
event_type: 'interaction.completed';
|
|
6507
6334
|
/**
|
|
6508
6335
|
* Required. The completed interaction with empty outputs to reduce the payload
|
|
6509
6336
|
* size. Use the preceding ContentDelta events for the actual output.
|
|
@@ -6515,6 +6342,18 @@ declare interface InteractionCompleteEvent {
|
|
|
6515
6342
|
event_id?: string;
|
|
6516
6343
|
}
|
|
6517
6344
|
|
|
6345
|
+
declare interface InteractionCreatedEvent {
|
|
6346
|
+
event_type: 'interaction.created';
|
|
6347
|
+
/**
|
|
6348
|
+
* The Interaction resource.
|
|
6349
|
+
*/
|
|
6350
|
+
interaction: Interaction;
|
|
6351
|
+
/**
|
|
6352
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
6353
|
+
*/
|
|
6354
|
+
event_id?: string;
|
|
6355
|
+
}
|
|
6356
|
+
|
|
6518
6357
|
declare type InteractionCreateParams = CreateModelInteractionParamsNonStreaming | CreateModelInteractionParamsStreaming | CreateAgentInteractionParamsNonStreaming | CreateAgentInteractionParamsStreaming;
|
|
6519
6358
|
|
|
6520
6359
|
declare interface InteractionDeleteParams {
|
|
@@ -6575,7 +6414,7 @@ export declare class Interactions extends BaseInteractions {
|
|
|
6575
6414
|
}
|
|
6576
6415
|
|
|
6577
6416
|
export declare namespace Interactions {
|
|
6578
|
-
export { type AllowedTools as AllowedTools, type Annotation as Annotation, type AudioContent as AudioContent, type
|
|
6417
|
+
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, };
|
|
6579
6418
|
}
|
|
6580
6419
|
|
|
6581
6420
|
declare namespace InteractionsAPI {
|
|
@@ -6585,58 +6424,64 @@ declare namespace InteractionsAPI {
|
|
|
6585
6424
|
AllowedTools,
|
|
6586
6425
|
Annotation,
|
|
6587
6426
|
AudioContent,
|
|
6427
|
+
AudioResponseFormat,
|
|
6588
6428
|
CodeExecutionCallArguments,
|
|
6589
|
-
|
|
6590
|
-
|
|
6429
|
+
CodeExecutionCallStep,
|
|
6430
|
+
CodeExecutionResultStep,
|
|
6591
6431
|
Content_2 as Content,
|
|
6592
|
-
ContentDelta,
|
|
6593
|
-
ContentStart,
|
|
6594
|
-
ContentStop,
|
|
6595
6432
|
DeepResearchAgentConfig,
|
|
6596
6433
|
DocumentContent,
|
|
6597
6434
|
DynamicAgentConfig,
|
|
6598
6435
|
ErrorEvent_2 as ErrorEvent,
|
|
6599
6436
|
FileCitation,
|
|
6600
|
-
|
|
6601
|
-
|
|
6437
|
+
FileSearchCallStep,
|
|
6438
|
+
FileSearchResultStep,
|
|
6602
6439
|
Function_2 as Function,
|
|
6603
|
-
|
|
6604
|
-
|
|
6440
|
+
FunctionCallStep,
|
|
6441
|
+
FunctionResultStep,
|
|
6605
6442
|
GenerationConfig_2 as GenerationConfig,
|
|
6606
6443
|
GoogleMapsCallArguments,
|
|
6607
|
-
|
|
6444
|
+
GoogleMapsCallStep,
|
|
6608
6445
|
GoogleMapsResult,
|
|
6609
|
-
|
|
6446
|
+
GoogleMapsResultStep,
|
|
6610
6447
|
GoogleSearchCallArguments,
|
|
6611
|
-
|
|
6448
|
+
GoogleSearchCallStep,
|
|
6612
6449
|
GoogleSearchResult,
|
|
6613
|
-
|
|
6450
|
+
GoogleSearchResultStep,
|
|
6614
6451
|
ImageConfig_2 as ImageConfig,
|
|
6615
6452
|
ImageContent,
|
|
6453
|
+
ImageResponseFormat,
|
|
6616
6454
|
Interaction,
|
|
6617
|
-
|
|
6455
|
+
InteractionCompletedEvent,
|
|
6456
|
+
InteractionCreatedEvent,
|
|
6618
6457
|
InteractionSSEEvent,
|
|
6619
|
-
InteractionStartEvent,
|
|
6620
6458
|
InteractionStatusUpdate,
|
|
6621
|
-
|
|
6622
|
-
|
|
6459
|
+
MCPServerToolCallStep,
|
|
6460
|
+
MCPServerToolResultStep,
|
|
6623
6461
|
Model_2 as Model,
|
|
6462
|
+
ModelOutputStep,
|
|
6624
6463
|
PlaceCitation,
|
|
6625
6464
|
SpeechConfig_2 as SpeechConfig,
|
|
6465
|
+
Step,
|
|
6466
|
+
StepDelta,
|
|
6467
|
+
StepStart,
|
|
6468
|
+
StepStop,
|
|
6626
6469
|
TextContent,
|
|
6470
|
+
TextResponseFormat,
|
|
6627
6471
|
ThinkingLevel_2 as ThinkingLevel,
|
|
6628
|
-
|
|
6472
|
+
ThoughtStep,
|
|
6629
6473
|
Tool_2 as Tool,
|
|
6630
6474
|
ToolChoiceConfig,
|
|
6631
6475
|
ToolChoiceType,
|
|
6632
|
-
Turn,
|
|
6633
6476
|
URLCitation,
|
|
6634
6477
|
URLContextCallArguments,
|
|
6635
|
-
|
|
6478
|
+
URLContextCallStep,
|
|
6636
6479
|
URLContextResult,
|
|
6637
|
-
|
|
6480
|
+
URLContextResultStep,
|
|
6638
6481
|
Usage,
|
|
6482
|
+
UserInputStep,
|
|
6639
6483
|
VideoContent,
|
|
6484
|
+
VideoResponseFormat,
|
|
6640
6485
|
WebhookConfig_2 as WebhookConfig,
|
|
6641
6486
|
InteractionDeleteResponse,
|
|
6642
6487
|
InteractionCreateParams,
|
|
@@ -6655,19 +6500,7 @@ declare namespace InteractionsAPI {
|
|
|
6655
6500
|
}
|
|
6656
6501
|
}
|
|
6657
6502
|
|
|
6658
|
-
declare type InteractionSSEEvent =
|
|
6659
|
-
|
|
6660
|
-
declare interface InteractionStartEvent {
|
|
6661
|
-
event_type: 'interaction.start';
|
|
6662
|
-
/**
|
|
6663
|
-
* The Interaction resource.
|
|
6664
|
-
*/
|
|
6665
|
-
interaction: Interaction;
|
|
6666
|
-
/**
|
|
6667
|
-
* The event_id token to be used to resume the interaction stream, from this event.
|
|
6668
|
-
*/
|
|
6669
|
-
event_id?: string;
|
|
6670
|
-
}
|
|
6503
|
+
declare type InteractionSSEEvent = InteractionCreatedEvent | InteractionCompletedEvent | InteractionStatusUpdate | ErrorEvent_2 | StepStart | StepDelta | StepStop;
|
|
6671
6504
|
|
|
6672
6505
|
declare interface InteractionStatusUpdate {
|
|
6673
6506
|
event_type: 'interaction.status_update';
|
|
@@ -7870,9 +7703,9 @@ export declare interface McpServer {
|
|
|
7870
7703
|
}
|
|
7871
7704
|
|
|
7872
7705
|
/**
|
|
7873
|
-
* MCPServer tool call
|
|
7706
|
+
* MCPServer tool call step.
|
|
7874
7707
|
*/
|
|
7875
|
-
declare interface
|
|
7708
|
+
declare interface MCPServerToolCallStep {
|
|
7876
7709
|
/**
|
|
7877
7710
|
* Required. A unique ID for this specific tool call.
|
|
7878
7711
|
*/
|
|
@@ -7899,9 +7732,9 @@ declare interface MCPServerToolCallContent {
|
|
|
7899
7732
|
}
|
|
7900
7733
|
|
|
7901
7734
|
/**
|
|
7902
|
-
* MCPServer tool result
|
|
7735
|
+
* MCPServer tool result step.
|
|
7903
7736
|
*/
|
|
7904
|
-
declare interface
|
|
7737
|
+
declare interface MCPServerToolResultStep {
|
|
7905
7738
|
/**
|
|
7906
7739
|
* Required. ID to match the ID from the function call block.
|
|
7907
7740
|
*/
|
|
@@ -7909,7 +7742,7 @@ declare interface MCPServerToolResultContent {
|
|
|
7909
7742
|
/**
|
|
7910
7743
|
* The output from the MCP server call. Can be simple text or rich content.
|
|
7911
7744
|
*/
|
|
7912
|
-
result: unknown | Array<TextContent | ImageContent
|
|
7745
|
+
result: unknown | string | Array<TextContent | ImageContent>;
|
|
7913
7746
|
type: 'mcp_server_tool_result';
|
|
7914
7747
|
/**
|
|
7915
7748
|
* Name of the tool which is called for this specific tool call.
|
|
@@ -8094,6 +7927,14 @@ export declare interface ModelArmorConfig {
|
|
|
8094
7927
|
responseTemplateName?: string;
|
|
8095
7928
|
}
|
|
8096
7929
|
|
|
7930
|
+
/**
|
|
7931
|
+
* Output generated by the model.
|
|
7932
|
+
*/
|
|
7933
|
+
declare interface ModelOutputStep {
|
|
7934
|
+
type: 'model_output';
|
|
7935
|
+
content?: Array<Content_2>;
|
|
7936
|
+
}
|
|
7937
|
+
|
|
8097
7938
|
export declare class Models extends BaseModule {
|
|
8098
7939
|
private readonly apiClient;
|
|
8099
7940
|
constructor(apiClient: ApiClient);
|
|
@@ -10121,6 +9962,119 @@ export declare enum StartSensitivity {
|
|
|
10121
9962
|
START_SENSITIVITY_LOW = "START_SENSITIVITY_LOW"
|
|
10122
9963
|
}
|
|
10123
9964
|
|
|
9965
|
+
/**
|
|
9966
|
+
* A step in the interaction.
|
|
9967
|
+
*/
|
|
9968
|
+
declare type Step = UserInputStep | ModelOutputStep | ThoughtStep | FunctionCallStep | CodeExecutionCallStep | URLContextCallStep | MCPServerToolCallStep | GoogleSearchCallStep | FileSearchCallStep | GoogleMapsCallStep | FunctionResultStep | CodeExecutionResultStep | URLContextResultStep | GoogleSearchResultStep | MCPServerToolResultStep | FileSearchResultStep | GoogleMapsResultStep;
|
|
9969
|
+
|
|
9970
|
+
declare interface StepDelta {
|
|
9971
|
+
delta: StepDelta.Text | StepDelta.Image | StepDelta.Audio | StepDelta.Document | StepDelta.Video | StepDelta.ThoughtSummary | StepDelta.ThoughtSignature | StepDelta.TextAnnotationDelta | StepDelta.ArgumentsDelta;
|
|
9972
|
+
event_type: 'step.delta';
|
|
9973
|
+
index: number;
|
|
9974
|
+
/**
|
|
9975
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
9976
|
+
*/
|
|
9977
|
+
event_id?: string;
|
|
9978
|
+
}
|
|
9979
|
+
|
|
9980
|
+
declare namespace StepDelta {
|
|
9981
|
+
interface Text {
|
|
9982
|
+
text: string;
|
|
9983
|
+
type: 'text';
|
|
9984
|
+
}
|
|
9985
|
+
interface Image {
|
|
9986
|
+
type: 'image';
|
|
9987
|
+
data?: string;
|
|
9988
|
+
mime_type?: 'image/png' | 'image/jpeg' | 'image/webp' | 'image/heic' | 'image/heif' | 'image/gif' | 'image/bmp' | 'image/tiff';
|
|
9989
|
+
/**
|
|
9990
|
+
* The resolution of the media.
|
|
9991
|
+
*/
|
|
9992
|
+
resolution?: 'low' | 'medium' | 'high' | 'ultra_high';
|
|
9993
|
+
uri?: string;
|
|
9994
|
+
}
|
|
9995
|
+
interface Audio {
|
|
9996
|
+
type: 'audio';
|
|
9997
|
+
/**
|
|
9998
|
+
* The number of audio channels.
|
|
9999
|
+
*/
|
|
10000
|
+
channels?: number;
|
|
10001
|
+
data?: string;
|
|
10002
|
+
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';
|
|
10003
|
+
/**
|
|
10004
|
+
* @deprecated Deprecated. Use sample_rate instead. The value is ignored.
|
|
10005
|
+
*/
|
|
10006
|
+
rate?: number;
|
|
10007
|
+
/**
|
|
10008
|
+
* The sample rate of the audio.
|
|
10009
|
+
*/
|
|
10010
|
+
sample_rate?: number;
|
|
10011
|
+
uri?: string;
|
|
10012
|
+
}
|
|
10013
|
+
interface Document {
|
|
10014
|
+
type: 'document';
|
|
10015
|
+
data?: string;
|
|
10016
|
+
mime_type?: 'application/pdf';
|
|
10017
|
+
uri?: string;
|
|
10018
|
+
}
|
|
10019
|
+
interface Video {
|
|
10020
|
+
type: 'video';
|
|
10021
|
+
data?: string;
|
|
10022
|
+
mime_type?: 'video/mp4' | 'video/mpeg' | 'video/mpg' | 'video/mov' | 'video/avi' | 'video/x-flv' | 'video/webm' | 'video/wmv' | 'video/3gpp';
|
|
10023
|
+
/**
|
|
10024
|
+
* The resolution of the media.
|
|
10025
|
+
*/
|
|
10026
|
+
resolution?: 'low' | 'medium' | 'high' | 'ultra_high';
|
|
10027
|
+
uri?: string;
|
|
10028
|
+
}
|
|
10029
|
+
interface ThoughtSummary {
|
|
10030
|
+
type: 'thought_summary';
|
|
10031
|
+
/**
|
|
10032
|
+
* A new summary item to be added to the thought.
|
|
10033
|
+
*/
|
|
10034
|
+
content?: InteractionsAPI.TextContent | InteractionsAPI.ImageContent;
|
|
10035
|
+
}
|
|
10036
|
+
interface ThoughtSignature {
|
|
10037
|
+
type: 'thought_signature';
|
|
10038
|
+
/**
|
|
10039
|
+
* Signature to match the backend source to be part of the generation.
|
|
10040
|
+
*/
|
|
10041
|
+
signature?: string;
|
|
10042
|
+
}
|
|
10043
|
+
interface TextAnnotationDelta {
|
|
10044
|
+
type: 'text_annotation_delta';
|
|
10045
|
+
/**
|
|
10046
|
+
* Citation information for model-generated content.
|
|
10047
|
+
*/
|
|
10048
|
+
annotations?: Array<InteractionsAPI.Annotation>;
|
|
10049
|
+
}
|
|
10050
|
+
interface ArgumentsDelta {
|
|
10051
|
+
type: 'arguments_delta';
|
|
10052
|
+
partial_arguments?: string;
|
|
10053
|
+
}
|
|
10054
|
+
}
|
|
10055
|
+
|
|
10056
|
+
declare interface StepStart {
|
|
10057
|
+
event_type: 'step.start';
|
|
10058
|
+
index: number;
|
|
10059
|
+
/**
|
|
10060
|
+
* A step in the interaction.
|
|
10061
|
+
*/
|
|
10062
|
+
step: Step;
|
|
10063
|
+
/**
|
|
10064
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
10065
|
+
*/
|
|
10066
|
+
event_id?: string;
|
|
10067
|
+
}
|
|
10068
|
+
|
|
10069
|
+
declare interface StepStop {
|
|
10070
|
+
event_type: 'step.stop';
|
|
10071
|
+
index: number;
|
|
10072
|
+
/**
|
|
10073
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
10074
|
+
*/
|
|
10075
|
+
event_id?: string;
|
|
10076
|
+
}
|
|
10077
|
+
|
|
10124
10078
|
declare class Stream<Item> implements AsyncIterable<Item> {
|
|
10125
10079
|
private iterator;
|
|
10126
10080
|
controller: AbortController;
|
|
@@ -10356,6 +10310,24 @@ declare interface TextContent {
|
|
|
10356
10310
|
annotations?: Array<Annotation>;
|
|
10357
10311
|
}
|
|
10358
10312
|
|
|
10313
|
+
/**
|
|
10314
|
+
* Configuration for text output format.
|
|
10315
|
+
*/
|
|
10316
|
+
declare interface TextResponseFormat {
|
|
10317
|
+
type: 'text';
|
|
10318
|
+
/**
|
|
10319
|
+
* The MIME type of the text output.
|
|
10320
|
+
*/
|
|
10321
|
+
mimeType?: 'application/json' | 'text/plain';
|
|
10322
|
+
/**
|
|
10323
|
+
* The JSON schema that the output should conform to. Only applicable when
|
|
10324
|
+
* mime_type is application/json.
|
|
10325
|
+
*/
|
|
10326
|
+
schema?: {
|
|
10327
|
+
[key: string]: unknown;
|
|
10328
|
+
};
|
|
10329
|
+
}
|
|
10330
|
+
|
|
10359
10331
|
/** The thinking features configuration. */
|
|
10360
10332
|
export declare interface ThinkingConfig {
|
|
10361
10333
|
/** Indicates whether to include thoughts in the response. If true, thoughts are returned only if the model supports thought and thoughts are available.
|
|
@@ -10395,12 +10367,12 @@ export declare enum ThinkingLevel {
|
|
|
10395
10367
|
declare type ThinkingLevel_2 = 'minimal' | 'low' | 'medium' | 'high';
|
|
10396
10368
|
|
|
10397
10369
|
/**
|
|
10398
|
-
* A thought
|
|
10370
|
+
* A thought step.
|
|
10399
10371
|
*/
|
|
10400
|
-
declare interface
|
|
10372
|
+
declare interface ThoughtStep {
|
|
10401
10373
|
type: 'thought';
|
|
10402
10374
|
/**
|
|
10403
|
-
*
|
|
10375
|
+
* A signature hash for backend validation.
|
|
10404
10376
|
*/
|
|
10405
10377
|
signature?: string;
|
|
10406
10378
|
/**
|
|
@@ -11109,14 +11081,6 @@ export declare interface TuningValidationDataset {
|
|
|
11109
11081
|
vertexDatasetResource?: string;
|
|
11110
11082
|
}
|
|
11111
11083
|
|
|
11112
|
-
declare interface Turn {
|
|
11113
|
-
content?: Array<Content_2> | string;
|
|
11114
|
-
/**
|
|
11115
|
-
* The originator of this turn. Must be user for input or model for model output.
|
|
11116
|
-
*/
|
|
11117
|
-
role?: string;
|
|
11118
|
-
}
|
|
11119
|
-
|
|
11120
11084
|
/** The reason why the turn is complete. */
|
|
11121
11085
|
export declare enum TurnCompleteReason {
|
|
11122
11086
|
/**
|
|
@@ -12116,9 +12080,9 @@ declare interface URLContextCallArguments {
|
|
|
12116
12080
|
}
|
|
12117
12081
|
|
|
12118
12082
|
/**
|
|
12119
|
-
* URL context
|
|
12083
|
+
* URL context call step.
|
|
12120
12084
|
*/
|
|
12121
|
-
declare interface
|
|
12085
|
+
declare interface URLContextCallStep {
|
|
12122
12086
|
/**
|
|
12123
12087
|
* Required. A unique ID for this specific tool call.
|
|
12124
12088
|
*/
|
|
@@ -12126,7 +12090,7 @@ declare interface URLContextCallContent {
|
|
|
12126
12090
|
/**
|
|
12127
12091
|
* Required. The arguments to pass to the URL context.
|
|
12128
12092
|
*/
|
|
12129
|
-
arguments:
|
|
12093
|
+
arguments: URLContextCallStep.Arguments;
|
|
12130
12094
|
type: 'url_context_call';
|
|
12131
12095
|
/**
|
|
12132
12096
|
* A signature hash for backend validation.
|
|
@@ -12134,6 +12098,18 @@ declare interface URLContextCallContent {
|
|
|
12134
12098
|
signature?: string;
|
|
12135
12099
|
}
|
|
12136
12100
|
|
|
12101
|
+
declare namespace URLContextCallStep {
|
|
12102
|
+
/**
|
|
12103
|
+
* Required. The arguments to pass to the URL context.
|
|
12104
|
+
*/
|
|
12105
|
+
interface Arguments {
|
|
12106
|
+
/**
|
|
12107
|
+
* The URLs to fetch.
|
|
12108
|
+
*/
|
|
12109
|
+
urls?: Array<string>;
|
|
12110
|
+
}
|
|
12111
|
+
}
|
|
12112
|
+
|
|
12137
12113
|
/** Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. */
|
|
12138
12114
|
export declare interface UrlContextMetadata {
|
|
12139
12115
|
/** Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. */
|
|
@@ -12155,9 +12131,9 @@ declare interface URLContextResult {
|
|
|
12155
12131
|
}
|
|
12156
12132
|
|
|
12157
12133
|
/**
|
|
12158
|
-
* URL context result
|
|
12134
|
+
* URL context result step.
|
|
12159
12135
|
*/
|
|
12160
|
-
declare interface
|
|
12136
|
+
declare interface URLContextResultStep {
|
|
12161
12137
|
/**
|
|
12162
12138
|
* Required. ID to match the ID from the function call block.
|
|
12163
12139
|
*/
|
|
@@ -12165,7 +12141,7 @@ declare interface URLContextResultContent {
|
|
|
12165
12141
|
/**
|
|
12166
12142
|
* Required. The results of the URL context.
|
|
12167
12143
|
*/
|
|
12168
|
-
result: Array<
|
|
12144
|
+
result: Array<URLContextResultStep.Result>;
|
|
12169
12145
|
type: 'url_context_result';
|
|
12170
12146
|
/**
|
|
12171
12147
|
* Whether the URL context resulted in an error.
|
|
@@ -12177,6 +12153,22 @@ declare interface URLContextResultContent {
|
|
|
12177
12153
|
signature?: string;
|
|
12178
12154
|
}
|
|
12179
12155
|
|
|
12156
|
+
declare namespace URLContextResultStep {
|
|
12157
|
+
/**
|
|
12158
|
+
* The result of the URL context.
|
|
12159
|
+
*/
|
|
12160
|
+
interface Result {
|
|
12161
|
+
/**
|
|
12162
|
+
* The status of the URL retrieval.
|
|
12163
|
+
*/
|
|
12164
|
+
status?: 'success' | 'error' | 'paywall' | 'unsafe';
|
|
12165
|
+
/**
|
|
12166
|
+
* The URL that was fetched.
|
|
12167
|
+
*/
|
|
12168
|
+
url?: string;
|
|
12169
|
+
}
|
|
12170
|
+
}
|
|
12171
|
+
|
|
12180
12172
|
/** The metadata for a single URL retrieval. */
|
|
12181
12173
|
export declare interface UrlMetadata {
|
|
12182
12174
|
/** The URL retrieved by the tool. */
|
|
@@ -12355,6 +12347,14 @@ export declare interface UsageMetadata {
|
|
|
12355
12347
|
trafficType?: TrafficType;
|
|
12356
12348
|
}
|
|
12357
12349
|
|
|
12350
|
+
/**
|
|
12351
|
+
* Input provided by the user.
|
|
12352
|
+
*/
|
|
12353
|
+
declare interface UserInputStep {
|
|
12354
|
+
type: 'user_input';
|
|
12355
|
+
content?: Array<Content_2>;
|
|
12356
|
+
}
|
|
12357
|
+
|
|
12358
12358
|
/** The type of the VAD signal. */
|
|
12359
12359
|
export declare enum VadSignalType {
|
|
12360
12360
|
/**
|
|
@@ -12568,6 +12568,13 @@ export declare interface VideoMetadata {
|
|
|
12568
12568
|
startOffset?: string;
|
|
12569
12569
|
}
|
|
12570
12570
|
|
|
12571
|
+
/**
|
|
12572
|
+
* Configuration for video output format.
|
|
12573
|
+
*/
|
|
12574
|
+
declare interface VideoResponseFormat {
|
|
12575
|
+
type: 'video';
|
|
12576
|
+
}
|
|
12577
|
+
|
|
12571
12578
|
/** Voice activity signal. */
|
|
12572
12579
|
export declare interface VoiceActivity {
|
|
12573
12580
|
/** The type of the voice activity signal. */
|