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