mtmsdk 0.0.14 → 0.0.15

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.
Files changed (135) hide show
  1. package/dist/gomtmapi/zod.gen.d.ts +17 -17
  2. package/dist/gomtmapi_v2/@tanstack/react-query.gen.d.ts +61 -0
  3. package/dist/gomtmapi_v2/@tanstack/react-query.gen.d.ts.map +1 -1
  4. package/dist/gomtmapi_v2/@tanstack/react-query.gen.js +61 -0
  5. package/dist/gomtmapi_v2/@tanstack/react-query.gen.js.map +1 -1
  6. package/dist/gomtmapi_v2/client/index.d.ts +1 -0
  7. package/dist/gomtmapi_v2/client/index.d.ts.map +1 -1
  8. package/dist/gomtmapi_v2/client/index.js +1 -0
  9. package/dist/gomtmapi_v2/client/index.js.map +1 -1
  10. package/dist/gomtmapi_v2/client/utils.gen.d.ts +1 -1
  11. package/dist/gomtmapi_v2/client/utils.gen.d.ts.map +1 -1
  12. package/dist/gomtmapi_v2/client/utils.gen.js +7 -6
  13. package/dist/gomtmapi_v2/client/utils.gen.js.map +1 -1
  14. package/dist/gomtmapi_v2/core/bodySerializer.gen.d.ts +12 -4
  15. package/dist/gomtmapi_v2/core/bodySerializer.gen.d.ts.map +1 -1
  16. package/dist/gomtmapi_v2/core/bodySerializer.gen.js.map +1 -1
  17. package/dist/gomtmapi_v2/core/queryKeySerializer.gen.d.ts +19 -0
  18. package/dist/gomtmapi_v2/core/queryKeySerializer.gen.d.ts.map +1 -0
  19. package/dist/gomtmapi_v2/core/queryKeySerializer.gen.js +100 -0
  20. package/dist/gomtmapi_v2/core/queryKeySerializer.gen.js.map +1 -0
  21. package/dist/gomtmapi_v2/sdk.gen.d.ts +59 -0
  22. package/dist/gomtmapi_v2/sdk.gen.d.ts.map +1 -1
  23. package/dist/gomtmapi_v2/sdk.gen.js +59 -0
  24. package/dist/gomtmapi_v2/sdk.gen.js.map +1 -1
  25. package/dist/mtgate_api/@tanstack/react-query.gen.d.ts +983 -929
  26. package/dist/mtgate_api/@tanstack/react-query.gen.d.ts.map +1 -1
  27. package/dist/mtgate_api/@tanstack/react-query.gen.js +876 -387
  28. package/dist/mtgate_api/@tanstack/react-query.gen.js.map +1 -1
  29. package/dist/mtgate_api/client/index.d.ts +1 -0
  30. package/dist/mtgate_api/client/index.d.ts.map +1 -1
  31. package/dist/mtgate_api/client/index.js +1 -0
  32. package/dist/mtgate_api/client/index.js.map +1 -1
  33. package/dist/mtgate_api/client/utils.gen.d.ts +1 -1
  34. package/dist/mtgate_api/client/utils.gen.d.ts.map +1 -1
  35. package/dist/mtgate_api/client/utils.gen.js +7 -6
  36. package/dist/mtgate_api/client/utils.gen.js.map +1 -1
  37. package/dist/mtgate_api/core/bodySerializer.gen.d.ts +12 -4
  38. package/dist/mtgate_api/core/bodySerializer.gen.d.ts.map +1 -1
  39. package/dist/mtgate_api/core/bodySerializer.gen.js.map +1 -1
  40. package/dist/mtgate_api/core/queryKeySerializer.gen.d.ts +19 -0
  41. package/dist/mtgate_api/core/queryKeySerializer.gen.d.ts.map +1 -0
  42. package/dist/mtgate_api/core/queryKeySerializer.gen.js +100 -0
  43. package/dist/mtgate_api/core/queryKeySerializer.gen.js.map +1 -0
  44. package/dist/mtgate_api/schemas.gen.d.ts +2258 -483
  45. package/dist/mtgate_api/schemas.gen.d.ts.map +1 -1
  46. package/dist/mtgate_api/schemas.gen.js +2344 -492
  47. package/dist/mtgate_api/schemas.gen.js.map +1 -1
  48. package/dist/mtgate_api/sdk.gen.d.ts +94 -26
  49. package/dist/mtgate_api/sdk.gen.d.ts.map +1 -1
  50. package/dist/mtgate_api/sdk.gen.js +554 -100
  51. package/dist/mtgate_api/sdk.gen.js.map +1 -1
  52. package/dist/mtgate_api/types.gen.d.ts +3608 -1167
  53. package/dist/mtgate_api/types.gen.d.ts.map +1 -1
  54. package/dist/mtgate_api/types.gen.js +3 -0
  55. package/dist/mtgate_api/types.gen.js.map +1 -1
  56. package/dist/mtgate_api/zod.gen.d.ts +4374 -1328
  57. package/dist/mtgate_api/zod.gen.d.ts.map +1 -1
  58. package/dist/mtgate_api/zod.gen.js +2078 -629
  59. package/dist/mtgate_api/zod.gen.js.map +1 -1
  60. package/dist/mtmai_api/@tanstack/react-query.gen.d.ts +23 -0
  61. package/dist/mtmai_api/@tanstack/react-query.gen.d.ts.map +1 -1
  62. package/dist/mtmai_api/@tanstack/react-query.gen.js +23 -0
  63. package/dist/mtmai_api/@tanstack/react-query.gen.js.map +1 -1
  64. package/dist/mtmai_api/client/index.d.ts +1 -0
  65. package/dist/mtmai_api/client/index.d.ts.map +1 -1
  66. package/dist/mtmai_api/client/index.js +1 -0
  67. package/dist/mtmai_api/client/index.js.map +1 -1
  68. package/dist/mtmai_api/client/utils.gen.d.ts +1 -1
  69. package/dist/mtmai_api/client/utils.gen.d.ts.map +1 -1
  70. package/dist/mtmai_api/client/utils.gen.js +7 -6
  71. package/dist/mtmai_api/client/utils.gen.js.map +1 -1
  72. package/dist/mtmai_api/core/bodySerializer.gen.d.ts +12 -4
  73. package/dist/mtmai_api/core/bodySerializer.gen.d.ts.map +1 -1
  74. package/dist/mtmai_api/core/bodySerializer.gen.js.map +1 -1
  75. package/dist/mtmai_api/core/queryKeySerializer.gen.d.ts +19 -0
  76. package/dist/mtmai_api/core/queryKeySerializer.gen.d.ts.map +1 -0
  77. package/dist/mtmai_api/core/queryKeySerializer.gen.js +100 -0
  78. package/dist/mtmai_api/core/queryKeySerializer.gen.js.map +1 -0
  79. package/dist/mtmai_api/sdk.gen.d.ts +23 -0
  80. package/dist/mtmai_api/sdk.gen.d.ts.map +1 -1
  81. package/dist/mtmai_api/sdk.gen.js +23 -0
  82. package/dist/mtmai_api/sdk.gen.js.map +1 -1
  83. package/dist/mtmai_api/types.gen.d.ts +552 -0
  84. package/dist/mtmai_api/types.gen.d.ts.map +1 -1
  85. package/dist/mtmai_api/types.gen.js +19 -0
  86. package/dist/mtmai_api/types.gen.js.map +1 -1
  87. package/dist/mtmai_api/zod.gen.d.ts +18866 -18674
  88. package/dist/mtmai_api/zod.gen.d.ts.map +1 -1
  89. package/dist/mtmai_api/zod.gen.js +1826 -1634
  90. package/dist/mtmai_api/zod.gen.js.map +1 -1
  91. package/package.json +28 -5
  92. package/dist/components/MustAdmin.d.ts +0 -14
  93. package/dist/components/MustAdmin.d.ts.map +0 -1
  94. package/dist/components/MustAdmin.js +0 -37
  95. package/dist/components/MustAdmin.js.map +0 -1
  96. package/dist/lib/adk-utils.d.ts +0 -19
  97. package/dist/lib/adk-utils.d.ts.map +0 -1
  98. package/dist/lib/adk-utils.js +0 -50
  99. package/dist/lib/adk-utils.js.map +0 -1
  100. package/dist/lib/auth-client.d.ts +0 -5965
  101. package/dist/lib/auth-client.d.ts.map +0 -1
  102. package/dist/lib/auth-client.js +0 -29
  103. package/dist/lib/auth-client.js.map +0 -1
  104. package/dist/lib/get-query-client.d.ts +0 -3
  105. package/dist/lib/get-query-client.d.ts.map +0 -1
  106. package/dist/lib/get-query-client.js +0 -23
  107. package/dist/lib/get-query-client.js.map +0 -1
  108. package/dist/lib/mtgate_client_ss.d.ts +0 -10
  109. package/dist/lib/mtgate_client_ss.d.ts.map +0 -1
  110. package/dist/lib/mtgate_client_ss.js +0 -24
  111. package/dist/lib/mtgate_client_ss.js.map +0 -1
  112. package/dist/store/AuthProviders.d.ts +0 -8
  113. package/dist/store/AuthProviders.d.ts.map +0 -1
  114. package/dist/store/AuthProviders.js +0 -34
  115. package/dist/store/AuthProviders.js.map +0 -1
  116. package/dist/store/GomtmProvider.d.ts +0 -10
  117. package/dist/store/GomtmProvider.d.ts.map +0 -1
  118. package/dist/store/GomtmProvider.js +0 -24
  119. package/dist/store/GomtmProvider.js.map +0 -1
  120. package/dist/store/GomtmV1Provider.d.ts +0 -10
  121. package/dist/store/GomtmV1Provider.d.ts.map +0 -1
  122. package/dist/store/GomtmV1Provider.js +0 -24
  123. package/dist/store/GomtmV1Provider.js.map +0 -1
  124. package/dist/store/MtgateProvider.d.ts +0 -6015
  125. package/dist/store/MtgateProvider.d.ts.map +0 -1
  126. package/dist/store/MtgateProvider.js +0 -76
  127. package/dist/store/MtgateProvider.js.map +0 -1
  128. package/dist/store/MtmsdkProvider.d.ts +0 -16
  129. package/dist/store/MtmsdkProvider.d.ts.map +0 -1
  130. package/dist/store/MtmsdkProvider.js +0 -47
  131. package/dist/store/MtmsdkProvider.js.map +0 -1
  132. package/dist/store/ReactQueryMtmaiApiProvider.d.ts +0 -10
  133. package/dist/store/ReactQueryMtmaiApiProvider.d.ts.map +0 -1
  134. package/dist/store/ReactQueryMtmaiApiProvider.js +0 -23
  135. package/dist/store/ReactQueryMtmaiApiProvider.js.map +0 -1
@@ -48,6 +48,7 @@ export type AddSessionToEvalSetRequest = {
48
48
  };
49
49
  /**
50
50
  * AgentDetails
51
+ *
51
52
  * Details about the individual agent in the App.
52
53
  *
53
54
  * This could be a root agent or the sub-agents in the Agent Tree.
@@ -68,6 +69,7 @@ export type AgentDetailsInput = {
68
69
  };
69
70
  /**
70
71
  * AgentDetails
72
+ *
71
73
  * Details about the individual agent in the App.
72
74
  *
73
75
  * This could be a root agent or the sub-agents in the Agent Tree.
@@ -88,17 +90,20 @@ export type AgentDetailsOutput = {
88
90
  };
89
91
  /**
90
92
  * ApiKeyConfig
93
+ *
91
94
  * Config for authentication with API key.
92
95
  */
93
96
  export type ApiKeyConfig = {
94
97
  /**
95
98
  * Apikeystring
99
+ *
96
100
  * The API key to be used in the request directly.
97
101
  */
98
102
  apiKeyString?: string | null;
99
103
  };
100
104
  /**
101
105
  * AppDetails
106
+ *
102
107
  * Contains details about the App (the agentic system).
103
108
  *
104
109
  * This structure is only a projection of the acutal app. Only details
@@ -114,6 +119,7 @@ export type AppDetailsInput = {
114
119
  };
115
120
  /**
116
121
  * AppDetails
122
+ *
117
123
  * Contains details about the App (the agentic system).
118
124
  *
119
125
  * This structure is only a projection of the acutal app. Only details
@@ -129,60 +135,71 @@ export type AppDetailsOutput = {
129
135
  };
130
136
  /**
131
137
  * AuthConfigGoogleServiceAccountConfig
138
+ *
132
139
  * Config for Google Service Account Authentication.
133
140
  */
134
141
  export type AuthConfigGoogleServiceAccountConfig = {
135
142
  /**
136
143
  * Serviceaccount
144
+ *
137
145
  * Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
138
146
  */
139
147
  serviceAccount?: string | null;
140
148
  };
141
149
  /**
142
150
  * AuthConfigHttpBasicAuthConfig
151
+ *
143
152
  * Config for HTTP Basic Authentication.
144
153
  */
145
154
  export type AuthConfigHttpBasicAuthConfig = {
146
155
  /**
147
156
  * Credentialsecret
157
+ *
148
158
  * Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
149
159
  */
150
160
  credentialSecret?: string | null;
151
161
  };
152
162
  /**
153
163
  * AuthConfigOauthConfig
164
+ *
154
165
  * Config for user oauth.
155
166
  */
156
167
  export type AuthConfigOauthConfig = {
157
168
  /**
158
169
  * Accesstoken
170
+ *
159
171
  * Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
160
172
  */
161
173
  accessToken?: string | null;
162
174
  /**
163
175
  * Serviceaccount
176
+ *
164
177
  * The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
165
178
  */
166
179
  serviceAccount?: string | null;
167
180
  };
168
181
  /**
169
182
  * AuthConfigOidcConfig
183
+ *
170
184
  * Config for user OIDC auth.
171
185
  */
172
186
  export type AuthConfigOidcConfig = {
173
187
  /**
174
188
  * Idtoken
189
+ *
175
190
  * OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
176
191
  */
177
192
  idToken?: string | null;
178
193
  /**
179
194
  * Serviceaccount
195
+ *
180
196
  * The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
181
197
  */
182
198
  serviceAccount?: string | null;
183
199
  };
184
200
  /**
185
201
  * AuthCredential
202
+ *
186
203
  * Data class representing an authentication credential.
187
204
  *
188
205
  * To exchange for the actual credential, please use
@@ -255,6 +272,7 @@ export type AuthCredentialInput = {
255
272
  };
256
273
  /**
257
274
  * AuthCredential
275
+ *
258
276
  * Data class representing an authentication credential.
259
277
  *
260
278
  * To exchange for the actual credential, please use
@@ -327,6 +345,7 @@ export type AuthCredentialOutput = {
327
345
  };
328
346
  /**
329
347
  * AuthCredentialTypes
348
+ *
330
349
  * Represents the type of authentication credential.
331
350
  */
