@google/genai 1.42.0 → 1.43.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/genai.d.ts +270 -160
- package/dist/index.cjs +187 -77
- package/dist/index.mjs +188 -78
- package/dist/index.mjs.map +1 -1
- package/dist/node/index.cjs +187 -77
- package/dist/node/index.mjs +188 -78
- package/dist/node/index.mjs.map +1 -1
- package/dist/node/node.d.ts +270 -160
- package/dist/tokenizer/node.cjs +48 -32
- package/dist/tokenizer/node.d.ts +48 -3
- package/dist/tokenizer/node.mjs +48 -32
- package/dist/tokenizer/node.mjs.map +1 -1
- package/dist/web/index.mjs +188 -78
- package/dist/web/index.mjs.map +1 -1
- package/dist/web/web.d.ts +270 -160
- package/package.json +1 -1
package/dist/web/web.d.ts
CHANGED
|
@@ -411,18 +411,13 @@ declare interface AudioContent {
|
|
|
411
411
|
/**
|
|
412
412
|
* The mime type of the audio.
|
|
413
413
|
*/
|
|
414
|
-
mime_type?:
|
|
414
|
+
mime_type?: 'audio/wav' | 'audio/mp3' | 'audio/aiff' | 'audio/aac' | 'audio/ogg' | 'audio/flac';
|
|
415
415
|
/**
|
|
416
416
|
* The URI of the audio.
|
|
417
417
|
*/
|
|
418
418
|
uri?: string;
|
|
419
419
|
}
|
|
420
420
|
|
|
421
|
-
/**
|
|
422
|
-
* The mime type of the audio.
|
|
423
|
-
*/
|
|
424
|
-
declare type AudioMimeType = 'audio/wav' | 'audio/mp3' | 'audio/aiff' | 'audio/aac' | 'audio/ogg' | 'audio/flac' | (string & {});
|
|
425
|
-
|
|
426
421
|
/** The audio transcription configuration in Setup. */
|
|
427
422
|
export declare interface AudioTranscriptionConfig {
|
|
428
423
|
}
|
|
@@ -1336,10 +1331,12 @@ export declare interface Candidate {
|
|
|
1336
1331
|
If empty, the model has not stopped generating the tokens.
|
|
1337
1332
|
*/
|
|
1338
1333
|
finishReason?: FinishReason;
|
|
1334
|
+
/** Output only. Metadata returned when grounding is enabled. It
|
|
1335
|
+
contains the sources used to ground the generated content.
|
|
1336
|
+
*/
|
|
1337
|
+
groundingMetadata?: GroundingMetadata;
|
|
1339
1338
|
/** Output only. Average log probability score of the candidate. */
|
|
1340
1339
|
avgLogprobs?: number;
|
|
1341
|
-
/** Output only. Metadata specifies sources used to ground generated content. */
|
|
1342
|
-
groundingMetadata?: GroundingMetadata;
|
|
1343
1340
|
/** Output only. Index of the candidate. */
|
|
1344
1341
|
index?: number;
|
|
1345
1342
|
/** Output only. Log-likelihood scores for the response tokens and top tokens */
|
|
@@ -1603,15 +1600,15 @@ declare interface CodeExecutionCallArguments {
|
|
|
1603
1600
|
* Code execution content.
|
|
1604
1601
|
*/
|
|
1605
1602
|
declare interface CodeExecutionCallContent {
|
|
1606
|
-
type: 'code_execution_call';
|
|
1607
1603
|
/**
|
|
1608
1604
|
* A unique ID for this specific tool call.
|
|
1609
1605
|
*/
|
|
1610
|
-
id
|
|
1606
|
+
id: string;
|
|
1611
1607
|
/**
|
|
1612
1608
|
* The arguments to pass to the code execution.
|
|
1613
1609
|
*/
|
|
1614
|
-
arguments
|
|
1610
|
+
arguments: CodeExecutionCallArguments;
|
|
1611
|
+
type: 'code_execution_call';
|
|
1615
1612
|
}
|
|
1616
1613
|
|
|
1617
1614
|
/** Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. */
|
|
@@ -1626,19 +1623,19 @@ export declare interface CodeExecutionResult {
|
|
|
1626
1623
|
* Code execution result content.
|
|
1627
1624
|
*/
|
|
1628
1625
|
declare interface CodeExecutionResultContent {
|
|
1629
|
-
type: 'code_execution_result';
|
|
1630
1626
|
/**
|
|
1631
1627
|
* ID to match the ID from the code execution call block.
|
|
1632
1628
|
*/
|
|
1633
|
-
call_id
|
|
1629
|
+
call_id: string;
|
|
1634
1630
|
/**
|
|
1635
|
-
*
|
|
1631
|
+
* The output of the code execution.
|
|
1636
1632
|
*/
|
|
1637
|
-
|
|
1633
|
+
result: string;
|
|
1634
|
+
type: 'code_execution_result';
|
|
1638
1635
|
/**
|
|
1639
|
-
*
|
|
1636
|
+
* Whether the code execution resulted in an error.
|
|
1640
1637
|
*/
|
|
1641
|
-
|
|
1638
|
+
is_error?: boolean;
|
|
1642
1639
|
/**
|
|
1643
1640
|
* A signature hash for backend validation.
|
|
1644
1641
|
*/
|
|
@@ -1730,31 +1727,28 @@ export declare interface Content {
|
|
|
1730
1727
|
declare type Content_2 = TextContent | ImageContent | AudioContent | DocumentContent | VideoContent | ThoughtContent | FunctionCallContent | FunctionResultContent | CodeExecutionCallContent | CodeExecutionResultContent | URLContextCallContent | URLContextResultContent | GoogleSearchCallContent | GoogleSearchResultContent | MCPServerToolCallContent | MCPServerToolResultContent | FileSearchCallContent | FileSearchResultContent;
|
|
1731
1728
|
|
|
1732
1729
|
declare interface ContentDelta {
|
|
1730
|
+
delta: ContentDelta.TextDelta | ContentDelta.ImageDelta | ContentDelta.AudioDelta | ContentDelta.DocumentDelta | ContentDelta.VideoDelta | ContentDelta.ThoughtSummaryDelta | ContentDelta.ThoughtSignatureDelta | ContentDelta.FunctionCallDelta | ContentDelta.FunctionResultDelta | ContentDelta.CodeExecutionCallDelta | ContentDelta.CodeExecutionResultDelta | ContentDelta.URLContextCallDelta | ContentDelta.URLContextResultDelta | ContentDelta.GoogleSearchCallDelta | ContentDelta.GoogleSearchResultDelta | ContentDelta.MCPServerToolCallDelta | ContentDelta.MCPServerToolResultDelta | ContentDelta.FileSearchCallDelta | ContentDelta.FileSearchResultDelta;
|
|
1733
1731
|
event_type: 'content.delta';
|
|
1734
|
-
|
|
1732
|
+
index: number;
|
|
1735
1733
|
/**
|
|
1736
1734
|
* The event_id token to be used to resume the interaction stream, from this event.
|
|
1737
1735
|
*/
|
|
1738
1736
|
event_id?: string;
|
|
1739
|
-
index?: number;
|
|
1740
1737
|
}
|
|
1741
1738
|
|
|
1742
1739
|
declare namespace ContentDelta {
|
|
1743
1740
|
interface TextDelta {
|
|
1741
|
+
text: string;
|
|
1744
1742
|
type: 'text';
|
|
1745
1743
|
/**
|
|
1746
1744
|
* Citation information for model-generated content.
|
|
1747
1745
|
*/
|
|
1748
1746
|
annotations?: Array<InteractionsAPI.Annotation>;
|
|
1749
|
-
text?: string;
|
|
1750
1747
|
}
|
|
1751
1748
|
interface ImageDelta {
|
|
1752
1749
|
type: 'image';
|
|
1753
1750
|
data?: string;
|
|
1754
|
-
|
|
1755
|
-
* The mime type of the image.
|
|
1756
|
-
*/
|
|
1757
|
-
mime_type?: InteractionsAPI.ImageMimeType;
|
|
1751
|
+
mime_type?: 'image/png' | 'image/jpeg' | 'image/webp' | 'image/heic' | 'image/heif';
|
|
1758
1752
|
/**
|
|
1759
1753
|
* The resolution of the media.
|
|
1760
1754
|
*/
|
|
@@ -1764,28 +1758,19 @@ declare namespace ContentDelta {
|
|
|
1764
1758
|
interface AudioDelta {
|
|
1765
1759
|
type: 'audio';
|
|
1766
1760
|
data?: string;
|
|
1767
|
-
|
|
1768
|
-
* The mime type of the audio.
|
|
1769
|
-
*/
|
|
1770
|
-
mime_type?: InteractionsAPI.AudioMimeType;
|
|
1761
|
+
mime_type?: 'audio/wav' | 'audio/mp3' | 'audio/aiff' | 'audio/aac' | 'audio/ogg' | 'audio/flac';
|
|
1771
1762
|
uri?: string;
|
|
1772
1763
|
}
|
|
1773
1764
|
interface DocumentDelta {
|
|
1774
1765
|
type: 'document';
|
|
1775
1766
|
data?: string;
|
|
1776
|
-
|
|
1777
|
-
* The mime type of the document.
|
|
1778
|
-
*/
|
|
1779
|
-
mime_type?: InteractionsAPI.DocumentMimeType;
|
|
1767
|
+
mime_type?: 'application/pdf';
|
|
1780
1768
|
uri?: string;
|
|
1781
1769
|
}
|
|
1782
1770
|
interface VideoDelta {
|
|
1783
1771
|
type: 'video';
|
|
1784
1772
|
data?: string;
|
|
1785
|
-
|
|
1786
|
-
* The mime type of the video.
|
|
1787
|
-
*/
|
|
1788
|
-
mime_type?: InteractionsAPI.VideoMimeType;
|
|
1773
|
+
mime_type?: 'video/mp4' | 'video/mpeg' | 'video/mpg' | 'video/mov' | 'video/avi' | 'video/x-flv' | 'video/webm' | 'video/wmv' | 'video/3gpp';
|
|
1789
1774
|
/**
|
|
1790
1775
|
* The resolution of the media.
|
|
1791
1776
|
*/
|
|
@@ -1807,28 +1792,28 @@ declare namespace ContentDelta {
|
|
|
1807
1792
|
signature?: string;
|
|
1808
1793
|
}
|
|
1809
1794
|
interface FunctionCallDelta {
|
|
1810
|
-
type: 'function_call';
|
|
1811
1795
|
/**
|
|
1812
1796
|
* A unique ID for this specific tool call.
|
|
1813
1797
|
*/
|
|
1814
|
-
id
|
|
1815
|
-
arguments
|
|
1798
|
+
id: string;
|
|
1799
|
+
arguments: {
|
|
1816
1800
|
[key: string]: unknown;
|
|
1817
1801
|
};
|
|
1818
|
-
name
|
|
1802
|
+
name: string;
|
|
1803
|
+
type: 'function_call';
|
|
1819
1804
|
}
|
|
1820
1805
|
interface FunctionResultDelta {
|
|
1821
|
-
type: 'function_result';
|
|
1822
1806
|
/**
|
|
1823
1807
|
* ID to match the ID from the function call block.
|
|
1824
1808
|
*/
|
|
1825
|
-
call_id
|
|
1826
|
-
is_error?: boolean;
|
|
1827
|
-
name?: string;
|
|
1809
|
+
call_id: string;
|
|
1828
1810
|
/**
|
|
1829
1811
|
* Tool call result delta.
|
|
1830
1812
|
*/
|
|
1831
|
-
result
|
|
1813
|
+
result: FunctionResultDelta.Items | unknown | string;
|
|
1814
|
+
type: 'function_result';
|
|
1815
|
+
is_error?: boolean;
|
|
1816
|
+
name?: string;
|
|
1832
1817
|
}
|
|
1833
1818
|
namespace FunctionResultDelta {
|
|
1834
1819
|
interface Items {
|
|
@@ -1836,91 +1821,91 @@ declare namespace ContentDelta {
|
|
|
1836
1821
|
}
|
|
1837
1822
|
}
|
|
1838
1823
|
interface CodeExecutionCallDelta {
|
|
1839
|
-
type: 'code_execution_call';
|
|
1840
1824
|
/**
|
|
1841
1825
|
* A unique ID for this specific tool call.
|
|
1842
1826
|
*/
|
|
1843
|
-
id
|
|
1827
|
+
id: string;
|
|
1844
1828
|
/**
|
|
1845
1829
|
* The arguments to pass to the code execution.
|
|
1846
1830
|
*/
|
|
1847
|
-
arguments
|
|
1831
|
+
arguments: InteractionsAPI.CodeExecutionCallArguments;
|
|
1832
|
+
type: 'code_execution_call';
|
|
1848
1833
|
}
|
|
1849
1834
|
interface CodeExecutionResultDelta {
|
|
1850
|
-
type: 'code_execution_result';
|
|
1851
1835
|
/**
|
|
1852
1836
|
* ID to match the ID from the function call block.
|
|
1853
1837
|
*/
|
|
1854
|
-
call_id
|
|
1838
|
+
call_id: string;
|
|
1839
|
+
result: string;
|
|
1840
|
+
type: 'code_execution_result';
|
|
1855
1841
|
is_error?: boolean;
|
|
1856
|
-
result?: string;
|
|
1857
1842
|
signature?: string;
|
|
1858
1843
|
}
|
|
1859
1844
|
interface URLContextCallDelta {
|
|
1860
|
-
type: 'url_context_call';
|
|
1861
1845
|
/**
|
|
1862
1846
|
* A unique ID for this specific tool call.
|
|
1863
1847
|
*/
|
|
1864
|
-
id
|
|
1848
|
+
id: string;
|
|
1865
1849
|
/**
|
|
1866
1850
|
* The arguments to pass to the URL context.
|
|
1867
1851
|
*/
|
|
1868
|
-
arguments
|
|
1852
|
+
arguments: InteractionsAPI.URLContextCallArguments;
|
|
1853
|
+
type: 'url_context_call';
|
|
1869
1854
|
}
|
|
1870
1855
|
interface URLContextResultDelta {
|
|
1871
|
-
type: 'url_context_result';
|
|
1872
1856
|
/**
|
|
1873
1857
|
* ID to match the ID from the function call block.
|
|
1874
1858
|
*/
|
|
1875
|
-
call_id
|
|
1859
|
+
call_id: string;
|
|
1860
|
+
result: Array<InteractionsAPI.URLContextResult>;
|
|
1861
|
+
type: 'url_context_result';
|
|
1876
1862
|
is_error?: boolean;
|
|
1877
|
-
result?: Array<InteractionsAPI.URLContextResult>;
|
|
1878
1863
|
signature?: string;
|
|
1879
1864
|
}
|
|
1880
1865
|
interface GoogleSearchCallDelta {
|
|
1881
|
-
type: 'google_search_call';
|
|
1882
1866
|
/**
|
|
1883
1867
|
* A unique ID for this specific tool call.
|
|
1884
1868
|
*/
|
|
1885
|
-
id
|
|
1869
|
+
id: string;
|
|
1886
1870
|
/**
|
|
1887
1871
|
* The arguments to pass to Google Search.
|
|
1888
1872
|
*/
|
|
1889
|
-
arguments
|
|
1873
|
+
arguments: InteractionsAPI.GoogleSearchCallArguments;
|
|
1874
|
+
type: 'google_search_call';
|
|
1890
1875
|
}
|
|
1891
1876
|
interface GoogleSearchResultDelta {
|
|
1892
|
-
type: 'google_search_result';
|
|
1893
1877
|
/**
|
|
1894
1878
|
* ID to match the ID from the function call block.
|
|
1895
1879
|
*/
|
|
1896
|
-
call_id
|
|
1880
|
+
call_id: string;
|
|
1881
|
+
result: Array<InteractionsAPI.GoogleSearchResult>;
|
|
1882
|
+
type: 'google_search_result';
|
|
1897
1883
|
is_error?: boolean;
|
|
1898
|
-
result?: Array<InteractionsAPI.GoogleSearchResult>;
|
|
1899
1884
|
signature?: string;
|
|
1900
1885
|
}
|
|
1901
1886
|
interface MCPServerToolCallDelta {
|
|
1902
|
-
type: 'mcp_server_tool_call';
|
|
1903
1887
|
/**
|
|
1904
1888
|
* A unique ID for this specific tool call.
|
|
1905
1889
|
*/
|
|
1906
|
-
id
|
|
1907
|
-
arguments
|
|
1890
|
+
id: string;
|
|
1891
|
+
arguments: {
|
|
1908
1892
|
[key: string]: unknown;
|
|
1909
1893
|
};
|
|
1910
|
-
name
|
|
1911
|
-
server_name
|
|
1894
|
+
name: string;
|
|
1895
|
+
server_name: string;
|
|
1896
|
+
type: 'mcp_server_tool_call';
|
|
1912
1897
|
}
|
|
1913
1898
|
interface MCPServerToolResultDelta {
|
|
1914
|
-
type: 'mcp_server_tool_result';
|
|
1915
1899
|
/**
|
|
1916
1900
|
* ID to match the ID from the function call block.
|
|
1917
1901
|
*/
|
|
1918
|
-
call_id
|
|
1919
|
-
name?: string;
|
|
1902
|
+
call_id: string;
|
|
1920
1903
|
/**
|
|
1921
1904
|
* Tool call result delta.
|
|
1922
1905
|
*/
|
|
1923
|
-
result
|
|
1906
|
+
result: MCPServerToolResultDelta.Items | unknown | string;
|
|
1907
|
+
type: 'mcp_server_tool_result';
|
|
1908
|
+
name?: string;
|
|
1924
1909
|
server_name?: string;
|
|
1925
1910
|
}
|
|
1926
1911
|
namespace MCPServerToolResultDelta {
|
|
@@ -1929,11 +1914,11 @@ declare namespace ContentDelta {
|
|
|
1929
1914
|
}
|
|
1930
1915
|
}
|
|
1931
1916
|
interface FileSearchCallDelta {
|
|
1932
|
-
type: 'file_search_call';
|
|
1933
1917
|
/**
|
|
1934
1918
|
* A unique ID for this specific tool call.
|
|
1935
1919
|
*/
|
|
1936
|
-
id
|
|
1920
|
+
id: string;
|
|
1921
|
+
type: 'file_search_call';
|
|
1937
1922
|
}
|
|
1938
1923
|
interface FileSearchResultDelta {
|
|
1939
1924
|
type: 'file_search_result';
|
|
@@ -2001,25 +1986,25 @@ export declare class ContentReferenceImage {
|
|
|
2001
1986
|
}
|
|
2002
1987
|
|
|
2003
1988
|
declare interface ContentStart {
|
|
2004
|
-
event_type: 'content.start';
|
|
2005
1989
|
/**
|
|
2006
1990
|
* The content of the response.
|
|
2007
1991
|
*/
|
|
2008
|
-
content
|
|
1992
|
+
content: Content_2;
|
|
1993
|
+
event_type: 'content.start';
|
|
1994
|
+
index: number;
|
|
2009
1995
|
/**
|
|
2010
1996
|
* The event_id token to be used to resume the interaction stream, from this event.
|
|
2011
1997
|
*/
|
|
2012
1998
|
event_id?: string;
|
|
2013
|
-
index?: number;
|
|
2014
1999
|
}
|
|
2015
2000
|
|
|
2016
2001
|
declare interface ContentStop {
|
|
2017
2002
|
event_type: 'content.stop';
|
|
2003
|
+
index: number;
|
|
2018
2004
|
/**
|
|
2019
2005
|
* The event_id token to be used to resume the interaction stream, from this event.
|
|
2020
2006
|
*/
|
|
2021
2007
|
event_id?: string;
|
|
2022
|
-
index?: number;
|
|
2023
2008
|
}
|
|
2024
2009
|
|
|
2025
2010
|
export declare type ContentUnion = Content | PartUnion[] | PartUnion;
|
|
@@ -2825,18 +2810,13 @@ declare interface DocumentContent {
|
|
|
2825
2810
|
/**
|
|
2826
2811
|
* The mime type of the document.
|
|
2827
2812
|
*/
|
|
2828
|
-
mime_type?:
|
|
2813
|
+
mime_type?: 'application/pdf';
|
|
2829
2814
|
/**
|
|
2830
2815
|
* The URI of the document.
|
|
2831
2816
|
*/
|
|
2832
2817
|
uri?: string;
|
|
2833
2818
|
}
|
|
2834
2819
|
|
|
2835
|
-
/**
|
|
2836
|
-
* The mime type of the document.
|
|
2837
|
-
*/
|
|
2838
|
-
declare type DocumentMimeType = (string & {}) | 'application/pdf';
|
|
2839
|
-
|
|
2840
2820
|
declare class Documents extends BaseModule {
|
|
2841
2821
|
private readonly apiClient;
|
|
2842
2822
|
constructor(apiClient: ApiClient);
|
|
@@ -3511,17 +3491,21 @@ export declare interface FileSearch {
|
|
|
3511
3491
|
* File Search content.
|
|
3512
3492
|
*/
|
|
3513
3493
|
declare interface FileSearchCallContent {
|
|
3514
|
-
type: 'file_search_call';
|
|
3515
3494
|
/**
|
|
3516
3495
|
* A unique ID for this specific tool call.
|
|
3517
3496
|
*/
|
|
3518
|
-
id
|
|
3497
|
+
id: string;
|
|
3498
|
+
type: 'file_search_call';
|
|
3519
3499
|
}
|
|
3520
3500
|
|
|
3521
3501
|
/**
|
|
3522
3502
|
* File Search result content.
|
|
3523
3503
|
*/
|
|
3524
3504
|
declare interface FileSearchResultContent {
|
|
3505
|
+
/**
|
|
3506
|
+
* ID to match the ID from the file search call block.
|
|
3507
|
+
*/
|
|
3508
|
+
call_id: string;
|
|
3525
3509
|
type: 'file_search_result';
|
|
3526
3510
|
/**
|
|
3527
3511
|
* The results of the File Search.
|
|
@@ -4718,7 +4702,7 @@ declare interface GenerationConfig_2 {
|
|
|
4718
4702
|
/**
|
|
4719
4703
|
* The tool choice for the interaction.
|
|
4720
4704
|
*/
|
|
4721
|
-
tool_choice?:
|
|
4705
|
+
tool_choice?: ToolChoiceType | ToolChoiceConfig;
|
|
4722
4706
|
/**
|
|
4723
4707
|
* The maximum cumulative probability of tokens to consider when sampling.
|
|
4724
4708
|
*/
|
|
@@ -5061,8 +5045,10 @@ export declare interface GoogleRpcStatus {
|
|
|
5061
5045
|
message?: string;
|
|
5062
5046
|
}
|
|
5063
5047
|
|
|
5064
|
-
/**
|
|
5048
|
+
/** Tool to support web search. */
|
|
5065
5049
|
export declare interface GoogleSearch {
|
|
5050
|
+
/** Different types of search that can be enabled on the GoogleSearch tool. */
|
|
5051
|
+
searchTypes?: SearchTypes;
|
|
5066
5052
|
/** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. This field is not supported in Gemini API. */
|
|
5067
5053
|
excludeDomains?: string[];
|
|
5068
5054
|
/** Optional. Sites with confidence level chosen & above this value will be blocked from the search results. This field is not supported in Gemini API. */
|
|
@@ -5085,15 +5071,19 @@ declare interface GoogleSearchCallArguments {
|
|
|
5085
5071
|
* Google Search content.
|
|
5086
5072
|
*/
|
|
5087
5073
|
declare interface GoogleSearchCallContent {
|
|
5088
|
-
type: 'google_search_call';
|
|
5089
5074
|
/**
|
|
5090
5075
|
* A unique ID for this specific tool call.
|
|
5091
5076
|
*/
|
|
5092
|
-
id
|
|
5077
|
+
id: string;
|
|
5093
5078
|
/**
|
|
5094
5079
|
* The arguments to pass to Google Search.
|
|
5095
5080
|
*/
|
|
5096
|
-
arguments
|
|
5081
|
+
arguments: GoogleSearchCallArguments;
|
|
5082
|
+
type: 'google_search_call';
|
|
5083
|
+
/**
|
|
5084
|
+
* The type of search grounding enabled.
|
|
5085
|
+
*/
|
|
5086
|
+
search_type?: 'web_search' | 'image_search';
|
|
5097
5087
|
}
|
|
5098
5088
|
|
|
5099
5089
|
/**
|
|
@@ -5118,19 +5108,19 @@ declare interface GoogleSearchResult {
|
|
|
5118
5108
|
* Google Search result content.
|
|
5119
5109
|
*/
|
|
5120
5110
|
declare interface GoogleSearchResultContent {
|
|
5121
|
-
type: 'google_search_result';
|
|
5122
5111
|
/**
|
|
5123
5112
|
* ID to match the ID from the google search call block.
|
|
5124
5113
|
*/
|
|
5125
|
-
call_id
|
|
5114
|
+
call_id: string;
|
|
5126
5115
|
/**
|
|
5127
|
-
*
|
|
5116
|
+
* The results of the Google Search.
|
|
5128
5117
|
*/
|
|
5129
|
-
|
|
5118
|
+
result: Array<GoogleSearchResult>;
|
|
5119
|
+
type: 'google_search_result';
|
|
5130
5120
|
/**
|
|
5131
|
-
*
|
|
5121
|
+
* Whether the Google Search resulted in an error.
|
|
5132
5122
|
*/
|
|
5133
|
-
|
|
5123
|
+
is_error?: boolean;
|
|
5134
5124
|
/**
|
|
5135
5125
|
* The signature of the Google Search result.
|
|
5136
5126
|
*/
|
|
@@ -5153,8 +5143,16 @@ export declare interface GoogleTypeDate {
|
|
|
5153
5143
|
year?: number;
|
|
5154
5144
|
}
|
|
5155
5145
|
|
|
5156
|
-
/**
|
|
5146
|
+
/** A piece of evidence that supports a claim made by the model.
|
|
5147
|
+
|
|
5148
|
+
This is used to show a citation for a claim made by the model. When grounding
|
|
5149
|
+
is enabled, the model returns a `GroundingChunk` that contains a reference to
|
|
5150
|
+
the source of the information. */
|
|
5157
5151
|
export declare interface GroundingChunk {
|
|
5152
|
+
/** A grounding chunk from an image search result. See the `Image`
|
|
5153
|
+
message for details.
|
|
5154
|
+
*/
|
|
5155
|
+
image?: GroundingChunkImage;
|
|
5158
5156
|
/** Grounding chunk from Google Maps. This field is not supported in Gemini API. */
|
|
5159
5157
|
maps?: GroundingChunkMaps;
|
|
5160
5158
|
/** Grounding chunk from context retrieved by the retrieval tools. This field is not supported in Gemini API. */
|
|
@@ -5163,6 +5161,22 @@ export declare interface GroundingChunk {
|
|
|
5163
5161
|
web?: GroundingChunkWeb;
|
|
5164
5162
|
}
|
|
5165
5163
|
|
|
5164
|
+
/** A piece of evidence that comes from an image search result.
|
|
5165
|
+
|
|
5166
|
+
It contains the URI of the image search result and the URI of the image.
|
|
5167
|
+
This is used to provide the user with a link to the source of the
|
|
5168
|
+
information. */
|
|
5169
|
+
export declare interface GroundingChunkImage {
|
|
5170
|
+
/** The URI of the image search result page. */
|
|
5171
|
+
sourceUri?: string;
|
|
5172
|
+
/** The URI of the image. */
|
|
5173
|
+
imageUri?: string;
|
|
5174
|
+
/** The title of the image search result page. */
|
|
5175
|
+
title?: string;
|
|
5176
|
+
/** The domain of the image search result page. */
|
|
5177
|
+
domain?: string;
|
|
5178
|
+
}
|
|
5179
|
+
|
|
5166
5180
|
/** Chunk from Google Maps. This data type is not supported in Gemini API. */
|
|
5167
5181
|
export declare interface GroundingChunkMaps {
|
|
5168
5182
|
/** Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. */
|
|
@@ -5237,12 +5251,19 @@ export declare interface GroundingChunkWeb {
|
|
|
5237
5251
|
uri?: string;
|
|
5238
5252
|
}
|
|
5239
5253
|
|
|
5240
|
-
/** Metadata returned to client when grounding is enabled. */
|
|
5241
5254
|
export declare interface GroundingMetadata {
|
|
5255
|
+
/** Optional. The image search queries that were used to generate the
|
|
5256
|
+
content. This field is populated only when the grounding source is Google
|
|
5257
|
+
Search with the Image Search search_type enabled.
|
|
5258
|
+
*/
|
|
5259
|
+
imageSearchQueries?: string[];
|
|
5260
|
+
/** A list of supporting references retrieved from the grounding
|
|
5261
|
+
source. This field is populated when the grounding source is Google
|
|
5262
|
+
Search, Vertex AI Search, or Google Maps.
|
|
5263
|
+
*/
|
|
5264
|
+
groundingChunks?: GroundingChunk[];
|
|
5242
5265
|
/** Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. This field is not supported in Gemini API. */
|
|
5243
5266
|
googleMapsWidgetContextToken?: string;
|
|
5244
|
-
/** List of supporting references retrieved from specified grounding source. */
|
|
5245
|
-
groundingChunks?: GroundingChunk[];
|
|
5246
5267
|
/** Optional. List of grounding support. */
|
|
5247
5268
|
groundingSupports?: GroundingSupport[];
|
|
5248
5269
|
/** Optional. Output only. Retrieval metadata. */
|
|
@@ -5566,6 +5587,12 @@ export declare interface ImageConfig {
|
|
|
5566
5587
|
/** Controls the generation of people. Supported values are:
|
|
5567
5588
|
ALLOW_ALL, ALLOW_ADULT, ALLOW_NONE. */
|
|
5568
5589
|
personGeneration?: string;
|
|
5590
|
+
/** Controls whether prominent people (celebrities)
|
|
5591
|
+
generation is allowed. If used with personGeneration, personGeneration
|
|
5592
|
+
enum would take precedence. For instance, if ALLOW_NONE is set, all person
|
|
5593
|
+
generation would be blocked. If this field is unspecified, the default
|
|
5594
|
+
behavior is to allow prominent people. */
|
|
5595
|
+
prominentPeople?: ProminentPeople;
|
|
5569
5596
|
/** MIME type of the generated image. This field is not
|
|
5570
5597
|
supported in Gemini API. */
|
|
5571
5598
|
outputMimeType?: string;
|
|
@@ -5578,8 +5605,8 @@ export declare interface ImageConfig {
|
|
|
5578
5605
|
* The configuration for image interaction.
|
|
5579
5606
|
*/
|
|
5580
5607
|
declare interface ImageConfig_2 {
|
|
5581
|
-
aspect_ratio?: '1:1' | '2:3' | '3:2' | '3:4' | '4:3' | '4:5' | '5:4' | '9:16' | '16:9' | '21:9';
|
|
5582
|
-
image_size?: '1K' | '2K' | '4K';
|
|
5608
|
+
aspect_ratio?: '1:1' | '2:3' | '3:2' | '3:4' | '4:3' | '4:5' | '5:4' | '9:16' | '16:9' | '21:9' | '1:8' | '8:1' | '1:4' | '4:1';
|
|
5609
|
+
image_size?: '1K' | '2K' | '4K' | '512';
|
|
5583
5610
|
}
|
|
5584
5611
|
|
|
5585
5612
|
/**
|
|
@@ -5594,7 +5621,7 @@ declare interface ImageContent {
|
|
|
5594
5621
|
/**
|
|
5595
5622
|
* The mime type of the image.
|
|
5596
5623
|
*/
|
|
5597
|
-
mime_type?:
|
|
5624
|
+
mime_type?: 'image/png' | 'image/jpeg' | 'image/webp' | 'image/heic' | 'image/heif';
|
|
5598
5625
|
/**
|
|
5599
5626
|
* The resolution of the media.
|
|
5600
5627
|
*/
|
|
@@ -5605,11 +5632,6 @@ declare interface ImageContent {
|
|
|
5605
5632
|
uri?: string;
|
|
5606
5633
|
}
|
|
5607
5634
|
|
|
5608
|
-
/**
|
|
5609
|
-
* The mime type of the image.
|
|
5610
|
-
*/
|
|
5611
|
-
declare type ImageMimeType = 'image/png' | 'image/jpeg' | 'image/webp' | 'image/heic' | 'image/heif' | (string & {});
|
|
5612
|
-
|
|
5613
5635
|
/** Enum that specifies the language of the text in the prompt. */
|
|
5614
5636
|
export declare enum ImagePromptLanguage {
|
|
5615
5637
|
/**
|
|
@@ -5646,6 +5668,10 @@ export declare enum ImagePromptLanguage {
|
|
|
5646
5668
|
es = "es"
|
|
5647
5669
|
}
|
|
5648
5670
|
|
|
5671
|
+
/** Image search for grounding and related configurations. */
|
|
5672
|
+
export declare interface ImageSearch {
|
|
5673
|
+
}
|
|
5674
|
+
|
|
5649
5675
|
/** Optional parameters for importing a file. */
|
|
5650
5676
|
export declare interface ImportFileConfig {
|
|
5651
5677
|
/** Used to override HTTP request options. */
|
|
@@ -5749,19 +5775,32 @@ declare interface Interaction {
|
|
|
5749
5775
|
* Output only. A unique identifier for the interaction completion.
|
|
5750
5776
|
*/
|
|
5751
5777
|
id: string;
|
|
5778
|
+
/**
|
|
5779
|
+
* Output only. The time at which the response was created in ISO 8601 format
|
|
5780
|
+
* (YYYY-MM-DDThh:mm:ssZ).
|
|
5781
|
+
*/
|
|
5782
|
+
created: string;
|
|
5752
5783
|
/**
|
|
5753
5784
|
* Output only. The status of the interaction.
|
|
5754
5785
|
*/
|
|
5755
5786
|
status: 'in_progress' | 'requires_action' | 'completed' | 'failed' | 'cancelled' | 'incomplete';
|
|
5787
|
+
/**
|
|
5788
|
+
* Output only. The time at which the response was last updated in ISO 8601 format
|
|
5789
|
+
* (YYYY-MM-DDThh:mm:ssZ).
|
|
5790
|
+
*/
|
|
5791
|
+
updated: string;
|
|
5756
5792
|
/**
|
|
5757
5793
|
* The name of the `Agent` used for generating the interaction.
|
|
5758
5794
|
*/
|
|
5759
5795
|
agent?: (string & {}) | 'deep-research-pro-preview-12-2025';
|
|
5760
5796
|
/**
|
|
5761
|
-
*
|
|
5762
|
-
|
|
5797
|
+
* Configuration for the agent.
|
|
5798
|
+
*/
|
|
5799
|
+
agent_config?: DynamicAgentConfig | DeepResearchAgentConfig;
|
|
5800
|
+
/**
|
|
5801
|
+
* The inputs for the interaction.
|
|
5763
5802
|
*/
|
|
5764
|
-
|
|
5803
|
+
input?: string | Array<Content_2> | Array<Turn> | TextContent | ImageContent | AudioContent | DocumentContent | VideoContent | ThoughtContent | FunctionCallContent | FunctionResultContent | CodeExecutionCallContent | CodeExecutionResultContent | URLContextCallContent | URLContextResultContent | GoogleSearchCallContent | GoogleSearchResultContent | MCPServerToolCallContent | MCPServerToolResultContent | FileSearchCallContent | FileSearchResultContent;
|
|
5765
5804
|
/**
|
|
5766
5805
|
* The name of the `Model` used for generating the interaction.
|
|
5767
5806
|
*/
|
|
@@ -5774,15 +5813,31 @@ declare interface Interaction {
|
|
|
5774
5813
|
* The ID of the previous interaction, if any.
|
|
5775
5814
|
*/
|
|
5776
5815
|
previous_interaction_id?: string;
|
|
5816
|
+
/**
|
|
5817
|
+
* Enforces that the generated response is a JSON object that complies with
|
|
5818
|
+
* the JSON schema specified in this field.
|
|
5819
|
+
*/
|
|
5820
|
+
response_format?: unknown;
|
|
5821
|
+
/**
|
|
5822
|
+
* The mime type of the response. This is required if response_format is set.
|
|
5823
|
+
*/
|
|
5824
|
+
response_mime_type?: string;
|
|
5825
|
+
/**
|
|
5826
|
+
* The requested modalities of the response (TEXT, IMAGE, AUDIO).
|
|
5827
|
+
*/
|
|
5828
|
+
response_modalities?: Array<'text' | 'image' | 'audio'>;
|
|
5777
5829
|
/**
|
|
5778
5830
|
* Output only. The role of the interaction.
|
|
5779
5831
|
*/
|
|
5780
5832
|
role?: string;
|
|
5781
5833
|
/**
|
|
5782
|
-
*
|
|
5783
|
-
* (YYYY-MM-DDThh:mm:ssZ).
|
|
5834
|
+
* System instruction for the interaction.
|
|
5784
5835
|
*/
|
|
5785
|
-
|
|
5836
|
+
system_instruction?: string;
|
|
5837
|
+
/**
|
|
5838
|
+
* A list of tool declarations the model may call during interaction.
|
|
5839
|
+
*/
|
|
5840
|
+
tools?: Array<Tool_2>;
|
|
5786
5841
|
/**
|
|
5787
5842
|
* Output only. Statistics on the interaction request's token usage.
|
|
5788
5843
|
*/
|
|
@@ -5799,13 +5854,14 @@ declare interface InteractionCancelParams {
|
|
|
5799
5854
|
declare interface InteractionCompleteEvent {
|
|
5800
5855
|
event_type: 'interaction.complete';
|
|
5801
5856
|
/**
|
|
5802
|
-
* The
|
|
5857
|
+
* The completed interaction with empty outputs to reduce the payload size.
|
|
5858
|
+
* Use the preceding ContentDelta events for the actual output.
|
|
5803
5859
|
*/
|
|
5804
|
-
|
|
5860
|
+
interaction: Interaction;
|
|
5805
5861
|
/**
|
|
5806
|
-
* The
|
|
5862
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
5807
5863
|
*/
|
|
5808
|
-
|
|
5864
|
+
event_id?: string;
|
|
5809
5865
|
}
|
|
5810
5866
|
|
|
5811
5867
|
declare type InteractionCreateParams = CreateModelInteractionParamsNonStreaming | CreateModelInteractionParamsStreaming | CreateAgentInteractionParamsNonStreaming | CreateAgentInteractionParamsStreaming;
|
|
@@ -5863,7 +5919,7 @@ export declare class Interactions extends BaseInteractions {
|
|
|
5863
5919
|
}
|
|
5864
5920
|
|
|
5865
5921
|
export declare namespace Interactions {
|
|
5866
|
-
export { type AllowedTools as AllowedTools, type Annotation as Annotation, type AudioContent as AudioContent, type
|
|
5922
|
+
export { type AllowedTools as AllowedTools, type Annotation as Annotation, type AudioContent as AudioContent, type CodeExecutionCallArguments as CodeExecutionCallArguments, type CodeExecutionCallContent as CodeExecutionCallContent, type CodeExecutionResultContent as CodeExecutionResultContent, type Content_2 as Content, type ContentDelta as ContentDelta, type ContentStart as ContentStart, type ContentStop as ContentStop, type DeepResearchAgentConfig as DeepResearchAgentConfig, type DocumentContent as DocumentContent, type DynamicAgentConfig as DynamicAgentConfig, type ErrorEvent_2 as ErrorEvent, type FileSearchCallContent as FileSearchCallContent, type FileSearchResultContent as FileSearchResultContent, type Function_2 as Function, type FunctionCallContent as FunctionCallContent, type FunctionResultContent as FunctionResultContent, type GenerationConfig_2 as GenerationConfig, type GoogleSearchCallArguments as GoogleSearchCallArguments, type GoogleSearchCallContent as GoogleSearchCallContent, type GoogleSearchResult as GoogleSearchResult, type GoogleSearchResultContent as GoogleSearchResultContent, type ImageConfig_2 as ImageConfig, type ImageContent as ImageContent, type Interaction as Interaction, type InteractionCompleteEvent as InteractionCompleteEvent, type InteractionSSEEvent as InteractionSSEEvent, type InteractionStartEvent as InteractionStartEvent, type InteractionStatusUpdate as InteractionStatusUpdate, type MCPServerToolCallContent as MCPServerToolCallContent, type MCPServerToolResultContent as MCPServerToolResultContent, type Model_2 as Model, type SpeechConfig_2 as SpeechConfig, type TextContent as TextContent, type ThinkingLevel_2 as ThinkingLevel, type ThoughtContent as ThoughtContent, type Tool_2 as Tool, type ToolChoiceConfig as ToolChoiceConfig, type ToolChoiceType as ToolChoiceType, type Turn as Turn, type URLContextCallArguments as URLContextCallArguments, type URLContextCallContent as URLContextCallContent, type URLContextResult as URLContextResult, type URLContextResultContent as URLContextResultContent, type Usage as Usage, type VideoContent as VideoContent, 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, };
|
|
5867
5923
|
}
|
|
5868
5924
|
|
|
5869
5925
|
declare namespace InteractionsAPI {
|
|
@@ -5873,7 +5929,6 @@ declare namespace InteractionsAPI {
|
|
|
5873
5929
|
AllowedTools,
|
|
5874
5930
|
Annotation,
|
|
5875
5931
|
AudioContent,
|
|
5876
|
-
AudioMimeType,
|
|
5877
5932
|
CodeExecutionCallArguments,
|
|
5878
5933
|
CodeExecutionCallContent,
|
|
5879
5934
|
CodeExecutionResultContent,
|
|
@@ -5883,7 +5938,6 @@ declare namespace InteractionsAPI {
|
|
|
5883
5938
|
ContentStop,
|
|
5884
5939
|
DeepResearchAgentConfig,
|
|
5885
5940
|
DocumentContent,
|
|
5886
|
-
DocumentMimeType,
|
|
5887
5941
|
DynamicAgentConfig,
|
|
5888
5942
|
ErrorEvent_2 as ErrorEvent,
|
|
5889
5943
|
FileSearchCallContent,
|
|
@@ -5898,7 +5952,6 @@ declare namespace InteractionsAPI {
|
|
|
5898
5952
|
GoogleSearchResultContent,
|
|
5899
5953
|
ImageConfig_2 as ImageConfig,
|
|
5900
5954
|
ImageContent,
|
|
5901
|
-
ImageMimeType,
|
|
5902
5955
|
Interaction,
|
|
5903
5956
|
InteractionCompleteEvent,
|
|
5904
5957
|
InteractionSSEEvent,
|
|
@@ -5912,7 +5965,6 @@ declare namespace InteractionsAPI {
|
|
|
5912
5965
|
ThinkingLevel_2 as ThinkingLevel,
|
|
5913
5966
|
ThoughtContent,
|
|
5914
5967
|
Tool_2 as Tool,
|
|
5915
|
-
ToolChoice,
|
|
5916
5968
|
ToolChoiceConfig,
|
|
5917
5969
|
ToolChoiceType,
|
|
5918
5970
|
Turn,
|
|
@@ -5922,7 +5974,6 @@ declare namespace InteractionsAPI {
|
|
|
5922
5974
|
URLContextResultContent,
|
|
5923
5975
|
Usage,
|
|
5924
5976
|
VideoContent,
|
|
5925
|
-
VideoMimeType,
|
|
5926
5977
|
InteractionDeleteResponse,
|
|
5927
5978
|
InteractionCreateParams,
|
|
5928
5979
|
BaseCreateModelInteractionParams,
|
|
@@ -5945,23 +5996,23 @@ declare type InteractionSSEEvent = InteractionStartEvent | InteractionCompleteEv
|
|
|
5945
5996
|
declare interface InteractionStartEvent {
|
|
5946
5997
|
event_type: 'interaction.start';
|
|
5947
5998
|
/**
|
|
5948
|
-
* The
|
|
5999
|
+
* The Interaction resource.
|
|
5949
6000
|
*/
|
|
5950
|
-
|
|
6001
|
+
interaction: Interaction;
|
|
5951
6002
|
/**
|
|
5952
|
-
* The
|
|
6003
|
+
* The event_id token to be used to resume the interaction stream, from this event.
|
|
5953
6004
|
*/
|
|
5954
|
-
|
|
6005
|
+
event_id?: string;
|
|
5955
6006
|
}
|
|
5956
6007
|
|
|
5957
6008
|
declare interface InteractionStatusUpdate {
|
|
5958
6009
|
event_type: 'interaction.status_update';
|
|
6010
|
+
interaction_id: string;
|
|
6011
|
+
status: 'in_progress' | 'requires_action' | 'completed' | 'failed' | 'cancelled' | 'incomplete';
|
|
5959
6012
|
/**
|
|
5960
6013
|
* The event_id token to be used to resume the interaction stream, from this event.
|
|
5961
6014
|
*/
|
|
5962
6015
|
event_id?: string;
|
|
5963
|
-
interaction_id?: string;
|
|
5964
|
-
status?: 'in_progress' | 'requires_action' | 'completed' | 'failed' | 'cancelled' | 'incomplete';
|
|
5965
6016
|
}
|
|
5966
6017
|
|
|
5967
6018
|
/** Parameters for the private _Register method. */
|
|
@@ -7131,6 +7182,14 @@ export declare enum MaskReferenceMode {
|
|
|
7131
7182
|
MASK_MODE_SEMANTIC = "MASK_MODE_SEMANTIC"
|
|
7132
7183
|
}
|
|
7133
7184
|
|
|
7185
|
+
/** A MCPServer is a server that can be called by the model to perform actions. It is a server that implements the MCP protocol. Next ID: 5. This data type is not supported in Vertex AI. */
|
|
7186
|
+
export declare interface McpServer {
|
|
7187
|
+
/** The name of the MCPServer. */
|
|
7188
|
+
name?: string;
|
|
7189
|
+
/** A transport that can stream HTTP requests and responses. */
|
|
7190
|
+
streamableHttpTransport?: StreamableHttpTransport;
|
|
7191
|
+
}
|
|
7192
|
+
|
|
7134
7193
|
/**
|
|
7135
7194
|
* MCPServer tool call content.
|
|
7136
7195
|
*/
|
|
@@ -7339,7 +7398,7 @@ export declare interface Model {
|
|
|
7339
7398
|
/**
|
|
7340
7399
|
* The model that will complete your prompt.\n\nSee [models](https://ai.google.dev/gemini-api/docs/models) for additional details.
|
|
7341
7400
|
*/
|
|
7342
|
-
declare type Model_2 = 'gemini-2.5-flash' | 'gemini-2.5-flash-image' | 'gemini-2.5-flash-lite' | 'gemini-2.5-flash-lite-preview-09-2025' | 'gemini-2.5-flash-native-audio-preview-12-2025' | 'gemini-2.5-flash-preview-09-2025' | 'gemini-2.5-flash-preview-tts' | 'gemini-2.5-pro' | 'gemini-2.5-pro-preview-tts' | 'gemini-3-flash-preview' | 'gemini-3-pro-image-preview' | 'gemini-3-pro-preview' | (string & {});
|
|
7401
|
+
declare type Model_2 = 'gemini-2.5-flash' | 'gemini-2.5-flash-image' | 'gemini-2.5-flash-lite' | 'gemini-2.5-flash-lite-preview-09-2025' | 'gemini-2.5-flash-native-audio-preview-12-2025' | 'gemini-2.5-flash-preview-09-2025' | 'gemini-2.5-flash-preview-tts' | 'gemini-2.5-pro' | 'gemini-2.5-pro-preview-tts' | 'gemini-3-flash-preview' | 'gemini-3-pro-image-preview' | 'gemini-3-pro-preview' | 'gemini-3.1-pro-preview' | (string & {});
|
|
7343
7402
|
|
|
7344
7403
|
/** Configuration for Model Armor integrations of prompt and responses. This data type is not supported in Gemini API. */
|
|
7345
7404
|
export declare interface ModelArmorConfig {
|
|
@@ -8260,6 +8319,22 @@ export declare interface ProductImage {
|
|
|
8260
8319
|
productImage?: Image_2;
|
|
8261
8320
|
}
|
|
8262
8321
|
|
|
8322
|
+
/** Enum for controlling whether the model can generate images of prominent people (celebrities). */
|
|
8323
|
+
export declare enum ProminentPeople {
|
|
8324
|
+
/**
|
|
8325
|
+
* Unspecified value. The model will proceed with the default behavior, which is to allow generation of prominent people.
|
|
8326
|
+
*/
|
|
8327
|
+
PROMINENT_PEOPLE_UNSPECIFIED = "PROMINENT_PEOPLE_UNSPECIFIED",
|
|
8328
|
+
/**
|
|
8329
|
+
* Allows the model to generate images of prominent people.
|
|
8330
|
+
*/
|
|
8331
|
+
ALLOW_PROMINENT_PEOPLE = "ALLOW_PROMINENT_PEOPLE",
|
|
8332
|
+
/**
|
|
8333
|
+
* Prevents the model from generating images of prominent people.
|
|
8334
|
+
*/
|
|
8335
|
+
BLOCK_PROMINENT_PEOPLE = "BLOCK_PROMINENT_PEOPLE"
|
|
8336
|
+
}
|
|
8337
|
+
|
|
8263
8338
|
/**
|
|
8264
8339
|
* @license
|
|
8265
8340
|
* Copyright 2025 Google LLC
|
|
@@ -8812,6 +8887,15 @@ export declare interface SearchEntryPoint {
|
|
|
8812
8887
|
sdkBlob?: string;
|
|
8813
8888
|
}
|
|
8814
8889
|
|
|
8890
|
+
/** Tool to support computer use. */
|
|
8891
|
+
export declare interface SearchTypes {
|
|
8892
|
+
/** Setting this field enables web search. Only text results are
|
|
8893
|
+
returned. */
|
|
8894
|
+
webSearch?: WebSearch;
|
|
8895
|
+
/** Setting this field enables image search. Image bytes are returned. */
|
|
8896
|
+
imageSearch?: ImageSearch;
|
|
8897
|
+
}
|
|
8898
|
+
|
|
8815
8899
|
/** Segment of the content. */
|
|
8816
8900
|
export declare interface Segment {
|
|
8817
8901
|
/** Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. */
|
|
@@ -9174,6 +9258,20 @@ declare class Stream<Item> implements AsyncIterable<Item> {
|
|
|
9174
9258
|
toReadableStream(): _ReadableStream_2;
|
|
9175
9259
|
}
|
|
9176
9260
|
|
|
9261
|
+
/** A transport that can stream HTTP requests and responses. Next ID: 6. This data type is not supported in Vertex AI. */
|
|
9262
|
+
export declare interface StreamableHttpTransport {
|
|
9263
|
+
/** Optional: Fields for authentication headers, timeouts, etc., if needed. */
|
|
9264
|
+
headers?: Record<string, string>;
|
|
9265
|
+
/** Timeout for SSE read operations. */
|
|
9266
|
+
sseReadTimeout?: string;
|
|
9267
|
+
/** Whether to close the client session when the transport closes. */
|
|
9268
|
+
terminateOnClose?: boolean;
|
|
9269
|
+
/** HTTP timeout for regular operations. */
|
|
9270
|
+
timeout?: string;
|
|
9271
|
+
/** The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp". */
|
|
9272
|
+
url?: string;
|
|
9273
|
+
}
|
|
9274
|
+
|
|
9177
9275
|
/** User provided string values assigned to a single metadata key. This data type is not supported in Vertex AI. */
|
|
9178
9276
|
export declare interface StringList {
|
|
9179
9277
|
/** The string values of the metadata to store. */
|
|
@@ -9359,15 +9457,15 @@ export declare interface TestTableItem {
|
|
|
9359
9457
|
* A text content block.
|
|
9360
9458
|
*/
|
|
9361
9459
|
declare interface TextContent {
|
|
9460
|
+
/**
|
|
9461
|
+
* The text content.
|
|
9462
|
+
*/
|
|
9463
|
+
text: string;
|
|
9362
9464
|
type: 'text';
|
|
9363
9465
|
/**
|
|
9364
9466
|
* Citation information for model-generated content.
|
|
9365
9467
|
*/
|
|
9366
9468
|
annotations?: Array<Annotation>;
|
|
9367
|
-
/**
|
|
9368
|
-
* The text content.
|
|
9369
|
-
*/
|
|
9370
|
-
text?: string;
|
|
9371
9469
|
}
|
|
9372
9470
|
|
|
9373
9471
|
/** The thinking features configuration. */
|
|
@@ -9533,6 +9631,8 @@ export declare interface Tool {
|
|
|
9533
9631
|
computerUse?: ComputerUse;
|
|
9534
9632
|
/** Optional. Tool to retrieve knowledge from the File Search Stores. */
|
|
9535
9633
|
fileSearch?: FileSearch;
|
|
9634
|
+
/** Enables the model to execute Google Search as part of generation. */
|
|
9635
|
+
googleSearch?: GoogleSearch;
|
|
9536
9636
|
/** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
|
|
9537
9637
|
codeExecution?: ToolCodeExecution;
|
|
9538
9638
|
/** Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. This field is not supported in Gemini API. */
|
|
@@ -9541,12 +9641,12 @@ export declare interface Tool {
|
|
|
9541
9641
|
functionDeclarations?: FunctionDeclaration[];
|
|
9542
9642
|
/** Optional. GoogleMaps tool type. Tool to support Google Maps in Model. */
|
|
9543
9643
|
googleMaps?: GoogleMaps;
|
|
9544
|
-
/** Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */
|
|
9545
|
-
googleSearch?: GoogleSearch;
|
|
9546
9644
|
/** Optional. Specialized retrieval tool that is powered by Google Search. */
|
|
9547
9645
|
googleSearchRetrieval?: GoogleSearchRetrieval;
|
|
9548
9646
|
/** Optional. Tool to support URL context retrieval. */
|
|
9549
9647
|
urlContext?: UrlContext;
|
|
9648
|
+
/** Optional. MCP Servers to connect to. This field is not supported in Vertex AI. */
|
|
9649
|
+
mcpServers?: McpServer[];
|
|
9550
9650
|
}
|
|
9551
9651
|
|
|
9552
9652
|
/**
|
|
@@ -9560,6 +9660,10 @@ declare namespace Tool_2 {
|
|
|
9560
9660
|
*/
|
|
9561
9661
|
interface GoogleSearch {
|
|
9562
9662
|
type: 'google_search';
|
|
9663
|
+
/**
|
|
9664
|
+
* The types of search grounding to enable.
|
|
9665
|
+
*/
|
|
9666
|
+
search_types?: Array<'web_search' | 'image_search'>;
|
|
9563
9667
|
}
|
|
9564
9668
|
/**
|
|
9565
9669
|
* A tool that can be used by the model to execute code.
|
|
@@ -9633,13 +9737,11 @@ declare namespace Tool_2 {
|
|
|
9633
9737
|
}
|
|
9634
9738
|
|
|
9635
9739
|
/**
|
|
9636
|
-
* The configuration
|
|
9740
|
+
* The tool choice configuration containing allowed tools.
|
|
9637
9741
|
*/
|
|
9638
|
-
declare type ToolChoice = ToolChoiceType | ToolChoiceConfig;
|
|
9639
|
-
|
|
9640
9742
|
declare interface ToolChoiceConfig {
|
|
9641
9743
|
/**
|
|
9642
|
-
* The
|
|
9744
|
+
* The allowed tools.
|
|
9643
9745
|
*/
|
|
9644
9746
|
allowed_tools?: AllowedTools;
|
|
9645
9747
|
}
|
|
@@ -10050,10 +10152,10 @@ declare namespace types {
|
|
|
10050
10152
|
Language,
|
|
10051
10153
|
FunctionResponseScheduling,
|
|
10052
10154
|
Type,
|
|
10155
|
+
PhishBlockThreshold,
|
|
10053
10156
|
ApiSpec,
|
|
10054
10157
|
AuthType,
|
|
10055
10158
|
HttpElementLocation,
|
|
10056
|
-
PhishBlockThreshold,
|
|
10057
10159
|
Behavior,
|
|
10058
10160
|
DynamicRetrievalConfigMode,
|
|
10059
10161
|
FunctionCallingConfigMode,
|
|
@@ -10077,6 +10179,7 @@ declare namespace types {
|
|
|
10077
10179
|
ResourceScope,
|
|
10078
10180
|
FeatureSelectionPreference,
|
|
10079
10181
|
Environment,
|
|
10182
|
+
ProminentPeople,
|
|
10080
10183
|
EmbeddingApiType,
|
|
10081
10184
|
SafetyFilterLevel,
|
|
10082
10185
|
PersonGeneration,
|
|
@@ -10124,6 +10227,11 @@ declare namespace types {
|
|
|
10124
10227
|
ModelSelectionConfig,
|
|
10125
10228
|
ComputerUse,
|
|
10126
10229
|
FileSearch,
|
|
10230
|
+
WebSearch,
|
|
10231
|
+
ImageSearch,
|
|
10232
|
+
SearchTypes,
|
|
10233
|
+
Interval,
|
|
10234
|
+
GoogleSearch,
|
|
10127
10235
|
ApiAuthApiKeyConfig,
|
|
10128
10236
|
ApiAuth,
|
|
10129
10237
|
ApiKeyConfig,
|
|
@@ -10150,11 +10258,11 @@ declare namespace types {
|
|
|
10150
10258
|
EnterpriseWebSearch,
|
|
10151
10259
|
FunctionDeclaration,
|
|
10152
10260
|
GoogleMaps,
|
|
10153
|
-
Interval,
|
|
10154
|
-
GoogleSearch,
|
|
10155
10261
|
DynamicRetrievalConfig,
|
|
10156
10262
|
GoogleSearchRetrieval,
|
|
10157
10263
|
UrlContext,
|
|
10264
|
+
StreamableHttpTransport,
|
|
10265
|
+
McpServer,
|
|
10158
10266
|
Tool,
|
|
10159
10267
|
LatLng,
|
|
10160
10268
|
RetrievalConfig,
|
|
@@ -10181,6 +10289,7 @@ declare namespace types {
|
|
|
10181
10289
|
GoogleTypeDate,
|
|
10182
10290
|
Citation,
|
|
10183
10291
|
CitationMetadata,
|
|
10292
|
+
GroundingChunkImage,
|
|
10184
10293
|
GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution,
|
|
10185
10294
|
GroundingChunkMapsPlaceAnswerSourcesReviewSnippet,
|
|
10186
10295
|
GroundingChunkMapsPlaceAnswerSources,
|
|
@@ -10791,15 +10900,15 @@ declare interface URLContextCallArguments {
|
|
|
10791
10900
|
* URL context content.
|
|
10792
10901
|
*/
|
|
10793
10902
|
declare interface URLContextCallContent {
|
|
10794
|
-
type: 'url_context_call';
|
|
10795
10903
|
/**
|
|
10796
10904
|
* A unique ID for this specific tool call.
|
|
10797
10905
|
*/
|
|
10798
|
-
id
|
|
10906
|
+
id: string;
|
|
10799
10907
|
/**
|
|
10800
10908
|
* The arguments to pass to the URL context.
|
|
10801
10909
|
*/
|
|
10802
|
-
arguments
|
|
10910
|
+
arguments: URLContextCallArguments;
|
|
10911
|
+
type: 'url_context_call';
|
|
10803
10912
|
}
|
|
10804
10913
|
|
|
10805
10914
|
/** Metadata related to url context retrieval tool. */
|
|
@@ -10826,19 +10935,19 @@ declare interface URLContextResult {
|
|
|
10826
10935
|
* URL context result content.
|
|
10827
10936
|
*/
|
|
10828
10937
|
declare interface URLContextResultContent {
|
|
10829
|
-
type: 'url_context_result';
|
|
10830
10938
|
/**
|
|
10831
10939
|
* ID to match the ID from the url context call block.
|
|
10832
10940
|
*/
|
|
10833
|
-
call_id
|
|
10941
|
+
call_id: string;
|
|
10834
10942
|
/**
|
|
10835
|
-
*
|
|
10943
|
+
* The results of the URL context.
|
|
10836
10944
|
*/
|
|
10837
|
-
|
|
10945
|
+
result: Array<URLContextResult>;
|
|
10946
|
+
type: 'url_context_result';
|
|
10838
10947
|
/**
|
|
10839
|
-
*
|
|
10948
|
+
* Whether the URL context resulted in an error.
|
|
10840
10949
|
*/
|
|
10841
|
-
|
|
10950
|
+
is_error?: boolean;
|
|
10842
10951
|
/**
|
|
10843
10952
|
* The signature of the URL context result.
|
|
10844
10953
|
*/
|
|
@@ -11125,7 +11234,7 @@ declare interface VideoContent {
|
|
|
11125
11234
|
/**
|
|
11126
11235
|
* The mime type of the video.
|
|
11127
11236
|
*/
|
|
11128
|
-
mime_type?:
|
|
11237
|
+
mime_type?: 'video/mp4' | 'video/mpeg' | 'video/mpg' | 'video/mov' | 'video/avi' | 'video/x-flv' | 'video/webm' | 'video/wmv' | 'video/3gpp';
|
|
11129
11238
|
/**
|
|
11130
11239
|
* The resolution of the media.
|
|
11131
11240
|
*/
|
|
@@ -11207,11 +11316,6 @@ export declare interface VideoMetadata {
|
|
|
11207
11316
|
startOffset?: string;
|
|
11208
11317
|
}
|
|
11209
11318
|
|
|
11210
|
-
/**
|
|
11211
|
-
* The mime type of the video.
|
|
11212
|
-
*/
|
|
11213
|
-
declare type VideoMimeType = 'video/mp4' | 'video/mpeg' | 'video/mov' | 'video/avi' | 'video/x-flv' | 'video/mpg' | 'video/webm' | 'video/wmv' | 'video/3gpp' | (string & {});
|
|
11214
|
-
|
|
11215
11319
|
/** Voice activity signal. */
|
|
11216
11320
|
export declare interface VoiceActivity {
|
|
11217
11321
|
/** The type of the voice activity signal. */
|
|
@@ -11246,6 +11350,12 @@ export declare interface VoiceConfig {
|
|
|
11246
11350
|
prebuiltVoiceConfig?: PrebuiltVoiceConfig;
|
|
11247
11351
|
}
|
|
11248
11352
|
|
|
11353
|
+
/** Standard web search for grounding and related configurations.
|
|
11354
|
+
|
|
11355
|
+
Only text results are returned. */
|
|
11356
|
+
export declare interface WebSearch {
|
|
11357
|
+
}
|
|
11358
|
+
|
|
11249
11359
|
declare interface WebSocket_2 {
|
|
11250
11360
|
/**
|
|
11251
11361
|
* Connects the socket to the server.
|