@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.3.20260831 → 0.3.20260914
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=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260914
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -632,6 +632,9 @@ declare namespace gapi.client {
|
|
|
632
632
|
interface GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig {
|
|
633
633
|
/** Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models. */
|
|
634
634
|
name?: string;
|
|
635
|
+
/** Optional. Sent as Vertex `ThinkingConfig.thinking_level`. */
|
|
636
|
+
thinkingLevel?:
|
|
637
|
+
'THINKING_LEVEL_UNSPECIFIED' | 'MINIMAL' | 'LOW' | 'MEDIUM' | 'HIGH';
|
|
635
638
|
/** 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. */
|
|
636
639
|
weight?: number;
|
|
637
640
|
}
|
|
@@ -3023,6 +3026,8 @@ declare namespace gapi.client {
|
|
|
3023
3026
|
recommendationMetadata?: GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata;
|
|
3024
3027
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
3025
3028
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig;
|
|
3029
|
+
/** Optional. Non-empty default. Session config for the engine. */
|
|
3030
|
+
sessionConfig?: GoogleCloudDiscoveryengineV1alphaSessionConfig;
|
|
3026
3031
|
/** Additional config specs for a `similar-items` engine. */
|
|
3027
3032
|
similarDocumentsConfig?: any;
|
|
3028
3033
|
/** Required. The solutions of the engine. */
|
|
@@ -5603,6 +5608,19 @@ declare namespace gapi.client {
|
|
|
5603
5608
|
/** A unique identifier for tracking users. */
|
|
5604
5609
|
userPseudoId?: string;
|
|
5605
5610
|
}
|
|
5611
|
+
interface GoogleCloudDiscoveryengineV1alphaSessionConfig {
|
|
5612
|
+
/** Optional. Session management policy that defines who will manage the session. */
|
|
5613
|
+
sessionManagementPolicy?:
|
|
5614
|
+
| 'SESSION_MANAGEMENT_POLICY_UNSPECIFIED'
|
|
5615
|
+
| 'NOT_MANAGED'
|
|
5616
|
+
| 'VERTEX_AI_MANAGED';
|
|
5617
|
+
/** Optional. The TTL for the session. If unset, the default value is 60 days. */
|
|
5618
|
+
sessionTtl?: GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl;
|
|
5619
|
+
}
|
|
5620
|
+
interface GoogleCloudDiscoveryengineV1alphaSessionConfigSessionTtl {
|
|
5621
|
+
/** Defines the number of days for session TTL. */
|
|
5622
|
+
days?: number;
|
|
5623
|
+
}
|
|
5606
5624
|
interface GoogleCloudDiscoveryengineV1alphaSessionTurn {
|
|
5607
5625
|
/** Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */
|
|
5608
5626
|
answer?: string;
|
|
@@ -6449,6 +6467,8 @@ declare namespace gapi.client {
|
|
|
6449
6467
|
displayName?: string;
|
|
6450
6468
|
/** Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). */
|
|
6451
6469
|
icon?: string;
|
|
6470
|
+
/** 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. */
|
|
6471
|
+
iconUrl?: string;
|
|
6452
6472
|
/** Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. */
|
|
6453
6473
|
isPreview?: boolean;
|
|
6454
6474
|
/** 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. */
|
|
@@ -6553,6 +6573,8 @@ declare namespace gapi.client {
|
|
|
6553
6573
|
interface GoogleCloudDiscoveryengineV1AssistantCustomerPolicy {
|
|
6554
6574
|
/** Optional. List of banned phrases. */
|
|
6555
6575
|
bannedPhrases?: GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase[];
|
|
6576
|
+
/** Optional. Data protection policy to be used for sanitizing file uploads. */
|
|
6577
|
+
dataProtectionPolicy?: GoogleCloudDiscoveryengineV1DataProtectionPolicy;
|
|
6556
6578
|
/** Optional. Model Armor configuration to be used for sanitizing user prompts and assistant responses. */
|
|
6557
6579
|
modelArmorConfig?: GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig;
|
|
6558
6580
|
}
|
|
@@ -6857,6 +6879,14 @@ declare namespace gapi.client {
|
|
|
6857
6879
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
6858
6880
|
updateTime?: string;
|
|
6859
6881
|
}
|
|
6882
|
+
interface GoogleCloudDiscoveryengineV1betaDataProtectionPolicy {
|
|
6883
|
+
/** Optional. Specifies the sensitive data protection policy for the connector source. */
|
|
6884
|
+
sensitiveDataProtectionPolicy?: GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy;
|
|
6885
|
+
}
|
|
6886
|
+
interface GoogleCloudDiscoveryengineV1betaDataProtectionPolicySensitiveDataProtectionPolicy {
|
|
6887
|
+
/** Optional. Specifies the resource name of the Sensitive Data Protection content policy. */
|
|
6888
|
+
policy?: string;
|
|
6889
|
+
}
|
|
6860
6890
|
interface GoogleCloudDiscoveryengineV1betaDataStore {
|
|
6861
6891
|
/** 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. */
|
|
6862
6892
|
aclEnabled?: boolean;
|
|
@@ -6882,6 +6912,8 @@ declare namespace gapi.client {
|
|
|
6882
6912
|
| 'GOOGLE_WORKSPACE';
|
|
6883
6913
|
/** Output only. Timestamp the DataStore was created at. */
|
|
6884
6914
|
createTime?: string;
|
|
6915
|
+
/** Optional. Specifies the data protection policy for the data store. */
|
|
6916
|
+
dataProtectionPolicy?: GoogleCloudDiscoveryengineV1betaDataProtectionPolicy;
|
|
6885
6917
|
/** Output only. The id of the default Schema associated to this data store. */
|
|
6886
6918
|
defaultSchemaId?: string;
|
|
6887
6919
|
/** 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. */
|
|
@@ -7173,6 +7205,8 @@ declare namespace gapi.client {
|
|
|
7173
7205
|
procurementContactEmails?: string[];
|
|
7174
7206
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
7175
7207
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
|
|
7208
|
+
/** Optional. Non-empty default. Session config for the engine. */
|
|
7209
|
+
sessionConfig?: GoogleCloudDiscoveryengineV1betaSessionConfig;
|
|
7176
7210
|
/** Required. The solutions of the engine. */
|
|
7177
7211
|
solutionType?:
|
|
7178
7212
|
| 'SOLUTION_TYPE_UNSPECIFIED'
|
|
@@ -8072,6 +8106,19 @@ declare namespace gapi.client {
|
|
|
8072
8106
|
/** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
|
|
8073
8107
|
mode?: 'MODE_UNSPECIFIED' | 'SUGGESTION_ONLY' | 'AUTO';
|
|
8074
8108
|
}
|
|
8109
|
+
interface GoogleCloudDiscoveryengineV1betaSessionConfig {
|
|
8110
|
+
/** Optional. Session management policy that defines who will manage the session. */
|
|
8111
|
+
sessionManagementPolicy?:
|
|
8112
|
+
| 'SESSION_MANAGEMENT_POLICY_UNSPECIFIED'
|
|
8113
|
+
| 'NOT_MANAGED'
|
|
8114
|
+
| 'VERTEX_AI_MANAGED';
|
|
8115
|
+
/** Optional. The TTL for the session. If unset, the default value is 60 days. */
|
|
8116
|
+
sessionTtl?: GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl;
|
|
8117
|
+
}
|
|
8118
|
+
interface GoogleCloudDiscoveryengineV1betaSessionConfigSessionTtl {
|
|
8119
|
+
/** Defines the number of days for session TTL. */
|
|
8120
|
+
days?: number;
|
|
8121
|
+
}
|
|
8075
8122
|
interface GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata {
|
|
8076
8123
|
/** Operation create time. */
|
|
8077
8124
|
createTime?: string;
|
|
@@ -8484,6 +8531,8 @@ declare namespace gapi.client {
|
|
|
8484
8531
|
createEuaSaas?: boolean;
|
|
8485
8532
|
/** Output only. Timestamp the DataConnector was created at. */
|
|
8486
8533
|
createTime?: string;
|
|
8534
|
+
/** Optional. Specifies the data protection policy for the connector. */
|
|
8535
|
+
dataProtectionPolicy?: GoogleCloudDiscoveryengineV1DataProtectionPolicy;
|
|
8487
8536
|
/** 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). */
|
|
8488
8537
|
dataSource?: string;
|
|
8489
8538
|
/** Optional. Any target destinations used to connect to third-party services. */
|
|
@@ -8633,6 +8682,14 @@ declare namespace gapi.client {
|
|
|
8633
8682
|
/** 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). */
|
|
8634
8683
|
startingSchema?: GoogleCloudDiscoveryengineV1Schema;
|
|
8635
8684
|
}
|
|
8685
|
+
interface GoogleCloudDiscoveryengineV1DataProtectionPolicy {
|
|
8686
|
+
/** Optional. Specifies the sensitive data protection policy for the connector source. */
|
|
8687
|
+
sensitiveDataProtectionPolicy?: GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy;
|
|
8688
|
+
}
|
|
8689
|
+
interface GoogleCloudDiscoveryengineV1DataProtectionPolicySensitiveDataProtectionPolicy {
|
|
8690
|
+
/** Optional. Specifies the resource name of the Sensitive Data Protection content policy. */
|
|
8691
|
+
policy?: string;
|
|
8692
|
+
}
|
|
8636
8693
|
interface GoogleCloudDiscoveryengineV1DataStore {
|
|
8637
8694
|
/** 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. */
|
|
8638
8695
|
aclEnabled?: boolean;
|
|
@@ -8658,6 +8715,8 @@ declare namespace gapi.client {
|
|
|
8658
8715
|
| 'GOOGLE_WORKSPACE';
|
|
8659
8716
|
/** Output only. Timestamp the DataStore was created at. */
|
|
8660
8717
|
createTime?: string;
|
|
8718
|
+
/** Optional. Specifies the data protection policy for the data store. */
|
|
8719
|
+
dataProtectionPolicy?: GoogleCloudDiscoveryengineV1DataProtectionPolicy;
|
|
8661
8720
|
/** Output only. The id of the default Schema associated to this data store. */
|
|
8662
8721
|
defaultSchemaId?: string;
|
|
8663
8722
|
/** 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. */
|
|
@@ -8975,6 +9034,8 @@ declare namespace gapi.client {
|
|
|
8975
9034
|
procurementContactEmails?: string[];
|
|
8976
9035
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
8977
9036
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
|
|
9037
|
+
/** Optional. Non-empty default. Session config for the engine. */
|
|
9038
|
+
sessionConfig?: GoogleCloudDiscoveryengineV1SessionConfig;
|
|
8978
9039
|
/** Required. The solutions of the engine. */
|
|
8979
9040
|
solutionType?:
|
|
8980
9041
|
| 'SOLUTION_TYPE_UNSPECIFIED'
|
|
@@ -9566,6 +9627,19 @@ declare namespace gapi.client {
|
|
|
9566
9627
|
/** Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. */
|
|
9567
9628
|
demotionEventType?: string;
|
|
9568
9629
|
}
|
|
9630
|
+
interface GoogleCloudDiscoveryengineV1SessionConfig {
|
|
9631
|
+
/** Optional. Session management policy that defines who will manage the session. */
|
|
9632
|
+
sessionManagementPolicy?:
|
|
9633
|
+
| 'SESSION_MANAGEMENT_POLICY_UNSPECIFIED'
|
|
9634
|
+
| 'NOT_MANAGED'
|
|
9635
|
+
| 'VERTEX_AI_MANAGED';
|
|
9636
|
+
/** Optional. The TTL for the session. If unset, the default value is 60 days. */
|
|
9637
|
+
sessionTtl?: GoogleCloudDiscoveryengineV1SessionConfigSessionTtl;
|
|
9638
|
+
}
|
|
9639
|
+
interface GoogleCloudDiscoveryengineV1SessionConfigSessionTtl {
|
|
9640
|
+
/** Defines the number of days for session TTL. */
|
|
9641
|
+
days?: number;
|
|
9642
|
+
}
|
|
9569
9643
|
interface GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata {}
|
|
9570
9644
|
interface GoogleCloudDiscoveryengineV1SingleRegionKey {
|
|
9571
9645
|
/** Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
|
|
@@ -14758,9 +14832,12 @@ declare namespace gapi.client {
|
|
|
14758
14832
|
key?: string;
|
|
14759
14833
|
/** 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). */
|
|
14760
14834
|
languageCode?: string;
|
|
14761
|
-
/** Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `
|
|
14835
|
+
/** 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. */
|
|
14762
14836
|
modelInfoView?:
|
|
14763
|
-
|
|
14837
|
+
| 'MODEL_INFO_VIEW_UNSPECIFIED'
|
|
14838
|
+
| 'END_USER_WEB'
|
|
14839
|
+
| 'ADMIN'
|
|
14840
|
+
| 'END_USER_MOBILE';
|
|
14764
14841
|
/** Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}` */
|
|
14765
14842
|
name: string;
|
|
14766
14843
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -18652,9 +18729,12 @@ declare namespace gapi.client {
|
|
|
18652
18729
|
key?: string;
|
|
18653
18730
|
/** 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). */
|
|
18654
18731
|
languageCode?: string;
|
|
18655
|
-
/** Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `
|
|
18732
|
+
/** 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. */
|
|
18656
18733
|
modelInfoView?:
|
|
18657
|
-
|
|
18734
|
+
| 'MODEL_INFO_VIEW_UNSPECIFIED'
|
|
18735
|
+
| 'END_USER_WEB'
|
|
18736
|
+
| 'ADMIN'
|
|
18737
|
+
| 'END_USER_MOBILE';
|
|
18658
18738
|
/** Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}` */
|
|
18659
18739
|
name: string;
|
|
18660
18740
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -22974,9 +23054,12 @@ declare namespace gapi.client {
|
|
|
22974
23054
|
key?: string;
|
|
22975
23055
|
/** 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). */
|
|
22976
23056
|
languageCode?: string;
|
|
22977
|
-
/** Optional. Selects which view of `WidgetConfig.UiSettings.ModelConfigInfo` the backend computes. `
|
|
23057
|
+
/** 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. */
|
|
22978
23058
|
modelInfoView?:
|
|
22979
|
-
|
|
23059
|
+
| 'MODEL_INFO_VIEW_UNSPECIFIED'
|
|
23060
|
+
| 'END_USER_WEB'
|
|
23061
|
+
| 'ADMIN'
|
|
23062
|
+
| 'END_USER_MOBILE';
|
|
22980
23063
|
/** Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}` */
|
|
22981
23064
|
name: string;
|
|
22982
23065
|
/** OAuth 2.0 token for the current user. */
|