332
351
  export declare const AuthCredentialTypes: {
@@ -338,11 +357,13 @@ export declare const AuthCredentialTypes: {
338
357
  };
339
358
  /**
340
359
  * AuthCredentialTypes
360
+ *
341
361
  * Represents the type of authentication credential.
342
362
  */
343
363
  export type AuthCredentialTypes = (typeof AuthCredentialTypes)[keyof typeof AuthCredentialTypes];
344
364
  /**
345
365
  * AuthType
366
+ *
346
367
  * Type of auth scheme.
347
368
  */
348
369
  export declare const AuthType: {
@@ -356,16 +377,19 @@ export declare const AuthType: {
356
377
  };
357
378
  /**
358
379
  * AuthType
380
+ *
359
381
  * Type of auth scheme.
360
382
  */
361
383
  export type AuthType = (typeof AuthType)[keyof typeof AuthType];
362
384
  /**
363
385
  * AutomaticFunctionCallingConfig
386
+ *
364
387
  * The configuration for automatic function calling.
365
388
  */
366
389
  export type AutomaticFunctionCallingConfig = {
367
390
  /**
368
391
  * Disable
392
+ *
369
393
  * Whether to disable automatic function calling.
370
394
  * If not set or set to False, will enable automatic function calling.
371
395
  * If set to True, will disable automatic function calling.
@@ -374,6 +398,7 @@ export type AutomaticFunctionCallingConfig = {
374
398
  disable?: boolean | null;
375
399
  /**
376
400
  * Maximumremotecalls
401
+ *
377
402
  * If automatic function calling is enabled,
378
403
  * maximum number of remote calls for automatic function calling.
379
404
  * This number should be a positive integer.
@@ -383,6 +408,7 @@ export type AutomaticFunctionCallingConfig = {
383
408
  maximumRemoteCalls?: number | null;
384
409
  /**
385
410
  * Ignorecallhistory
411
+ *
386
412
  * If automatic function calling is enabled,
387
413
  * whether to ignore call history to the response.
388
414
  * If not set, SDK will set ignore_call_history to false,
@@ -394,11 +420,13 @@ export type AutomaticFunctionCallingConfig = {
394
420
  };
395
421
  /**
396
422
  * BaseCriterion
423
+ *
397
424
  * Base creterion to use for an Eval Metric.
398
425
  */
399
426
  export type BaseCriterion = {
400
427
  /**
401
428
  * Threshold
429
+ *
402
430
  * The threshold to be used by the metric.
403
431
  */
404
432
  threshold: number;
@@ -406,6 +434,7 @@ export type BaseCriterion = {
406
434
  };
407
435
  /**
408
436
  * Behavior
437
+ *
409
438
  * Defines the function behavior. Defaults to `BLOCKING`.
410
439
  */
411
440
  export declare const Behavior: {
@@ -415,26 +444,31 @@ export declare const Behavior: {
415
444
  };
416
445
  /**
417
446
  * Behavior
447
+ *
418
448
  * Defines the function behavior. Defaults to `BLOCKING`.
419
449
  */
420
450
  export type Behavior = (typeof Behavior)[keyof typeof Behavior];
421
451
  /**
422
452
  * Blob
453
+ *
423
454
  * Content blob.
424
455
  */
425
456
  export type Blob = {
426
457
  /**
427
458
  * Displayname
459
+ *
428
460
  * Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is not currently used in the Gemini GenerateContent calls.
429
461
  */
430
462
  displayName?: string | null;
431
463
  /**
432
464
  * Data
465
+ *
433
466
  * Required. Raw bytes.
434
467
  */
435
468
  data?: string | null;
436
469
  /**
437
470
  * Mimetype
471
+ *
438
472
  * Required. The IANA standard MIME type of the source data.
439
473
  */
440
474
  mimeType?: string | null;
@@ -450,6 +484,7 @@ export type BodyBuilderBuild = {
450
484
  };
451
485
  /**
452
486
  * CacheMetadata
487
+ *
453
488
  * Metadata for context cache associated with LLM responses.
454
489
  *
455
490
  * This class stores cache identification, usage tracking, and lifecycle
@@ -470,37 +505,44 @@ export type BodyBuilderBuild = {
470
505
  export type CacheMetadata = {
471
506
  /**
472
507
  * Cache Name
508
+ *
473
509
  * Full resource name of the cached content
474
510
  */
475
511
  cache_name: string;
476
512
  /**
477
513
  * Expire Time
514
+ *
478
515
  * Unix timestamp when cache expires
479
516
  */
480
517
  expire_time: number;
481
518
  /**
482
519
  * Fingerprint
520
+ *
483
521
  * Hash of agent configuration used to detect changes
484
522
  */
485
523
  fingerprint: string;
486
524
  /**
487
525
  * Invocations Used
526
+ *
488
527
  * Number of invocations this cache has been used for
489
528
  */
490
529
  invocations_used: number;
491
530
  /**
492
531
  * Cached Contents Count
532
+ *
493
533
  * Number of contents stored in this cache
494
534
  */
495
535
  cached_contents_count: number;
496
536
  /**
497
537
  * Created At
538
+ *
498
539
  * Unix timestamp when cache was created (None if reused existing)
499
540
  */
500
541
  created_at?: number | null;
501
542
  };
502
543
  /**
503
544
  * ChatConfig
545
+ *
504
546
  * 聊天配置
505
547
  */
506
548
  export type ChatConfig = {
@@ -531,6 +573,7 @@ export type ChatConfig = {
531
573
  };
532
574
  /**
533
575
  * ChatRequest
576
+ *
534
577
  * 聊天请求 - 兼容旧API格式
535
578
  */
536
579
  export type ChatRequest = {
@@ -542,6 +585,7 @@ export type ChatRequest = {
542
585
  };
543
586
  /**
544
587
  * ChatResponse
588
+ *
545
589
  * 聊天响应 - 兼容旧API格式
546
590
  */
547
591
  export type ChatResponse = {
@@ -564,6 +608,7 @@ export type ChatResponse = {
564
608
  export type CheckSandboxStatusRequest = {
565
609
  /**
566
610
  * Sandboxids
611
+ *
567
612
  * 需要检测是 sandbox id 列表
568
613
  */
569
614
  sandboxIds: Array<string>;
@@ -574,17 +619,20 @@ export type CheckSandboxStatusRequest = {
574
619
  export type CheckSandboxStatusResponse = {
575
620
  /**
576
621
  * Results
622
+ *
577
623
  * 每个沙盒的状态检测结果
578
624
  */
579
625
  results?: Array<SandboxStatusInfo>;
580
626
  /**
581
627
  * Total Checked
628
+ *
582
629
  * 检查的沙盒总数
583
630
  */
584
631
  total_checked: number;
585
632
  };
586
633
  /**
587
634
  * CodeExecutionResult
635
+ *
588
636
  * Result of executing the [ExecutableCode].
589
637
  *
590
638
  * Always follows a `part` containing the [ExecutableCode].
@@ -596,23 +644,27 @@ export type CodeExecutionResult = {
596
644
  outcome?: Outcome | null;
597
645
  /**
598
646
  * Output
647
+ *
599
648
  * Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
600
649
  */
601
650
  output?: string | null;
602
651
  };
603
652
  /**
604
653
  * Content
654
+ *
605
655
  * Contains the multi-part content of a message.
606
656
  */
607
657
  export type ContentInput = {
608
658
  /**
609
659
  * Parts
660
+ *
610
661
  * List of parts that constitute a single message. Each part may have
611
662
  * a different IANA MIME type.
612
663
  */
613
664
  parts?: Array<PartInput> | null;
614
665
  /**
615
666
  * Role
667
+ *
616
668
  * Optional. The producer of the content. Must be either 'user' or
617
669
  * 'model'. Useful to set for multi-turn conversations, otherwise can be
618
670
  * empty. If role is not specified, SDK will determine the role.
@@ -621,17 +673,20 @@ export type ContentInput = {
621
673
  };
622
674
  /**
623
675
  * Content
676
+ *
624
677
  * Contains the multi-part content of a message.
625
678
  */
626
679
  export type ContentOutput = {
627
680
  /**
628
681
  * Parts
682
+ *
629
683
  * List of parts that constitute a single message. Each part may have
630
684
  * a different IANA MIME type.
631
685
  */
632
686
  parts?: Array<PartOutput> | null;
633
687
  /**
634
688
  * Role
689
+ *
635
690
  * Optional. The producer of the content. Must be either 'user' or
636
691
  * 'model'. Useful to set for multi-turn conversations, otherwise can be
637
692
  * empty. If role is not specified, SDK will determine the role.
@@ -650,11 +705,13 @@ export type CreateEvalSetRequest = {
650
705
  export type CreateSessionRequest = {
651
706
  /**
652
707
  * Sessionid
708
+ *
653
709
  * The ID of the session to create. If not provided, a random session ID will be generated.
654
710
  */
655
711
  sessionId?: string | null;
656
712
  /**
657
713
  * State
714
+ *
658
715
  * The initial state of the session.
659
716
  */
660
717
  state?: {
@@ -662,12 +719,14 @@ export type CreateSessionRequest = {
662
719
  } | null;
663
720
  /**
664
721
  * Events
722
+ *
665
723
  * A list of events to initialize the session with.
666
724
  */
667
725
  events?: Array<EventInput> | null;
668
726
  };
669
727
  /**
670
728
  * DynamicRetrievalConfig
729
+ *
671
730
  * Describes the options to customize dynamic retrieval.
672
731
  */
673
732
  export type DynamicRetrievalConfig = {
@@ -677,12 +736,14 @@ export type DynamicRetrievalConfig = {
677
736
  mode?: DynamicRetrievalConfigMode | null;
678
737
  /**
679
738
  * Dynamicthreshold
739
+ *
680
740
  * Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
681
741
  */
682
742
  dynamicThreshold?: number | null;
683
743
  };
684
744
  /**
685
745
  * DynamicRetrievalConfigMode
746
+ *
686
747
  * Config for the dynamic retrieval config mode.
687
748
  */
688
749
  export declare const DynamicRetrievalConfigMode: {
@@ -691,11 +752,13 @@ export declare const DynamicRetrievalConfigMode: {
691
752
  };
692
753
  /**
693
754
  * DynamicRetrievalConfigMode
755
+ *
694
756
  * Config for the dynamic retrieval config mode.
695
757
  */
696
758
  export type DynamicRetrievalConfigMode = (typeof DynamicRetrievalConfigMode)[keyof typeof DynamicRetrievalConfigMode];
697
759
  /**
698
760
  * EnterpriseWebSearch
761
+ *
699
762
  * Tool to search public web data, powered by Vertex AI Search and Sec4 compliance.
700
763
  */
701
764
  export type EnterpriseWebSearch = {
@@ -703,6 +766,7 @@ export type EnterpriseWebSearch = {
703
766
  };
704
767
  /**
705
768
  * EvalCase
769
+ *
706
770
  * An eval case.
707
771
  */
708
772
  export type EvalCaseInput = {
@@ -726,6 +790,7 @@ export type EvalCaseInput = {
726
790
  };
727
791
  /**
728
792
  * EvalCase
793
+ *
729
794
  * An eval case.
730
795
  */
731
796
  export type EvalCaseOutput = {
@@ -749,12 +814,15 @@ export type EvalCaseOutput = {
749
814
  };
750
815
  /**
751
816
  * EvalCaseResult
817
+ *
752
818
  * Case level evaluation results.
753
819
  */
754
820
  export type EvalCaseResult = {
755
821
  /**
756
822
  * Evalsetfile
823
+ *
757
824
  * This field is deprecated, use eval_set_id instead.
825
+ *
758
826
  * @deprecated
759
827
  */
760
828
  evalSetFile?: string | null;
@@ -769,7 +837,9 @@ export type EvalCaseResult = {
769
837
  finalEvalStatus: EvalStatus;
770
838
  /**
771
839
  * Evalmetricresults
840
+ *
772
841
  * This field is deprecated, use overall_eval_metric_results instead.
842
+ *
773
843
  * @deprecated
774
844
  */
775
845
  evalMetricResults?: Array<[EvalMetricOutput, EvalMetricResult]> | null;
@@ -793,21 +863,25 @@ export type EvalCaseResult = {
793
863
  };
794
864
  /**
795
865
  * EvalMetric
866
+ *
796
867
  * A metric used to evaluate a particular aspect of an eval case.
797
868
  */
798
869
  export type EvalMetricInput = {
799
870
  /**
800
871
  * Metricname
872
+ *
801
873
  * The name of the metric.
802
874
  */
803
875
  metricName: string;
804
876
  /**
805
877
  * Threshold
878
+ *
806
879
  * A threshold value. Each metric decides how to interpret this threshold.
807
880
  */
808
881
  threshold: number;
809
882
  /**
810
883
  * [DEPRECATED] This field is deprecated in favor of `criterion`. Depending on the metric you may want to one of the sub-classes of BaseCriterion.
884
+ *
811
885
  * @deprecated
812
886
  */
813
887
  judgeModelOptions?: JudgeModelOptionsInput | null;
@@ -818,21 +892,25 @@ export type EvalMetricInput = {
818
892
  };
819
893
  /**
820
894
  * EvalMetric
895
+ *
821
896
  * A metric used to evaluate a particular aspect of an eval case.
822
897
  */
823
898
  export type EvalMetricOutput = {
824
899
  /**
825
900
  * Metricname
901
+ *
826
902
  * The name of the metric.
827
903
  */
828
904
  metricName: string;
829
905
  /**
830
906
  * Threshold
907
+ *
831
908
  * A threshold value. Each metric decides how to interpret this threshold.
832
909
  */
833
910
  threshold: number;
834
911
  /**
835
912
  * [DEPRECATED] This field is deprecated in favor of `criterion`. Depending on the metric you may want to one of the sub-classes of BaseCriterion.
913
+ *
836
914
  * @deprecated
837
915
  */
838
916
  judgeModelOptions?: JudgeModelOptionsOutput | null;
@@ -843,21 +921,25 @@ export type EvalMetricOutput = {
843
921
  };
844
922
  /**
845
923
  * EvalMetricResult
924
+ *
846
925
  * The actual computed score/value of a particular EvalMetric.
847
926
  */
848
927
  export type EvalMetricResult = {
849
928
  /**
850
929
  * Metricname
930
+ *
851
931
  * The name of the metric.
852
932
  */
853
933
  metricName: string;
854
934
  /**
855
935
  * Threshold
936
+ *
856
937
  * A threshold value. Each metric decides how to interpret this threshold.
857
938
  */
858
939
  threshold: number;
859
940
  /**
860
941
  * [DEPRECATED] This field is deprecated in favor of `criterion`. Depending on the metric you may want to one of the sub-classes of BaseCriterion.
942
+ *
861
943
  * @deprecated
862
944
  */
863
945
  judgeModelOptions?: JudgeModelOptionsOutput | null;
@@ -867,6 +949,7 @@ export type EvalMetricResult = {
867
949
  criterion?: BaseCriterion | null;
868
950
  /**
869
951
  * Score
952
+ *
870
953
  * Score obtained after evaluating the metric. Optional, as evaluation might not have happened.
871
954
  */
872
955
  score?: number | null;
@@ -882,12 +965,14 @@ export type EvalMetricResult = {
882
965
  export type EvalMetricResultDetails = {
883
966
  /**
884
967
  * Rubricscores
968
+ *
885
969
  * The scores obtained after applying the rubrics to the Agent's response.
886
970
  */
887
971
  rubricScores?: Array<RubricScore> | null;
888
972
  };
889
973
  /**
890
974
  * EvalMetricResultPerInvocation
975
+ *
891
976
  * Eval metric results per invocation.
892
977
  */
893
978
  export type EvalMetricResultPerInvocation = {
@@ -901,12 +986,14 @@ export type EvalMetricResultPerInvocation = {
901
986
  expectedInvocation: InvocationOutput;
902
987
  /**
903
988
  * Evalmetricresults
989
+ *
904
990
  * Eval resutls for each applicable metric.
905
991
  */
906
992
  evalMetricResults?: Array<EvalMetricResult>;
907
993
  };
908
994
  /**
909
995
  * EvalResult
996
+ *
910
997
  * This class has no field intentionally.
911
998
  *
912
999
  * The goal here is to just give a new name to the class to align with the API
@@ -936,6 +1023,7 @@ export type EvalResult = {
936
1023
  };
937
1024
  /**
938
1025
  * EvalSet
1026
+ *
939
1027
  * A set of eval cases.
940
1028
  */
941
1029
  export type EvalSetInput = {
@@ -962,6 +1050,7 @@ export type EvalSetInput = {
962
1050
  };
963
1051
  /**
964
1052
  * EvalSet
1053
+ *
965
1054
  * A set of eval cases.
966
1055
  */
967
1056
  export type EvalSetOutput = {
@@ -988,6 +1077,7 @@ export type EvalSetOutput = {
988
1077
  };
989
1078
  /**
990
1079
  * EvalSetResult
1080
+ *
991
1081
  * Eval set level evaluation results.
992
1082
  */
993
1083
  export type EvalSetResult = {
@@ -1026,6 +1116,7 @@ export declare const EvalStatus: {
1026
1116
  export type EvalStatus = (typeof EvalStatus)[keyof typeof EvalStatus];
1027
1117
  /**
1028
1118
  * Event
1119
+ *
1029
1120
  * Represents an event in a conversation between agents and users.
1030
1121
  *
1031
1122
  * It is used to store the content of the conversation, as well as the actions
@@ -1099,6 +1190,7 @@ export type EventInput = {
1099
1190
  };
1100
1191
  /**
1101
1192
  * Event
1193
+ *
1102
1194
  * Represents an event in a conversation between agents and users.
1103
1195
  *
1104
1196
  * It is used to store the content of the conversation, as well as the actions
@@ -1172,6 +1264,7 @@ export type EventOutput = {
1172
1264
  };
1173
1265
  /**
1174
1266
  * EventActions
1267
+ *
1175
1268
  * Represents the actions attached to an event.
1176
1269
  */
1177
1270
  export type EventActionsInput = {
@@ -1215,6 +1308,7 @@ export type EventActionsInput = {
1215
1308
  };
1216
1309
  /**
1217
1310
  * EventActions
1311
+ *
1218
1312
  * Represents the actions attached to an event.
1219
1313
  */
1220
1314
  export type EventActionsOutput = {
@@ -1258,6 +1352,7 @@ export type EventActionsOutput = {
1258
1352
  };
1259
1353
  /**
1260
1354
  * EventCompaction
1355
+ *
1261
1356
  * The compaction of the events.
1262
1357
  */
1263
1358
  export type EventCompactionInput = {
@@ -1273,6 +1368,7 @@ export type EventCompactionInput = {
1273
1368
  };
1274
1369
  /**
1275
1370
  * EventCompaction
1371
+ *
1276
1372
  * The compaction of the events.
1277
1373
  */
1278
1374
  export type EventCompactionOutput = {
@@ -1288,6 +1384,7 @@ export type EventCompactionOutput = {
1288
1384
  };
1289
1385
  /**
1290
1386
  * ExecutableCode
1387
+ *
1291
1388
  * Code generated by the model that is meant to be executed, and the result returned to the model.
1292
1389
  *
1293
1390
  * Generated when using the [FunctionDeclaration] tool and
@@ -1296,6 +1393,7 @@ export type EventCompactionOutput = {
1296
1393
  export type ExecutableCode = {
1297
1394
  /**
1298
1395
  * Code
1396
+ *
1299
1397
  * Required. The code to be executed.
1300
1398
  */
1301
1399
  code?: string | null;
@@ -1306,6 +1404,7 @@ export type ExecutableCode = {
1306
1404
  };
1307
1405
  /**
1308
1406
  * FeatureSelectionPreference
1407
+ *
1309
1408
  * Options for feature selection preference.
1310
1409
  */
1311
1410
  export declare const FeatureSelectionPreference: {
@@ -1316,61 +1415,73 @@ export declare const FeatureSelectionPreference: {
1316
1415
  };
1317
1416
  /**
1318
1417
  * FeatureSelectionPreference
1418
+ *
1319
1419
  * Options for feature selection preference.
1320
1420
  */
1321
1421
  export type FeatureSelectionPreference = (typeof FeatureSelectionPreference)[keyof typeof FeatureSelectionPreference];
1322
1422
  /**
1323
1423
  * File
1424
+ *
1324
1425
  * A file uploaded to the API.
1325
1426
  */
1326
1427
  export type File = {
1327
1428
  /**
1328
1429
  * Name
1430
+ *
1329
1431
  * The `File` resource name. The ID (name excluding the "files/" prefix) can contain up to 40 characters that are lowercase alphanumeric or dashes (-). The ID cannot start or end with a dash. If the name is empty on create, a unique name will be generated. Example: `files/123-456`
1330
1432
  */
1331
1433
  name?: string | null;
1332
1434
  /**
1333
1435
  * Displayname
1436
+ *
1334
1437
  * Optional. The human-readable display name for the `File`. The display name must be no more than 512 characters in length, including spaces. Example: 'Welcome Image'
1335
1438
  */
1336
1439
  displayName?: string | null;
1337
1440
  /**
1338
1441
  * Mimetype
1442
+ *
1339
1443
  * Output only. MIME type of the file.
1340
1444
  */
1341
1445
  mimeType?: string | null;
1342
1446
  /**
1343
1447
  * Sizebytes
1448
+ *
1344
1449
  * Output only. Size of the file in bytes.
1345
1450
  */
1346
1451
  sizeBytes?: number | null;
1347
1452
  /**
1348
1453
  * Createtime
1454
+ *
1349
1455
  * Output only. The timestamp of when the `File` was created.
1350
1456
  */
1351
1457
  createTime?: string | null;
1352
1458
  /**
1353
1459
  * Expirationtime
1460
+ *
1354
1461
  * Output only. The timestamp of when the `File` will be deleted. Only set if the `File` is scheduled to expire.
1355
1462
  */
1356
1463
  expirationTime?: string | null;
1357
1464
  /**
1358
1465
  * Updatetime
1466
+ *
1359
1467
  * Output only. The timestamp of when the `File` was last updated.
1360
1468
  */
1361
1469
  updateTime?: string | null;
1362
1470
  /**
1363
1471
  * Sha256Hash
1472
+ *
1364
1473
  * Output only. SHA-256 hash of the uploaded bytes. The hash value is encoded in base64 format.
1365
1474
  */
1366
1475
  sha256Hash?: string | null;
1367
1476
  /**
1368
1477
  * Uri
1478
+ *
1369
1479
  * Output only. The URI of the `File`.
1370
1480
  */
1371
1481
  uri?: string | null;
1372
1482
  /**
1373
1483
  * Downloaduri
1484
+ *
1374
1485
  * Output only. The URI of the `File`, only set for downloadable (generated) files.
1375
1486
  */
1376
1487
  downloadUri?: string | null;
@@ -1384,6 +1495,7 @@ export type File = {
1384
1495
  source?: FileSource | null;
1385
1496
  /**
1386
1497
  * Videometadata
1498
+ *
1387
1499
  * Output only. Metadata for a video.
1388
1500
  */
1389
1501
  videoMetadata?: {
@@ -1396,27 +1508,32 @@ export type File = {
1396
1508
  };
1397
1509
  /**
1398
1510
  * FileData
1511
+ *
1399
1512
  * URI based data.
1400
1513
  */
1401
1514
  export type FileData = {
1402
1515
  /**
1403
1516
  * Displayname
1517
+ *
1404
1518
  * Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. It is not currently used in the Gemini GenerateContent calls.
1405
1519
  */
1406
1520
  displayName?: string | null;
1407
1521
  /**
1408
1522
  * Fileuri
1523
+ *
1409
1524
  * Required. URI.
1410
1525
  */
1411
1526
  fileUri?: string | null;
1412
1527
  /**
1413
1528
  * Mimetype
1529
+ *
1414
1530
  * Required. The IANA standard MIME type of the source data.
1415
1531
  */
1416
1532
  mimeType?: string | null;
1417
1533
  };
1418
1534
  /**
1419
1535
  * FileSource
1536
+ *
1420
1537
  * Source of the File.
1421
1538
  */
1422
1539
  export declare const FileSource: {
@@ -1426,11 +1543,13 @@ export declare const FileSource: {
1426
1543
  };
1427
1544
  /**
1428
1545
  * FileSource
1546
+ *
1429
1547
  * Source of the File.
1430
1548
  */
1431
1549
  export type FileSource = (typeof FileSource)[keyof typeof FileSource];
1432
1550
  /**
1433
1551
  * FileState
1552
+ *
1434
1553
  * State for the lifecycle of a File.
1435
1554
  */
1436
1555
  export declare const FileState: {
@@ -1441,16 +1560,19 @@ export declare const FileState: {
1441
1560
  };
1442
1561
  /**
1443
1562
  * FileState
1563
+ *
1444
1564
  * State for the lifecycle of a File.
1445
1565
  */
1446
1566
  export type FileState = (typeof FileState)[keyof typeof FileState];
1447
1567
  /**
1448
1568
  * FileStatus
1569
+ *
1449
1570
  * Status of a File that uses a common error model.
1450
1571
  */
1451
1572
  export type FileStatus = {
1452
1573
  /**
1453
1574
  * Details
1575
+ *
1454
1576
  * A list of messages that carry the error details. There is a common set of message types for APIs to use.
1455
1577
  */
1456
1578
  details?: Array<{
@@ -1458,17 +1580,20 @@ export type FileStatus = {
1458
1580
  }> | null;
1459
1581
  /**
1460
1582
  * Message
1583
+ *
1461
1584
  * A list of messages that carry the error details. There is a common set of message types for APIs to use.
1462
1585
  */
1463
1586
  message?: string | null;
1464
1587
  /**
1465
1588
  * Code
1589
+ *
1466
1590
  * The status code. 0 for OK, 1 for CANCELLED
1467
1591
  */
1468
1592
  code?: number | null;
1469
1593
  };
1470
1594
  /**
1471
1595
  * FinishReason
1596
+ *
1472
1597
  * Output only. The reason why the model stopped generating tokens.
1473
1598
  *
1474
1599
  * If empty, the model has not stopped generating the tokens.
@@ -1490,6 +1615,7 @@ export declare const FinishReason: {
1490
1615
  };
1491
1616
  /**
1492
1617
  * FinishReason
1618
+ *
1493
1619
  * Output only. The reason why the model stopped generating tokens.
1494
1620
  *
1495
1621
  * If empty, the model has not stopped generating the tokens.
@@ -1497,17 +1623,20 @@ export declare const FinishReason: {
1497
1623
  export type FinishReason = (typeof FinishReason)[keyof typeof FinishReason];
1498
1624
  /**
1499
1625
  * FunctionCall
1626
+ *
1500
1627
  * A function call.
1501
1628
  */
1502
1629
  export type FunctionCall = {
1503
1630
  /**
1504
1631
  * Id
1632
+ *
1505
1633
  * The unique id of the function call. If populated, the client to execute the
1506
1634
  * `function_call` and return the response with the matching `id`.
1507
1635
  */
1508
1636
  id?: string | null;
1509
1637
  /**
1510
1638
  * Args
1639
+ *
1511
1640
  * Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
1512
1641
  */
1513
1642
  args?: {
@@ -1515,12 +1644,14 @@ export type FunctionCall = {
1515
1644
  } | null;
1516
1645
  /**
1517
1646
  * Name
1647
+ *
1518
1648
  * Required. The name of the function to call. Matches [FunctionDeclaration.name].
1519
1649
  */
1520
1650
  name?: string | null;
1521
1651
  };
1522
1652
  /**
1523
1653
  * FunctionCallingConfig
1654
+ *
1524
1655
  * Function calling config.
1525
1656
  */
1526
1657
  export type FunctionCallingConfig = {
@@ -1530,12 +1661,14 @@ export type FunctionCallingConfig = {
1530
1661
  mode?: FunctionCallingConfigMode | null;
1531
1662
  /**
1532
1663
  * Allowedfunctionnames
1664
+ *
1533
1665
  * 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.
1534
1666
  */
1535
1667
  allowedFunctionNames?: Array<string> | null;
1536
1668
  };
1537
1669
  /**
1538
1670
  * FunctionCallingConfigMode
1671
+ *
1539
1672
  * Config for the function calling config mode.
1540
1673
  */
1541
1674
  export declare const FunctionCallingConfigMode: {
@@ -1546,11 +1679,13 @@ export declare const FunctionCallingConfigMode: {
1546
1679
  };
1547
1680
  /**
1548
1681
  * FunctionCallingConfigMode
1682
+ *
1549
1683
  * Config for the function calling config mode.
1550
1684
  */
1551
1685
  export type FunctionCallingConfigMode = (typeof FunctionCallingConfigMode)[keyof typeof FunctionCallingConfigMode];
1552
1686
  /**
1553
1687
  * FunctionDeclaration
1688
+ *
1554
1689
  * Defines a function that the model can generate JSON inputs for.
1555
1690
  *
1556
1691
  * The inputs are based on `OpenAPI 3.0 specifications
@@ -1563,11 +1698,13 @@ export type FunctionDeclarationInput = {
1563
1698
  behavior?: Behavior | null;
1564
1699
  /**
1565
1700
  * Description
1701
+ *
1566
1702
  * Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
1567
1703
  */
1568
1704
  description?: string | null;
1569
1705
  /**
1570
1706
  * Name
1707
+ *
1571
1708
  * Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.
1572
1709
  */
1573
1710
  name?: string | null;
@@ -1577,6 +1714,7 @@ export type FunctionDeclarationInput = {
1577
1714
  parameters?: SchemaInput | null;
1578
1715
  /**
1579
1716
  * Parametersjsonschema
1717
+ *
1580
1718
  * Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`.
1581
1719
  */
1582
1720
  parametersJsonSchema?: unknown | null;
@@ -1586,12 +1724,14 @@ export type FunctionDeclarationInput = {
1586
1724
  response?: SchemaInput | null;
1587
1725
  /**
1588
1726
  * Responsejsonschema
1727
+ *
1589
1728
  * Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
1590
1729
  */
1591
1730
  responseJsonSchema?: unknown | null;
1592
1731
  };
1593
1732
  /**
1594
1733
  * FunctionDeclaration
1734
+ *
1595
1735
  * Defines a function that the model can generate JSON inputs for.
1596
1736
  *
1597
1737
  * The inputs are based on `OpenAPI 3.0 specifications
@@ -1604,11 +1744,13 @@ export type FunctionDeclarationOutput = {
1604
1744
  behavior?: Behavior | null;
1605
1745
  /**
1606
1746
  * Description
1747
+ *
1607
1748
  * Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
1608
1749
  */
1609
1750
  description?: string | null;
1610
1751
  /**
1611
1752
  * Name
1753
+ *
1612
1754
  * Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.
1613
1755
  */
1614
1756
  name?: string | null;
@@ -1618,6 +1760,7 @@ export type FunctionDeclarationOutput = {
1618
1760
  parameters?: SchemaOutput | null;
1619
1761
  /**
1620
1762
  * Parametersjsonschema
1763
+ *
1621
1764
  * Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`.
1622
1765
  */
1623
1766
  parametersJsonSchema?: unknown | null;
@@ -1627,17 +1770,20 @@ export type FunctionDeclarationOutput = {
1627
1770
  response?: SchemaOutput | null;
1628
1771
  /**
1629
1772
  * Responsejsonschema
1773
+ *
1630
1774
  * Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
1631
1775
  */
1632
1776
  responseJsonSchema?: unknown | null;
1633
1777
  };
1634
1778
  /**
1635
1779
  * FunctionResponse
1780
+ *
1636
1781
  * A function response.
1637
1782
  */
1638
1783
  export type FunctionResponse = {
1639
1784
  /**
1640
1785
  * Willcontinue
1786
+ *
1641
1787
  * Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls (see FunctionDeclaration.behavior for details), ignored otherwise. If false, the default, future responses will not be considered. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty `response` with `will_continue=False` to signal that the function call is finished.
1642
1788
  */
1643
1789
  willContinue?: boolean | null;
@@ -1647,16 +1793,19 @@ export type FunctionResponse = {
1647
1793
  scheduling?: FunctionResponseScheduling | null;
1648
1794
  /**
1649
1795
  * Id
1796
+ *
1650
1797
  * Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
1651
1798
  */
1652
1799
  id?: string | null;
1653
1800
  /**
1654
1801
  * Name
1802
+ *
1655
1803
  * Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
1656
1804
  */
1657
1805
  name?: string | null;
1658
1806
  /**
1659
1807
  * Response
1808
+ *
1660
1809
  * Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
1661
1810
  */
1662
1811
  response?: {
@@ -1665,6 +1814,7 @@ export type FunctionResponse = {
1665
1814
  };
1666
1815
  /**
1667
1816
  * FunctionResponseScheduling
1817
+ *
1668
1818
  * Specifies how the response should be scheduled in the conversation.
1669
1819
  */
1670
1820
  export declare const FunctionResponseScheduling: {
@@ -1675,11 +1825,13 @@ export declare const FunctionResponseScheduling: {
1675
1825
  };
1676
1826
  /**
1677
1827
  * FunctionResponseScheduling
1828
+ *
1678
1829
  * Specifies how the response should be scheduled in the conversation.
1679
1830
  */
1680
1831
  export type FunctionResponseScheduling = (typeof FunctionResponseScheduling)[keyof typeof FunctionResponseScheduling];
1681
1832
  /**
1682
1833
  * GenerateContentConfig
1834
+ *
1683
1835
  * Optional model configuration parameters.
1684
1836
  *
1685
1837
  * For more information, see `Content generation parameters
@@ -1692,6 +1844,7 @@ export type GenerateContentConfigInput = {
1692
1844
  httpOptions?: HttpOptions | null;
1693
1845
  /**
1694
1846
  * Systeminstruction
1847
+ *
1695
1848
  * Instructions for the model to steer it toward better performance.
1696
1849
  * For example, "Answer as concisely as possible" or "Don't use technical
1697
1850
  * terms in your response".
@@ -1700,6 +1853,7 @@ export type GenerateContentConfigInput = {
1700
1853
  systemInstruction?: ContentInput | Array<File | PartInput | string> | File | PartInput | string | null;
1701
1854
  /**
1702
1855
  * Temperature
1856
+ *
1703
1857
  * Value that controls the degree of randomness in token selection.
1704
1858
  * Lower temperatures are good for prompts that require a less open-ended or
1705
1859
  * creative response, while higher temperatures can lead to more diverse or
@@ -1709,6 +1863,7 @@ export type GenerateContentConfigInput = {
1709
1863
  temperature?: number | null;
1710
1864
  /**
1711
1865
  * Topp
1866
+ *
1712
1867
  * Tokens are selected from the most to least probable until the sum
1713
1868
  * of their probabilities equals this value. Use a lower value for less
1714
1869
  * random responses and a higher value for more random responses.
@@ -1717,6 +1872,7 @@ export type GenerateContentConfigInput = {
1717
1872
  topP?: number | null;
1718
1873
  /**
1719
1874
  * Topk
1875
+ *
1720
1876
  * For each token selection step, the ``top_k`` tokens with the
1721
1877
  * highest probabilities are sampled. Then tokens are further filtered based
1722
1878
  * on ``top_p`` with the final token selected using temperature sampling. Use
@@ -1727,18 +1883,21 @@ export type GenerateContentConfigInput = {
1727
1883
  topK?: number | null;
1728
1884
  /**
1729
1885
  * Candidatecount
1886
+ *
1730
1887
  * Number of response variations to return.
1731
1888
  *
1732
1889
  */
1733
1890
  candidateCount?: number | null;
1734
1891
  /**
1735
1892
  * Maxoutputtokens
1893
+ *
1736
1894
  * Maximum number of tokens that can be generated in the response.
1737
1895
  *
1738
1896
  */
1739
1897
  maxOutputTokens?: number | null;
1740
1898
  /**
1741
1899
  * Stopsequences
1900
+ *
1742
1901
  * List of strings that tells the model to stop generating text if one
1743
1902
  * of the strings is encountered in the response.
1744
1903
  *
@@ -1746,6 +1905,7 @@ export type GenerateContentConfigInput = {
1746
1905
  stopSequences?: Array<string> | null;
1747
1906
  /**
1748
1907
  * Responselogprobs
1908
+ *
1749
1909
  * Whether to return the log probabilities of the tokens that were
1750
1910
  * chosen by the model at each step.
1751
1911
  *
@@ -1753,6 +1913,7 @@ export type GenerateContentConfigInput = {
1753
1913
  responseLogprobs?: boolean | null;
1754
1914
  /**
1755
1915
  * Logprobs
1916
+ *
1756
1917
  * Number of top candidate tokens to return the log probabilities for
1757
1918
  * at each generation step.
1758
1919
  *
@@ -1760,6 +1921,7 @@ export type GenerateContentConfigInput = {
1760
1921
  logprobs?: number | null;
1761
1922
  /**
1762
1923
  * Presencepenalty
1924
+ *
1763
1925
  * Positive values penalize tokens that already appear in the
1764
1926
  * generated text, increasing the probability of generating more diverse
1765
1927
  * content.
@@ -1768,6 +1930,7 @@ export type GenerateContentConfigInput = {
1768
1930
  presencePenalty?: number | null;
1769
1931
  /**
1770
1932
  * Frequencypenalty
1933
+ *
1771
1934
  * Positive values penalize tokens that repeatedly appear in the
1772
1935
  * generated text, increasing the probability of generating more diverse
1773
1936
  * content.
@@ -1776,6 +1939,7 @@ export type GenerateContentConfigInput = {
1776
1939
  frequencyPenalty?: number | null;
1777
1940
  /**
1778
1941
  * Seed
1942
+ *
1779
1943
  * When ``seed`` is fixed to a specific number, the model makes a best
1780
1944
  * effort to provide the same response for repeated requests. By default, a
1781
1945
  * random number is used.
@@ -1784,6 +1948,7 @@ export type GenerateContentConfigInput = {
1784
1948
  seed?: number | null;
1785
1949
  /**
1786
1950
  * Responsemimetype
1951
+ *
1787
1952
  * Output response mimetype of the generated candidate text.
1788
1953
  * Supported mimetype:
1789
1954
  * - `text/plain`: (default) Text output.
@@ -1796,6 +1961,7 @@ export type GenerateContentConfigInput = {
1796
1961
  responseMimeType?: string | null;
1797
1962
  /**
1798
1963
  * Responseschema
1964
+ *
1799
1965
  * The `Schema` object allows the definition of input and output data types.
1800
1966
  * These types can be objects, but also primitives and arrays.
1801
1967
  * Represents a select subset of an [OpenAPI 3.0 schema
@@ -1809,6 +1975,7 @@ export type GenerateContentConfigInput = {
1809
1975
  } | SchemaInput | null;
1810
1976
  /**
1811
1977
  * Responsejsonschema
1978
+ *
1812
1979
  * Optional. Output schema of the generated response.
1813
1980
  * This is an alternative to `response_schema` that accepts [JSON
1814
1981
  * Schema](https://json-schema.org/). If set, `response_schema` must be
@@ -1838,6 +2005,7 @@ export type GenerateContentConfigInput = {
1838
2005
  modelSelectionConfig?: ModelSelectionConfig | null;
1839
2006
  /**
1840
2007
  * Safetysettings
2008
+ *
1841
2009
  * Safety settings in the request to block unsafe content in the
1842
2010
  * response.
1843
2011
  *
@@ -1845,6 +2013,7 @@ export type GenerateContentConfigInput = {
1845
2013
  safetySettings?: Array<SafetySetting> | null;
1846
2014
  /**
1847
2015
  * Tools
2016
+ *
1848
2017
  * Code that enables the system to interact with external systems to
1849
2018
  * perform an action outside of the knowledge and scope of the model.
1850
2019
  *
@@ -1857,6 +2026,7 @@ export type GenerateContentConfigInput = {
1857
2026
  toolConfig?: ToolConfigInput | null;
1858
2027
  /**
1859
2028
  * Labels
2029
+ *
1860
2030
  * Labels with user-defined metadata to break down billed charges.
1861
2031
  */
1862
2032
  labels?: {
@@ -1864,6 +2034,7 @@ export type GenerateContentConfigInput = {
1864
2034
  } | null;
1865
2035
  /**
1866
2036
  * Cachedcontent
2037
+ *
1867
2038
  * Resource name of a context cache that can be used in subsequent
1868
2039
  * requests.
1869
2040
  *
@@ -1871,6 +2042,7 @@ export type GenerateContentConfigInput = {
1871
2042
  cachedContent?: string | null;
1872
2043
  /**
1873
2044
  * Responsemodalities
2045
+ *
1874
2046
  * The requested modalities of the response. Represents the set of
1875
2047
  * modalities that the model can return.
1876
2048
  *
@@ -1883,12 +2055,14 @@ export type GenerateContentConfigInput = {
1883
2055
  mediaResolution?: MediaResolution | null;
1884
2056
  /**
1885
2057
  * Speechconfig
2058
+ *
1886
2059
  * The speech generation configuration.
1887
2060
  *
1888
2061
  */
1889
2062
  speechConfig?: SpeechConfigInput | string | null;
1890
2063
  /**
1891
2064
  * Audiotimestamp
2065
+ *
1892
2066
  * If enabled, audio timestamp will be included in the request to the
1893
2067
  * model.
1894
2068
  *
@@ -1907,6 +2081,7 @@ export type GenerateContentConfigInput = {
1907
2081
  };
1908
2082
  /**
1909
2083
  * GenerateContentConfig
2084
+ *
1910
2085
  * Optional model configuration parameters.
1911
2086
  *
1912
2087
  * For more information, see `Content generation parameters
@@ -1919,6 +2094,7 @@ export type GenerateContentConfigOutput = {
1919
2094
  httpOptions?: HttpOptions | null;
1920
2095
  /**
1921
2096
  * Systeminstruction
2097
+ *
1922
2098
  * Instructions for the model to steer it toward better performance.
1923
2099
  * For example, "Answer as concisely as possible" or "Don't use technical
1924
2100
  * terms in your response".
@@ -1927,6 +2103,7 @@ export type GenerateContentConfigOutput = {
1927
2103
  systemInstruction?: ContentOutput | Array<File | PartOutput | string> | File | PartOutput | string | null;
1928
2104
  /**
1929
2105
  * Temperature
2106
+ *
1930
2107
  * Value that controls the degree of randomness in token selection.
1931
2108
  * Lower temperatures are good for prompts that require a less open-ended or
1932
2109
  * creative response, while higher temperatures can lead to more diverse or
@@ -1936,6 +2113,7 @@ export type GenerateContentConfigOutput = {
1936
2113
  temperature?: number | null;
1937
2114
  /**
1938
2115
  * Topp
2116
+ *
1939
2117
  * Tokens are selected from the most to least probable until the sum
1940
2118
  * of their probabilities equals this value. Use a lower value for less
1941
2119
  * random responses and a higher value for more random responses.
@@ -1944,6 +2122,7 @@ export type GenerateContentConfigOutput = {
1944
2122
  topP?: number | null;
1945
2123
  /**
1946
2124
  * Topk
2125
+ *
1947
2126
  * For each token selection step, the ``top_k`` tokens with the
1948
2127
  * highest probabilities are sampled. Then tokens are further filtered based
1949
2128
  * on ``top_p`` with the final token selected using temperature sampling. Use
@@ -1954,18 +2133,21 @@ export type GenerateContentConfigOutput = {
1954
2133
  topK?: number | null;
1955
2134
  /**
1956
2135
  * Candidatecount
2136
+ *
1957
2137
  * Number of response variations to return.
1958
2138
  *
1959
2139
  */
1960
2140
  candidateCount?: number | null;
1961
2141
  /**
1962
2142
  * Maxoutputtokens
2143
+ *
1963
2144
  * Maximum number of tokens that can be generated in the response.
1964
2145
  *
1965
2146
  */
1966
2147
  maxOutputTokens?: number | null;
1967
2148
  /**
1968
2149
  * Stopsequences
2150
+ *
1969
2151
  * List of strings that tells the model to stop generating text if one
1970
2152
  * of the strings is encountered in the response.
1971
2153
  *
@@ -1973,6 +2155,7 @@ export type GenerateContentConfigOutput = {
1973
2155
  stopSequences?: Array<string> | null;
1974
2156
  /**
1975
2157
  * Responselogprobs
2158
+ *
1976
2159
  * Whether to return the log probabilities of the tokens that were
1977
2160
  * chosen by the model at each step.
1978
2161
  *
@@ -1980,6 +2163,7 @@ export type GenerateContentConfigOutput = {
1980
2163
  responseLogprobs?: boolean | null;
1981
2164
  /**
1982
2165
  * Logprobs
2166
+ *
1983
2167
  * Number of top candidate tokens to return the log probabilities for
1984
2168
  * at each generation step.
1985
2169
  *
@@ -1987,6 +2171,7 @@ export type GenerateContentConfigOutput = {
1987
2171
  logprobs?: number | null;
1988
2172
  /**
1989
2173
  * Presencepenalty
2174
+ *
1990
2175
  * Positive values penalize tokens that already appear in the
1991
2176
  * generated text, increasing the probability of generating more diverse
1992
2177
  * content.
@@ -1995,6 +2180,7 @@ export type GenerateContentConfigOutput = {
1995
2180
  presencePenalty?: number | null;
1996
2181
  /**
1997
2182
  * Frequencypenalty
2183
+ *
1998
2184
  * Positive values penalize tokens that repeatedly appear in the
1999
2185
  * generated text, increasing the probability of generating more diverse
2000
2186
  * content.
@@ -2003,6 +2189,7 @@ export type GenerateContentConfigOutput = {
2003
2189
  frequencyPenalty?: number | null;
2004
2190
  /**
2005
2191
  * Seed
2192
+ *
2006
2193
  * When ``seed`` is fixed to a specific number, the model makes a best
2007
2194
  * effort to provide the same response for repeated requests. By default, a
2008
2195
  * random number is used.
@@ -2011,6 +2198,7 @@ export type GenerateContentConfigOutput = {
2011
2198
  seed?: number | null;
2012
2199
  /**
2013
2200
  * Responsemimetype
2201
+ *
2014
2202
  * Output response mimetype of the generated candidate text.
2015
2203
  * Supported mimetype:
2016
2204
  * - `text/plain`: (default) Text output.
@@ -2023,6 +2211,7 @@ export type GenerateContentConfigOutput = {
2023
2211
  responseMimeType?: string | null;
2024
2212
  /**
2025
2213
  * Responseschema
2214
+ *
2026
2215
  * The `Schema` object allows the definition of input and output data types.
2027
2216
  * These types can be objects, but also primitives and arrays.
2028
2217
  * Represents a select subset of an [OpenAPI 3.0 schema
@@ -2036,6 +2225,7 @@ export type GenerateContentConfigOutput = {
2036
2225
  } | SchemaOutput | null;
2037
2226
  /**
2038
2227
  * Responsejsonschema
2228
+ *
2039
2229
  * Optional. Output schema of the generated response.
2040
2230
  * This is an alternative to `response_schema` that accepts [JSON
2041
2231
  * Schema](https://json-schema.org/). If set, `response_schema` must be
@@ -2065,6 +2255,7 @@ export type GenerateContentConfigOutput = {
2065
2255
  modelSelectionConfig?: ModelSelectionConfig | null;
2066
2256
  /**
2067
2257
  * Safetysettings
2258
+ *
2068
2259
  * Safety settings in the request to block unsafe content in the
2069
2260
  * response.
2070
2261
  *
@@ -2072,6 +2263,7 @@ export type GenerateContentConfigOutput = {
2072
2263
  safetySettings?: Array<SafetySetting> | null;
2073
2264
  /**
2074
2265
  * Tools
2266
+ *
2075
2267
  * Code that enables the system to interact with external systems to
2076
2268
  * perform an action outside of the knowledge and scope of the model.
2077
2269
  *
@@ -2084,6 +2276,7 @@ export type GenerateContentConfigOutput = {
2084
2276
  toolConfig?: ToolConfigOutput | null;
2085
2277
  /**
2086
2278
  * Labels
2279
+ *
2087
2280
  * Labels with user-defined metadata to break down billed charges.
2088
2281
  */
2089
2282
  labels?: {
@@ -2091,6 +2284,7 @@ export type GenerateContentConfigOutput = {
2091
2284
  } | null;
2092
2285
  /**
2093
2286
  * Cachedcontent
2287
+ *
2094
2288
  * Resource name of a context cache that can be used in subsequent
2095
2289
  * requests.
2096
2290
  *
@@ -2098,6 +2292,7 @@ export type GenerateContentConfigOutput = {
2098
2292
  cachedContent?: string | null;
2099
2293
  /**
2100
2294
  * Responsemodalities
2295
+ *
2101
2296
  * The requested modalities of the response. Represents the set of
2102
2297
  * modalities that the model can return.
2103
2298
  *
@@ -2110,12 +2305,14 @@ export type GenerateContentConfigOutput = {
2110
2305
  mediaResolution?: MediaResolution | null;
2111
2306
  /**
2112
2307
  * Speechconfig
2308
+ *
2113
2309
  * The speech generation configuration.
2114
2310
  *
2115
2311
  */
2116
2312
  speechConfig?: SpeechConfigOutput | string | null;
2117
2313
  /**
2118
2314
  * Audiotimestamp
2315
+ *
2119
2316
  * If enabled, audio timestamp will be included in the request to the
2120
2317
  * model.
2121
2318
  *
@@ -2134,56 +2331,67 @@ export type GenerateContentConfigOutput = {
2134
2331
  };
2135
2332
  /**
2136
2333
  * GenerateContentResponseUsageMetadata
2334
+ *
2137
2335
  * Usage metadata about response(s).
2138
2336
  */
2139
2337
  export type GenerateContentResponseUsageMetadataInput = {
2140
2338
  /**
2141
2339
  * Cachetokensdetails
2340
+ *
2142
2341
  * Output only. List of modalities of the cached content in the request input.
2143
2342
  */
2144
2343
  cacheTokensDetails?: Array<ModalityTokenCount> | null;
2145
2344
  /**
2146
2345
  * Cachedcontenttokencount
2346
+ *
2147
2347
  * Output only. Number of tokens in the cached part in the input (the cached content).
2148
2348
  */
2149
2349
  cachedContentTokenCount?: number | null;
2150
2350
  /**
2151
2351
  * Candidatestokencount
2352
+ *
2152
2353
  * Number of tokens in the response(s).
2153
2354
  */
2154
2355
  candidatesTokenCount?: number | null;
2155
2356
  /**
2156
2357
  * Candidatestokensdetails
2358
+ *
2157
2359
  * Output only. List of modalities that were returned in the response.
2158
2360
  */
2159
2361
  candidatesTokensDetails?: Array<ModalityTokenCount> | null;
2160
2362
  /**
2161
2363
  * Prompttokencount
2364
+ *
2162
2365
  * Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.
2163
2366
  */
2164
2367
  promptTokenCount?: number | null;
2165
2368
  /**
2166
2369
  * Prompttokensdetails
2370
+ *
2167
2371
  * Output only. List of modalities that were processed in the request input.
2168
2372
  */
2169
2373
  promptTokensDetails?: Array<ModalityTokenCount> | null;
2170
2374
  /**
2171
2375
  * Thoughtstokencount
2376
+ *
2172
2377
  * Output only. Number of tokens present in thoughts output.
2173
2378
  */
2174
2379
  thoughtsTokenCount?: number | null;
2175
2380
  /**
2176
2381
  * Tooluseprompttokencount
2382
+ *
2177
2383
  * Output only. Number of tokens present in tool-use prompt(s).
2178
2384
  */
2179
2385
  toolUsePromptTokenCount?: number | null;
2180
2386
  /**
2181
2387
  * Tooluseprompttokensdetails
2388
+ *
2182
2389
  * Output only. List of modalities that were processed for tool-use request inputs.
2183
2390
  */
2184
2391
  toolUsePromptTokensDetails?: Array<ModalityTokenCount> | null;
2185
2392
  /**
2186
2393
  * Totaltokencount
2394
+ *
2187
2395
  * Total token count for prompt, response candidates, and tool-use prompts (if present).
2188
2396
  */
2189
2397
  totalTokenCount?: number | null;
@@ -2194,56 +2402,67 @@ export type GenerateContentResponseUsageMetadataInput = {
2194
2402
  };
2195
2403
  /**
2196
2404
  * GenerateContentResponseUsageMetadata
2405
+ *
2197
2406
  * Usage metadata about response(s).
2198
2407
  */
2199
2408
  export type GenerateContentResponseUsageMetadataOutput = {
2200
2409
  /**
2201
2410
  * Cachetokensdetails
2411
+ *
2202
2412
  * Output only. List of modalities of the cached content in the request input.
2203
2413
  */
2204
2414
  cacheTokensDetails?: Array<ModalityTokenCount> | null;
2205
2415
  /**
2206
2416
  * Cachedcontenttokencount
2417
+ *
2207
2418
  * Output only. Number of tokens in the cached part in the input (the cached content).
2208
2419
  */
2209
2420
  cachedContentTokenCount?: number | null;
2210
2421
  /**
2211
2422
  * Candidatestokencount
2423
+ *
2212
2424
  * Number of tokens in the response(s).
2213
2425
  */
2214
2426
  candidatesTokenCount?: number | null;
2215
2427
  /**
2216
2428
  * Candidatestokensdetails
2429
+ *
2217
2430
  * Output only. List of modalities that were returned in the response.
2218
2431
  */
2219
2432
  candidatesTokensDetails?: Array<ModalityTokenCount> | null;
2220
2433
  /**
2221
2434
  * Prompttokencount
2435
+ *
2222
2436
  * Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.
2223
2437
  */
2224
2438
  promptTokenCount?: number | null;
2225
2439
  /**
2226
2440
  * Prompttokensdetails
2441
+ *
2227
2442
  * Output only. List of modalities that were processed in the request input.
2228
2443
  */
2229
2444
  promptTokensDetails?: Array<ModalityTokenCount> | null;
2230
2445
  /**
2231
2446
  * Thoughtstokencount
2447
+ *
2232
2448
  * Output only. Number of tokens present in thoughts output.
2233
2449
  */
2234
2450
  thoughtsTokenCount?: number | null;
2235
2451
  /**
2236
2452
  * Tooluseprompttokencount
2453
+ *
2237
2454
  * Output only. Number of tokens present in tool-use prompt(s).
2238
2455
  */
2239
2456
  toolUsePromptTokenCount?: number | null;
2240
2457
  /**
2241
2458
  * Tooluseprompttokensdetails
2459
+ *
2242
2460
  * Output only. List of modalities that were processed for tool-use request inputs.
2243
2461
  */
2244
2462
  toolUsePromptTokensDetails?: Array<ModalityTokenCount> | null;
2245
2463
  /**
2246
2464
  * Totaltokencount
2465
+ *
2247
2466
  * Total token count for prompt, response candidates, and tool-use prompts (if present).
2248
2467
  */
2249
2468
  totalTokenCount?: number | null;
@@ -2254,6 +2473,7 @@ export type GenerateContentResponseUsageMetadataOutput = {
2254
2473
  };
2255
2474
  /**
2256
2475
  * GenerationConfigRoutingConfig
2476
+ *
2257
2477
  * The configuration for routing the request to a specific model.
2258
2478
  */
2259
2479
  export type GenerationConfigRoutingConfig = {
@@ -2268,28 +2488,33 @@ export type GenerationConfigRoutingConfig = {
2268
2488
  };
2269
2489
  /**
2270
2490
  * GenerationConfigRoutingConfigAutoRoutingMode
2491
+ *
2271
2492
  * When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.
2272
2493
  */
2273
2494
  export type GenerationConfigRoutingConfigAutoRoutingMode = {
2274
2495
  /**
2275
2496
  * Modelroutingpreference
2497
+ *
2276
2498
  * The model routing preference.
2277
2499
  */
2278
2500
  modelRoutingPreference?: "UNKNOWN" | "PRIORITIZE_QUALITY" | "BALANCED" | "PRIORITIZE_COST" | null;
2279
2501
  };
2280
2502
  /**
2281
2503
  * GenerationConfigRoutingConfigManualRoutingMode
2504
+ *
2282
2505
  * When manual routing is set, the specified model will be used directly.
2283
2506
  */
2284
2507
  export type GenerationConfigRoutingConfigManualRoutingMode = {
2285
2508
  /**
2286
2509
  * Modelname
2510
+ *
2287
2511
  * The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
2288
2512
  */
2289
2513
  modelName?: string | null;
2290
2514
  };
2291
2515
  /**
2292
2516
  * GoogleMaps
2517
+ *
2293
2518
  * Tool to support Google Maps in Model.
2294
2519
  */
2295
2520
  export type GoogleMapsInput = {
@@ -2300,6 +2525,7 @@ export type GoogleMapsInput = {
2300
2525
  };
2301
2526
  /**
2302
2527
  * GoogleMaps
2528
+ *
2303
2529
  * Tool to support Google Maps in Model.
2304
2530
  */
2305
2531
  export type GoogleMapsOutput = {
@@ -2310,6 +2536,7 @@ export type GoogleMapsOutput = {
2310
2536
  };
2311
2537
  /**
2312
2538
  * GoogleSearch
2539
+ *
2313
2540
  * Tool to support Google Search in Model. Powered by Google.
2314
2541
  */
2315
2542
  export type GoogleSearchInput = {
@@ -2322,6 +2549,7 @@ export type GoogleSearchInput = {
2322
2549
  };
2323
2550
  /**
2324
2551
  * GoogleSearch
2552
+ *
2325
2553
  * Tool to support Google Search in Model. Powered by Google.
2326
2554
  */
2327
2555
  export type GoogleSearchOutput = {
@@ -2334,6 +2562,7 @@ export type GoogleSearchOutput = {
2334
2562
  };
2335
2563
  /**
2336
2564
  * GoogleSearchRetrieval
2565
+ *
2337
2566
  * Tool to retrieve public web data for grounding, powered by Google.
2338
2567
  */
2339
2568
  export type GoogleSearchRetrievalInput = {
@@ -2344,6 +2573,7 @@ export type GoogleSearchRetrievalInput = {
2344
2573
  };
2345
2574
  /**
2346
2575
  * GoogleSearchRetrieval
2576
+ *
2347
2577
  * Tool to retrieve public web data for grounding, powered by Google.
2348
2578
  */
2349
2579
  export type GoogleSearchRetrievalOutput = {
@@ -2354,6 +2584,7 @@ export type GoogleSearchRetrievalOutput = {
2354
2584
  };
2355
2585
  /**
2356
2586
  * GroundingChunk
2587
+ *
2357
2588
  * Grounding chunk.
2358
2589
  */
2359
2590
  export type GroundingChunkInput = {
@@ -2368,6 +2599,7 @@ export type GroundingChunkInput = {
2368
2599
  };
2369
2600
  /**
2370
2601
  * GroundingChunk
2602
+ *
2371
2603
  * Grounding chunk.
2372
2604
  */
2373
2605
  export type GroundingChunkOutput = {
@@ -2382,6 +2614,7 @@ export type GroundingChunkOutput = {
2382
2614
  };
2383
2615
  /**
2384
2616
  * GroundingChunkRetrievedContext
2617
+ *
2385
2618
  * Chunk from context retrieved by the retrieval tools.
2386
2619
  */
2387
2620
  export type GroundingChunkRetrievedContextInput = {
@@ -2391,22 +2624,26 @@ export type GroundingChunkRetrievedContextInput = {
2391
2624
  ragChunk?: RagChunk | null;
2392
2625
  /**
2393
2626
  * Text
2627
+ *
2394
2628
  * Text of the attribution.
2395
2629
  */
2396
2630
  text?: string | null;
2397
2631
  /**
2398
2632
  * Title
2633
+ *
2399
2634
  * Title of the attribution.
2400
2635
  */
2401
2636
  title?: string | null;
2402
2637
  /**
2403
2638
  * Uri
2639
+ *
2404
2640
  * URI reference of the attribution.
2405
2641
  */
2406
2642
  uri?: string | null;
2407
2643
  };
2408
2644
  /**
2409
2645
  * GroundingChunkRetrievedContext
2646
+ *
2410
2647
  * Chunk from context retrieved by the retrieval tools.
2411
2648
  */
2412
2649
  export type GroundingChunkRetrievedContextOutput = {
@@ -2416,53 +2653,63 @@ export type GroundingChunkRetrievedContextOutput = {
2416
2653
  ragChunk?: RagChunk | null;
2417
2654
  /**
2418
2655
  * Text
2656
+ *
2419
2657
  * Text of the attribution.
2420
2658
  */
2421
2659
  text?: string | null;
2422
2660
  /**
2423
2661
  * Title
2662
+ *
2424
2663
  * Title of the attribution.
2425
2664
  */
2426
2665
  title?: string | null;
2427
2666
  /**
2428
2667
  * Uri
2668
+ *
2429
2669
  * URI reference of the attribution.
2430
2670
  */
2431
2671
  uri?: string | null;
2432
2672
  };
2433
2673
  /**
2434
2674
  * GroundingChunkWeb
2675
+ *
2435
2676
  * Chunk from the web.
2436
2677
  */
2437
2678
  export type GroundingChunkWeb = {
2438
2679
  /**
2439
2680
  * Domain
2681
+ *
2440
2682
  * Domain of the (original) URI.
2441
2683
  */
2442
2684
  domain?: string | null;
2443
2685
  /**
2444
2686
  * Title
2687
+ *
2445
2688
  * Title of the chunk.
2446
2689
  */
2447
2690
  title?: string | null;
2448
2691
  /**
2449
2692
  * Uri
2693
+ *
2450
2694
  * URI reference of the chunk.
2451
2695
  */
2452
2696
  uri?: string | null;
2453
2697
  };
2454
2698
  /**
2455
2699
  * GroundingMetadata
2700
+ *
2456
2701
  * Metadata returned to client when grounding is enabled.
2457
2702
  */
2458
2703
  export type GroundingMetadataInput = {
2459
2704
  /**
2460
2705
  * Groundingchunks
2706
+ *
2461
2707
  * List of supporting references retrieved from specified grounding source.
2462
2708
  */
2463
2709
  groundingChunks?: Array<GroundingChunkInput> | null;
2464
2710
  /**
2465
2711
  * Groundingsupports
2712
+ *
2466
2713
  * Optional. List of grounding support.
2467
2714
  */
2468
2715
  groundingSupports?: Array<GroundingSupport> | null;
@@ -2472,6 +2719,7 @@ export type GroundingMetadataInput = {
2472
2719
  retrievalMetadata?: RetrievalMetadata | null;
2473
2720
  /**
2474
2721
  * Retrievalqueries
2722
+ *
2475
2723
  * Optional. Queries executed by the retrieval tools.
2476
2724
  */
2477
2725
  retrievalQueries?: Array<string> | null;
@@ -2481,22 +2729,26 @@ export type GroundingMetadataInput = {
2481
2729
  searchEntryPoint?: SearchEntryPoint | null;
2482
2730
  /**
2483
2731
  * Websearchqueries
2732
+ *
2484
2733
  * Optional. Web search queries for the following-up web search.
2485
2734
  */
2486
2735
  webSearchQueries?: Array<string> | null;
2487
2736
  };
2488
2737
  /**
2489
2738
  * GroundingMetadata
2739
+ *
2490
2740
  * Metadata returned to client when grounding is enabled.
2491
2741
  */
2492
2742
  export type GroundingMetadataOutput = {
2493
2743
  /**
2494
2744
  * Groundingchunks
2745
+ *
2495
2746
  * List of supporting references retrieved from specified grounding source.
2496
2747
  */
2497
2748
  groundingChunks?: Array<GroundingChunkOutput> | null;
2498
2749
  /**
2499
2750
  * Groundingsupports
2751
+ *
2500
2752
  * Optional. List of grounding support.
2501
2753
  */
2502
2754
  groundingSupports?: Array<GroundingSupport> | null;
@@ -2506,6 +2758,7 @@ export type GroundingMetadataOutput = {
2506
2758
  retrievalMetadata?: RetrievalMetadata | null;
2507
2759
  /**
2508
2760
  * Retrievalqueries
2761
+ *
2509
2762
  * Optional. Queries executed by the retrieval tools.
2510
2763
  */
2511
2764
  retrievalQueries?: Array<string> | null;
@@ -2515,22 +2768,26 @@ export type GroundingMetadataOutput = {
2515
2768
  searchEntryPoint?: SearchEntryPoint | null;
2516
2769
  /**
2517
2770
  * Websearchqueries
2771
+ *
2518
2772
  * Optional. Web search queries for the following-up web search.
2519
2773
  */
2520
2774
  webSearchQueries?: Array<string> | null;
2521
2775
  };
2522
2776
  /**
2523
2777
  * GroundingSupport
2778
+ *
2524
2779
  * Grounding support.
2525
2780
  */
2526
2781
  export type GroundingSupport = {
2527
2782
  /**
2528
2783
  * Confidencescores
2784
+ *
2529
2785
  * Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the grounding_chunk_indices.
2530
2786
  */
2531
2787
  confidenceScores?: Array<number> | null;
2532
2788
  /**
2533
2789
  * Groundingchunkindices
2790
+ *
2534
2791
  * A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.
2535
2792
  */
2536
2793
  groundingChunkIndices?: Array<number> | null;
@@ -2584,6 +2841,7 @@ export type HttpValidationError = {
2584
2841
  };
2585
2842
  /**
2586
2843
  * HarmBlockMethod
2844
+ *
2587
2845
  * Optional.
2588
2846
  *
2589
2847
  * Specify if the threshold is used for probability or severity score. If not
@@ -2596,6 +2854,7 @@ export declare const HarmBlockMethod: {
2596
2854
  };
2597
2855
  /**
2598
2856
  * HarmBlockMethod
2857
+ *
2599
2858
  * Optional.
2600
2859
  *
2601
2860
  * Specify if the threshold is used for probability or severity score. If not
@@ -2604,6 +2863,7 @@ export declare const HarmBlockMethod: {
2604
2863
  export type HarmBlockMethod = (typeof HarmBlockMethod)[keyof typeof HarmBlockMethod];
2605
2864
  /**
2606
2865
  * HarmBlockThreshold
2866
+ *
2607
2867
  * Required. The harm block threshold.
2608
2868
  */
2609
2869
  export declare const HarmBlockThreshold: {
@@ -2616,11 +2876,13 @@ export declare const HarmBlockThreshold: {
2616
2876
  };
2617
2877
  /**
2618
2878
  * HarmBlockThreshold
2879
+ *
2619
2880
  * Required. The harm block threshold.
2620
2881
  */
2621
2882
  export type HarmBlockThreshold = (typeof HarmBlockThreshold)[keyof typeof HarmBlockThreshold];
2622
2883
  /**
2623
2884
  * HarmCategory
2885
+ *
2624
2886
  * Required. Harm category.
2625
2887
  */
2626
2888
  export declare const HarmCategory: {
@@ -2633,11 +2895,13 @@ export declare const HarmCategory: {
2633
2895
  };
2634
2896
  /**
2635
2897
  * HarmCategory
2898
+ *
2636
2899
  * Required. Harm category.
2637
2900
  */
2638
2901
  export type HarmCategory = (typeof HarmCategory)[keyof typeof HarmCategory];
2639
2902
  /**
2640
2903
  * HttpAuth
2904
+ *
2641
2905
  * The credentials and metadata for HTTP authentication.
2642
2906
  */
2643
2907
  export type HttpAuth = {
@@ -2650,6 +2914,7 @@ export type HttpAuth = {
2650
2914
  };
2651
2915
  /**
2652
2916
  * HttpCredentials
2917
+ *
2653
2918
  * Represents the secret token value for HTTP authentication, like user name, password, oauth token, etc.
2654
2919
  */
2655
2920
  export type HttpCredentials = {
@@ -2669,21 +2934,25 @@ export type HttpCredentials = {
2669
2934
  };
2670
2935
  /**
2671
2936
  * HttpOptions
2937
+ *
2672
2938
  * HTTP options to be used in each of the requests.
2673
2939
  */
2674
2940
  export type HttpOptions = {
2675
2941
  /**
2676
2942
  * Baseurl
2943
+ *
2677
2944
  * The base URL for the AI platform service endpoint.
2678
2945
  */
2679
2946
  baseUrl?: string | null;
2680
2947
  /**
2681
2948
  * Apiversion
2949
+ *
2682
2950
  * Specifies the version of the API to use.
2683
2951
  */
2684
2952
  apiVersion?: string | null;
2685
2953
  /**
2686
2954
  * Headers
2955
+ *
2687
2956
  * Additional HTTP headers to be sent with the request.
2688
2957
  */
2689
2958
  headers?: {
@@ -2691,11 +2960,13 @@ export type HttpOptions = {
2691
2960
  } | null;
2692
2961
  /**
2693
2962
  * Timeout
2963
+ *
2694
2964
  * Timeout for the request in milliseconds.
2695
2965
  */
2696
2966
  timeout?: number | null;
2697
2967
  /**
2698
2968
  * Clientargs
2969
+ *
2699
2970
  * Args passed to the HTTP client.
2700
2971
  */
2701
2972
  clientArgs?: {
@@ -2703,6 +2974,7 @@ export type HttpOptions = {
2703
2974
  } | null;
2704
2975
  /**
2705
2976
  * Asyncclientargs
2977
+ *
2706
2978
  * Args passed to the async HTTP client.
2707
2979
  */
2708
2980
  asyncClientArgs?: {
@@ -2710,6 +2982,7 @@ export type HttpOptions = {
2710
2982
  } | null;
2711
2983
  /**
2712
2984
  * Extrabody
2985
+ *
2713
2986
  * Extra parameters to add to the request body.
2714
2987
  */
2715
2988
  extraBody?: {
@@ -2722,37 +2995,44 @@ export type HttpOptions = {
2722
2995
  };
2723
2996
  /**
2724
2997
  * HttpRetryOptions
2998
+ *
2725
2999
  * HTTP retry options to be used in each of the requests.
2726
3000
  */
2727
3001
  export type HttpRetryOptions = {
2728
3002
  /**
2729
3003
  * Attempts
3004
+ *
2730
3005
  * Maximum number of attempts, including the original request.
2731
3006
  * If 0 or 1, it means no retries.
2732
3007
  */
2733
3008
  attempts?: number | null;
2734
3009
  /**
2735
3010
  * Initialdelay
3011
+ *
2736
3012
  * Initial delay before the first retry, in fractions of a second.
2737
3013
  */
2738
3014
  initialDelay?: number | null;
2739
3015
  /**
2740
3016
  * Maxdelay
3017
+ *
2741
3018
  * Maximum delay between retries, in fractions of a second.
2742
3019
  */
2743
3020
  maxDelay?: number | null;
2744
3021
  /**
2745
3022
  * Expbase
3023
+ *
2746
3024
  * Multiplier by which the delay increases after each attempt.
2747
3025
  */
2748
3026
  expBase?: number | null;
2749
3027
  /**
2750
3028
  * Jitter
3029
+ *
2751
3030
  * Randomness factor for the delay.
2752
3031
  */
2753
3032
  jitter?: number | null;
2754
3033
  /**
2755
3034
  * Httpstatuscodes
3035
+ *
2756
3036
  * List of HTTP status codes that should trigger a retry.
2757
3037
  * If not specified, a default set of retryable codes may be used.
2758
3038
  */
@@ -2760,6 +3040,7 @@ export type HttpRetryOptions = {
2760
3040
  };
2761
3041
  /**
2762
3042
  * IntermediateData
3043
+ *
2763
3044
  * Container for intermediate data that an agent would generate as it responds with a final answer.
2764
3045
  */
2765
3046
  export type IntermediateDataInput = {
@@ -2778,6 +3059,7 @@ export type IntermediateDataInput = {
2778
3059
  };
2779
3060
  /**
2780
3061
  * IntermediateData
3062
+ *
2781
3063
  * Container for intermediate data that an agent would generate as it responds with a final answer.
2782
3064
  */
2783
3065
  export type IntermediateDataOutput = {
@@ -2796,6 +3078,7 @@ export type IntermediateDataOutput = {
2796
3078
  };
2797
3079
  /**
2798
3080
  * Interval
3081
+ *
2799
3082
  * Represents a time interval, encoded as a start time (inclusive) and an end time (exclusive).
2800
3083
  *
2801
3084
  * The start time must be less than or equal to the end time.
@@ -2806,17 +3089,20 @@ export type IntermediateDataOutput = {
2806
3089
  export type IntervalInput = {
2807
3090
  /**
2808
3091
  * Starttime
3092
+ *
2809
3093
  * The start time of the interval.
2810
3094
  */
2811
3095
  startTime?: string | null;
2812
3096
  /**
2813
3097
  * Endtime
3098
+ *
2814
3099
  * The end time of the interval.
2815
3100
  */
2816
3101
  endTime?: string | null;
2817
3102
  };
2818
3103
  /**
2819
3104
  * Invocation
3105
+ *
2820
3106
  * Represents a single invocation.
2821
3107
  */
2822
3108
  export type InvocationInput = {
@@ -2842,6 +3128,7 @@ export type InvocationInput = {
2842
3128
  };
2843
3129
  /**
2844
3130
  * Invocation
3131
+ *
2845
3132
  * Represents a single invocation.
2846
3133
  */
2847
3134
  export type InvocationOutput = {
@@ -2867,6 +3154,7 @@ export type InvocationOutput = {
2867
3154
  };
2868
3155
  /**
2869
3156
  * InvocationEvent
3157
+ *
2870
3158
  * An immutable record representing a specific point in the agent's invocation.
2871
3159
  *
2872
3160
  * It captures agent's replies, requests to use tools (function calls), and tool
@@ -2884,6 +3172,7 @@ export type InvocationEventInput = {
2884
3172
  };
2885
3173
  /**
2886
3174
  * InvocationEvent
3175
+ *
2887
3176
  * An immutable record representing a specific point in the agent's invocation.
2888
3177
  *
2889
3178
  * It captures agent's replies, requests to use tools (function calls), and tool
@@ -2901,6 +3190,7 @@ export type InvocationEventOutput = {
2901
3190
  };
2902
3191
  /**
2903
3192
  * InvocationEvents
3193
+ *
2904
3194
  * A container for events that occur during the course of an invocation.
2905
3195
  */
2906
3196
  export type InvocationEventsInput = {
@@ -2911,6 +3201,7 @@ export type InvocationEventsInput = {
2911
3201
  };
2912
3202
  /**
2913
3203
  * InvocationEvents
3204
+ *
2914
3205
  * A container for events that occur during the course of an invocation.
2915
3206
  */
2916
3207
  export type InvocationEventsOutput = {
@@ -2946,11 +3237,13 @@ export type Item = {
2946
3237
  };
2947
3238
  /**
2948
3239
  * JudgeModelOptions
3240
+ *
2949
3241
  * Options for an eval metric's judge model.
2950
3242
  */
2951
3243
  export type JudgeModelOptionsInput = {
2952
3244
  /**
2953
3245
  * Judgemodel
3246
+ *
2954
3247
  * The judge model to use for evaluation. It can be a model name.
2955
3248
  */
2956
3249
  judgeModel?: string;
@@ -2960,17 +3253,20 @@ export type JudgeModelOptionsInput = {
2960
3253
  judgeModelConfig?: GenerateContentConfigInput | null;
2961
3254
  /**
2962
3255
  * Numsamples
3256
+ *
2963
3257
  * The number of times to sample the model for each invocation evaluation. Given that models tend to have certain degree of unreliability to them, we repeatedly sample them with the same data. These repeated invocation are them aggregated using some strategy. From experimentation, we have found 5 to be a good default.
2964
3258
  */
2965
3259
  numSamples?: number;
2966
3260
  };
2967
3261
  /**
2968
3262
  * JudgeModelOptions
3263
+ *
2969
3264
  * Options for an eval metric's judge model.
2970
3265
  */
2971
3266
  export type JudgeModelOptionsOutput = {
2972
3267
  /**
2973
3268
  * Judgemodel
3269
+ *
2974
3270
  * The judge model to use for evaluation. It can be a model name.
2975
3271
  */
2976
3272
  judgeModel?: string;
@@ -2980,12 +3276,14 @@ export type JudgeModelOptionsOutput = {
2980
3276
  judgeModelConfig?: GenerateContentConfigOutput | null;
2981
3277
  /**
2982
3278
  * Numsamples
3279
+ *
2983
3280
  * The number of times to sample the model for each invocation evaluation. Given that models tend to have certain degree of unreliability to them, we repeatedly sample them with the same data. These repeated invocation are them aggregated using some strategy. From experimentation, we have found 5 to be a good default.
2984
3281
  */
2985
3282
  numSamples?: number;
2986
3283
  };
2987
3284
  /**
2988
3285
  * Language
3286
+ *
2989
3287
  * Required. Programming language of the `code`.
2990
3288
  */
2991
3289
  export declare const Language: {
@@ -2994,11 +3292,13 @@ export declare const Language: {
2994
3292
  };
2995
3293
  /**
2996
3294
  * Language
3295
+ *
2997
3296
  * Required. Programming language of the `code`.
2998
3297
  */
2999
3298
  export type Language = (typeof Language)[keyof typeof Language];
3000
3299
  /**
3001
3300
  * LatLng
3301
+ *
3002
3302
  * An object that represents a latitude/longitude pair.
3003
3303
  *
3004
3304
  * This is expressed as a pair of doubles to represent degrees latitude and
@@ -3009,11 +3309,13 @@ export type Language = (typeof Language)[keyof typeof Language];
3009
3309
  export type LatLng = {
3010
3310
  /**
3011
3311
  * Latitude
3312
+ *
3012
3313
  * The latitude in degrees. It must be in the range [-90.0, +90.0].
3013
3314
  */
3014
3315
  latitude?: number | null;
3015
3316
  /**
3016
3317
  * Longitude
3318
+ *
3017
3319
  * The longitude in degrees. It must be in the range [-180.0, +180.0]
3018
3320
  */
3019
3321
  longitude?: number | null;
@@ -3047,6 +3349,7 @@ export type ListMetricsInfoResponse = {
3047
3349
  };
3048
3350
  /**
3049
3351
  * LiveServerSessionResumptionUpdate
3352
+ *
3050
3353
  * Update of the session resumption state.
3051
3354
  *
3052
3355
  * Only sent if `session_resumption` was set in the connection config.
@@ -3054,16 +3357,19 @@ export type ListMetricsInfoResponse = {
3054
3357
  export type LiveServerSessionResumptionUpdate = {
3055
3358
  /**
3056
3359
  * Newhandle
3360
+ *
3057
3361
  * New handle that represents state that can be resumed. Empty if `resumable`=false.
3058
3362
  */
3059
3363
  newHandle?: string | null;
3060
3364
  /**
3061
3365
  * Resumable
3366
+ *
3062
3367
  * True if session can be resumed at this point. It might be not possible to resume session at some points. In that case we send update empty new_handle and resumable=false. Example of such case could be model executing function calls or just generating. Resuming session (using previous session token) in such state will result in some data loss.
3063
3368
  */
3064
3369
  resumable?: boolean | null;
3065
3370
  /**
3066
3371
  * Lastconsumedclientmessageindex
3372
+ *
3067
3373
  * Index of last message sent by client that is included in state represented by this SessionResumptionToken. Only sent when `SessionResumptionConfig.transparent` is set.
3068
3374
  *
3069
3375
  * Presence of this index allows users to transparently reconnect and avoid issue of losing some part of realtime audio input/video. If client wishes to temporarily disconnect (for example as result of receiving GoAway) they can do it without losing state by buffering messages sent since last `SessionResmumptionTokenUpdate`. This field will enable them to limit buffering (avoid keeping all requests in RAM).
@@ -3074,70 +3380,83 @@ export type LiveServerSessionResumptionUpdate = {
3074
3380
  };
3075
3381
  /**
3076
3382
  * LogprobsResult
3383
+ *
3077
3384
  * Logprobs Result
3078
3385
  */
3079
3386
  export type LogprobsResultInput = {
3080
3387
  /**
3081
3388
  * Chosencandidates
3389
+ *
3082
3390
  * Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.
3083
3391
  */
3084
3392
  chosenCandidates?: Array<LogprobsResultCandidate> | null;
3085
3393
  /**
3086
3394
  * Topcandidates
3395
+ *
3087
3396
  * Length = total number of decoding steps.
3088
3397
  */
3089
3398
  topCandidates?: Array<LogprobsResultTopCandidates> | null;
3090
3399
  };
3091
3400
  /**
3092
3401
  * LogprobsResult
3402
+ *
3093
3403
  * Logprobs Result
3094
3404
  */
3095
3405
  export type LogprobsResultOutput = {
3096
3406
  /**
3097
3407
  * Chosencandidates
3408
+ *
3098
3409
  * Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.
3099
3410
  */
3100
3411
  chosenCandidates?: Array<LogprobsResultCandidate> | null;
3101
3412
  /**
3102
3413
  * Topcandidates
3414
+ *
3103
3415
  * Length = total number of decoding steps.
3104
3416
  */
3105
3417
  topCandidates?: Array<LogprobsResultTopCandidates> | null;
3106
3418
  };
3107
3419
  /**
3108
3420
  * LogprobsResultCandidate
3421
+ *
3109
3422
  * Candidate for the logprobs token and score.
3110
3423
  */
3111
3424
  export type LogprobsResultCandidate = {
3112
3425
  /**
3113
3426
  * Logprobability
3427
+ *
3114
3428
  * The candidate's log probability.
3115
3429
  */
3116
3430
  logProbability?: number | null;
3117
3431
  /**
3118
3432
  * Token
3433
+ *
3119
3434
  * The candidate's token string value.
3120
3435
  */
3121
3436
  token?: string | null;
3122
3437
  /**
3123
3438
  * Tokenid
3439
+ *
3124
3440
  * The candidate's token id value.
3125
3441
  */
3126
3442
  tokenId?: number | null;
3127
3443
  };
3128
3444
  /**
3129
3445
  * LogprobsResultTopCandidates
3446
+ *
3130
3447
  * Candidates with top log probabilities at each decoding step.
3131
3448
  */
3132
3449
  export type LogprobsResultTopCandidates = {
3133
3450
  /**
3134
3451
  * Candidates
3452
+ *
3135
3453
  * Sorted by log probability in descending order.
3136
3454
  */
3137
3455
  candidates?: Array<LogprobsResultCandidate> | null;
3138
3456
  };
3139
3457
  /**
3140
3458
  * MediaModality
3459
+ *
3141
3460
  * Server content modalities.
3142
3461
  */
3143
3462
  export declare const MediaModality: {
@@ -3150,11 +3469,13 @@ export declare const MediaModality: {
3150
3469
  };
3151
3470
  /**
3152
3471
  * MediaModality
3472
+ *
3153
3473
  * Server content modalities.
3154
3474
  */
3155
3475
  export type MediaModality = (typeof MediaModality)[keyof typeof MediaModality];
3156
3476
  /**
3157
3477
  * MediaResolution
3478
+ *
3158
3479
  * The media resolution to use.
3159
3480
  */
3160
3481
  export declare const MediaResolution: {
@@ -3165,21 +3486,25 @@ export declare const MediaResolution: {
3165
3486
  };
3166
3487
  /**
3167
3488
  * MediaResolution
3489
+ *
3168
3490
  * The media resolution to use.
3169
3491
  */
3170
3492
  export type MediaResolution = (typeof MediaResolution)[keyof typeof MediaResolution];
3171
3493
  /**
3172
3494
  * MetricInfo
3495
+ *
3173
3496
  * Information about the metric that are used for Evals.
3174
3497
  */
3175
3498
  export type MetricInfo = {
3176
3499
  /**
3177
3500
  * Metricname
3501
+ *
3178
3502
  * The name of the metric.
3179
3503
  */
3180
3504
  metricName: string;
3181
3505
  /**
3182
3506
  * Description
3507
+ *
3183
3508
  * A 2 to 3 line description of the metric.
3184
3509
  */
3185
3510
  description?: string;
@@ -3190,6 +3515,7 @@ export type MetricInfo = {
3190
3515
  };
3191
3516
  /**
3192
3517
  * MetricValueInfo
3518
+ *
3193
3519
  * Information about the type of metric value.
3194
3520
  */
3195
3521
  export type MetricValueInfo = {
@@ -3200,6 +3526,7 @@ export type MetricValueInfo = {
3200
3526
  };
3201
3527
  /**
3202
3528
  * ModalityTokenCount
3529
+ *
3203
3530
  * Represents token counting info for a single modality.
3204
3531
  */
3205
3532
  export type ModalityTokenCount = {
@@ -3209,12 +3536,14 @@ export type ModalityTokenCount = {
3209
3536
  modality?: MediaModality | null;
3210
3537
  /**
3211
3538
  * Tokencount
3539
+ *
3212
3540
  * Number of tokens.
3213
3541
  */
3214
3542
  tokenCount?: number | null;
3215
3543
  };
3216
3544
  /**
3217
3545
  * ModelSelectionConfig
3546
+ *
3218
3547
  * Config for model selection.
3219
3548
  */
3220
3549
  export type ModelSelectionConfig = {
@@ -3225,22 +3554,26 @@ export type ModelSelectionConfig = {
3225
3554
  };
3226
3555
  /**
3227
3556
  * MultiSpeakerVoiceConfig
3557
+ *
3228
3558
  * The configuration for the multi-speaker setup.
3229
3559
  */
3230
3560
  export type MultiSpeakerVoiceConfigInput = {
3231
3561
  /**
3232
3562
  * Speakervoiceconfigs
3563
+ *
3233
3564
  * The configuration for the speaker to use.
3234
3565
  */
3235
3566
  speakerVoiceConfigs?: Array<SpeakerVoiceConfigInput> | null;
3236
3567
  };
3237
3568
  /**
3238
3569
  * MultiSpeakerVoiceConfig
3570
+ *
3239
3571
  * The configuration for the multi-speaker setup.
3240
3572
  */
3241
3573
  export type MultiSpeakerVoiceConfigOutput = {
3242
3574
  /**
3243
3575
  * Speakervoiceconfigs
3576
+ *
3244
3577
  * The configuration for the speaker to use.
3245
3578
  */
3246
3579
  speakerVoiceConfigs?: Array<SpeakerVoiceConfigOutput> | null;
@@ -3271,6 +3604,7 @@ export type OAuth2Output = {
3271
3604
  };
3272
3605
  /**
3273
3606
  * OAuth2Auth
3607
+ *
3274
3608
  * Represents credential value and its metadata for a OAuth2 credential.
3275
3609
  */
3276
3610
  export type OAuth2Auth = {
@@ -3482,6 +3816,7 @@ export type OpenIdConnectWithConfig = {
3482
3816
  };
3483
3817
  /**
3484
3818
  * Outcome
3819
+ *
3485
3820
  * Required. Outcome of the code execution.
3486
3821
  */
3487
3822
  export declare const Outcome: {
@@ -3492,11 +3827,13 @@ export declare const Outcome: {
3492
3827
  };
3493
3828
  /**
3494
3829
  * Outcome
3830
+ *
3495
3831
  * Required. Outcome of the code execution.
3496
3832
  */
3497
3833
  export type Outcome = (typeof Outcome)[keyof typeof Outcome];
3498
3834
  /**
3499
3835
  * Part
3836
+ *
3500
3837
  * A datatype containing media content.
3501
3838
  *
3502
3839
  * Exactly one field within a Part should be set, representing the specific type
@@ -3510,6 +3847,7 @@ export type PartInput = {
3510
3847
  videoMetadata?: VideoMetadata | null;
3511
3848
  /**
3512
3849
  * Thought
3850
+ *
3513
3851
  * Indicates if the part is thought from the model.
3514
3852
  */
3515
3853
  thought?: boolean | null;
@@ -3523,6 +3861,7 @@ export type PartInput = {
3523
3861
  fileData?: FileData | null;
3524
3862
  /**
3525
3863
  * Thoughtsignature
3864
+ *
3526
3865
  * An opaque signature for the thought so it can be reused in subsequent requests.
3527
3866
  */
3528
3867
  thoughtSignature?: string | null;
@@ -3544,12 +3883,14 @@ export type PartInput = {
3544
3883
  functionResponse?: FunctionResponse | null;
3545
3884
  /**
3546
3885
  * Text
3886
+ *
3547
3887
  * Optional. Text part (can be code).
3548
3888
  */
3549
3889
  text?: string | null;
3550
3890
  };
3551
3891
  /**
3552
3892
  * Part
3893
+ *
3553
3894
  * A datatype containing media content.
3554
3895
  *
3555
3896
  * Exactly one field within a Part should be set, representing the specific type
@@ -3563,6 +3904,7 @@ export type PartOutput = {
3563
3904
  videoMetadata?: VideoMetadata | null;
3564
3905
  /**
3565
3906
  * Thought
3907
+ *
3566
3908
  * Indicates if the part is thought from the model.
3567
3909
  */
3568
3910
  thought?: boolean | null;
@@ -3576,6 +3918,7 @@ export type PartOutput = {
3576
3918
  fileData?: FileData | null;
3577
3919
  /**
3578
3920
  * Thoughtsignature
3921
+ *
3579
3922
  * An opaque signature for the thought so it can be reused in subsequent requests.
3580
3923
  */
3581
3924
  thoughtSignature?: string | null;
@@ -3597,23 +3940,27 @@ export type PartOutput = {
3597
3940
  functionResponse?: FunctionResponse | null;
3598
3941
  /**
3599
3942
  * Text
3943
+ *
3600
3944
  * Optional. Text part (can be code).
3601
3945
  */
3602
3946
  text?: string | null;
3603
3947
  };
3604
3948
  /**
3605
3949
  * PrebuiltVoiceConfig
3950
+ *
3606
3951
  * The configuration for the prebuilt speaker to use.
3607
3952
  */
3608
3953
  export type PrebuiltVoiceConfig = {
3609
3954
  /**
3610
3955
  * Voicename
3956
+ *
3611
3957
  * The name of the prebuilt voice to use.
3612
3958
  */
3613
3959
  voiceName?: string | null;
3614
3960
  };
3615
3961
  /**
3616
3962
  * RagChunk
3963
+ *
3617
3964
  * A RagChunk includes the content of a chunk of a RagFile, and associated metadata.
3618
3965
  */
3619
3966
  export type RagChunk = {
@@ -3623,28 +3970,33 @@ export type RagChunk = {
3623
3970
  pageSpan?: RagChunkPageSpan | null;
3624
3971
  /**
3625
3972
  * Text
3973
+ *
3626
3974
  * The content of the chunk.
3627
3975
  */
3628
3976
  text?: string | null;
3629
3977
  };
3630
3978
  /**
3631
3979
  * RagChunkPageSpan
3980
+ *
3632
3981
  * Represents where the chunk starts and ends in the document.
3633
3982
  */
3634
3983
  export type RagChunkPageSpan = {
3635
3984
  /**
3636
3985
  * Firstpage
3986
+ *
3637
3987
  * Page where chunk starts in the document. Inclusive. 1-indexed.
3638
3988
  */
3639
3989
  firstPage?: number | null;
3640
3990
  /**
3641
3991
  * Lastpage
3992
+ *
3642
3993
  * Page where chunk ends in the document. Inclusive. 1-indexed.
3643
3994
  */
3644
3995
  lastPage?: number | null;
3645
3996
  };
3646
3997
  /**
3647
3998
  * RagRetrievalConfig
3999
+ *
3648
4000
  * Specifies the context retrieval config.
3649
4001
  */
3650
4002
  export type RagRetrievalConfigInput = {
@@ -3662,12 +4014,14 @@ export type RagRetrievalConfigInput = {
3662
4014
  ranking?: RagRetrievalConfigRanking | null;
3663
4015
  /**
3664
4016
  * Topk
4017
+ *
3665
4018
  * Optional. The number of contexts to retrieve.
3666
4019
  */
3667
4020
  topK?: number | null;
3668
4021
  };
3669
4022
  /**
3670
4023
  * RagRetrievalConfig
4024
+ *
3671
4025
  * Specifies the context retrieval config.
3672
4026
  */
3673
4027
  export type RagRetrievalConfigOutput = {
@@ -3685,44 +4039,52 @@ export type RagRetrievalConfigOutput = {
3685
4039
  ranking?: RagRetrievalConfigRanking | null;
3686
4040
  /**
3687
4041
  * Topk
4042
+ *
3688
4043
  * Optional. The number of contexts to retrieve.
3689
4044
  */
3690
4045
  topK?: number | null;
3691
4046
  };
3692
4047
  /**
3693
4048
  * RagRetrievalConfigFilter
4049
+ *
3694
4050
  * Config for filters.
3695
4051
  */
3696
4052
  export type RagRetrievalConfigFilter = {
3697
4053
  /**
3698
4054
  * Metadatafilter
4055
+ *
3699
4056
  * Optional. String for metadata filtering.
3700
4057
  */
3701
4058
  metadataFilter?: string | null;
3702
4059
  /**
3703
4060
  * Vectordistancethreshold
4061
+ *
3704
4062
  * Optional. Only returns contexts with vector distance smaller than the threshold.
3705
4063
  */
3706
4064
  vectorDistanceThreshold?: number | null;
3707
4065
  /**
3708
4066
  * Vectorsimilaritythreshold
4067
+ *
3709
4068
  * Optional. Only returns contexts with vector similarity larger than the threshold.
3710
4069
  */
3711
4070
  vectorSimilarityThreshold?: number | null;
3712
4071
  };
3713
4072
  /**
3714
4073
  * RagRetrievalConfigHybridSearch
4074
+ *
3715
4075
  * Config for Hybrid Search.
3716
4076
  */
3717
4077
  export type RagRetrievalConfigHybridSearch = {
3718
4078
  /**
3719
4079
  * Alpha
4080
+ *
3720
4081
  * Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.
3721
4082
  */
3722
4083
  alpha?: number | null;
3723
4084
  };
3724
4085
  /**
3725
4086
  * RagRetrievalConfigRanking
4087
+ *
3726
4088
  * Config for ranking and reranking.
3727
4089
  */
3728
4090
  export type RagRetrievalConfigRanking = {
@@ -3737,33 +4099,39 @@ export type RagRetrievalConfigRanking = {
3737
4099
  };
3738
4100
  /**
3739
4101
  * RagRetrievalConfigRankingLlmRanker
4102
+ *
3740
4103
  * Config for LlmRanker.
3741
4104
  */
3742
4105
  export type RagRetrievalConfigRankingLlmRanker = {
3743
4106
  /**
3744
4107
  * Modelname
4108
+ *
3745
4109
  * Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
3746
4110
  */
3747
4111
  modelName?: string | null;
3748
4112
  };
3749
4113
  /**
3750
4114
  * RagRetrievalConfigRankingRankService
4115
+ *
3751
4116
  * Config for Rank Service.
3752
4117
  */
3753
4118
  export type RagRetrievalConfigRankingRankService = {
3754
4119
  /**
3755
4120
  * Modelname
4121
+ *
3756
4122
  * Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
3757
4123
  */
3758
4124
  modelName?: string | null;
3759
4125
  };
3760
4126
  /**
3761
4127
  * Retrieval
4128
+ *
3762
4129
  * Defines a retrieval tool that model can call to access external knowledge.
3763
4130
  */
3764
4131
  export type RetrievalInput = {
3765
4132
  /**
3766
4133
  * Disableattribution
4134
+ *
3767
4135
  * Optional. Deprecated. This option is no longer supported.
3768
4136
  */
3769
4137
  disableAttribution?: boolean | null;
@@ -3778,11 +4146,13 @@ export type RetrievalInput = {
3778
4146
  };
3779
4147
  /**
3780
4148
  * Retrieval
4149
+ *
3781
4150
  * Defines a retrieval tool that model can call to access external knowledge.
3782
4151
  */
3783
4152
  export type RetrievalOutput = {
3784
4153
  /**
3785
4154
  * Disableattribution
4155
+ *
3786
4156
  * Optional. Deprecated. This option is no longer supported.
3787
4157
  */
3788
4158
  disableAttribution?: boolean | null;
@@ -3797,6 +4167,7 @@ export type RetrievalOutput = {
3797
4167
  };
3798
4168
  /**
3799
4169
  * RetrievalConfig
4170
+ *
3800
4171
  * Retrieval config.
3801
4172
  */
3802
4173
  export type RetrievalConfig = {
@@ -3806,28 +4177,33 @@ export type RetrievalConfig = {
3806
4177
  latLng?: LatLng | null;
3807
4178
  /**
3808
4179
  * Languagecode
4180
+ *
3809
4181
  * The language code of the user.
3810
4182
  */
3811
4183
  languageCode?: string | null;
3812
4184
  };
3813
4185
  /**
3814
4186
  * RetrievalMetadata
4187
+ *
3815
4188
  * Metadata related to retrieval in the grounding flow.
3816
4189
  */
3817
4190
  export type RetrievalMetadata = {
3818
4191
  /**
3819
4192
  * Googlesearchdynamicretrievalscore
4193
+ *
3820
4194
  * Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.
3821
4195
  */
3822
4196
  googleSearchDynamicRetrievalScore?: number | null;
3823
4197
  };
3824
4198
  /**
3825
4199
  * Rubric
4200
+ *
3826
4201
  * This class represents a single Rubric.
3827
4202
  */
3828
4203
  export type Rubric = {
3829
4204
  /**
3830
4205
  * Rubricid
4206
+ *
3831
4207
  * Unique identifier for the rubric.
3832
4208
  */
3833
4209
  rubricId: string;
@@ -3837,11 +4213,13 @@ export type Rubric = {
3837
4213
  rubricContent: RubricContent;
3838
4214
  /**
3839
4215
  * Description
4216
+ *
3840
4217
  * A description of the rubric that provide details on how the results of the rubric assessment be interpreted.
3841
4218
  */
3842
4219
  description?: string | null;
3843
4220
  /**
3844
4221
  * Type
4222
+ *
3845
4223
  * Optional. A type designator for the rubric, which can
3846
4224
  * inform how it's evaluated or interpreted by systems or users.
3847
4225
  *
@@ -3855,32 +4233,38 @@ export type Rubric = {
3855
4233
  };
3856
4234
  /**
3857
4235
  * RubricContent
4236
+ *
3858
4237
  * The content of a rubric.
3859
4238
  */
3860
4239
  export type RubricContent = {
3861
4240
  /**
3862
4241
  * Textproperty
4242
+ *
3863
4243
  * The property being evaluated. Example: "The agent's response is grammatically correct."
3864
4244
  */
3865
4245
  textProperty: string | null;
3866
4246
  };
3867
4247
  /**
3868
4248
  * RubricScore
4249
+ *
3869
4250
  * The score obtained after applying the rubric to the Agent's response.
3870
4251
  */
3871
4252
  export type RubricScore = {
3872
4253
  /**
3873
4254
  * Rubricid
4255
+ *
3874
4256
  * The id of the rubric that was assessed.
3875
4257
  */
3876
4258
  rubricId: string;
3877
4259
  /**
3878
4260
  * Rationale
4261
+ *
3879
4262
  * Reasoning/rationale for the score.
3880
4263
  */
3881
4264
  rationale?: string | null;
3882
4265
  /**
3883
4266
  * Score
4267
+ *
3884
4268
  * Score obtained after assessing the rubric. Optional, as assessment might not have happened.
3885
4269
  */
3886
4270
  score?: number | null;
@@ -3919,12 +4303,15 @@ export type RunAgentRequest = {
3919
4303
  export type RunEvalRequest = {
3920
4304
  /**
3921
4305
  * Evalids
4306
+ *
3922
4307
  * This field is deprecated, use eval_case_ids instead.
4308
+ *
3923
4309
  * @deprecated
3924
4310
  */
3925
4311
  evalIds?: Array<string>;
3926
4312
  /**
3927
4313
  * Evalcaseids
4314
+ *
3928
4315
  * List of eval case ids to evaluate. if empty, then all eval cases in the eval set are run.
3929
4316
  */
3930
4317
  evalCaseIds?: Array<string>;
@@ -3961,7 +4348,9 @@ export type RunEvalResult = {
3961
4348
  finalEvalStatus: EvalStatus;
3962
4349
  /**
3963
4350
  * Evalmetricresults
4351
+ *
3964
4352
  * This field is deprecated, use overall_eval_metric_results instead.
4353
+ *
3965
4354
  * @deprecated
3966
4355
  */
3967
4356
  evalMetricResults?: Array<[EvalMetricOutput, EvalMetricResult]>;
@@ -3984,6 +4373,7 @@ export type RunEvalResult = {
3984
4373
  };
3985
4374
  /**
3986
4375
  * SafetySetting
4376
+ *
3987
4377
  * Safety settings.
3988
4378
  */
3989
4379
  export type SafetySetting = {
@@ -4003,27 +4393,32 @@ export type SafetySetting = {
4003
4393
  };
4004
4394
  /**
4005
4395
  * SandboxStatusInfo
4396
+ *
4006
4397
  * 沙盒状态信息
4007
4398
  */
4008
4399
  export type SandboxStatusInfo = {
4009
4400
  /**
4010
4401
  * Sandboxid
4402
+ *
4011
4403
  * 沙盒唯一标识符
4012
4404
  */
4013
4405
  sandboxId: string;
4014
4406
  /**
4015
4407
  * Status
4408
+ *
4016
4409
  * 沙盒状态
4017
4410
  */
4018
4411
  status: string;
4019
4412
  /**
4020
4413
  * Error
4414
+ *
4021
4415
  * 错误信息
4022
4416
  */
4023
4417
  error?: string | null;
4024
4418
  };
4025
4419
  /**
4026
4420
  * Schema
4421
+ *
4027
4422
  * Schema is used to define the format of input/output data.
4028
4423
  *
4029
4424
  * Represents a select subset of an [OpenAPI 3.0 schema
@@ -4033,11 +4428,13 @@ export type SandboxStatusInfo = {
4033
4428
  export type SchemaInput = {
4034
4429
  /**
4035
4430
  * Additionalproperties
4431
+ *
4036
4432
  * Optional. Can either be a boolean or an object; controls the presence of additional properties.
4037
4433
  */
4038
4434
  additionalProperties?: unknown | null;
4039
4435
  /**
4040
4436
  * Defs
4437
+ *
4041
4438
  * Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
4042
4439
  */
4043
4440
  defs?: {
@@ -4045,36 +4442,43 @@ export type SchemaInput = {
4045
4442
  } | null;
4046
4443
  /**
4047
4444
  * Ref
4445
+ *
4048
4446
  * Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
4049
4447
  */
4050
4448
  ref?: string | null;
4051
4449
  /**
4052
4450
  * Anyof
4451
+ *
4053
4452
  * Optional. The value should be validated against any (one or more) of the subschemas in the list.
4054
4453
  */
4055
4454
  anyOf?: Array<SchemaInput> | null;
4056
4455
  /**
4057
4456
  * Default
4457
+ *
4058
4458
  * Optional. Default value of the data.
4059
4459
  */
4060
4460
  default?: unknown | null;
4061
4461
  /**
4062
4462
  * Description
4463
+ *
4063
4464
  * Optional. The description of the data.
4064
4465
  */
4065
4466
  description?: string | null;
4066
4467
  /**
4067
4468
  * Enum
4469
+ *
4068
4470
  * Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
4069
4471
  */
4070
4472
  enum?: Array<string> | null;
4071
4473
  /**
4072
4474
  * Example
4475
+ *
4073
4476
  * Optional. Example of the object. Will only populated when the object is the root.
4074
4477
  */
4075
4478
  example?: unknown | null;
4076
4479
  /**
4077
4480
  * Format
4481
+ *
4078
4482
  * Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
4079
4483
  */
4080
4484
  format?: string | null;
@@ -4084,56 +4488,67 @@ export type SchemaInput = {
4084
4488
  items?: SchemaInput | null;
4085
4489
  /**
4086
4490
  * Maxitems
4491
+ *
4087
4492
  * Optional. Maximum number of the elements for Type.ARRAY.
4088
4493
  */
4089
4494
  maxItems?: number | null;
4090
4495
  /**
4091
4496
  * Maxlength
4497
+ *
4092
4498
  * Optional. Maximum length of the Type.STRING
4093
4499
  */
4094
4500
  maxLength?: number | null;
4095
4501
  /**
4096
4502
  * Maxproperties
4503
+ *
4097
4504
  * Optional. Maximum number of the properties for Type.OBJECT.
4098
4505
  */
4099
4506
  maxProperties?: number | null;
4100
4507
  /**
4101
4508
  * Maximum
4509
+ *
4102
4510
  * Optional. Maximum value of the Type.INTEGER and Type.NUMBER
4103
4511
  */
4104
4512
  maximum?: number | null;
4105
4513
  /**
4106
4514
  * Minitems
4515
+ *
4107
4516
  * Optional. Minimum number of the elements for Type.ARRAY.
4108
4517
  */
4109
4518
  minItems?: number | null;
4110
4519
  /**
4111
4520
  * Minlength
4521
+ *
4112
4522
  * Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
4113
4523
  */
4114
4524
  minLength?: number | null;
4115
4525
  /**
4116
4526
  * Minproperties
4527
+ *
4117
4528
  * Optional. Minimum number of the properties for Type.OBJECT.
4118
4529
  */
4119
4530
  minProperties?: number | null;
4120
4531
  /**
4121
4532
  * Minimum
4533
+ *
4122
4534
  * Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
4123
4535
  */
4124
4536
  minimum?: number | null;
4125
4537
  /**
4126
4538
  * Nullable
4539
+ *
4127
4540
  * Optional. Indicates if the value may be null.
4128
4541
  */
4129
4542
  nullable?: boolean | null;
4130
4543
  /**
4131
4544
  * Pattern
4545
+ *
4132
4546
  * Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
4133
4547
  */
4134
4548
  pattern?: string | null;
4135
4549
  /**
4136
4550
  * Properties
4551
+ *
4137
4552
  * Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
4138
4553
  */
4139
4554
  properties?: {
@@ -4141,16 +4556,19 @@ export type SchemaInput = {
4141
4556
  } | null;
4142
4557
  /**
4143
4558
  * Propertyordering
4559
+ *
4144
4560
  * Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
4145
4561
  */
4146
4562
  propertyOrdering?: Array<string> | null;
4147
4563
  /**
4148
4564
  * Required
4565
+ *
4149
4566
  * Optional. Required properties of Type.OBJECT.
4150
4567
  */
4151
4568
  required?: Array<string> | null;
4152
4569
  /**
4153
4570
  * Title
4571
+ *
4154
4572
  * Optional. The title of the Schema.
4155
4573
  */
4156
4574
  title?: string | null;
@@ -4161,6 +4579,7 @@ export type SchemaInput = {
4161
4579
  };
4162
4580
  /**
4163
4581
  * Schema
4582
+ *
4164
4583
  * Schema is used to define the format of input/output data.
4165
4584
  *
4166
4585
  * Represents a select subset of an [OpenAPI 3.0 schema
@@ -4170,11 +4589,13 @@ export type SchemaInput = {
4170
4589
  export type SchemaOutput = {
4171
4590
  /**
4172
4591
  * Additionalproperties
4592
+ *
4173
4593
  * Optional. Can either be a boolean or an object; controls the presence of additional properties.
4174
4594
  */
4175
4595
  additionalProperties?: unknown | null;
4176
4596
  /**
4177
4597
  * Defs
4598
+ *
4178
4599
  * Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
4179
4600
  */
4180
4601
  defs?: {
@@ -4182,36 +4603,43 @@ export type SchemaOutput = {
4182
4603
  } | null;
4183
4604
  /**
4184
4605
  * Ref
4606
+ *
4185
4607
  * Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
4186
4608
  */
4187
4609
  ref?: string | null;
4188
4610
  /**
4189
4611
  * Anyof
4612
+ *
4190
4613
  * Optional. The value should be validated against any (one or more) of the subschemas in the list.
4191
4614
  */
4192
4615
  anyOf?: Array<SchemaOutput> | null;
4193
4616
  /**
4194
4617
  * Default
4618
+ *
4195
4619
  * Optional. Default value of the data.
4196
4620
  */
4197
4621
  default?: unknown | null;
4198
4622
  /**
4199
4623
  * Description
4624
+ *
4200
4625
  * Optional. The description of the data.
4201
4626
  */
4202
4627
  description?: string | null;
4203
4628
  /**
4204
4629
  * Enum
4630
+ *
4205
4631
  * Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
4206
4632
  */
4207
4633
  enum?: Array<string> | null;
4208
4634
  /**
4209
4635
  * Example
4636
+ *
4210
4637
  * Optional. Example of the object. Will only populated when the object is the root.
4211
4638
  */
4212
4639
  example?: unknown | null;
4213
4640
  /**
4214
4641
  * Format
4642
+ *
4215
4643
  * Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
4216
4644
  */
4217
4645
  format?: string | null;
@@ -4221,56 +4649,67 @@ export type SchemaOutput = {
4221
4649
  items?: SchemaOutput | null;
4222
4650
  /**
4223
4651
  * Maxitems
4652
+ *
4224
4653
  * Optional. Maximum number of the elements for Type.ARRAY.
4225
4654
  */
4226
4655
  maxItems?: number | null;
4227
4656
  /**
4228
4657
  * Maxlength
4658
+ *
4229
4659
  * Optional. Maximum length of the Type.STRING
4230
4660
  */
4231
4661
  maxLength?: number | null;
4232
4662
  /**
4233
4663
  * Maxproperties
4664
+ *
4234
4665
  * Optional. Maximum number of the properties for Type.OBJECT.
4235
4666
  */
4236
4667
  maxProperties?: number | null;
4237
4668
  /**
4238
4669
  * Maximum
4670
+ *
4239
4671
  * Optional. Maximum value of the Type.INTEGER and Type.NUMBER
4240
4672
  */
4241
4673
  maximum?: number | null;
4242
4674
  /**
4243
4675
  * Minitems
4676
+ *
4244
4677
  * Optional. Minimum number of the elements for Type.ARRAY.
4245
4678
  */
4246
4679
  minItems?: number | null;
4247
4680
  /**
4248
4681
  * Minlength
4682
+ *
4249
4683
  * Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
4250
4684
  */
4251
4685
  minLength?: number | null;
4252
4686
  /**
4253
4687
  * Minproperties
4688
+ *
4254
4689
  * Optional. Minimum number of the properties for Type.OBJECT.
4255
4690
  */
4256
4691
  minProperties?: number | null;
4257
4692
  /**
4258
4693
  * Minimum
4694
+ *
4259
4695
  * Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
4260
4696
  */
4261
4697
  minimum?: number | null;
4262
4698
  /**
4263
4699
  * Nullable
4700
+ *
4264
4701
  * Optional. Indicates if the value may be null.
4265
4702
  */
4266
4703
  nullable?: boolean | null;
4267
4704
  /**
4268
4705
  * Pattern
4706
+ *
4269
4707
  * Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
4270
4708
  */
4271
4709
  pattern?: string | null;
4272
4710
  /**
4273
4711
  * Properties
4712
+ *
4274
4713
  * Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
4275
4714
  */
4276
4715
  properties?: {
@@ -4278,16 +4717,19 @@ export type SchemaOutput = {
4278
4717
  } | null;
4279
4718
  /**
4280
4719
  * Propertyordering
4720
+ *
4281
4721
  * Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
4282
4722
  */
4283
4723
  propertyOrdering?: Array<string> | null;
4284
4724
  /**
4285
4725
  * Required
4726
+ *
4286
4727
  * Optional. Required properties of Type.OBJECT.
4287
4728
  */
4288
4729
  required?: Array<string> | null;
4289
4730
  /**
4290
4731
  * Title
4732
+ *
4291
4733
  * Optional. The title of the Schema.
4292
4734
  */
4293
4735
  title?: string | null;
@@ -4298,16 +4740,19 @@ export type SchemaOutput = {
4298
4740
  };
4299
4741
  /**
4300
4742
  * SearchEntryPoint
4743
+ *
4301
4744
  * Google search entry point.
4302
4745
  */
4303
4746
  export type SearchEntryPoint = {
4304
4747
  /**
4305
4748
  * Renderedcontent
4749
+ *
4306
4750
  * Optional. Web content snippet that can be embedded in a web page or an app webview.
4307
4751
  */
4308
4752
  renderedContent?: string | null;
4309
4753
  /**
4310
4754
  * Sdkblob
4755
+ *
4311
4756
  * Optional. Base64 encoded JSON representing array of tuple.
4312
4757
  */
4313
4758
  sdkBlob?: string | null;
@@ -4327,32 +4772,38 @@ export declare const SecuritySchemeType: {
4327
4772
  export type SecuritySchemeType = (typeof SecuritySchemeType)[keyof typeof SecuritySchemeType];
4328
4773
  /**
4329
4774
  * Segment
4775
+ *
4330
4776
  * Segment of the content.
4331
4777
  */
4332
4778
  export type Segment = {
4333
4779
  /**
4334
4780
  * Endindex
4781
+ *
4335
4782
  * Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
4336
4783
  */
4337
4784
  endIndex?: number | null;
4338
4785
  /**
4339
4786
  * Partindex
4787
+ *
4340
4788
  * Output only. The index of a Part object within its parent Content object.
4341
4789
  */
4342
4790
  partIndex?: number | null;
4343
4791
  /**
4344
4792
  * Startindex
4793
+ *
4345
4794
  * Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
4346
4795
  */
4347
4796
  startIndex?: number | null;
4348
4797
  /**
4349
4798
  * Text
4799
+ *
4350
4800
  * Output only. The text corresponding to the segment from the response.
4351
4801
  */
4352
4802
  text?: string | null;
4353
4803
  };
4354
4804
  /**
4355
4805
  * ServiceAccount
4806
+ *
4356
4807
  * Represents Google Service Account configuration.
4357
4808
  */
4358
4809
  export type ServiceAccount = {
@@ -4369,6 +4820,7 @@ export type ServiceAccount = {
4369
4820
  };
4370
4821
  /**
4371
4822
  * ServiceAccountCredential
4823
+ *
4372
4824
  * Represents Google Service Account configuration.
4373
4825
  *
4374
4826
  * Attributes:
@@ -4454,6 +4906,7 @@ export type ServiceAccountCredential = {
4454
4906
  };
4455
4907
  /**
4456
4908
  * Session
4909
+ *
4457
4910
  * Represents a series of interactions between a user and agents.
4458
4911
  */
4459
4912
  export type Session = {
@@ -4486,6 +4939,7 @@ export type Session = {
4486
4939
  };
4487
4940
  /**
4488
4941
  * SessionInput
4942
+ *
4489
4943
  * Values that help initialize a Session.
4490
4944
  */
4491
4945
  export type SessionInput = {
@@ -4506,11 +4960,13 @@ export type SessionInput = {
4506
4960
  };
4507
4961
  /**
4508
4962
  * SpeakerVoiceConfig
4963
+ *
4509
4964
  * The configuration for the speaker to use.
4510
4965
  */
4511
4966
  export type SpeakerVoiceConfigInput = {
4512
4967
  /**
4513
4968
  * Speaker
4969
+ *
4514
4970
  * The name of the speaker to use. Should be the same as in the
4515
4971
  * prompt.
4516
4972
  */
@@ -4522,11 +4978,13 @@ export type SpeakerVoiceConfigInput = {
4522
4978
  };
4523
4979
  /**
4524
4980
  * SpeakerVoiceConfig
4981
+ *
4525
4982
  * The configuration for the speaker to use.
4526
4983
  */
4527
4984
  export type SpeakerVoiceConfigOutput = {
4528
4985
  /**
4529
4986
  * Speaker
4987
+ *
4530
4988
  * The name of the speaker to use. Should be the same as in the
4531
4989
  * prompt.
4532
4990
  */
@@ -4538,6 +4996,7 @@ export type SpeakerVoiceConfigOutput = {
4538
4996
  };
4539
4997
  /**
4540
4998
  * SpeechConfig
4999
+ *
4541
5000
  * The speech generation configuration.
4542
5001
  */
4543
5002
  export type SpeechConfigInput = {
@@ -4554,6 +5013,7 @@ export type SpeechConfigInput = {
4554
5013
  multiSpeakerVoiceConfig?: MultiSpeakerVoiceConfigInput | null;
4555
5014
  /**
4556
5015
  * Languagecode
5016
+ *
4557
5017
  * Language code (ISO 639. e.g. en-US) for the speech synthesization.
4558
5018
  * Only available for Live API.
4559
5019
  *
@@ -4562,6 +5022,7 @@ export type SpeechConfigInput = {
4562
5022
  };
4563
5023
  /**
4564
5024
  * SpeechConfig
5025
+ *
4565
5026
  * The speech generation configuration.
4566
5027
  */
4567
5028
  export type SpeechConfigOutput = {
@@ -4578,6 +5039,7 @@ export type SpeechConfigOutput = {
4578
5039
  multiSpeakerVoiceConfig?: MultiSpeakerVoiceConfigOutput | null;
4579
5040
  /**
4580
5041
  * Languagecode
5042
+ *
4581
5043
  * Language code (ISO 639. e.g. en-US) for the speech synthesization.
4582
5044
  * Only available for Live API.
4583
5045
  *
@@ -4586,49 +5048,58 @@ export type SpeechConfigOutput = {
4586
5048
  };
4587
5049
  /**
4588
5050
  * StartNapcatRequest
5051
+ *
4589
5052
  * 启动Napcat沙盒请求模型
4590
5053
  */
4591
5054
  export type StartNapcatRequest = {
4592
5055
  /**
4593
5056
  * Sandbox Type
5057
+ *
4594
5058
  * 沙盒类型
4595
5059
  */
4596
5060
  sandbox_type: string;
4597
5061
  /**
4598
5062
  * Sandboxid
5063
+ *
4599
5064
  * 沙盒唯一标识符
4600
5065
  */
4601
5066
  sandboxId: string;
4602
5067
  };
4603
5068
  /**
4604
5069
  * StartNapcatResponse
5070
+ *
4605
5071
  * 启动Napcat沙盒响应模型
4606
5072
  */
4607
5073
  export type StartNapcatResponse = {
4608
5074
  /**
4609
5075
  * Sandboxid
5076
+ *
4610
5077
  * 沙盒唯一标识符
4611
5078
  */
4612
5079
  sandboxId: string;
4613
5080
  /**
4614
5081
  * Error
5082
+ *
4615
5083
  * 错误信息,成功时为None
4616
5084
  */
4617
5085
  error?: string | null;
4618
5086
  };
4619
5087
  /**
4620
5088
  * ThinkingConfig
5089
+ *
4621
5090
  * The thinking features configuration.
4622
5091
  */
4623
5092
  export type ThinkingConfig = {
4624
5093
  /**
4625
5094
  * Includethoughts
5095
+ *
4626
5096
  * Indicates whether to include thoughts in the response. If true, thoughts are returned only if the model supports thought and thoughts are available.
4627
5097
  *
4628
5098
  */
4629
5099
  includeThoughts?: boolean | null;
4630
5100
  /**
4631
5101
  * Thinkingbudget
5102
+ *
4632
5103
  * Indicates the thinking budget in tokens. 0 is DISABLED. -1 is AUTOMATIC. The default values and allowed ranges are model dependent.
4633
5104
  *
4634
5105
  */
@@ -4636,6 +5107,7 @@ export type ThinkingConfig = {
4636
5107
  };
4637
5108
  /**
4638
5109
  * ToolAnnotations
5110
+ *
4639
5111
  * Additional properties describing a Tool to clients.
4640
5112
  *
4641
5113
  * NOTE: all properties in ToolAnnotations are **hints**.
@@ -4670,6 +5142,7 @@ export type ToolAnnotations = {
4670
5142
  };
4671
5143
  /**
4672
5144
  * ToolCodeExecution
5145
+ *
4673
5146
  * Tool that executes code generated by the model, and automatically returns the result to the model.
4674
5147
  *
4675
5148
  * See also [ExecutableCode]and [CodeExecutionResult] which are input and output
@@ -4680,6 +5153,7 @@ export type ToolCodeExecution = {
4680
5153
  };
4681
5154
  /**
4682
5155
  * ToolConfig
5156
+ *
4683
5157
  * Tool config.
4684
5158
  *
4685
5159
  * This config is shared for all tools provided in the request.
@@ -4696,6 +5170,7 @@ export type ToolConfigInput = {
4696
5170
  };
4697
5171
  /**
4698
5172
  * ToolConfig
5173
+ *
4699
5174
  * Tool config.
4700
5175
  *
4701
5176
  * This config is shared for all tools provided in the request.
@@ -4712,6 +5187,7 @@ export type ToolConfigOutput = {
4712
5187
  };
4713
5188
  /**
4714
5189
  * ToolConfirmation
5190
+ *
4715
5191
  * Represents a tool confirmation configuration.
4716
5192
  */
4717
5193
  export type ToolConfirmation = {
@@ -4730,6 +5206,7 @@ export type ToolConfirmation = {
4730
5206
  };
4731
5207
  /**
4732
5208
  * TrafficType
5209
+ *
4733
5210
  * Output only.
4734
5211
  *
4735
5212
  * Traffic type. This shows whether a request consumes Pay-As-You-Go or
@@ -4742,6 +5219,7 @@ export declare const TrafficType: {
4742
5219
  };
4743
5220
  /**
4744
5221
  * TrafficType
5222
+ *
4745
5223
  * Output only.
4746
5224
  *
4747
5225
  * Traffic type. This shows whether a request consumes Pay-As-You-Go or
@@ -4750,17 +5228,20 @@ export declare const TrafficType: {
4750
5228
  export type TrafficType = (typeof TrafficType)[keyof typeof TrafficType];
4751
5229
  /**
4752
5230
  * Transcription
5231
+ *
4753
5232
  * Audio transcription in Server Conent.
4754
5233
  */
4755
5234
  export type Transcription = {
4756
5235
  /**
4757
5236
  * Text
5237
+ *
4758
5238
  * Transcription text.
4759
5239
  *
4760
5240
  */
4761
5241
  text?: string | null;
4762
5242
  /**
4763
5243
  * Finished
5244
+ *
4764
5245
  * The bool indicates the end of the transcription.
4765
5246
  *
4766
5247
  */
@@ -4768,6 +5249,7 @@ export type Transcription = {
4768
5249
  };
4769
5250
  /**
4770
5251
  * Type
5252
+ *
4771
5253
  * Optional. The type of the data.
4772
5254
  */
4773
5255
  export declare const Type: {
@@ -4782,11 +5264,13 @@ export declare const Type: {
4782
5264
  };
4783
5265
  /**
4784
5266
  * Type
5267
+ *
4785
5268
  * Optional. The type of the data.
4786
5269
  */
4787
5270
  export type Type = (typeof Type)[keyof typeof Type];
4788
5271
  /**
4789
5272
  * UrlContext
5273
+ *
4790
5274
  * Tool to support URL context retrieval.
4791
5275
  */
4792
5276
  export type UrlContext = {
@@ -4811,6 +5295,7 @@ export type ValidationError = {
4811
5295
  };
4812
5296
  /**
4813
5297
  * VertexAISearch
5298
+ *
4814
5299
  * Retrieve from Vertex AI Search datastore or engine for grounding.
4815
5300
  *
4816
5301
  * datastore and engine are mutually exclusive. See
@@ -4819,32 +5304,38 @@ export type ValidationError = {
4819
5304
  export type VertexAiSearch = {
4820
5305
  /**
4821
5306
  * Datastorespecs
5307
+ *
4822
5308
  * Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
4823
5309
  */
4824
5310
  dataStoreSpecs?: Array<VertexAiSearchDataStoreSpec> | null;
4825
5311
  /**
4826
5312
  * Datastore
5313
+ *
4827
5314
  * Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
4828
5315
  */
4829
5316
  datastore?: string | null;
4830
5317
  /**
4831
5318
  * Engine
5319
+ *
4832
5320
  * Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
4833
5321
  */
4834
5322
  engine?: string | null;
4835
5323
  /**
4836
5324
  * Filter
5325
+ *
4837
5326
  * Optional. Filter strings to be passed to the search API.
4838
5327
  */
4839
5328
  filter?: string | null;
4840
5329
  /**
4841
5330
  * Maxresults
5331
+ *
4842
5332
  * Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
4843
5333
  */
4844
5334
  maxResults?: number | null;
4845
5335
  };
4846
5336
  /**
4847
5337
  * VertexAISearchDataStoreSpec
5338
+ *
4848
5339
  * Define data stores within engine to filter on in a search call and configurations for those data stores.
4849
5340
  *
4850
5341
  * For more information, see
@@ -4853,27 +5344,32 @@ export type VertexAiSearch = {
4853
5344
  export type VertexAiSearchDataStoreSpec = {
4854
5345
  /**
4855
5346
  * Datastore
5347
+ *
4856
5348
  * Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
4857
5349
  */
4858
5350
  dataStore?: string | null;
4859
5351
  /**
4860
5352
  * Filter
5353
+ *
4861
5354
  * Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
4862
5355
  */
4863
5356
  filter?: string | null;
4864
5357
  };
4865
5358
  /**
4866
5359
  * VertexRagStore
5360
+ *
4867
5361
  * Retrieve from Vertex RAG Store for grounding.
4868
5362
  */
4869
5363
  export type VertexRagStoreInput = {
4870
5364
  /**
4871
5365
  * Ragcorpora
5366
+ *
4872
5367
  * Optional. Deprecated. Please use rag_resources instead.
4873
5368
  */
4874
5369
  ragCorpora?: Array<string> | null;
4875
5370
  /**
4876
5371
  * Ragresources
5372
+ *
4877
5373
  * Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
4878
5374
  */
4879
5375
  ragResources?: Array<VertexRagStoreRagResource> | null;
@@ -4883,32 +5379,38 @@ export type VertexRagStoreInput = {
4883
5379
  ragRetrievalConfig?: RagRetrievalConfigInput | null;
4884
5380
  /**
4885
5381
  * Similaritytopk
5382
+ *
4886
5383
  * Optional. Number of top k results to return from the selected corpora.
4887
5384
  */
4888
5385
  similarityTopK?: number | null;
4889
5386
  /**
4890
5387
  * Storecontext
5388
+ *
4891
5389
  * Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions.
4892
5390
  */
4893
5391
  storeContext?: boolean | null;
4894
5392
  /**
4895
5393
  * Vectordistancethreshold
5394
+ *
4896
5395
  * Optional. Only return results with vector distance smaller than the threshold.
4897
5396
  */
4898
5397
  vectorDistanceThreshold?: number | null;
4899
5398
  };
4900
5399
  /**
4901
5400
  * VertexRagStore
5401
+ *
4902
5402
  * Retrieve from Vertex RAG Store for grounding.
4903
5403
  */
4904
5404
  export type VertexRagStoreOutput = {
4905
5405
  /**
4906
5406
  * Ragcorpora
5407
+ *
4907
5408
  * Optional. Deprecated. Please use rag_resources instead.
4908
5409
  */
4909
5410
  ragCorpora?: Array<string> | null;
4910
5411
  /**
4911
5412
  * Ragresources
5413
+ *
4912
5414
  * Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
4913
5415
  */
4914
5416
  ragResources?: Array<VertexRagStoreRagResource> | null;
@@ -4918,60 +5420,71 @@ export type VertexRagStoreOutput = {
4918
5420
  ragRetrievalConfig?: RagRetrievalConfigOutput | null;
4919
5421
  /**
4920
5422
  * Similaritytopk
5423
+ *
4921
5424
  * Optional. Number of top k results to return from the selected corpora.
4922
5425
  */
4923
5426
  similarityTopK?: number | null;
4924
5427
  /**
4925
5428
  * Storecontext
5429
+ *
4926
5430
  * Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions.
4927
5431
  */
4928
5432
  storeContext?: boolean | null;
4929
5433
  /**
4930
5434
  * Vectordistancethreshold
5435
+ *
4931
5436
  * Optional. Only return results with vector distance smaller than the threshold.
4932
5437
  */
4933
5438
  vectorDistanceThreshold?: number | null;
4934
5439
  };
4935
5440
  /**
4936
5441
  * VertexRagStoreRagResource
5442
+ *
4937
5443
  * The definition of the Rag resource.
4938
5444
  */
4939
5445
  export type VertexRagStoreRagResource = {
4940
5446
  /**
4941
5447
  * Ragcorpus
5448
+ *
4942
5449
  * Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
4943
5450
  */
4944
5451
  ragCorpus?: string | null;
4945
5452
  /**
4946
5453
  * Ragfileids
5454
+ *
4947
5455
  * Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
4948
5456
  */
4949
5457
  ragFileIds?: Array<string> | null;
4950
5458
  };
4951
5459
  /**
4952
5460
  * VideoMetadata
5461
+ *
4953
5462
  * Describes how the video in the Part should be used by the model.
4954
5463
  */
4955
5464
  export type VideoMetadata = {
4956
5465
  /**
4957
5466
  * Fps
5467
+ *
4958
5468
  * The frame rate of the video sent to the model. If not specified, the
4959
5469
  * default value will be 1.0. The fps range is (0.0, 24.0].
4960
5470
  */
4961
5471
  fps?: number | null;
4962
5472
  /**
4963
5473
  * Endoffset
5474
+ *
4964
5475
  * Optional. The end offset of the video.
4965
5476
  */
4966
5477
  endOffset?: string | null;
4967
5478
  /**
4968
5479
  * Startoffset
5480
+ *
4969
5481
  * Optional. The start offset of the video.
4970
5482
  */
4971
5483
  startOffset?: string | null;
4972
5484
  };
4973
5485
  /**
4974
5486
  * VoiceConfig
5487
+ *
4975
5488
  * The configuration for the voice to use.
4976
5489
  */
4977
5490
  export type VoiceConfig = {
@@ -4983,6 +5496,7 @@ export type VoiceConfig = {
4983
5496
  };
4984
5497
  /**
4985
5498
  * AuthConfig
5499
+ *
4986
5500
  * The auth config sent by tool asking client to collect auth credentials and
4987
5501
  *
4988
5502
  * adk and client will help to fill in the response
@@ -5002,6 +5516,7 @@ export type GoogleAdkAuthAuthToolAuthConfigInput = {
5002
5516
  };
5003
5517
  /**
5004
5518
  * AuthConfig
5519
+ *
5005
5520
  * The auth config sent by tool asking client to collect auth credentials and
5006
5521
  *
5007
5522
  * adk and client will help to fill in the response
@@ -5021,32 +5536,38 @@ export type GoogleAdkAuthAuthToolAuthConfigOutput = {
5021
5536
  };
5022
5537
  /**
5023
5538
  * Interval
5539
+ *
5024
5540
  * Represents a range of numeric values, e.g. [0 ,1] or (2,3) or [-1, 6).
5025
5541
  */
5026
5542
  export type GoogleAdkEvaluationEvalMetricsInterval = {
5027
5543
  /**
5028
5544
  * Minvalue
5545
+ *
5029
5546
  * The smaller end of the interval.
5030
5547
  */
5031
5548
  minValue: number;
5032
5549
  /**
5033
5550
  * Openatmin
5551
+ *
5034
5552
  * The interval is Open on the min end. The default value is False, which means that we assume that the interval is Closed.
5035
5553
  */
5036
5554
  openAtMin?: boolean;
5037
5555
  /**
5038
5556
  * Maxvalue
5557
+ *
5039
5558
  * The larger end of the interval.
5040
5559
  */
5041
5560
  maxValue: number;
5042
5561
  /**
5043
5562
  * Openatmax
5563
+ *
5044
5564
  * The interval is Open on the max end. The default value is False, which means that we assume that the interval is Closed.
5045
5565
  */
5046
5566
  openAtMax?: boolean;
5047
5567
  };
5048
5568
  /**
5049
5569
  * AuthConfig
5570
+ *
5050
5571
  * Auth configuration to run the extension.
5051
5572
  */
5052
5573
  export type GoogleGenaiTypesAuthConfig = {
@@ -5077,6 +5598,7 @@ export type GoogleGenaiTypesAuthConfig = {
5077
5598
  };
5078
5599
  /**
5079
5600
  * Interval
5601
+ *
5080
5602
  * Represents a time interval, encoded as a start time (inclusive) and an end time (exclusive).
5081
5603
  *
5082
5604
  * The start time must be less than or equal to the end time.
@@ -5087,22 +5609,26 @@ export type GoogleGenaiTypesAuthConfig = {
5087
5609
  export type GoogleGenaiTypesInterval = {
5088
5610
  /**
5089
5611
  * Starttime
5612
+ *
5090
5613
  * The start time of the interval.
5091
5614
  */
5092
5615
  startTime?: string | null;
5093
5616
  /**
5094
5617
  * Endtime
5618
+ *
5095
5619
  * The end time of the interval.
5096
5620
  */
5097
5621
  endTime?: string | null;
5098
5622
  };
5099
5623
  /**
5100
5624
  * Tool
5625
+ *
5101
5626
  * Tool details of a tool that the model may use to generate a response.
5102
5627
  */
5103
5628
  export type GoogleGenaiTypesToolInput = {
5104
5629
  /**
5105
5630
  * Functiondeclarations
5631
+ *
5106
5632
  * List of function declarations that the tool supports.
5107
5633
  */
5108
5634
  functionDeclarations?: Array<FunctionDeclarationInput> | null;
@@ -5140,11 +5666,13 @@ export type GoogleGenaiTypesToolInput = {
5140
5666
  };
5141
5667
  /**
5142
5668
  * Tool
5669
+ *
5143
5670
  * Tool details of a tool that the model may use to generate a response.
5144
5671
  */
5145
5672
  export type GoogleGenaiTypesToolOutput = {
5146
5673
  /**
5147
5674
  * Functiondeclarations
5675
+ *
5148
5676
  * List of function declarations that the tool supports.
5149
5677
  */
5150
5678
  functionDeclarations?: Array<FunctionDeclarationOutput> | null;
@@ -5182,6 +5710,7 @@ export type GoogleGenaiTypesToolOutput = {
5182
5710
  };
5183
5711
  /**
5184
5712
  * Tool
5713
+ *
5185
5714
  * Definition for a tool the client can call.
5186
5715
  */
5187
5716
  export type McpTypesTool = {
@@ -5213,6 +5742,7 @@ export type ListAppsData = {
5213
5742
  export type ListAppsResponses = {
5214
5743
  /**
5215
5744
  * Response List Apps
5745
+ *
5216
5746
  * Successful Response
5217
5747
  */
5218
5748
  200: Array<string>;
@@ -5239,6 +5769,7 @@ export type DebugGetTraceDictError = DebugGetTraceDictErrors[keyof DebugGetTrace
5239
5769
  export type DebugGetTraceDictResponses = {
5240
5770
  /**
5241
5771
  * Response Debug-Get Trace Dict
5772
+ *
5242
5773
  * Successful Response
5243
5774
  */
5244
5775
  200: unknown;
@@ -5264,6 +5795,7 @@ export type DebugGetSessionTraceError = DebugGetSessionTraceErrors[keyof DebugGe
5264
5795
  export type DebugGetSessionTraceResponses = {
5265
5796
  /**
5266
5797
  * Response Debug-Get Session Trace
5798
+ *
5267
5799
  * Successful Response
5268
5800
  */
5269
5801
  200: unknown;
@@ -5297,6 +5829,7 @@ export type DeleteSessionError = DeleteSessionErrors[keyof DeleteSessionErrors];
5297
5829
  export type DeleteSessionResponses = {
5298
5830
  /**
5299
5831
  * Response Delete Session
5832
+ *
5300
5833
  * Successful Response
5301
5834
  */
5302
5835
  200: null;
@@ -5398,6 +5931,7 @@ export type ListSessionsError = ListSessionsErrors[keyof ListSessionsErrors];
5398
5931
  export type ListSessionsResponses = {
5399
5932
  /**
5400
5933
  * Response List Sessions
5934
+ *
5401
5935
  * Successful Response
5402
5936
  */
5403
5937
  200: Array<Session>;
@@ -5534,6 +6068,7 @@ export type EvaluationListEvalSetsLegacyError = EvaluationListEvalSetsLegacyErro
5534
6068
  export type EvaluationListEvalSetsLegacyResponses = {
5535
6069
  /**
5536
6070
  * Response Evaluation-List Eval Sets Legacy
6071
+ *
5537
6072
  * Successful Response
5538
6073
  */
5539
6074
  200: Array<string>;
@@ -5592,6 +6127,7 @@ export type EvaluationListEvalsInEvalSetError = EvaluationListEvalsInEvalSetErro
5592
6127
  export type EvaluationListEvalsInEvalSetResponses = {
5593
6128
  /**
5594
6129
  * Response Evaluation-List Evals In Eval Set
6130
+ *
5595
6131
  * Successful Response
5596
6132
  */
5597
6133
  200: Array<string>;
@@ -5626,6 +6162,7 @@ export type EvaluationDeleteEvalError = EvaluationDeleteEvalErrors[keyof Evaluat
5626
6162
  export type EvaluationDeleteEvalResponses = {
5627
6163
  /**
5628
6164
  * Response Evaluation-Delete Eval
6165
+ *
5629
6166
  * Successful Response
5630
6167
  */
5631
6168
  200: null;
@@ -5721,6 +6258,7 @@ export type EvaluationRunEvalLegacyError = EvaluationRunEvalLegacyErrors[keyof E
5721
6258
  export type EvaluationRunEvalLegacyResponses = {
5722
6259
  /**
5723
6260
  * Response Evaluation-Run Eval Legacy
6261
+ *
5724
6262
  * Successful Response
5725
6263
  */
5726
6264
  200: Array<RunEvalResult>;
@@ -5859,6 +6397,7 @@ export type EvaluationListEvalResultsLegacyError = EvaluationListEvalResultsLega
5859
6397
  export type EvaluationListEvalResultsLegacyResponses = {
5860
6398
  /**
5861
6399
  * Response Evaluation-List Eval Results Legacy
6400
+ *
5862
6401
  * Successful Response
5863
6402
  */
5864
6403
  200: Array<string>;
@@ -5922,6 +6461,7 @@ export type DeleteArtifactError = DeleteArtifactErrors[keyof DeleteArtifactError
5922
6461
  export type DeleteArtifactResponses = {
5923
6462
  /**
5924
6463
  * Response Delete Artifact
6464
+ *
5925
6465
  * Successful Response
5926
6466
  */
5927
6467
  200: null;
@@ -5965,6 +6505,7 @@ export type LoadArtifactError = LoadArtifactErrors[keyof LoadArtifactErrors];
5965
6505
  export type LoadArtifactResponses = {
5966
6506
  /**
5967
6507
  * Response Load Artifact
6508
+ *
5968
6509
  * Successful Response
5969
6510
  */
5970
6511
  200: PartOutput | null;
@@ -6007,6 +6548,7 @@ export type LoadArtifactVersionError = LoadArtifactVersionErrors[keyof LoadArtif
6007
6548
  export type LoadArtifactVersionResponses = {
6008
6549
  /**
6009
6550
  * Response Load Artifact Version
6551
+ *
6010
6552
  * Successful Response
6011
6553
  */
6012
6554
  200: PartOutput | null;
@@ -6041,6 +6583,7 @@ export type ListArtifactNamesError = ListArtifactNamesErrors[keyof ListArtifactN
6041
6583
  export type ListArtifactNamesResponses = {
6042
6584
  /**
6043
6585
  * Response List Artifact Names
6586
+ *
6044
6587
  * Successful Response
6045
6588
  */
6046
6589
  200: Array<string>;
@@ -6079,6 +6622,7 @@ export type ListArtifactVersionsError = ListArtifactVersionsErrors[keyof ListArt
6079
6622
  export type ListArtifactVersionsResponses = {
6080
6623
  /**
6081
6624
  * Response List Artifact Versions
6625
+ *
6082
6626
  * Successful Response
6083
6627
  */
6084
6628
  200: Array<number>;
@@ -6100,6 +6644,7 @@ export type RunAgentError = RunAgentErrors[keyof RunAgentErrors];
6100
6644
  export type RunAgentResponses = {
6101
6645
  /**
6102
6646
  * Response Run Agent
6647
+ *
6103
6648
  * Successful Response
6104
6649
  */
6105
6650
  200: Array<EventOutput>;
@@ -6200,6 +6745,7 @@ export type BuilderBuildError = BuilderBuildErrors[keyof BuilderBuildErrors];
6200
6745
  export type BuilderBuildResponses = {
6201
6746
  /**
6202
6747
  * Response Builder Build
6748
+ *
6203
6749
  * Successful Response
6204
6750
  */
6205
6751
  200: boolean;
@@ -6385,6 +6931,7 @@ export type ListItemsError = ListItemsErrors[keyof ListItemsErrors];
6385
6931
  export type ListItemsResponses = {
6386
6932
  /**
6387
6933
  * Response List Items
6934
+ *
6388
6935
  * Successful Response
6389
6936
  */
6390
6937
  200: Array<Item>;
@@ -6490,21 +7037,25 @@ export type SearchItemsData = {
6490
7037
  query?: {
6491
7038
  /**
6492
7039
  * Q
7040
+ *
6493
7041
  * Search query string
6494
7042
  */
6495
7043
  q?: string | null;
6496
7044
  /**
6497
7045
  * Min Price
7046
+ *
6498
7047
  * Minimum price
6499
7048
  */
6500
7049
  min_price?: number | null;
6501
7050
  /**
6502
7051
  * Max Price
7052
+ *
6503
7053
  * Maximum price
6504
7054
  */
6505
7055
  max_price?: number | null;
6506
7056
  /**
6507
7057
  * Tags
7058
+ *
6508
7059
  * Filter by tags
6509
7060
  */
6510
7061
  tags?: Array<string>;
@@ -6521,6 +7072,7 @@ export type SearchItemsError = SearchItemsErrors[keyof SearchItemsErrors];
6521
7072
  export type SearchItemsResponses = {
6522
7073
  /**
6523
7074
  * Response Search Items
7075
+ *
6524
7076
  * Successful Response
6525
7077
  */
6526
7078
  200: Array<Item>;