@maxim_mazurok/gapi.client.discoveryengine-v1 0.3.20260831 → 0.3.20260908
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +90 -7
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260908
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -859,6 +859,9 @@ declare namespace gapi.client {
|
|
|
859
859
|
interface GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig {
|
|
860
860
|
/** Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models. */
|
|
861
861
|
name?: string;
|
|
862
|
+
/** Optional. Sent as Vertex `ThinkingConfig.thinking_level`. */
|
|
863
|
+
thinkingLevel?:
|
|
864
|
+
'THINKING_LEVEL_UNSPECIFIED' | 'MINIMAL' | 'LOW' | 'MEDIUM' | 'HIGH';
|
|
862
865
|
/** Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT. */
|
|
863
866
|
weight?: number;
|
|
864
867
|
}
|
|
@@ -2235,6 +2238,8 @@ declare namespace gapi.client {
|
|
|
2235
2238
|
recommendationMetadata?: GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata;
|
|
2236
2239
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
2237
2240
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig;
|
|
2241
|
+
/** Optional. Non-empty default. Session config for the engine. */
|
|
2242
|
+
sessionConfig?: GoogleCloudDiscoveryengineV1alphaSessionConfig;
|
|
2238
2243
|
/** Additional config specs for a `similar-items` engine. */
|
|
2239
2244
|
similarDocumentsConfig?: any;
|
|
2240
2245
|
/** Required. The solutions of the engine. */
|
|
@@ -3492,6 +3497,19 @@ declare namespace gapi.client {
|
|
|
3492
3497
|
/** A unique identifier for tracking users. */
|
|
3493
3498
|
userPseudoId?: string;
|
|
3494
3499
|
}
|
|
3500
|
+
interface GoogleCloudDiscoveryengineV1alphaSessionConfig {
|
|
3501
|
+
/** Optional. Session management policy that defines who will manage the session. */
|
|
3502
|
+
sessionManagementPolicy?:
|
|
3503
|
+
| 'SESSION_MANAGEMENT_POLICY_UNSPECIFIED'
|
|
3504
|
+
| 'NOT_MANAGED'
|
|
3505
|
+
| 'VERTEX_AI_MANAGED';
|
|
3506
|
+
/** Optional. The TTL for the session. If unset, the default value is 60 days. */
|
|
3507
|
+
sessionTtl?: GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl;
|
|
3508
|
+
}
|
|
3509
|
+
interface GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl {
|
|
3510
|
+
/** Defines the number of days for session TTL. */
|
|
3511
|
+
days?: number;
|
|
3512
|
+
}
|
|
3495
3513
|
interface GoogleCloudDiscoveryengineV1alphaSessionTurn {
|
|
3496
3514
|
/** Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */
|
|
3497
3515
|
answer?: string;
|
|
@@ -4282,6 +4300,8 @@ declare namespace gapi.client {
|
|
|
4282
4300
|
interface GoogleCloudDiscoveryengineV1AssistantCustomerPolicy {
|
|
4283
4301
|
/** Optional. List of banned phrases. */
|
|
4284
4302
|
bannedPhrases?: GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase[];
|
|
4303
|
+
/** Optional. Data protection policy to be used for sanitizing file uploads. */
|
|
4304
|
+
dataProtectionPolicy?: GoogleCloudDiscoveryengineV1DataProtectionPolicy;
|
|
4285
4305
|
/** Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. */
|
|
4286
4306
|
modelArmorConfig?: GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig;
|
|
4287
4307
|
}
|
|
@@ -4689,6 +4709,14 @@ declare namespace gapi.client {
|
|
|
4689
4709
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
4690
4710
|
updateTime?: string;
|
|
4691
4711
|
}
|
|
4712
|
+
interface GoogleCloudDiscoveryengineV1betaDataProtectionPolicy {
|
|
4713
|
+
/** Optional. Specifies the sensitive data protection policy for the connector source. */
|
|
4714
|
+
sensitiveDataProtectionPolicy?: GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy;
|
|
4715
|
+
}
|
|
4716
|
+
interface GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy {
|
|
4717
|
+
/** Optional. Specifies the resource name of the Sensitive Data Protection content policy. */
|
|
4718
|
+
policy?: string;
|
|
4719
|
+
}
|
|
4692
4720
|
interface GoogleCloudDiscoveryengineV1betaDataStore {
|
|
4693
4721
|
/** Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. */
|
|
4694
4722
|
aclEnabled?: boolean;
|
|
@@ -4714,6 +4742,8 @@ declare namespace gapi.client {
|
|
|
4714
4742
|
| 'GOOGLE_WORKSPACE';
|
|
4715
4743
|
/** Output only. Timestamp the DataStore was created at. */
|
|
4716
4744
|
createTime?: string;
|
|
4745
|
+
/** Optional. Specifies the data protection policy for the data store. */
|
|
4746
|
+
dataProtectionPolicy?: GoogleCloudDiscoveryengineV1betaDataProtectionPolicy;
|
|
4717
4747
|
/** Output only. The id of the default Schema associated to this data store. */
|
|
4718
4748
|
defaultSchemaId?: string;
|
|
4719
4749
|
/** Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
@@ -5005,6 +5035,8 @@ declare namespace gapi.client {
|
|
|
5005
5035
|
procurementContactEmails?: string[];
|
|
5006
5036
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
5007
5037
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
|
|
5038
|
+
/** Optional. Non-empty default. Session config for the engine. */
|
|
5039
|
+
sessionConfig?: GoogleCloudDiscoveryengineV1betaSessionConfig;
|
|
5008
5040
|
/** Required. The solutions of the engine. */
|
|
5009
5041
|
solutionType?:
|
|
5010
5042
|
| 'SOLUTION_TYPE_UNSPECIFIED'
|
|
@@ -5904,6 +5936,19 @@ declare namespace gapi.client {
|
|
|
5904
5936
|
/** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
|
|
5905
5937
|
mode?: 'MODE_UNSPECIFIED' | 'SUGGESTION_ONLY' | 'AUTO';
|
|
5906
5938
|
}
|
|
5939
|
+
interface GoogleCloudDiscoveryengineV1betaSessionConfig {
|
|
5940
|
+
/** Optional. Session management policy that defines who will manage the session. */
|
|
5941
|
+
sessionManagementPolicy?:
|
|
5942
|
+
| 'SESSION_MANAGEMENT_POLICY_UNSPECIFIED'
|
|
5943
|
+
| 'NOT_MANAGED'
|
|
5944
|
+
| 'VERTEX_AI_MANAGED';
|
|
5945
|
+
/** Optional. The TTL for the session. If unset, the default value is 60 days. */
|
|
5946
|
+
sessionTtl?: GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl;
|
|
5947
|
+
}
|
|
5948
|
+
interface GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl {
|
|
5949
|
+
/** Defines the number of days for session TTL. */
|
|
5950
|
+
days?: number;
|
|
5951
|
+
}
|
|
5907
5952
|
interface GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata {
|
|
5908
5953
|
/** Operation create time. */
|
|
5909
5954
|
createTime?: string;
|
|
@@ -6650,6 +6695,8 @@ declare namespace gapi.client {
|
|
|
6650
6695
|
createEuaSaas?: boolean;
|
|
6651
6696
|
/** Output only. Timestamp the DataConnector was created at. */
|
|
6652
6697
|
createTime?: string;
|
|
6698
|
+
/** Optional. Specifies the data protection policy for the connector. */
|
|
6699
|
+
dataProtectionPolicy?: GoogleCloudDiscoveryengineV1DataProtectionPolicy;
|
|
6653
6700
|
/** Required. The identifier for the data source. For the full, up-to-date list of supported connectors and their values, see [Connect a third-party data source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage). */
|
|
6654
6701
|
dataSource?: string;
|
|
6655
6702
|
/** Optional. Any target destinations used to connect to third-party services. */
|
|
@@ -6799,6 +6846,14 @@ declare namespace gapi.client {
|
|
|
6799
6846
|
/** Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
|
|
6800
6847
|
startingSchema?: GoogleCloudDiscoveryengineV1Schema;
|
|
6801
6848
|
}
|
|
6849
|
+
interface GoogleCloudDiscoveryengineV1DataProtectionPolicy {
|
|
6850
|
+
/** Optional. Specifies the sensitive data protection policy for the connector source. */
|
|
6851
|
+
sensitiveDataProtectionPolicy?: GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy;
|
|
6852
|
+
}
|
|
6853
|
+
interface GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy {
|
|
6854
|
+
/** Optional. Specifies the resource name of the Sensitive Data Protection content policy. */
|
|
6855
|
+
policy?: string;
|
|
6856
|
+
}
|
|
6802
6857
|
interface GoogleCloudDiscoveryengineV1DataStore {
|
|
6803
6858
|
/** Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. */
|
|
6804
6859
|
aclEnabled?: boolean;
|
|
@@ -6824,6 +6879,8 @@ declare namespace gapi.client {
|
|
|
6824
6879
|
| 'GOOGLE_WORKSPACE';
|
|
6825
6880
|
/** Output only. Timestamp the DataStore was created at. */
|
|
6826
6881
|
createTime?: string;
|
|
6882
|
+
/** Optional. Specifies the data protection policy for the data store. */
|
|
6883
|
+
dataProtectionPolicy?: GoogleCloudDiscoveryengineV1DataProtectionPolicy;
|
|
6827
6884
|
/** Output only. The id of the default Schema associated to this data store. */
|
|
6828
6885
|
defaultSchemaId?: string;
|
|
6829
6886
|
/** Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
@@ -7227,6 +7284,8 @@ declare namespace gapi.client {
|
|
|
7227
7284
|
procurementContactEmails?: string[];
|
|
7228
7285
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
7229
7286
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
|
|
7287
|
+
/** Optional. Non-empty default. Session config for the engine. */
|
|
7288
|
+
sessionConfig?: GoogleCloudDiscoveryengineV1SessionConfig;
|
|
7230
7289
|
/** Required. The solutions of the engine. */
|
|
7231
7290
|
solutionType?:
|
|
7232
7291
|
| 'SOLUTION_TYPE_UNSPECIFIED'
|
|
@@ -8865,6 +8924,19 @@ declare namespace gapi.client {
|
|
|
8865
8924
|
/** A unique identifier for tracking users. */
|
|
8866
8925
|
userPseudoId?: string;
|
|
8867
8926
|
}
|
|
8927
|
+
interface GoogleCloudDiscoveryengineV1SessionConfig {
|
|
8928
|
+
/** Optional. Session management policy that defines who will manage the session. */
|
|
8929
|
+
sessionManagementPolicy?:
|
|
8930
|
+
| 'SESSION_MANAGEMENT_POLICY_UNSPECIFIED'
|
|
8931
|
+
| 'NOT_MANAGED'
|
|
8932
|
+
| 'VERTEX_AI_MANAGED';
|
|
8933
|
+
/** Optional. The TTL for the session. If unset, the default value is 60 days. */
|
|
8934
|
+
sessionTtl?: GoogleCloudDiscoveryengineV1SessionConfigSessionTtl;
|
|
8935
|
+
}
|
|
8936
|
+
interface GoogleCloudDiscoveryengineV1SessionConfigSessionTtl {
|
|
8937
|
+
/** Defines the number of days for session TTL. */
|
|
8938
|
+
days?: number;
|
|
8939
|
+
}
|
|
8868
8940
|
interface GoogleCloudDiscoveryengineV1SessionTurn {
|
|
8869
8941
|
/** Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */
|
|
8870
8942
|
answer?: string;
|
|
@@ -9580,6 +9652,8 @@ declare namespace gapi.client {
|
|
|
9580
9652
|
displayName?: string;
|
|
9581
9653
|
/** Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). */
|
|
9582
9654
|
icon?: string;
|
|
9655
|
+
/** Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. */
|
|
9656
|
+
iconUrl?: string;
|
|
9583
9657
|
/** Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. */
|
|
9584
9658
|
isPreview?: boolean;
|
|
9585
9659
|
/** Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label. */
|
|
@@ -13599,9 +13673,12 @@ declare namespace gapi.client {
|
|
|
13599
13673
|
key?: string;
|
|
13600
13674
|
/** Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English). */
|
|
13601
13675
|
languageCode?: string;
|
|
13602
|
-
/** Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `
|
|
13676
|
+
/** Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector. */
|
|
13603
13677
|
modelInfoView?:
|
|
13604
|
-
|
|
13678
|
+
| 'MODEL_INFO_VIEW_UNSPECIFIED'
|
|
13679
|
+
| 'END_USER_WEB'
|
|
13680
|
+
| 'ADMIN'
|
|
13681
|
+
| 'END_USER_MOBILE';
|
|
13605
13682
|
/** Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}` */
|
|
13606
13683
|
name: string;
|
|
13607
13684
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -16273,9 +16350,12 @@ declare namespace gapi.client {
|
|
|
16273
16350
|
key?: string;
|
|
16274
16351
|
/** Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English). */
|
|
16275
16352
|
languageCode?: string;
|
|
16276
|
-
/** Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `
|
|
16353
|
+
/** Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector. */
|
|
16277
16354
|
modelInfoView?:
|
|
16278
|
-
|
|
16355
|
+
| 'MODEL_INFO_VIEW_UNSPECIFIED'
|
|
16356
|
+
| 'END_USER_WEB'
|
|
16357
|
+
| 'ADMIN'
|
|
16358
|
+
| 'END_USER_MOBILE';
|
|
16279
16359
|
/** Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}` */
|
|
16280
16360
|
name: string;
|
|
16281
16361
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -20022,9 +20102,12 @@ declare namespace gapi.client {
|
|
|
20022
20102
|
key?: string;
|
|
20023
20103
|
/** Optional. BCP-47 language tag (e.g. "en", "fr-CA"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English). */
|
|
20024
20104
|
languageCode?: string;
|
|
20025
|
-
/** Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `
|
|
20105
|
+
/** Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `ADMIN` is set by the Cloud Console admin "Feature Management" page (screen/4Vn9gQKbN8tb7gm) to receive the admin-surfaced model set with `ResolvedModel.admin_view` populated; `END_USER_MOBILE` is set by the Gemini Enterprise mobile app to receive the mobile model set; unset / `END_USER_WEB` returns the end-user web selector. */
|
|
20026
20106
|
modelInfoView?:
|
|
20027
|
-
|
|
20107
|
+
| 'MODEL_INFO_VIEW_UNSPECIFIED'
|
|
20108
|
+
| 'END_USER_WEB'
|
|
20109
|
+
| 'ADMIN'
|
|
20110
|
+
| 'END_USER_MOBILE';
|
|
20028
20111
|
/** Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}` */
|
|
20029
20112
|
name: string;
|
|
20030
20113
|
/** OAuth 2.0 token for the current user. */
|