@googleapis/discoveryengine 26.1.0 → 27.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +20 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +2687 -158
- package/build/v1.js +641 -44
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +4693 -248
- package/build/v1alpha.js +1294 -46
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +670 -9
- package/build/v1beta.js +171 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +4478 -436
- package/v1alpha.ts +27038 -19399
- package/v1beta.ts +1104 -9
package/build/v1.d.ts
CHANGED
|
@@ -809,7 +809,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
809
809
|
*/
|
|
810
810
|
userInfo?: Schema$GoogleCloudDiscoveryengineV1UserInfo;
|
|
811
811
|
/**
|
|
812
|
-
* A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
|
|
812
|
+
* Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
|
|
813
813
|
*/
|
|
814
814
|
userPseudoId?: string | null;
|
|
815
815
|
}
|
|
@@ -2714,6 +2714,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
2714
2714
|
* Optional. Configuration for configurable billing approach. See
|
|
2715
2715
|
*/
|
|
2716
2716
|
configurableBillingApproach?: string | null;
|
|
2717
|
+
/**
|
|
2718
|
+
* Output only. The timestamp when configurable_billing_approach was last updated.
|
|
2719
|
+
*/
|
|
2720
|
+
configurableBillingApproachUpdateTime?: string | null;
|
|
2717
2721
|
/**
|
|
2718
2722
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
2719
2723
|
*/
|
|
@@ -2846,6 +2850,19 @@ export declare namespace discoveryengine_v1 {
|
|
|
2846
2850
|
*/
|
|
2847
2851
|
userTriggeredCrawlRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
|
|
2848
2852
|
}
|
|
2853
|
+
/**
|
|
2854
|
+
* Metadata related to the progress of the AgentService.DeleteAgent operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
2855
|
+
*/
|
|
2856
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata {
|
|
2857
|
+
/**
|
|
2858
|
+
* Operation create time.
|
|
2859
|
+
*/
|
|
2860
|
+
createTime?: string | null;
|
|
2861
|
+
/**
|
|
2862
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
2863
|
+
*/
|
|
2864
|
+
updateTime?: string | null;
|
|
2865
|
+
}
|
|
2849
2866
|
/**
|
|
2850
2867
|
* Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.
|
|
2851
2868
|
*/
|
|
@@ -2959,6 +2976,19 @@ export declare namespace discoveryengine_v1 {
|
|
|
2959
2976
|
*/
|
|
2960
2977
|
updateTime?: string | null;
|
|
2961
2978
|
}
|
|
2979
|
+
/**
|
|
2980
|
+
* Metadata related to the progress of the UserStoreService.DeleteUserStore operation. This will be returned by the google.longrunning.Operation.metadata field. Delete UserStore will delete all the end users under the user store, return the number of end users successfully deleted or failed to delete in the metadata.
|
|
2981
|
+
*/
|
|
2982
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata {
|
|
2983
|
+
/**
|
|
2984
|
+
* The number of end users under the user store that failed to be deleted.
|
|
2985
|
+
*/
|
|
2986
|
+
failureCount?: string | null;
|
|
2987
|
+
/**
|
|
2988
|
+
* The number of end users under the user store that were successfully deleted.
|
|
2989
|
+
*/
|
|
2990
|
+
successCount?: string | null;
|
|
2991
|
+
}
|
|
2962
2992
|
/**
|
|
2963
2993
|
* Defines target endpoints used to connect to third-party sources.
|
|
2964
2994
|
*/
|
|
@@ -3092,6 +3122,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
3092
3122
|
* Optional. If true, the LLM based annotation is added to the image during parsing.
|
|
3093
3123
|
*/
|
|
3094
3124
|
enableImageAnnotation?: boolean | null;
|
|
3125
|
+
/**
|
|
3126
|
+
* Optional. If true, the pdf layout will be refined using an LLM.
|
|
3127
|
+
*/
|
|
3128
|
+
enableLlmLayoutParsing?: boolean | null;
|
|
3095
3129
|
/**
|
|
3096
3130
|
* Optional. If true, the LLM based annotation is added to the table during parsing.
|
|
3097
3131
|
*/
|
|
@@ -3160,6 +3194,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
3160
3194
|
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
3161
3195
|
*/
|
|
3162
3196
|
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata;
|
|
3197
|
+
/**
|
|
3198
|
+
* Output only. CMEK-related information for the Engine.
|
|
3199
|
+
*/
|
|
3200
|
+
cmekConfig?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig;
|
|
3163
3201
|
/**
|
|
3164
3202
|
* Common config spec that specifies the metadata of the engine.
|
|
3165
3203
|
*/
|
|
@@ -3198,6 +3236,12 @@ export declare namespace discoveryengine_v1 {
|
|
|
3198
3236
|
* Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
|
|
3199
3237
|
*/
|
|
3200
3238
|
mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
|
|
3239
|
+
/**
|
|
3240
|
+
* Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
|
|
3241
|
+
*/
|
|
3242
|
+
modelConfigs?: {
|
|
3243
|
+
[key: string]: string;
|
|
3244
|
+
} | null;
|
|
3201
3245
|
/**
|
|
3202
3246
|
* Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
3203
3247
|
*/
|
|
@@ -4010,6 +4054,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
4010
4054
|
* Metadata and configurations for a Google Cloud project in the service.
|
|
4011
4055
|
*/
|
|
4012
4056
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaProject {
|
|
4057
|
+
/**
|
|
4058
|
+
* Output only. The current status of the project's configurable billing.
|
|
4059
|
+
*/
|
|
4060
|
+
configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus;
|
|
4013
4061
|
/**
|
|
4014
4062
|
* Output only. The timestamp when this project is created.
|
|
4015
4063
|
*/
|
|
@@ -4033,6 +4081,23 @@ export declare namespace discoveryengine_v1 {
|
|
|
4033
4081
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
|
|
4034
4082
|
} | null;
|
|
4035
4083
|
}
|
|
4084
|
+
/**
|
|
4085
|
+
* Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).
|
|
4086
|
+
*/
|
|
4087
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus {
|
|
4088
|
+
/**
|
|
4089
|
+
* Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
|
|
4090
|
+
*/
|
|
4091
|
+
effectiveIndexingCoreThreshold?: string | null;
|
|
4092
|
+
/**
|
|
4093
|
+
* Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
|
|
4094
|
+
*/
|
|
4095
|
+
effectiveSearchQpmThreshold?: string | null;
|
|
4096
|
+
/**
|
|
4097
|
+
* Optional. The start time of the currently active billing subscription.
|
|
4098
|
+
*/
|
|
4099
|
+
startTime?: string | null;
|
|
4100
|
+
}
|
|
4036
4101
|
/**
|
|
4037
4102
|
* Customer provided configurations.
|
|
4038
4103
|
*/
|
|
@@ -4050,6 +4115,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
4050
4115
|
* Model Armor configuration to be used for sanitizing user prompts and LLM responses.
|
|
4051
4116
|
*/
|
|
4052
4117
|
modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
|
|
4118
|
+
/**
|
|
4119
|
+
* Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
|
|
4120
|
+
*/
|
|
4121
|
+
optOutNotebookSharing?: boolean | null;
|
|
4053
4122
|
}
|
|
4054
4123
|
/**
|
|
4055
4124
|
* Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
|
|
@@ -4629,7 +4698,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
4629
4698
|
[key: string]: string;
|
|
4630
4699
|
} | null;
|
|
4631
4700
|
/**
|
|
4632
|
-
* A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
4701
|
+
* Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
4633
4702
|
*/
|
|
4634
4703
|
userPseudoId?: string | null;
|
|
4635
4704
|
}
|
|
@@ -7301,6 +7370,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
7301
7370
|
* Optional. Configuration for configurable billing approach. See
|
|
7302
7371
|
*/
|
|
7303
7372
|
configurableBillingApproach?: string | null;
|
|
7373
|
+
/**
|
|
7374
|
+
* Output only. The timestamp when configurable_billing_approach was last updated.
|
|
7375
|
+
*/
|
|
7376
|
+
configurableBillingApproachUpdateTime?: string | null;
|
|
7304
7377
|
/**
|
|
7305
7378
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
7306
7379
|
*/
|
|
@@ -7604,6 +7677,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
7604
7677
|
* Optional. If true, the LLM based annotation is added to the image during parsing.
|
|
7605
7678
|
*/
|
|
7606
7679
|
enableImageAnnotation?: boolean | null;
|
|
7680
|
+
/**
|
|
7681
|
+
* Optional. If true, the pdf layout will be refined using an LLM.
|
|
7682
|
+
*/
|
|
7683
|
+
enableLlmLayoutParsing?: boolean | null;
|
|
7607
7684
|
/**
|
|
7608
7685
|
* Optional. If true, the LLM based annotation is added to the table during parsing.
|
|
7609
7686
|
*/
|
|
@@ -7672,6 +7749,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
7672
7749
|
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
7673
7750
|
*/
|
|
7674
7751
|
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata;
|
|
7752
|
+
/**
|
|
7753
|
+
* Output only. CMEK-related information for the Engine.
|
|
7754
|
+
*/
|
|
7755
|
+
cmekConfig?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig;
|
|
7675
7756
|
/**
|
|
7676
7757
|
* Common config spec that specifies the metadata of the engine.
|
|
7677
7758
|
*/
|
|
@@ -7710,6 +7791,12 @@ export declare namespace discoveryengine_v1 {
|
|
|
7710
7791
|
* Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
|
|
7711
7792
|
*/
|
|
7712
7793
|
mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig;
|
|
7794
|
+
/**
|
|
7795
|
+
* Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
|
|
7796
|
+
*/
|
|
7797
|
+
modelConfigs?: {
|
|
7798
|
+
[key: string]: string;
|
|
7799
|
+
} | null;
|
|
7713
7800
|
/**
|
|
7714
7801
|
* Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
7715
7802
|
*/
|
|
@@ -8310,6 +8397,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
8310
8397
|
* Metadata and configurations for a Google Cloud project in the service.
|
|
8311
8398
|
*/
|
|
8312
8399
|
export interface Schema$GoogleCloudDiscoveryengineV1betaProject {
|
|
8400
|
+
/**
|
|
8401
|
+
* Output only. The current status of the project's configurable billing.
|
|
8402
|
+
*/
|
|
8403
|
+
configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus;
|
|
8313
8404
|
/**
|
|
8314
8405
|
* Output only. The timestamp when this project is created.
|
|
8315
8406
|
*/
|
|
@@ -8333,6 +8424,23 @@ export declare namespace discoveryengine_v1 {
|
|
|
8333
8424
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms;
|
|
8334
8425
|
} | null;
|
|
8335
8426
|
}
|
|
8427
|
+
/**
|
|
8428
|
+
* Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).
|
|
8429
|
+
*/
|
|
8430
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus {
|
|
8431
|
+
/**
|
|
8432
|
+
* Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
|
|
8433
|
+
*/
|
|
8434
|
+
effectiveIndexingCoreThreshold?: string | null;
|
|
8435
|
+
/**
|
|
8436
|
+
* Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
|
|
8437
|
+
*/
|
|
8438
|
+
effectiveSearchQpmThreshold?: string | null;
|
|
8439
|
+
/**
|
|
8440
|
+
* Optional. The start time of the currently active billing subscription.
|
|
8441
|
+
*/
|
|
8442
|
+
startTime?: string | null;
|
|
8443
|
+
}
|
|
8336
8444
|
/**
|
|
8337
8445
|
* Customer provided configurations.
|
|
8338
8446
|
*/
|
|
@@ -8350,6 +8458,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
8350
8458
|
* Model Armor configuration to be used for sanitizing user prompts and LLM responses.
|
|
8351
8459
|
*/
|
|
8352
8460
|
modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
|
|
8461
|
+
/**
|
|
8462
|
+
* Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
|
|
8463
|
+
*/
|
|
8464
|
+
optOutNotebookSharing?: boolean | null;
|
|
8353
8465
|
}
|
|
8354
8466
|
/**
|
|
8355
8467
|
* Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
|
|
@@ -8727,7 +8839,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
8727
8839
|
[key: string]: string;
|
|
8728
8840
|
} | null;
|
|
8729
8841
|
/**
|
|
8730
|
-
* A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
8842
|
+
* Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
8731
8843
|
*/
|
|
8732
8844
|
userPseudoId?: string | null;
|
|
8733
8845
|
}
|
|
@@ -9420,6 +9532,31 @@ export declare namespace discoveryengine_v1 {
|
|
|
9420
9532
|
*/
|
|
9421
9533
|
userProfile?: string | null;
|
|
9422
9534
|
}
|
|
9535
|
+
/**
|
|
9536
|
+
* Configures metadata that is used for End User entities.
|
|
9537
|
+
*/
|
|
9538
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaUserStore {
|
|
9539
|
+
/**
|
|
9540
|
+
* Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
|
|
9541
|
+
*/
|
|
9542
|
+
defaultLicenseConfig?: string | null;
|
|
9543
|
+
/**
|
|
9544
|
+
* The display name of the User Store.
|
|
9545
|
+
*/
|
|
9546
|
+
displayName?: string | null;
|
|
9547
|
+
/**
|
|
9548
|
+
* Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
|
|
9549
|
+
*/
|
|
9550
|
+
enableExpiredLicenseAutoUpdate?: boolean | null;
|
|
9551
|
+
/**
|
|
9552
|
+
* Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
|
|
9553
|
+
*/
|
|
9554
|
+
enableLicenseAutoRegister?: boolean | null;
|
|
9555
|
+
/**
|
|
9556
|
+
* Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
9557
|
+
*/
|
|
9558
|
+
name?: string | null;
|
|
9559
|
+
}
|
|
9423
9560
|
/**
|
|
9424
9561
|
* Config to store data store type configuration for workspace data
|
|
9425
9562
|
*/
|
|
@@ -10702,6 +10839,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
10702
10839
|
* Optional. Configuration for configurable billing approach. See
|
|
10703
10840
|
*/
|
|
10704
10841
|
configurableBillingApproach?: string | null;
|
|
10842
|
+
/**
|
|
10843
|
+
* Output only. The timestamp when configurable_billing_approach was last updated.
|
|
10844
|
+
*/
|
|
10845
|
+
configurableBillingApproachUpdateTime?: string | null;
|
|
10705
10846
|
/**
|
|
10706
10847
|
* Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
|
|
10707
10848
|
*/
|
|
@@ -11185,6 +11326,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
11185
11326
|
* Optional. If true, the LLM based annotation is added to the image during parsing.
|
|
11186
11327
|
*/
|
|
11187
11328
|
enableImageAnnotation?: boolean | null;
|
|
11329
|
+
/**
|
|
11330
|
+
* Optional. If true, the pdf layout will be refined using an LLM.
|
|
11331
|
+
*/
|
|
11332
|
+
enableLlmLayoutParsing?: boolean | null;
|
|
11188
11333
|
/**
|
|
11189
11334
|
* Optional. If true, the LLM based annotation is added to the table during parsing.
|
|
11190
11335
|
*/
|
|
@@ -11267,6 +11412,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
11267
11412
|
* Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
|
|
11268
11413
|
*/
|
|
11269
11414
|
chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata;
|
|
11415
|
+
/**
|
|
11416
|
+
* Output only. CMEK-related information for the Engine.
|
|
11417
|
+
*/
|
|
11418
|
+
cmekConfig?: Schema$GoogleCloudDiscoveryengineV1CmekConfig;
|
|
11270
11419
|
/**
|
|
11271
11420
|
* Common config spec that specifies the metadata of the engine.
|
|
11272
11421
|
*/
|
|
@@ -11305,6 +11454,12 @@ export declare namespace discoveryengine_v1 {
|
|
|
11305
11454
|
* Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
|
|
11306
11455
|
*/
|
|
11307
11456
|
mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig;
|
|
11457
|
+
/**
|
|
11458
|
+
* Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
|
|
11459
|
+
*/
|
|
11460
|
+
modelConfigs?: {
|
|
11461
|
+
[key: string]: string;
|
|
11462
|
+
} | null;
|
|
11308
11463
|
/**
|
|
11309
11464
|
* Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
11310
11465
|
*/
|
|
@@ -12101,6 +12256,19 @@ export declare namespace discoveryengine_v1 {
|
|
|
12101
12256
|
*/
|
|
12102
12257
|
subscriptionTier?: string | null;
|
|
12103
12258
|
}
|
|
12259
|
+
/**
|
|
12260
|
+
* Stats about users' licenses.
|
|
12261
|
+
*/
|
|
12262
|
+
export interface Schema$GoogleCloudDiscoveryengineV1LicenseConfigUsageStats {
|
|
12263
|
+
/**
|
|
12264
|
+
* Required. The LicenseConfig name.
|
|
12265
|
+
*/
|
|
12266
|
+
licenseConfig?: string | null;
|
|
12267
|
+
/**
|
|
12268
|
+
* Required. The number of licenses used.
|
|
12269
|
+
*/
|
|
12270
|
+
usedLicenseCount?: string | null;
|
|
12271
|
+
}
|
|
12104
12272
|
/**
|
|
12105
12273
|
* Response message for CmekConfigService.ListCmekConfigs method.
|
|
12106
12274
|
*/
|
|
@@ -12210,6 +12378,15 @@ export declare namespace discoveryengine_v1 {
|
|
|
12210
12378
|
*/
|
|
12211
12379
|
nextPageToken?: string | null;
|
|
12212
12380
|
}
|
|
12381
|
+
/**
|
|
12382
|
+
* Response message for UserLicenseService.ListLicenseConfigUsageStats method.
|
|
12383
|
+
*/
|
|
12384
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse {
|
|
12385
|
+
/**
|
|
12386
|
+
* All the customer's LicenseConfigUsageStats.
|
|
12387
|
+
*/
|
|
12388
|
+
licenseConfigUsageStats?: Schema$GoogleCloudDiscoveryengineV1LicenseConfigUsageStats[];
|
|
12389
|
+
}
|
|
12213
12390
|
/**
|
|
12214
12391
|
* Response message for SchemaService.ListSchemas method.
|
|
12215
12392
|
*/
|
|
@@ -12223,6 +12400,19 @@ export declare namespace discoveryengine_v1 {
|
|
|
12223
12400
|
*/
|
|
12224
12401
|
schemas?: Schema$GoogleCloudDiscoveryengineV1Schema[];
|
|
12225
12402
|
}
|
|
12403
|
+
/**
|
|
12404
|
+
* Response for ListServingConfigs method.
|
|
12405
|
+
*/
|
|
12406
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse {
|
|
12407
|
+
/**
|
|
12408
|
+
* Pagination token, if not returned indicates the last page.
|
|
12409
|
+
*/
|
|
12410
|
+
nextPageToken?: string | null;
|
|
12411
|
+
/**
|
|
12412
|
+
* All the ServingConfigs for a given dataStore.
|
|
12413
|
+
*/
|
|
12414
|
+
servingConfigs?: Schema$GoogleCloudDiscoveryengineV1ServingConfig[];
|
|
12415
|
+
}
|
|
12226
12416
|
/**
|
|
12227
12417
|
* Response for ListSessions method.
|
|
12228
12418
|
*/
|
|
@@ -12346,6 +12536,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
12346
12536
|
* Metadata and configurations for a Google Cloud project in the service.
|
|
12347
12537
|
*/
|
|
12348
12538
|
export interface Schema$GoogleCloudDiscoveryengineV1Project {
|
|
12539
|
+
/**
|
|
12540
|
+
* Output only. The current status of the project's configurable billing.
|
|
12541
|
+
*/
|
|
12542
|
+
configurableBillingStatus?: Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus;
|
|
12349
12543
|
/**
|
|
12350
12544
|
* Output only. The timestamp when this project is created.
|
|
12351
12545
|
*/
|
|
@@ -12369,6 +12563,23 @@ export declare namespace discoveryengine_v1 {
|
|
|
12369
12563
|
[key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms;
|
|
12370
12564
|
} | null;
|
|
12371
12565
|
}
|
|
12566
|
+
/**
|
|
12567
|
+
* Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).
|
|
12568
|
+
*/
|
|
12569
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus {
|
|
12570
|
+
/**
|
|
12571
|
+
* Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
|
|
12572
|
+
*/
|
|
12573
|
+
effectiveIndexingCoreThreshold?: string | null;
|
|
12574
|
+
/**
|
|
12575
|
+
* Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
|
|
12576
|
+
*/
|
|
12577
|
+
effectiveSearchQpmThreshold?: string | null;
|
|
12578
|
+
/**
|
|
12579
|
+
* Optional. The start time of the currently active billing subscription.
|
|
12580
|
+
*/
|
|
12581
|
+
startTime?: string | null;
|
|
12582
|
+
}
|
|
12372
12583
|
/**
|
|
12373
12584
|
* Customer provided configurations.
|
|
12374
12585
|
*/
|
|
@@ -12386,6 +12597,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
12386
12597
|
* Model Armor configuration to be used for sanitizing user prompts and LLM responses.
|
|
12387
12598
|
*/
|
|
12388
12599
|
modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
|
|
12600
|
+
/**
|
|
12601
|
+
* Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
|
|
12602
|
+
*/
|
|
12603
|
+
optOutNotebookSharing?: boolean | null;
|
|
12389
12604
|
}
|
|
12390
12605
|
/**
|
|
12391
12606
|
* Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.
|
|
@@ -13034,7 +13249,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
13034
13249
|
[key: string]: string;
|
|
13035
13250
|
} | null;
|
|
13036
13251
|
/**
|
|
13037
|
-
* A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
13252
|
+
* Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
13038
13253
|
*/
|
|
13039
13254
|
userPseudoId?: string | null;
|
|
13040
13255
|
}
|
|
@@ -14510,6 +14725,506 @@ export declare namespace discoveryengine_v1 {
|
|
|
14510
14725
|
*/
|
|
14511
14726
|
userProfile?: string | null;
|
|
14512
14727
|
}
|
|
14728
|
+
/**
|
|
14729
|
+
* Configures metadata that is used for End User entities.
|
|
14730
|
+
*/
|
|
14731
|
+
export interface Schema$GoogleCloudDiscoveryengineV1UserStore {
|
|
14732
|
+
/**
|
|
14733
|
+
* Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
|
|
14734
|
+
*/
|
|
14735
|
+
defaultLicenseConfig?: string | null;
|
|
14736
|
+
/**
|
|
14737
|
+
* The display name of the User Store.
|
|
14738
|
+
*/
|
|
14739
|
+
displayName?: string | null;
|
|
14740
|
+
/**
|
|
14741
|
+
* Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
|
|
14742
|
+
*/
|
|
14743
|
+
enableExpiredLicenseAutoUpdate?: boolean | null;
|
|
14744
|
+
/**
|
|
14745
|
+
* Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
|
|
14746
|
+
*/
|
|
14747
|
+
enableLicenseAutoRegister?: boolean | null;
|
|
14748
|
+
/**
|
|
14749
|
+
* Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
14750
|
+
*/
|
|
14751
|
+
name?: string | null;
|
|
14752
|
+
}
|
|
14753
|
+
/**
|
|
14754
|
+
* WidgetConfig captures configs at the Widget level.
|
|
14755
|
+
*/
|
|
14756
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfig {
|
|
14757
|
+
/**
|
|
14758
|
+
* Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.
|
|
14759
|
+
*/
|
|
14760
|
+
accessSettings?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings;
|
|
14761
|
+
/**
|
|
14762
|
+
* Allowlisted domains that can load this widget.
|
|
14763
|
+
*/
|
|
14764
|
+
allowlistedDomains?: string[] | null;
|
|
14765
|
+
/**
|
|
14766
|
+
* Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.
|
|
14767
|
+
*/
|
|
14768
|
+
allowPublicAccess?: boolean | null;
|
|
14769
|
+
/**
|
|
14770
|
+
* Optional. Output only. Describes the assistant settings of the widget.
|
|
14771
|
+
*/
|
|
14772
|
+
assistantSettings?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings;
|
|
14773
|
+
/**
|
|
14774
|
+
* Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.
|
|
14775
|
+
*/
|
|
14776
|
+
collectionComponents?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent[];
|
|
14777
|
+
/**
|
|
14778
|
+
* Output only. Unique obfuscated identifier of a WidgetConfig.
|
|
14779
|
+
*/
|
|
14780
|
+
configId?: string | null;
|
|
14781
|
+
/**
|
|
14782
|
+
* The content search spec that configs the desired behavior of content search.
|
|
14783
|
+
*/
|
|
14784
|
+
contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec;
|
|
14785
|
+
/**
|
|
14786
|
+
* Output only. Timestamp the WidgetConfig was created.
|
|
14787
|
+
*/
|
|
14788
|
+
createTime?: string | null;
|
|
14789
|
+
/**
|
|
14790
|
+
* Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.
|
|
14791
|
+
*/
|
|
14792
|
+
customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig;
|
|
14793
|
+
/**
|
|
14794
|
+
* Output only. The type of the parent data store.
|
|
14795
|
+
*/
|
|
14796
|
+
dataStoreType?: string | null;
|
|
14797
|
+
/**
|
|
14798
|
+
* Configurable UI configurations per data store.
|
|
14799
|
+
*/
|
|
14800
|
+
dataStoreUiConfigs?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig[];
|
|
14801
|
+
/**
|
|
14802
|
+
* The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
|
|
14803
|
+
*/
|
|
14804
|
+
defaultSearchRequestOrderBy?: string | null;
|
|
14805
|
+
/**
|
|
14806
|
+
* Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
14807
|
+
*/
|
|
14808
|
+
displayName?: string | null;
|
|
14809
|
+
/**
|
|
14810
|
+
* Whether or not to enable autocomplete.
|
|
14811
|
+
*/
|
|
14812
|
+
enableAutocomplete?: boolean | null;
|
|
14813
|
+
/**
|
|
14814
|
+
* Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
|
|
14815
|
+
*/
|
|
14816
|
+
enableConversationalSearch?: boolean | null;
|
|
14817
|
+
/**
|
|
14818
|
+
* Optional. Output only. Whether to enable private knowledge graph.
|
|
14819
|
+
*/
|
|
14820
|
+
enablePrivateKnowledgeGraph?: boolean | null;
|
|
14821
|
+
/**
|
|
14822
|
+
* Turn on or off collecting the search result quality feedback from end users.
|
|
14823
|
+
*/
|
|
14824
|
+
enableQualityFeedback?: boolean | null;
|
|
14825
|
+
/**
|
|
14826
|
+
* Whether to show the result score.
|
|
14827
|
+
*/
|
|
14828
|
+
enableResultScore?: boolean | null;
|
|
14829
|
+
/**
|
|
14830
|
+
* Whether to enable safe search.
|
|
14831
|
+
*/
|
|
14832
|
+
enableSafeSearch?: boolean | null;
|
|
14833
|
+
/**
|
|
14834
|
+
* Whether to enable search-as-you-type behavior for the search widget
|
|
14835
|
+
*/
|
|
14836
|
+
enableSearchAsYouType?: boolean | null;
|
|
14837
|
+
/**
|
|
14838
|
+
* Turn on or off summary for each snippets result.
|
|
14839
|
+
*/
|
|
14840
|
+
enableSnippetResultSummary?: boolean | null;
|
|
14841
|
+
/**
|
|
14842
|
+
* Turn on or off summarization for the search response.
|
|
14843
|
+
*/
|
|
14844
|
+
enableSummarization?: boolean | null;
|
|
14845
|
+
/**
|
|
14846
|
+
* Whether to enable standalone web app.
|
|
14847
|
+
*/
|
|
14848
|
+
enableWebApp?: boolean | null;
|
|
14849
|
+
/**
|
|
14850
|
+
* The configuration and appearance of facets in the end user view.
|
|
14851
|
+
*/
|
|
14852
|
+
facetField?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigFacetField[];
|
|
14853
|
+
/**
|
|
14854
|
+
* The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
|
|
14855
|
+
*/
|
|
14856
|
+
fieldsUiComponentsMap?: {
|
|
14857
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField;
|
|
14858
|
+
} | null;
|
|
14859
|
+
/**
|
|
14860
|
+
* Output only. Whether the subscription is gemini bundle or not.
|
|
14861
|
+
*/
|
|
14862
|
+
geminiBundle?: boolean | null;
|
|
14863
|
+
/**
|
|
14864
|
+
* Optional. Describes the homepage settings of the widget.
|
|
14865
|
+
*/
|
|
14866
|
+
homepageSetting?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting;
|
|
14867
|
+
/**
|
|
14868
|
+
* Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
|
|
14869
|
+
*/
|
|
14870
|
+
industryVertical?: string | null;
|
|
14871
|
+
/**
|
|
14872
|
+
* Output only. Whether LLM is enabled in the corresponding data store.
|
|
14873
|
+
*/
|
|
14874
|
+
llmEnabled?: boolean | null;
|
|
14875
|
+
/**
|
|
14876
|
+
* Output only. Whether the customer accepted data use terms.
|
|
14877
|
+
*/
|
|
14878
|
+
minimumDataTermAccepted?: boolean | null;
|
|
14879
|
+
/**
|
|
14880
|
+
* Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
14881
|
+
*/
|
|
14882
|
+
name?: string | null;
|
|
14883
|
+
/**
|
|
14884
|
+
* The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
|
|
14885
|
+
*/
|
|
14886
|
+
resultDisplayType?: string | null;
|
|
14887
|
+
/**
|
|
14888
|
+
* Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
|
|
14889
|
+
*/
|
|
14890
|
+
solutionType?: string | null;
|
|
14891
|
+
/**
|
|
14892
|
+
* Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
|
|
14893
|
+
*/
|
|
14894
|
+
uiBranding?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings;
|
|
14895
|
+
/**
|
|
14896
|
+
* Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.
|
|
14897
|
+
*/
|
|
14898
|
+
uiSettings?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettings;
|
|
14899
|
+
/**
|
|
14900
|
+
* Output only. Timestamp the WidgetConfig was updated.
|
|
14901
|
+
*/
|
|
14902
|
+
updateTime?: string | null;
|
|
14903
|
+
}
|
|
14904
|
+
/**
|
|
14905
|
+
* Describes widget access settings.
|
|
14906
|
+
*/
|
|
14907
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings {
|
|
14908
|
+
/**
|
|
14909
|
+
* List of domains that are allowed to integrate the search widget.
|
|
14910
|
+
*/
|
|
14911
|
+
allowlistedDomains?: string[] | null;
|
|
14912
|
+
/**
|
|
14913
|
+
* Whether public unauthenticated access is allowed.
|
|
14914
|
+
*/
|
|
14915
|
+
allowPublicAccess?: boolean | null;
|
|
14916
|
+
/**
|
|
14917
|
+
* Whether web app access is enabled.
|
|
14918
|
+
*/
|
|
14919
|
+
enableWebApp?: boolean | null;
|
|
14920
|
+
/**
|
|
14921
|
+
* Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is "en-US".
|
|
14922
|
+
*/
|
|
14923
|
+
languageCode?: string | null;
|
|
14924
|
+
/**
|
|
14925
|
+
* Optional. The workforce identity pool provider used to access the widget.
|
|
14926
|
+
*/
|
|
14927
|
+
workforceIdentityPoolProvider?: string | null;
|
|
14928
|
+
}
|
|
14929
|
+
/**
|
|
14930
|
+
* Describes the assistant settings of the widget.
|
|
14931
|
+
*/
|
|
14932
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings {
|
|
14933
|
+
/**
|
|
14934
|
+
* Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
|
|
14935
|
+
*/
|
|
14936
|
+
defaultWebGroundingToggleOff?: boolean | null;
|
|
14937
|
+
/**
|
|
14938
|
+
* Optional. Output only. Whether to disable user location context.
|
|
14939
|
+
*/
|
|
14940
|
+
disableLocationContext?: boolean | null;
|
|
14941
|
+
/**
|
|
14942
|
+
* Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead.
|
|
14943
|
+
*/
|
|
14944
|
+
googleSearchGroundingEnabled?: boolean | null;
|
|
14945
|
+
/**
|
|
14946
|
+
* Optional. The type of web grounding to use.
|
|
14947
|
+
*/
|
|
14948
|
+
webGroundingType?: string | null;
|
|
14949
|
+
}
|
|
14950
|
+
/**
|
|
14951
|
+
* Read-only collection component that contains data store collections fields that may be used for filtering
|
|
14952
|
+
*/
|
|
14953
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent {
|
|
14954
|
+
/**
|
|
14955
|
+
* Output only. The icon link of the connector source.
|
|
14956
|
+
*/
|
|
14957
|
+
connectorIconLink?: string | null;
|
|
14958
|
+
/**
|
|
14959
|
+
* The name of the data source, retrieved from `Collection.data_connector.data_source`.
|
|
14960
|
+
*/
|
|
14961
|
+
dataSource?: string | null;
|
|
14962
|
+
/**
|
|
14963
|
+
* Output only. The display name of the data source.
|
|
14964
|
+
*/
|
|
14965
|
+
dataSourceDisplayName?: string | null;
|
|
14966
|
+
/**
|
|
14967
|
+
* For the data store collection, list of the children data stores.
|
|
14968
|
+
*/
|
|
14969
|
+
dataStoreComponents?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent[];
|
|
14970
|
+
/**
|
|
14971
|
+
* The display name of the collection.
|
|
14972
|
+
*/
|
|
14973
|
+
displayName?: string | null;
|
|
14974
|
+
/**
|
|
14975
|
+
* Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.
|
|
14976
|
+
*/
|
|
14977
|
+
id?: string | null;
|
|
14978
|
+
/**
|
|
14979
|
+
* The name of the collection. It should be collection resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
|
|
14980
|
+
*/
|
|
14981
|
+
name?: string | null;
|
|
14982
|
+
}
|
|
14983
|
+
/**
|
|
14984
|
+
* Customer provided configurations.
|
|
14985
|
+
*/
|
|
14986
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig {
|
|
14987
|
+
/**
|
|
14988
|
+
* Customer type.
|
|
14989
|
+
*/
|
|
14990
|
+
customerType?: string | null;
|
|
14991
|
+
}
|
|
14992
|
+
/**
|
|
14993
|
+
* Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.
|
|
14994
|
+
*/
|
|
14995
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent {
|
|
14996
|
+
/**
|
|
14997
|
+
* Output only. The type of the data store config.
|
|
14998
|
+
*/
|
|
14999
|
+
dataStoreConfigType?: string | null;
|
|
15000
|
+
/**
|
|
15001
|
+
* The display name of the data store.
|
|
15002
|
+
*/
|
|
15003
|
+
displayName?: string | null;
|
|
15004
|
+
/**
|
|
15005
|
+
* The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.
|
|
15006
|
+
*/
|
|
15007
|
+
entityName?: string | null;
|
|
15008
|
+
/**
|
|
15009
|
+
* Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
|
|
15010
|
+
*/
|
|
15011
|
+
id?: string | null;
|
|
15012
|
+
/**
|
|
15013
|
+
* The name of the data store. It should be data store resource name Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
|
|
15014
|
+
*/
|
|
15015
|
+
name?: string | null;
|
|
15016
|
+
}
|
|
15017
|
+
/**
|
|
15018
|
+
* UI component configuration for data store.
|
|
15019
|
+
*/
|
|
15020
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig {
|
|
15021
|
+
/**
|
|
15022
|
+
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
15023
|
+
*/
|
|
15024
|
+
facetField?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigFacetField[];
|
|
15025
|
+
/**
|
|
15026
|
+
* The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
|
|
15027
|
+
*/
|
|
15028
|
+
fieldsUiComponentsMap?: {
|
|
15029
|
+
[key: string]: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField;
|
|
15030
|
+
} | null;
|
|
15031
|
+
/**
|
|
15032
|
+
* Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
|
|
15033
|
+
*/
|
|
15034
|
+
id?: string | null;
|
|
15035
|
+
/**
|
|
15036
|
+
* The name of the data store. It should be data store resource name Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
|
|
15037
|
+
*/
|
|
15038
|
+
name?: string | null;
|
|
15039
|
+
}
|
|
15040
|
+
/**
|
|
15041
|
+
* Facet fields that store the mapping of fields to end user widget appearance.
|
|
15042
|
+
*/
|
|
15043
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigFacetField {
|
|
15044
|
+
/**
|
|
15045
|
+
* Optional. The field name that end users will see.
|
|
15046
|
+
*/
|
|
15047
|
+
displayName?: string | null;
|
|
15048
|
+
/**
|
|
15049
|
+
* Required. Registered field name. The format is `field.abc`.
|
|
15050
|
+
*/
|
|
15051
|
+
field?: string | null;
|
|
15052
|
+
}
|
|
15053
|
+
/**
|
|
15054
|
+
* Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts.
|
|
15055
|
+
*/
|
|
15056
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting {
|
|
15057
|
+
/**
|
|
15058
|
+
* Optional. The shortcuts to display on the homepage.
|
|
15059
|
+
*/
|
|
15060
|
+
shortcuts?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut[];
|
|
15061
|
+
}
|
|
15062
|
+
/**
|
|
15063
|
+
* Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.
|
|
15064
|
+
*/
|
|
15065
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut {
|
|
15066
|
+
/**
|
|
15067
|
+
* Optional. Destination URL of shortcut.
|
|
15068
|
+
*/
|
|
15069
|
+
destinationUri?: string | null;
|
|
15070
|
+
/**
|
|
15071
|
+
* Optional. Icon URL of shortcut.
|
|
15072
|
+
*/
|
|
15073
|
+
icon?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigImage;
|
|
15074
|
+
/**
|
|
15075
|
+
* Optional. Title of the shortcut.
|
|
15076
|
+
*/
|
|
15077
|
+
title?: string | null;
|
|
15078
|
+
}
|
|
15079
|
+
/**
|
|
15080
|
+
* Options to store an image.
|
|
15081
|
+
*/
|
|
15082
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigImage {
|
|
15083
|
+
/**
|
|
15084
|
+
* Image URL.
|
|
15085
|
+
*/
|
|
15086
|
+
url?: string | null;
|
|
15087
|
+
}
|
|
15088
|
+
/**
|
|
15089
|
+
* Describes widget UI branding settings.
|
|
15090
|
+
*/
|
|
15091
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings {
|
|
15092
|
+
/**
|
|
15093
|
+
* Logo image.
|
|
15094
|
+
*/
|
|
15095
|
+
logo?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigImage;
|
|
15096
|
+
}
|
|
15097
|
+
/**
|
|
15098
|
+
* Facet field that maps to a UI Component.
|
|
15099
|
+
*/
|
|
15100
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField {
|
|
15101
|
+
/**
|
|
15102
|
+
* The field visibility on different types of devices.
|
|
15103
|
+
*/
|
|
15104
|
+
deviceVisibility?: string[] | null;
|
|
15105
|
+
/**
|
|
15106
|
+
* The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value\}".
|
|
15107
|
+
*/
|
|
15108
|
+
displayTemplate?: string | null;
|
|
15109
|
+
/**
|
|
15110
|
+
* Required. Registered field name. The format is `field.abc`.
|
|
15111
|
+
*/
|
|
15112
|
+
field?: string | null;
|
|
15113
|
+
}
|
|
15114
|
+
/**
|
|
15115
|
+
* Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.
|
|
15116
|
+
*/
|
|
15117
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettings {
|
|
15118
|
+
/**
|
|
15119
|
+
* Per data store configuration.
|
|
15120
|
+
*/
|
|
15121
|
+
dataStoreUiConfigs?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig[];
|
|
15122
|
+
/**
|
|
15123
|
+
* The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
|
|
15124
|
+
*/
|
|
15125
|
+
defaultSearchRequestOrderBy?: string | null;
|
|
15126
|
+
/**
|
|
15127
|
+
* If set to true, the widget will not collect user events.
|
|
15128
|
+
*/
|
|
15129
|
+
disableUserEventsCollection?: boolean | null;
|
|
15130
|
+
/**
|
|
15131
|
+
* Whether or not to enable autocomplete.
|
|
15132
|
+
*/
|
|
15133
|
+
enableAutocomplete?: boolean | null;
|
|
15134
|
+
/**
|
|
15135
|
+
* Optional. If set to true, the widget will enable the create agent button.
|
|
15136
|
+
*/
|
|
15137
|
+
enableCreateAgentButton?: boolean | null;
|
|
15138
|
+
/**
|
|
15139
|
+
* Optional. If set to true, the widget will enable people search.
|
|
15140
|
+
*/
|
|
15141
|
+
enablePeopleSearch?: boolean | null;
|
|
15142
|
+
/**
|
|
15143
|
+
* Turn on or off collecting the search result quality feedback from end users.
|
|
15144
|
+
*/
|
|
15145
|
+
enableQualityFeedback?: boolean | null;
|
|
15146
|
+
/**
|
|
15147
|
+
* Whether to enable safe search.
|
|
15148
|
+
*/
|
|
15149
|
+
enableSafeSearch?: boolean | null;
|
|
15150
|
+
/**
|
|
15151
|
+
* Whether to enable search-as-you-type behavior for the search widget.
|
|
15152
|
+
*/
|
|
15153
|
+
enableSearchAsYouType?: boolean | null;
|
|
15154
|
+
/**
|
|
15155
|
+
* If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
|
|
15156
|
+
*/
|
|
15157
|
+
enableVisualContentSummary?: boolean | null;
|
|
15158
|
+
/**
|
|
15159
|
+
* Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
|
|
15160
|
+
*/
|
|
15161
|
+
features?: {
|
|
15162
|
+
[key: string]: string;
|
|
15163
|
+
} | null;
|
|
15164
|
+
/**
|
|
15165
|
+
* Describes generative answer configuration.
|
|
15166
|
+
*/
|
|
15167
|
+
generativeAnswerConfig?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig;
|
|
15168
|
+
/**
|
|
15169
|
+
* Describes widget (or web app) interaction type
|
|
15170
|
+
*/
|
|
15171
|
+
interactionType?: string | null;
|
|
15172
|
+
/**
|
|
15173
|
+
* Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.
|
|
15174
|
+
*/
|
|
15175
|
+
modelConfigs?: {
|
|
15176
|
+
[key: string]: string;
|
|
15177
|
+
} | null;
|
|
15178
|
+
/**
|
|
15179
|
+
* Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
|
|
15180
|
+
*/
|
|
15181
|
+
resultDescriptionType?: string | null;
|
|
15182
|
+
}
|
|
15183
|
+
/**
|
|
15184
|
+
* Describes configuration for generative answer.
|
|
15185
|
+
*/
|
|
15186
|
+
export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig {
|
|
15187
|
+
/**
|
|
15188
|
+
* Whether generated answer contains suggested related questions.
|
|
15189
|
+
*/
|
|
15190
|
+
disableRelatedQuestions?: boolean | null;
|
|
15191
|
+
/**
|
|
15192
|
+
* Optional. Specifies whether to filter out queries that are adversarial.
|
|
15193
|
+
*/
|
|
15194
|
+
ignoreAdversarialQuery?: boolean | null;
|
|
15195
|
+
/**
|
|
15196
|
+
* Optional. Specifies whether to filter out queries that are not relevant to the content.
|
|
15197
|
+
*/
|
|
15198
|
+
ignoreLowRelevantContent?: boolean | null;
|
|
15199
|
+
/**
|
|
15200
|
+
* Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
|
|
15201
|
+
*/
|
|
15202
|
+
ignoreNonAnswerSeekingQuery?: boolean | null;
|
|
15203
|
+
/**
|
|
15204
|
+
* Optional. Source of image returned in the answer.
|
|
15205
|
+
*/
|
|
15206
|
+
imageSource?: string | null;
|
|
15207
|
+
/**
|
|
15208
|
+
* Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
|
|
15209
|
+
*/
|
|
15210
|
+
languageCode?: string | null;
|
|
15211
|
+
/**
|
|
15212
|
+
* Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
|
|
15213
|
+
*/
|
|
15214
|
+
maxRephraseSteps?: number | null;
|
|
15215
|
+
/**
|
|
15216
|
+
* Text at the beginning of the prompt that instructs the model that generates the answer.
|
|
15217
|
+
*/
|
|
15218
|
+
modelPromptPreamble?: string | null;
|
|
15219
|
+
/**
|
|
15220
|
+
* The model version used to generate the answer.
|
|
15221
|
+
*/
|
|
15222
|
+
modelVersion?: string | null;
|
|
15223
|
+
/**
|
|
15224
|
+
* The number of top results to generate the answer from. Up to 10.
|
|
15225
|
+
*/
|
|
15226
|
+
resultCount?: number | null;
|
|
15227
|
+
}
|
|
14513
15228
|
/**
|
|
14514
15229
|
* Config to store data store type configuration for workspace data
|
|
14515
15230
|
*/
|
|
@@ -16413,6 +17128,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
16413
17128
|
siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine;
|
|
16414
17129
|
suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries;
|
|
16415
17130
|
userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
|
|
17131
|
+
widgetConfigs: Resource$Projects$Locations$Collections$Datastores$Widgetconfigs;
|
|
16416
17132
|
constructor(context: APIRequestContext);
|
|
16417
17133
|
/**
|
|
16418
17134
|
* Completes the specified user input with keyword suggestions.
|
|
@@ -16460,7 +17176,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
16460
17176
|
* query: 'placeholder-value',
|
|
16461
17177
|
* // Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
16462
17178
|
* queryModel: 'placeholder-value',
|
|
16463
|
-
* // A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
17179
|
+
* // Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
16464
17180
|
* userPseudoId: 'placeholder-value',
|
|
16465
17181
|
* },
|
|
16466
17182
|
* );
|
|
@@ -16549,6 +17265,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
16549
17265
|
* // "billingEstimation": {},
|
|
16550
17266
|
* // "cmekConfig": {},
|
|
16551
17267
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
17268
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
16552
17269
|
* // "contentConfig": "my_contentConfig",
|
|
16553
17270
|
* // "createTime": "my_createTime",
|
|
16554
17271
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -16712,6 +17429,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
16712
17429
|
* // "billingEstimation": {},
|
|
16713
17430
|
* // "cmekConfig": {},
|
|
16714
17431
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
17432
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
16715
17433
|
* // "contentConfig": "my_contentConfig",
|
|
16716
17434
|
* // "createTime": "my_createTime",
|
|
16717
17435
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -16935,6 +17653,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
16935
17653
|
* // "billingEstimation": {},
|
|
16936
17654
|
* // "cmekConfig": {},
|
|
16937
17655
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
17656
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
16938
17657
|
* // "contentConfig": "my_contentConfig",
|
|
16939
17658
|
* // "createTime": "my_createTime",
|
|
16940
17659
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -16962,6 +17681,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
16962
17681
|
* // "billingEstimation": {},
|
|
16963
17682
|
* // "cmekConfig": {},
|
|
16964
17683
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
17684
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
16965
17685
|
* // "contentConfig": "my_contentConfig",
|
|
16966
17686
|
* // "createTime": "my_createTime",
|
|
16967
17687
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -17099,7 +17819,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
17099
17819
|
*/
|
|
17100
17820
|
queryModel?: string;
|
|
17101
17821
|
/**
|
|
17102
|
-
* A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
17822
|
+
* Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
17103
17823
|
*/
|
|
17104
17824
|
userPseudoId?: string;
|
|
17105
17825
|
}
|
|
@@ -20642,6 +21362,163 @@ export declare namespace discoveryengine_v1 {
|
|
|
20642
21362
|
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
20643
21363
|
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
20644
21364
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
21365
|
+
/**
|
|
21366
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
21367
|
+
* @example
|
|
21368
|
+
* ```js
|
|
21369
|
+
* // Before running the sample:
|
|
21370
|
+
* // - Enable the API at:
|
|
21371
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
21372
|
+
* // - Login into gcloud by running:
|
|
21373
|
+
* // ```sh
|
|
21374
|
+
* // $ gcloud auth application-default login
|
|
21375
|
+
* // ```
|
|
21376
|
+
* // - Install the npm module by running:
|
|
21377
|
+
* // ```sh
|
|
21378
|
+
* // $ npm install googleapis
|
|
21379
|
+
* // ```
|
|
21380
|
+
*
|
|
21381
|
+
* const {google} = require('googleapis');
|
|
21382
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
21383
|
+
*
|
|
21384
|
+
* async function main() {
|
|
21385
|
+
* const auth = new google.auth.GoogleAuth({
|
|
21386
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
21387
|
+
* scopes: [
|
|
21388
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
21389
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
21390
|
+
* ],
|
|
21391
|
+
* });
|
|
21392
|
+
*
|
|
21393
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
21394
|
+
* const authClient = await auth.getClient();
|
|
21395
|
+
* google.options({auth: authClient});
|
|
21396
|
+
*
|
|
21397
|
+
* // Do the magic
|
|
21398
|
+
* const res =
|
|
21399
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.get(
|
|
21400
|
+
* {
|
|
21401
|
+
* // Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
21402
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
21403
|
+
* },
|
|
21404
|
+
* );
|
|
21405
|
+
* console.log(res.data);
|
|
21406
|
+
*
|
|
21407
|
+
* // Example response
|
|
21408
|
+
* // {
|
|
21409
|
+
* // "answerGenerationSpec": {},
|
|
21410
|
+
* // "boostControlIds": [],
|
|
21411
|
+
* // "createTime": "my_createTime",
|
|
21412
|
+
* // "displayName": "my_displayName",
|
|
21413
|
+
* // "dissociateControlIds": [],
|
|
21414
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
21415
|
+
* // "filterControlIds": [],
|
|
21416
|
+
* // "genericConfig": {},
|
|
21417
|
+
* // "ignoreControlIds": [],
|
|
21418
|
+
* // "mediaConfig": {},
|
|
21419
|
+
* // "modelId": "my_modelId",
|
|
21420
|
+
* // "name": "my_name",
|
|
21421
|
+
* // "onewaySynonymsControlIds": [],
|
|
21422
|
+
* // "promoteControlIds": [],
|
|
21423
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
21424
|
+
* // "redirectControlIds": [],
|
|
21425
|
+
* // "replacementControlIds": [],
|
|
21426
|
+
* // "solutionType": "my_solutionType",
|
|
21427
|
+
* // "synonymsControlIds": [],
|
|
21428
|
+
* // "updateTime": "my_updateTime"
|
|
21429
|
+
* // }
|
|
21430
|
+
* }
|
|
21431
|
+
*
|
|
21432
|
+
* main().catch(e => {
|
|
21433
|
+
* console.error(e);
|
|
21434
|
+
* throw e;
|
|
21435
|
+
* });
|
|
21436
|
+
*
|
|
21437
|
+
* ```
|
|
21438
|
+
*
|
|
21439
|
+
* @param params - Parameters for request
|
|
21440
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
21441
|
+
* @param callback - Optional callback that handles the response.
|
|
21442
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
21443
|
+
*/
|
|
21444
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
21445
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ServingConfig>>;
|
|
21446
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
21447
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
21448
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
21449
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
21450
|
+
/**
|
|
21451
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
21452
|
+
* @example
|
|
21453
|
+
* ```js
|
|
21454
|
+
* // Before running the sample:
|
|
21455
|
+
* // - Enable the API at:
|
|
21456
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
21457
|
+
* // - Login into gcloud by running:
|
|
21458
|
+
* // ```sh
|
|
21459
|
+
* // $ gcloud auth application-default login
|
|
21460
|
+
* // ```
|
|
21461
|
+
* // - Install the npm module by running:
|
|
21462
|
+
* // ```sh
|
|
21463
|
+
* // $ npm install googleapis
|
|
21464
|
+
* // ```
|
|
21465
|
+
*
|
|
21466
|
+
* const {google} = require('googleapis');
|
|
21467
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
21468
|
+
*
|
|
21469
|
+
* async function main() {
|
|
21470
|
+
* const auth = new google.auth.GoogleAuth({
|
|
21471
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
21472
|
+
* scopes: [
|
|
21473
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
21474
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
21475
|
+
* ],
|
|
21476
|
+
* });
|
|
21477
|
+
*
|
|
21478
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
21479
|
+
* const authClient = await auth.getClient();
|
|
21480
|
+
* google.options({auth: authClient});
|
|
21481
|
+
*
|
|
21482
|
+
* // Do the magic
|
|
21483
|
+
* const res =
|
|
21484
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.list(
|
|
21485
|
+
* {
|
|
21486
|
+
* // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
21487
|
+
* pageSize: 'placeholder-value',
|
|
21488
|
+
* // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
21489
|
+
* pageToken: 'placeholder-value',
|
|
21490
|
+
* // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
21491
|
+
* parent:
|
|
21492
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
21493
|
+
* },
|
|
21494
|
+
* );
|
|
21495
|
+
* console.log(res.data);
|
|
21496
|
+
*
|
|
21497
|
+
* // Example response
|
|
21498
|
+
* // {
|
|
21499
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
21500
|
+
* // "servingConfigs": []
|
|
21501
|
+
* // }
|
|
21502
|
+
* }
|
|
21503
|
+
*
|
|
21504
|
+
* main().catch(e => {
|
|
21505
|
+
* console.error(e);
|
|
21506
|
+
* throw e;
|
|
21507
|
+
* });
|
|
21508
|
+
*
|
|
21509
|
+
* ```
|
|
21510
|
+
*
|
|
21511
|
+
* @param params - Parameters for request
|
|
21512
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
21513
|
+
* @param callback - Optional callback that handles the response.
|
|
21514
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
21515
|
+
*/
|
|
21516
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
21517
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse>>;
|
|
21518
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
21519
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse>): void;
|
|
21520
|
+
list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse>): void;
|
|
21521
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse>): void;
|
|
20645
21522
|
/**
|
|
20646
21523
|
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
20647
21524
|
* @example
|
|
@@ -21170,6 +22047,26 @@ export declare namespace discoveryengine_v1 {
|
|
|
21170
22047
|
*/
|
|
21171
22048
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
21172
22049
|
}
|
|
22050
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
22051
|
+
/**
|
|
22052
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
22053
|
+
*/
|
|
22054
|
+
name?: string;
|
|
22055
|
+
}
|
|
22056
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List extends StandardParameters {
|
|
22057
|
+
/**
|
|
22058
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
22059
|
+
*/
|
|
22060
|
+
pageSize?: number;
|
|
22061
|
+
/**
|
|
22062
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
22063
|
+
*/
|
|
22064
|
+
pageToken?: string;
|
|
22065
|
+
/**
|
|
22066
|
+
* Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
22067
|
+
*/
|
|
22068
|
+
parent?: string;
|
|
22069
|
+
}
|
|
21173
22070
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
21174
22071
|
/**
|
|
21175
22072
|
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
@@ -23748,31 +24645,314 @@ export declare namespace discoveryengine_v1 {
|
|
|
23748
24645
|
*
|
|
23749
24646
|
* // Do the magic
|
|
23750
24647
|
* const res =
|
|
23751
|
-
* await discoveryengine.projects.locations.collections.dataStores.userEvents.purge(
|
|
24648
|
+
* await discoveryengine.projects.locations.collections.dataStores.userEvents.purge(
|
|
24649
|
+
* {
|
|
24650
|
+
* // Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`.
|
|
24651
|
+
* parent:
|
|
24652
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
24653
|
+
*
|
|
24654
|
+
* // Request body metadata
|
|
24655
|
+
* requestBody: {
|
|
24656
|
+
* // request body parameters
|
|
24657
|
+
* // {
|
|
24658
|
+
* // "filter": "my_filter",
|
|
24659
|
+
* // "force": false
|
|
24660
|
+
* // }
|
|
24661
|
+
* },
|
|
24662
|
+
* },
|
|
24663
|
+
* );
|
|
24664
|
+
* console.log(res.data);
|
|
24665
|
+
*
|
|
24666
|
+
* // Example response
|
|
24667
|
+
* // {
|
|
24668
|
+
* // "done": false,
|
|
24669
|
+
* // "error": {},
|
|
24670
|
+
* // "metadata": {},
|
|
24671
|
+
* // "name": "my_name",
|
|
24672
|
+
* // "response": {}
|
|
24673
|
+
* // }
|
|
24674
|
+
* }
|
|
24675
|
+
*
|
|
24676
|
+
* main().catch(e => {
|
|
24677
|
+
* console.error(e);
|
|
24678
|
+
* throw e;
|
|
24679
|
+
* });
|
|
24680
|
+
*
|
|
24681
|
+
* ```
|
|
24682
|
+
*
|
|
24683
|
+
* @param params - Parameters for request
|
|
24684
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
24685
|
+
* @param callback - Optional callback that handles the response.
|
|
24686
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
24687
|
+
*/
|
|
24688
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
24689
|
+
purge(params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
24690
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
24691
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
24692
|
+
purge(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
24693
|
+
purge(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
24694
|
+
/**
|
|
24695
|
+
* Writes a single user event.
|
|
24696
|
+
* @example
|
|
24697
|
+
* ```js
|
|
24698
|
+
* // Before running the sample:
|
|
24699
|
+
* // - Enable the API at:
|
|
24700
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
24701
|
+
* // - Login into gcloud by running:
|
|
24702
|
+
* // ```sh
|
|
24703
|
+
* // $ gcloud auth application-default login
|
|
24704
|
+
* // ```
|
|
24705
|
+
* // - Install the npm module by running:
|
|
24706
|
+
* // ```sh
|
|
24707
|
+
* // $ npm install googleapis
|
|
24708
|
+
* // ```
|
|
24709
|
+
*
|
|
24710
|
+
* const {google} = require('googleapis');
|
|
24711
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
24712
|
+
*
|
|
24713
|
+
* async function main() {
|
|
24714
|
+
* const auth = new google.auth.GoogleAuth({
|
|
24715
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
24716
|
+
* scopes: [
|
|
24717
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
24718
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
24719
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
24720
|
+
* ],
|
|
24721
|
+
* });
|
|
24722
|
+
*
|
|
24723
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
24724
|
+
* const authClient = await auth.getClient();
|
|
24725
|
+
* google.options({auth: authClient});
|
|
24726
|
+
*
|
|
24727
|
+
* // Do the magic
|
|
24728
|
+
* const res =
|
|
24729
|
+
* await discoveryengine.projects.locations.collections.dataStores.userEvents.write(
|
|
24730
|
+
* {
|
|
24731
|
+
* // Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`.
|
|
24732
|
+
* parent:
|
|
24733
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
24734
|
+
* // If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.
|
|
24735
|
+
* writeAsync: 'placeholder-value',
|
|
24736
|
+
*
|
|
24737
|
+
* // Request body metadata
|
|
24738
|
+
* requestBody: {
|
|
24739
|
+
* // request body parameters
|
|
24740
|
+
* // {
|
|
24741
|
+
* // "attributes": {},
|
|
24742
|
+
* // "attributionToken": "my_attributionToken",
|
|
24743
|
+
* // "completionInfo": {},
|
|
24744
|
+
* // "conversionType": "my_conversionType",
|
|
24745
|
+
* // "dataStore": "my_dataStore",
|
|
24746
|
+
* // "directUserRequest": false,
|
|
24747
|
+
* // "documents": [],
|
|
24748
|
+
* // "engine": "my_engine",
|
|
24749
|
+
* // "eventTime": "my_eventTime",
|
|
24750
|
+
* // "eventType": "my_eventType",
|
|
24751
|
+
* // "filter": "my_filter",
|
|
24752
|
+
* // "mediaInfo": {},
|
|
24753
|
+
* // "pageInfo": {},
|
|
24754
|
+
* // "panel": {},
|
|
24755
|
+
* // "panels": [],
|
|
24756
|
+
* // "promotionIds": [],
|
|
24757
|
+
* // "searchInfo": {},
|
|
24758
|
+
* // "sessionId": "my_sessionId",
|
|
24759
|
+
* // "tagIds": [],
|
|
24760
|
+
* // "transactionInfo": {},
|
|
24761
|
+
* // "userInfo": {},
|
|
24762
|
+
* // "userPseudoId": "my_userPseudoId"
|
|
24763
|
+
* // }
|
|
24764
|
+
* },
|
|
24765
|
+
* },
|
|
24766
|
+
* );
|
|
24767
|
+
* console.log(res.data);
|
|
24768
|
+
*
|
|
24769
|
+
* // Example response
|
|
24770
|
+
* // {
|
|
24771
|
+
* // "attributes": {},
|
|
24772
|
+
* // "attributionToken": "my_attributionToken",
|
|
24773
|
+
* // "completionInfo": {},
|
|
24774
|
+
* // "conversionType": "my_conversionType",
|
|
24775
|
+
* // "dataStore": "my_dataStore",
|
|
24776
|
+
* // "directUserRequest": false,
|
|
24777
|
+
* // "documents": [],
|
|
24778
|
+
* // "engine": "my_engine",
|
|
24779
|
+
* // "eventTime": "my_eventTime",
|
|
24780
|
+
* // "eventType": "my_eventType",
|
|
24781
|
+
* // "filter": "my_filter",
|
|
24782
|
+
* // "mediaInfo": {},
|
|
24783
|
+
* // "pageInfo": {},
|
|
24784
|
+
* // "panel": {},
|
|
24785
|
+
* // "panels": [],
|
|
24786
|
+
* // "promotionIds": [],
|
|
24787
|
+
* // "searchInfo": {},
|
|
24788
|
+
* // "sessionId": "my_sessionId",
|
|
24789
|
+
* // "tagIds": [],
|
|
24790
|
+
* // "transactionInfo": {},
|
|
24791
|
+
* // "userInfo": {},
|
|
24792
|
+
* // "userPseudoId": "my_userPseudoId"
|
|
24793
|
+
* // }
|
|
24794
|
+
* }
|
|
24795
|
+
*
|
|
24796
|
+
* main().catch(e => {
|
|
24797
|
+
* console.error(e);
|
|
24798
|
+
* throw e;
|
|
24799
|
+
* });
|
|
24800
|
+
*
|
|
24801
|
+
* ```
|
|
24802
|
+
*
|
|
24803
|
+
* @param params - Parameters for request
|
|
24804
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
24805
|
+
* @param callback - Optional callback that handles the response.
|
|
24806
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
24807
|
+
*/
|
|
24808
|
+
write(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
24809
|
+
write(params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1UserEvent>>;
|
|
24810
|
+
write(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
24811
|
+
write(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>): void;
|
|
24812
|
+
write(params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>): void;
|
|
24813
|
+
write(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>): void;
|
|
24814
|
+
}
|
|
24815
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect extends StandardParameters {
|
|
24816
|
+
/**
|
|
24817
|
+
* The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
|
|
24818
|
+
*/
|
|
24819
|
+
ets?: string;
|
|
24820
|
+
/**
|
|
24821
|
+
* Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`.
|
|
24822
|
+
*/
|
|
24823
|
+
parent?: string;
|
|
24824
|
+
/**
|
|
24825
|
+
* The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.
|
|
24826
|
+
*/
|
|
24827
|
+
uri?: string;
|
|
24828
|
+
/**
|
|
24829
|
+
* Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
|
|
24830
|
+
*/
|
|
24831
|
+
userEvent?: string;
|
|
24832
|
+
}
|
|
24833
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import extends StandardParameters {
|
|
24834
|
+
/**
|
|
24835
|
+
* Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
|
|
24836
|
+
*/
|
|
24837
|
+
parent?: string;
|
|
24838
|
+
/**
|
|
24839
|
+
* Request body metadata
|
|
24840
|
+
*/
|
|
24841
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1ImportUserEventsRequest;
|
|
24842
|
+
}
|
|
24843
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge extends StandardParameters {
|
|
24844
|
+
/**
|
|
24845
|
+
* Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`.
|
|
24846
|
+
*/
|
|
24847
|
+
parent?: string;
|
|
24848
|
+
/**
|
|
24849
|
+
* Request body metadata
|
|
24850
|
+
*/
|
|
24851
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1PurgeUserEventsRequest;
|
|
24852
|
+
}
|
|
24853
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write extends StandardParameters {
|
|
24854
|
+
/**
|
|
24855
|
+
* Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`.
|
|
24856
|
+
*/
|
|
24857
|
+
parent?: string;
|
|
24858
|
+
/**
|
|
24859
|
+
* If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.
|
|
24860
|
+
*/
|
|
24861
|
+
writeAsync?: boolean;
|
|
24862
|
+
/**
|
|
24863
|
+
* Request body metadata
|
|
24864
|
+
*/
|
|
24865
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1UserEvent;
|
|
24866
|
+
}
|
|
24867
|
+
export class Resource$Projects$Locations$Collections$Datastores$Widgetconfigs {
|
|
24868
|
+
context: APIRequestContext;
|
|
24869
|
+
constructor(context: APIRequestContext);
|
|
24870
|
+
/**
|
|
24871
|
+
* Gets a WidgetConfig.
|
|
24872
|
+
* @example
|
|
24873
|
+
* ```js
|
|
24874
|
+
* // Before running the sample:
|
|
24875
|
+
* // - Enable the API at:
|
|
24876
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
24877
|
+
* // - Login into gcloud by running:
|
|
24878
|
+
* // ```sh
|
|
24879
|
+
* // $ gcloud auth application-default login
|
|
24880
|
+
* // ```
|
|
24881
|
+
* // - Install the npm module by running:
|
|
24882
|
+
* // ```sh
|
|
24883
|
+
* // $ npm install googleapis
|
|
24884
|
+
* // ```
|
|
24885
|
+
*
|
|
24886
|
+
* const {google} = require('googleapis');
|
|
24887
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
24888
|
+
*
|
|
24889
|
+
* async function main() {
|
|
24890
|
+
* const auth = new google.auth.GoogleAuth({
|
|
24891
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
24892
|
+
* scopes: [
|
|
24893
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
24894
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
24895
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
24896
|
+
* ],
|
|
24897
|
+
* });
|
|
24898
|
+
*
|
|
24899
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
24900
|
+
* const authClient = await auth.getClient();
|
|
24901
|
+
* google.options({auth: authClient});
|
|
24902
|
+
*
|
|
24903
|
+
* // Do the magic
|
|
24904
|
+
* const res =
|
|
24905
|
+
* await discoveryengine.projects.locations.collections.dataStores.widgetConfigs.get(
|
|
23752
24906
|
* {
|
|
23753
|
-
* //
|
|
23754
|
-
*
|
|
23755
|
-
*
|
|
23756
|
-
*
|
|
23757
|
-
*
|
|
23758
|
-
*
|
|
23759
|
-
*
|
|
23760
|
-
* // {
|
|
23761
|
-
* // "filter": "my_filter",
|
|
23762
|
-
* // "force": false
|
|
23763
|
-
* // }
|
|
23764
|
-
* },
|
|
24907
|
+
* // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
24908
|
+
* acceptCache: 'placeholder-value',
|
|
24909
|
+
* // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
24910
|
+
* 'getWidgetConfigRequestOption.turnOffCollectionComponents':
|
|
24911
|
+
* 'placeholder-value',
|
|
24912
|
+
* // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
24913
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
23765
24914
|
* },
|
|
23766
24915
|
* );
|
|
23767
24916
|
* console.log(res.data);
|
|
23768
24917
|
*
|
|
23769
24918
|
* // Example response
|
|
23770
24919
|
* // {
|
|
23771
|
-
* // "
|
|
23772
|
-
* // "
|
|
23773
|
-
* // "
|
|
24920
|
+
* // "accessSettings": {},
|
|
24921
|
+
* // "allowPublicAccess": false,
|
|
24922
|
+
* // "allowlistedDomains": [],
|
|
24923
|
+
* // "assistantSettings": {},
|
|
24924
|
+
* // "collectionComponents": [],
|
|
24925
|
+
* // "configId": "my_configId",
|
|
24926
|
+
* // "contentSearchSpec": {},
|
|
24927
|
+
* // "createTime": "my_createTime",
|
|
24928
|
+
* // "customerProvidedConfig": {},
|
|
24929
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
24930
|
+
* // "dataStoreUiConfigs": [],
|
|
24931
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
24932
|
+
* // "displayName": "my_displayName",
|
|
24933
|
+
* // "enableAutocomplete": false,
|
|
24934
|
+
* // "enableConversationalSearch": false,
|
|
24935
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
24936
|
+
* // "enableQualityFeedback": false,
|
|
24937
|
+
* // "enableResultScore": false,
|
|
24938
|
+
* // "enableSafeSearch": false,
|
|
24939
|
+
* // "enableSearchAsYouType": false,
|
|
24940
|
+
* // "enableSnippetResultSummary": false,
|
|
24941
|
+
* // "enableSummarization": false,
|
|
24942
|
+
* // "enableWebApp": false,
|
|
24943
|
+
* // "facetField": [],
|
|
24944
|
+
* // "fieldsUiComponentsMap": {},
|
|
24945
|
+
* // "geminiBundle": false,
|
|
24946
|
+
* // "homepageSetting": {},
|
|
24947
|
+
* // "industryVertical": "my_industryVertical",
|
|
24948
|
+
* // "llmEnabled": false,
|
|
24949
|
+
* // "minimumDataTermAccepted": false,
|
|
23774
24950
|
* // "name": "my_name",
|
|
23775
|
-
* // "
|
|
24951
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
24952
|
+
* // "solutionType": "my_solutionType",
|
|
24953
|
+
* // "uiBranding": {},
|
|
24954
|
+
* // "uiSettings": {},
|
|
24955
|
+
* // "updateTime": "my_updateTime"
|
|
23776
24956
|
* // }
|
|
23777
24957
|
* }
|
|
23778
24958
|
*
|
|
@@ -23788,14 +24968,14 @@ export declare namespace discoveryengine_v1 {
|
|
|
23788
24968
|
* @param callback - Optional callback that handles the response.
|
|
23789
24969
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
23790
24970
|
*/
|
|
23791
|
-
|
|
23792
|
-
|
|
23793
|
-
|
|
23794
|
-
|
|
23795
|
-
|
|
23796
|
-
|
|
24971
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
24972
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
24973
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
24974
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
24975
|
+
get(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
24976
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
23797
24977
|
/**
|
|
23798
|
-
*
|
|
24978
|
+
* Update a WidgetConfig.
|
|
23799
24979
|
* @example
|
|
23800
24980
|
* ```js
|
|
23801
24981
|
* // Before running the sample:
|
|
@@ -23829,40 +25009,53 @@ export declare namespace discoveryengine_v1 {
|
|
|
23829
25009
|
*
|
|
23830
25010
|
* // Do the magic
|
|
23831
25011
|
* const res =
|
|
23832
|
-
* await discoveryengine.projects.locations.collections.dataStores.
|
|
25012
|
+
* await discoveryengine.projects.locations.collections.dataStores.widgetConfigs.patch(
|
|
23833
25013
|
* {
|
|
23834
|
-
* //
|
|
23835
|
-
*
|
|
23836
|
-
*
|
|
23837
|
-
*
|
|
23838
|
-
* writeAsync: 'placeholder-value',
|
|
25014
|
+
* // Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
25015
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
25016
|
+
* // Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
25017
|
+
* updateMask: 'placeholder-value',
|
|
23839
25018
|
*
|
|
23840
25019
|
* // Request body metadata
|
|
23841
25020
|
* requestBody: {
|
|
23842
25021
|
* // request body parameters
|
|
23843
25022
|
* // {
|
|
23844
|
-
* // "
|
|
23845
|
-
* // "
|
|
23846
|
-
* // "
|
|
23847
|
-
* // "
|
|
23848
|
-
* // "
|
|
23849
|
-
* // "
|
|
23850
|
-
* // "
|
|
23851
|
-
* // "
|
|
23852
|
-
* // "
|
|
23853
|
-
* // "
|
|
23854
|
-
* // "
|
|
23855
|
-
* // "
|
|
23856
|
-
* // "
|
|
23857
|
-
* // "
|
|
23858
|
-
* // "
|
|
23859
|
-
* // "
|
|
23860
|
-
* // "
|
|
23861
|
-
* // "
|
|
23862
|
-
* // "
|
|
23863
|
-
* // "
|
|
23864
|
-
* // "
|
|
23865
|
-
* // "
|
|
25023
|
+
* // "accessSettings": {},
|
|
25024
|
+
* // "allowPublicAccess": false,
|
|
25025
|
+
* // "allowlistedDomains": [],
|
|
25026
|
+
* // "assistantSettings": {},
|
|
25027
|
+
* // "collectionComponents": [],
|
|
25028
|
+
* // "configId": "my_configId",
|
|
25029
|
+
* // "contentSearchSpec": {},
|
|
25030
|
+
* // "createTime": "my_createTime",
|
|
25031
|
+
* // "customerProvidedConfig": {},
|
|
25032
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
25033
|
+
* // "dataStoreUiConfigs": [],
|
|
25034
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
25035
|
+
* // "displayName": "my_displayName",
|
|
25036
|
+
* // "enableAutocomplete": false,
|
|
25037
|
+
* // "enableConversationalSearch": false,
|
|
25038
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
25039
|
+
* // "enableQualityFeedback": false,
|
|
25040
|
+
* // "enableResultScore": false,
|
|
25041
|
+
* // "enableSafeSearch": false,
|
|
25042
|
+
* // "enableSearchAsYouType": false,
|
|
25043
|
+
* // "enableSnippetResultSummary": false,
|
|
25044
|
+
* // "enableSummarization": false,
|
|
25045
|
+
* // "enableWebApp": false,
|
|
25046
|
+
* // "facetField": [],
|
|
25047
|
+
* // "fieldsUiComponentsMap": {},
|
|
25048
|
+
* // "geminiBundle": false,
|
|
25049
|
+
* // "homepageSetting": {},
|
|
25050
|
+
* // "industryVertical": "my_industryVertical",
|
|
25051
|
+
* // "llmEnabled": false,
|
|
25052
|
+
* // "minimumDataTermAccepted": false,
|
|
25053
|
+
* // "name": "my_name",
|
|
25054
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
25055
|
+
* // "solutionType": "my_solutionType",
|
|
25056
|
+
* // "uiBranding": {},
|
|
25057
|
+
* // "uiSettings": {},
|
|
25058
|
+
* // "updateTime": "my_updateTime"
|
|
23866
25059
|
* // }
|
|
23867
25060
|
* },
|
|
23868
25061
|
* },
|
|
@@ -23871,28 +25064,42 @@ export declare namespace discoveryengine_v1 {
|
|
|
23871
25064
|
*
|
|
23872
25065
|
* // Example response
|
|
23873
25066
|
* // {
|
|
23874
|
-
* // "
|
|
23875
|
-
* // "
|
|
23876
|
-
* // "
|
|
23877
|
-
* // "
|
|
23878
|
-
* // "
|
|
23879
|
-
* // "
|
|
23880
|
-
* // "
|
|
23881
|
-
* // "
|
|
23882
|
-
* // "
|
|
23883
|
-
* // "
|
|
23884
|
-
* // "
|
|
23885
|
-
* // "
|
|
23886
|
-
* // "
|
|
23887
|
-
* // "
|
|
23888
|
-
* // "
|
|
23889
|
-
* // "
|
|
23890
|
-
* // "
|
|
23891
|
-
* // "
|
|
23892
|
-
* // "
|
|
23893
|
-
* // "
|
|
23894
|
-
* // "
|
|
23895
|
-
* // "
|
|
25067
|
+
* // "accessSettings": {},
|
|
25068
|
+
* // "allowPublicAccess": false,
|
|
25069
|
+
* // "allowlistedDomains": [],
|
|
25070
|
+
* // "assistantSettings": {},
|
|
25071
|
+
* // "collectionComponents": [],
|
|
25072
|
+
* // "configId": "my_configId",
|
|
25073
|
+
* // "contentSearchSpec": {},
|
|
25074
|
+
* // "createTime": "my_createTime",
|
|
25075
|
+
* // "customerProvidedConfig": {},
|
|
25076
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
25077
|
+
* // "dataStoreUiConfigs": [],
|
|
25078
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
25079
|
+
* // "displayName": "my_displayName",
|
|
25080
|
+
* // "enableAutocomplete": false,
|
|
25081
|
+
* // "enableConversationalSearch": false,
|
|
25082
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
25083
|
+
* // "enableQualityFeedback": false,
|
|
25084
|
+
* // "enableResultScore": false,
|
|
25085
|
+
* // "enableSafeSearch": false,
|
|
25086
|
+
* // "enableSearchAsYouType": false,
|
|
25087
|
+
* // "enableSnippetResultSummary": false,
|
|
25088
|
+
* // "enableSummarization": false,
|
|
25089
|
+
* // "enableWebApp": false,
|
|
25090
|
+
* // "facetField": [],
|
|
25091
|
+
* // "fieldsUiComponentsMap": {},
|
|
25092
|
+
* // "geminiBundle": false,
|
|
25093
|
+
* // "homepageSetting": {},
|
|
25094
|
+
* // "industryVertical": "my_industryVertical",
|
|
25095
|
+
* // "llmEnabled": false,
|
|
25096
|
+
* // "minimumDataTermAccepted": false,
|
|
25097
|
+
* // "name": "my_name",
|
|
25098
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
25099
|
+
* // "solutionType": "my_solutionType",
|
|
25100
|
+
* // "uiBranding": {},
|
|
25101
|
+
* // "uiSettings": {},
|
|
25102
|
+
* // "updateTime": "my_updateTime"
|
|
23896
25103
|
* // }
|
|
23897
25104
|
* }
|
|
23898
25105
|
*
|
|
@@ -23908,64 +25115,40 @@ export declare namespace discoveryengine_v1 {
|
|
|
23908
25115
|
* @param callback - Optional callback that handles the response.
|
|
23909
25116
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
23910
25117
|
*/
|
|
23911
|
-
|
|
23912
|
-
|
|
23913
|
-
|
|
23914
|
-
|
|
23915
|
-
|
|
23916
|
-
|
|
23917
|
-
}
|
|
23918
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect extends StandardParameters {
|
|
23919
|
-
/**
|
|
23920
|
-
* The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
|
|
23921
|
-
*/
|
|
23922
|
-
ets?: string;
|
|
23923
|
-
/**
|
|
23924
|
-
* Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`.
|
|
23925
|
-
*/
|
|
23926
|
-
parent?: string;
|
|
23927
|
-
/**
|
|
23928
|
-
* The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.
|
|
23929
|
-
*/
|
|
23930
|
-
uri?: string;
|
|
23931
|
-
/**
|
|
23932
|
-
* Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
|
|
23933
|
-
*/
|
|
23934
|
-
userEvent?: string;
|
|
25118
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25119
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
25120
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
25121
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
25122
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
25123
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
23935
25124
|
}
|
|
23936
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
25125
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get extends StandardParameters {
|
|
23937
25126
|
/**
|
|
23938
|
-
*
|
|
25127
|
+
* Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
23939
25128
|
*/
|
|
23940
|
-
|
|
25129
|
+
acceptCache?: boolean;
|
|
23941
25130
|
/**
|
|
23942
|
-
*
|
|
25131
|
+
* Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
23943
25132
|
*/
|
|
23944
|
-
|
|
23945
|
-
}
|
|
23946
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge extends StandardParameters {
|
|
25133
|
+
'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
|
|
23947
25134
|
/**
|
|
23948
|
-
* Required.
|
|
25135
|
+
* Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
23949
25136
|
*/
|
|
23950
|
-
|
|
23951
|
-
/**
|
|
23952
|
-
* Request body metadata
|
|
23953
|
-
*/
|
|
23954
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1PurgeUserEventsRequest;
|
|
25137
|
+
name?: string;
|
|
23955
25138
|
}
|
|
23956
|
-
export interface Params$Resource$Projects$Locations$Collections$Datastores$
|
|
25139
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch extends StandardParameters {
|
|
23957
25140
|
/**
|
|
23958
|
-
*
|
|
25141
|
+
* Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
23959
25142
|
*/
|
|
23960
|
-
|
|
25143
|
+
name?: string;
|
|
23961
25144
|
/**
|
|
23962
|
-
*
|
|
25145
|
+
* Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
23963
25146
|
*/
|
|
23964
|
-
|
|
25147
|
+
updateMask?: string;
|
|
23965
25148
|
/**
|
|
23966
25149
|
* Request body metadata
|
|
23967
25150
|
*/
|
|
23968
|
-
requestBody?: Schema$
|
|
25151
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1WidgetConfig;
|
|
23969
25152
|
}
|
|
23970
25153
|
export class Resource$Projects$Locations$Collections$Engines {
|
|
23971
25154
|
context: APIRequestContext;
|
|
@@ -23976,6 +25159,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
23976
25159
|
operations: Resource$Projects$Locations$Collections$Engines$Operations;
|
|
23977
25160
|
servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
|
|
23978
25161
|
sessions: Resource$Projects$Locations$Collections$Engines$Sessions;
|
|
25162
|
+
widgetConfigs: Resource$Projects$Locations$Collections$Engines$Widgetconfigs;
|
|
23979
25163
|
constructor(context: APIRequestContext);
|
|
23980
25164
|
/**
|
|
23981
25165
|
* Creates a Engine.
|
|
@@ -24025,6 +25209,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24025
25209
|
* // "appType": "my_appType",
|
|
24026
25210
|
* // "chatEngineConfig": {},
|
|
24027
25211
|
* // "chatEngineMetadata": {},
|
|
25212
|
+
* // "cmekConfig": {},
|
|
24028
25213
|
* // "commonConfig": {},
|
|
24029
25214
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
24030
25215
|
* // "createTime": "my_createTime",
|
|
@@ -24034,6 +25219,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24034
25219
|
* // "features": {},
|
|
24035
25220
|
* // "industryVertical": "my_industryVertical",
|
|
24036
25221
|
* // "mediaRecommendationEngineConfig": {},
|
|
25222
|
+
* // "modelConfigs": {},
|
|
24037
25223
|
* // "name": "my_name",
|
|
24038
25224
|
* // "searchEngineConfig": {},
|
|
24039
25225
|
* // "solutionType": "my_solutionType",
|
|
@@ -24183,6 +25369,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24183
25369
|
* // "appType": "my_appType",
|
|
24184
25370
|
* // "chatEngineConfig": {},
|
|
24185
25371
|
* // "chatEngineMetadata": {},
|
|
25372
|
+
* // "cmekConfig": {},
|
|
24186
25373
|
* // "commonConfig": {},
|
|
24187
25374
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
24188
25375
|
* // "createTime": "my_createTime",
|
|
@@ -24192,6 +25379,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24192
25379
|
* // "features": {},
|
|
24193
25380
|
* // "industryVertical": "my_industryVertical",
|
|
24194
25381
|
* // "mediaRecommendationEngineConfig": {},
|
|
25382
|
+
* // "modelConfigs": {},
|
|
24195
25383
|
* // "name": "my_name",
|
|
24196
25384
|
* // "searchEngineConfig": {},
|
|
24197
25385
|
* // "solutionType": "my_solutionType",
|
|
@@ -24337,6 +25525,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24337
25525
|
* // "appType": "my_appType",
|
|
24338
25526
|
* // "chatEngineConfig": {},
|
|
24339
25527
|
* // "chatEngineMetadata": {},
|
|
25528
|
+
* // "cmekConfig": {},
|
|
24340
25529
|
* // "commonConfig": {},
|
|
24341
25530
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
24342
25531
|
* // "createTime": "my_createTime",
|
|
@@ -24346,6 +25535,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24346
25535
|
* // "features": {},
|
|
24347
25536
|
* // "industryVertical": "my_industryVertical",
|
|
24348
25537
|
* // "mediaRecommendationEngineConfig": {},
|
|
25538
|
+
* // "modelConfigs": {},
|
|
24349
25539
|
* // "name": "my_name",
|
|
24350
25540
|
* // "searchEngineConfig": {},
|
|
24351
25541
|
* // "solutionType": "my_solutionType",
|
|
@@ -24360,6 +25550,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24360
25550
|
* // "appType": "my_appType",
|
|
24361
25551
|
* // "chatEngineConfig": {},
|
|
24362
25552
|
* // "chatEngineMetadata": {},
|
|
25553
|
+
* // "cmekConfig": {},
|
|
24363
25554
|
* // "commonConfig": {},
|
|
24364
25555
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
24365
25556
|
* // "createTime": "my_createTime",
|
|
@@ -24369,6 +25560,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24369
25560
|
* // "features": {},
|
|
24370
25561
|
* // "industryVertical": "my_industryVertical",
|
|
24371
25562
|
* // "mediaRecommendationEngineConfig": {},
|
|
25563
|
+
* // "modelConfigs": {},
|
|
24372
25564
|
* // "name": "my_name",
|
|
24373
25565
|
* // "searchEngineConfig": {},
|
|
24374
25566
|
* // "solutionType": "my_solutionType",
|
|
@@ -26178,6 +27370,163 @@ export declare namespace discoveryengine_v1 {
|
|
|
26178
27370
|
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
26179
27371
|
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
26180
27372
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
27373
|
+
/**
|
|
27374
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
27375
|
+
* @example
|
|
27376
|
+
* ```js
|
|
27377
|
+
* // Before running the sample:
|
|
27378
|
+
* // - Enable the API at:
|
|
27379
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
27380
|
+
* // - Login into gcloud by running:
|
|
27381
|
+
* // ```sh
|
|
27382
|
+
* // $ gcloud auth application-default login
|
|
27383
|
+
* // ```
|
|
27384
|
+
* // - Install the npm module by running:
|
|
27385
|
+
* // ```sh
|
|
27386
|
+
* // $ npm install googleapis
|
|
27387
|
+
* // ```
|
|
27388
|
+
*
|
|
27389
|
+
* const {google} = require('googleapis');
|
|
27390
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
27391
|
+
*
|
|
27392
|
+
* async function main() {
|
|
27393
|
+
* const auth = new google.auth.GoogleAuth({
|
|
27394
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
27395
|
+
* scopes: [
|
|
27396
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
27397
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
27398
|
+
* ],
|
|
27399
|
+
* });
|
|
27400
|
+
*
|
|
27401
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
27402
|
+
* const authClient = await auth.getClient();
|
|
27403
|
+
* google.options({auth: authClient});
|
|
27404
|
+
*
|
|
27405
|
+
* // Do the magic
|
|
27406
|
+
* const res =
|
|
27407
|
+
* await discoveryengine.projects.locations.collections.engines.servingConfigs.get(
|
|
27408
|
+
* {
|
|
27409
|
+
* // Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
27410
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig',
|
|
27411
|
+
* },
|
|
27412
|
+
* );
|
|
27413
|
+
* console.log(res.data);
|
|
27414
|
+
*
|
|
27415
|
+
* // Example response
|
|
27416
|
+
* // {
|
|
27417
|
+
* // "answerGenerationSpec": {},
|
|
27418
|
+
* // "boostControlIds": [],
|
|
27419
|
+
* // "createTime": "my_createTime",
|
|
27420
|
+
* // "displayName": "my_displayName",
|
|
27421
|
+
* // "dissociateControlIds": [],
|
|
27422
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
27423
|
+
* // "filterControlIds": [],
|
|
27424
|
+
* // "genericConfig": {},
|
|
27425
|
+
* // "ignoreControlIds": [],
|
|
27426
|
+
* // "mediaConfig": {},
|
|
27427
|
+
* // "modelId": "my_modelId",
|
|
27428
|
+
* // "name": "my_name",
|
|
27429
|
+
* // "onewaySynonymsControlIds": [],
|
|
27430
|
+
* // "promoteControlIds": [],
|
|
27431
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
27432
|
+
* // "redirectControlIds": [],
|
|
27433
|
+
* // "replacementControlIds": [],
|
|
27434
|
+
* // "solutionType": "my_solutionType",
|
|
27435
|
+
* // "synonymsControlIds": [],
|
|
27436
|
+
* // "updateTime": "my_updateTime"
|
|
27437
|
+
* // }
|
|
27438
|
+
* }
|
|
27439
|
+
*
|
|
27440
|
+
* main().catch(e => {
|
|
27441
|
+
* console.error(e);
|
|
27442
|
+
* throw e;
|
|
27443
|
+
* });
|
|
27444
|
+
*
|
|
27445
|
+
* ```
|
|
27446
|
+
*
|
|
27447
|
+
* @param params - Parameters for request
|
|
27448
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
27449
|
+
* @param callback - Optional callback that handles the response.
|
|
27450
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
27451
|
+
*/
|
|
27452
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
27453
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ServingConfig>>;
|
|
27454
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
27455
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
27456
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
27457
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
27458
|
+
/**
|
|
27459
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
27460
|
+
* @example
|
|
27461
|
+
* ```js
|
|
27462
|
+
* // Before running the sample:
|
|
27463
|
+
* // - Enable the API at:
|
|
27464
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
27465
|
+
* // - Login into gcloud by running:
|
|
27466
|
+
* // ```sh
|
|
27467
|
+
* // $ gcloud auth application-default login
|
|
27468
|
+
* // ```
|
|
27469
|
+
* // - Install the npm module by running:
|
|
27470
|
+
* // ```sh
|
|
27471
|
+
* // $ npm install googleapis
|
|
27472
|
+
* // ```
|
|
27473
|
+
*
|
|
27474
|
+
* const {google} = require('googleapis');
|
|
27475
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
27476
|
+
*
|
|
27477
|
+
* async function main() {
|
|
27478
|
+
* const auth = new google.auth.GoogleAuth({
|
|
27479
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
27480
|
+
* scopes: [
|
|
27481
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
27482
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
27483
|
+
* ],
|
|
27484
|
+
* });
|
|
27485
|
+
*
|
|
27486
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
27487
|
+
* const authClient = await auth.getClient();
|
|
27488
|
+
* google.options({auth: authClient});
|
|
27489
|
+
*
|
|
27490
|
+
* // Do the magic
|
|
27491
|
+
* const res =
|
|
27492
|
+
* await discoveryengine.projects.locations.collections.engines.servingConfigs.list(
|
|
27493
|
+
* {
|
|
27494
|
+
* // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
27495
|
+
* pageSize: 'placeholder-value',
|
|
27496
|
+
* // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
27497
|
+
* pageToken: 'placeholder-value',
|
|
27498
|
+
* // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
27499
|
+
* parent:
|
|
27500
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
27501
|
+
* },
|
|
27502
|
+
* );
|
|
27503
|
+
* console.log(res.data);
|
|
27504
|
+
*
|
|
27505
|
+
* // Example response
|
|
27506
|
+
* // {
|
|
27507
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
27508
|
+
* // "servingConfigs": []
|
|
27509
|
+
* // }
|
|
27510
|
+
* }
|
|
27511
|
+
*
|
|
27512
|
+
* main().catch(e => {
|
|
27513
|
+
* console.error(e);
|
|
27514
|
+
* throw e;
|
|
27515
|
+
* });
|
|
27516
|
+
*
|
|
27517
|
+
* ```
|
|
27518
|
+
*
|
|
27519
|
+
* @param params - Parameters for request
|
|
27520
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
27521
|
+
* @param callback - Optional callback that handles the response.
|
|
27522
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
27523
|
+
*/
|
|
27524
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
27525
|
+
list(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse>>;
|
|
27526
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
27527
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse>): void;
|
|
27528
|
+
list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse>): void;
|
|
27529
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse>): void;
|
|
26181
27530
|
/**
|
|
26182
27531
|
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
26183
27532
|
* @example
|
|
@@ -26706,6 +28055,26 @@ export declare namespace discoveryengine_v1 {
|
|
|
26706
28055
|
*/
|
|
26707
28056
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
26708
28057
|
}
|
|
28058
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
|
|
28059
|
+
/**
|
|
28060
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
28061
|
+
*/
|
|
28062
|
+
name?: string;
|
|
28063
|
+
}
|
|
28064
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List extends StandardParameters {
|
|
28065
|
+
/**
|
|
28066
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
28067
|
+
*/
|
|
28068
|
+
pageSize?: number;
|
|
28069
|
+
/**
|
|
28070
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
28071
|
+
*/
|
|
28072
|
+
pageToken?: string;
|
|
28073
|
+
/**
|
|
28074
|
+
* Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
28075
|
+
*/
|
|
28076
|
+
parent?: string;
|
|
28077
|
+
}
|
|
26709
28078
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters {
|
|
26710
28079
|
/**
|
|
26711
28080
|
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
@@ -27316,6 +28685,292 @@ export declare namespace discoveryengine_v1 {
|
|
|
27316
28685
|
*/
|
|
27317
28686
|
name?: string;
|
|
27318
28687
|
}
|
|
28688
|
+
export class Resource$Projects$Locations$Collections$Engines$Widgetconfigs {
|
|
28689
|
+
context: APIRequestContext;
|
|
28690
|
+
constructor(context: APIRequestContext);
|
|
28691
|
+
/**
|
|
28692
|
+
* Gets a WidgetConfig.
|
|
28693
|
+
* @example
|
|
28694
|
+
* ```js
|
|
28695
|
+
* // Before running the sample:
|
|
28696
|
+
* // - Enable the API at:
|
|
28697
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
28698
|
+
* // - Login into gcloud by running:
|
|
28699
|
+
* // ```sh
|
|
28700
|
+
* // $ gcloud auth application-default login
|
|
28701
|
+
* // ```
|
|
28702
|
+
* // - Install the npm module by running:
|
|
28703
|
+
* // ```sh
|
|
28704
|
+
* // $ npm install googleapis
|
|
28705
|
+
* // ```
|
|
28706
|
+
*
|
|
28707
|
+
* const {google} = require('googleapis');
|
|
28708
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
28709
|
+
*
|
|
28710
|
+
* async function main() {
|
|
28711
|
+
* const auth = new google.auth.GoogleAuth({
|
|
28712
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
28713
|
+
* scopes: [
|
|
28714
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
28715
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
28716
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
28717
|
+
* ],
|
|
28718
|
+
* });
|
|
28719
|
+
*
|
|
28720
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
28721
|
+
* const authClient = await auth.getClient();
|
|
28722
|
+
* google.options({auth: authClient});
|
|
28723
|
+
*
|
|
28724
|
+
* // Do the magic
|
|
28725
|
+
* const res =
|
|
28726
|
+
* await discoveryengine.projects.locations.collections.engines.widgetConfigs.get(
|
|
28727
|
+
* {
|
|
28728
|
+
* // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
28729
|
+
* acceptCache: 'placeholder-value',
|
|
28730
|
+
* // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
28731
|
+
* 'getWidgetConfigRequestOption.turnOffCollectionComponents':
|
|
28732
|
+
* 'placeholder-value',
|
|
28733
|
+
* // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
28734
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/widgetConfigs/my-widgetConfig',
|
|
28735
|
+
* },
|
|
28736
|
+
* );
|
|
28737
|
+
* console.log(res.data);
|
|
28738
|
+
*
|
|
28739
|
+
* // Example response
|
|
28740
|
+
* // {
|
|
28741
|
+
* // "accessSettings": {},
|
|
28742
|
+
* // "allowPublicAccess": false,
|
|
28743
|
+
* // "allowlistedDomains": [],
|
|
28744
|
+
* // "assistantSettings": {},
|
|
28745
|
+
* // "collectionComponents": [],
|
|
28746
|
+
* // "configId": "my_configId",
|
|
28747
|
+
* // "contentSearchSpec": {},
|
|
28748
|
+
* // "createTime": "my_createTime",
|
|
28749
|
+
* // "customerProvidedConfig": {},
|
|
28750
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
28751
|
+
* // "dataStoreUiConfigs": [],
|
|
28752
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
28753
|
+
* // "displayName": "my_displayName",
|
|
28754
|
+
* // "enableAutocomplete": false,
|
|
28755
|
+
* // "enableConversationalSearch": false,
|
|
28756
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
28757
|
+
* // "enableQualityFeedback": false,
|
|
28758
|
+
* // "enableResultScore": false,
|
|
28759
|
+
* // "enableSafeSearch": false,
|
|
28760
|
+
* // "enableSearchAsYouType": false,
|
|
28761
|
+
* // "enableSnippetResultSummary": false,
|
|
28762
|
+
* // "enableSummarization": false,
|
|
28763
|
+
* // "enableWebApp": false,
|
|
28764
|
+
* // "facetField": [],
|
|
28765
|
+
* // "fieldsUiComponentsMap": {},
|
|
28766
|
+
* // "geminiBundle": false,
|
|
28767
|
+
* // "homepageSetting": {},
|
|
28768
|
+
* // "industryVertical": "my_industryVertical",
|
|
28769
|
+
* // "llmEnabled": false,
|
|
28770
|
+
* // "minimumDataTermAccepted": false,
|
|
28771
|
+
* // "name": "my_name",
|
|
28772
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
28773
|
+
* // "solutionType": "my_solutionType",
|
|
28774
|
+
* // "uiBranding": {},
|
|
28775
|
+
* // "uiSettings": {},
|
|
28776
|
+
* // "updateTime": "my_updateTime"
|
|
28777
|
+
* // }
|
|
28778
|
+
* }
|
|
28779
|
+
*
|
|
28780
|
+
* main().catch(e => {
|
|
28781
|
+
* console.error(e);
|
|
28782
|
+
* throw e;
|
|
28783
|
+
* });
|
|
28784
|
+
*
|
|
28785
|
+
* ```
|
|
28786
|
+
*
|
|
28787
|
+
* @param params - Parameters for request
|
|
28788
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
28789
|
+
* @param callback - Optional callback that handles the response.
|
|
28790
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
28791
|
+
*/
|
|
28792
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
28793
|
+
get(params?: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
28794
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
28795
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28796
|
+
get(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28797
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28798
|
+
/**
|
|
28799
|
+
* Update a WidgetConfig.
|
|
28800
|
+
* @example
|
|
28801
|
+
* ```js
|
|
28802
|
+
* // Before running the sample:
|
|
28803
|
+
* // - Enable the API at:
|
|
28804
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
28805
|
+
* // - Login into gcloud by running:
|
|
28806
|
+
* // ```sh
|
|
28807
|
+
* // $ gcloud auth application-default login
|
|
28808
|
+
* // ```
|
|
28809
|
+
* // - Install the npm module by running:
|
|
28810
|
+
* // ```sh
|
|
28811
|
+
* // $ npm install googleapis
|
|
28812
|
+
* // ```
|
|
28813
|
+
*
|
|
28814
|
+
* const {google} = require('googleapis');
|
|
28815
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
28816
|
+
*
|
|
28817
|
+
* async function main() {
|
|
28818
|
+
* const auth = new google.auth.GoogleAuth({
|
|
28819
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
28820
|
+
* scopes: [
|
|
28821
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
28822
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
28823
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
28824
|
+
* ],
|
|
28825
|
+
* });
|
|
28826
|
+
*
|
|
28827
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
28828
|
+
* const authClient = await auth.getClient();
|
|
28829
|
+
* google.options({auth: authClient});
|
|
28830
|
+
*
|
|
28831
|
+
* // Do the magic
|
|
28832
|
+
* const res =
|
|
28833
|
+
* await discoveryengine.projects.locations.collections.engines.widgetConfigs.patch(
|
|
28834
|
+
* {
|
|
28835
|
+
* // Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
28836
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/widgetConfigs/my-widgetConfig',
|
|
28837
|
+
* // Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
28838
|
+
* updateMask: 'placeholder-value',
|
|
28839
|
+
*
|
|
28840
|
+
* // Request body metadata
|
|
28841
|
+
* requestBody: {
|
|
28842
|
+
* // request body parameters
|
|
28843
|
+
* // {
|
|
28844
|
+
* // "accessSettings": {},
|
|
28845
|
+
* // "allowPublicAccess": false,
|
|
28846
|
+
* // "allowlistedDomains": [],
|
|
28847
|
+
* // "assistantSettings": {},
|
|
28848
|
+
* // "collectionComponents": [],
|
|
28849
|
+
* // "configId": "my_configId",
|
|
28850
|
+
* // "contentSearchSpec": {},
|
|
28851
|
+
* // "createTime": "my_createTime",
|
|
28852
|
+
* // "customerProvidedConfig": {},
|
|
28853
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
28854
|
+
* // "dataStoreUiConfigs": [],
|
|
28855
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
28856
|
+
* // "displayName": "my_displayName",
|
|
28857
|
+
* // "enableAutocomplete": false,
|
|
28858
|
+
* // "enableConversationalSearch": false,
|
|
28859
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
28860
|
+
* // "enableQualityFeedback": false,
|
|
28861
|
+
* // "enableResultScore": false,
|
|
28862
|
+
* // "enableSafeSearch": false,
|
|
28863
|
+
* // "enableSearchAsYouType": false,
|
|
28864
|
+
* // "enableSnippetResultSummary": false,
|
|
28865
|
+
* // "enableSummarization": false,
|
|
28866
|
+
* // "enableWebApp": false,
|
|
28867
|
+
* // "facetField": [],
|
|
28868
|
+
* // "fieldsUiComponentsMap": {},
|
|
28869
|
+
* // "geminiBundle": false,
|
|
28870
|
+
* // "homepageSetting": {},
|
|
28871
|
+
* // "industryVertical": "my_industryVertical",
|
|
28872
|
+
* // "llmEnabled": false,
|
|
28873
|
+
* // "minimumDataTermAccepted": false,
|
|
28874
|
+
* // "name": "my_name",
|
|
28875
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
28876
|
+
* // "solutionType": "my_solutionType",
|
|
28877
|
+
* // "uiBranding": {},
|
|
28878
|
+
* // "uiSettings": {},
|
|
28879
|
+
* // "updateTime": "my_updateTime"
|
|
28880
|
+
* // }
|
|
28881
|
+
* },
|
|
28882
|
+
* },
|
|
28883
|
+
* );
|
|
28884
|
+
* console.log(res.data);
|
|
28885
|
+
*
|
|
28886
|
+
* // Example response
|
|
28887
|
+
* // {
|
|
28888
|
+
* // "accessSettings": {},
|
|
28889
|
+
* // "allowPublicAccess": false,
|
|
28890
|
+
* // "allowlistedDomains": [],
|
|
28891
|
+
* // "assistantSettings": {},
|
|
28892
|
+
* // "collectionComponents": [],
|
|
28893
|
+
* // "configId": "my_configId",
|
|
28894
|
+
* // "contentSearchSpec": {},
|
|
28895
|
+
* // "createTime": "my_createTime",
|
|
28896
|
+
* // "customerProvidedConfig": {},
|
|
28897
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
28898
|
+
* // "dataStoreUiConfigs": [],
|
|
28899
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
28900
|
+
* // "displayName": "my_displayName",
|
|
28901
|
+
* // "enableAutocomplete": false,
|
|
28902
|
+
* // "enableConversationalSearch": false,
|
|
28903
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
28904
|
+
* // "enableQualityFeedback": false,
|
|
28905
|
+
* // "enableResultScore": false,
|
|
28906
|
+
* // "enableSafeSearch": false,
|
|
28907
|
+
* // "enableSearchAsYouType": false,
|
|
28908
|
+
* // "enableSnippetResultSummary": false,
|
|
28909
|
+
* // "enableSummarization": false,
|
|
28910
|
+
* // "enableWebApp": false,
|
|
28911
|
+
* // "facetField": [],
|
|
28912
|
+
* // "fieldsUiComponentsMap": {},
|
|
28913
|
+
* // "geminiBundle": false,
|
|
28914
|
+
* // "homepageSetting": {},
|
|
28915
|
+
* // "industryVertical": "my_industryVertical",
|
|
28916
|
+
* // "llmEnabled": false,
|
|
28917
|
+
* // "minimumDataTermAccepted": false,
|
|
28918
|
+
* // "name": "my_name",
|
|
28919
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
28920
|
+
* // "solutionType": "my_solutionType",
|
|
28921
|
+
* // "uiBranding": {},
|
|
28922
|
+
* // "uiSettings": {},
|
|
28923
|
+
* // "updateTime": "my_updateTime"
|
|
28924
|
+
* // }
|
|
28925
|
+
* }
|
|
28926
|
+
*
|
|
28927
|
+
* main().catch(e => {
|
|
28928
|
+
* console.error(e);
|
|
28929
|
+
* throw e;
|
|
28930
|
+
* });
|
|
28931
|
+
*
|
|
28932
|
+
* ```
|
|
28933
|
+
*
|
|
28934
|
+
* @param params - Parameters for request
|
|
28935
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
28936
|
+
* @param callback - Optional callback that handles the response.
|
|
28937
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
28938
|
+
*/
|
|
28939
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
28940
|
+
patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
28941
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
28942
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28943
|
+
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28944
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
28945
|
+
}
|
|
28946
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get extends StandardParameters {
|
|
28947
|
+
/**
|
|
28948
|
+
* Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
28949
|
+
*/
|
|
28950
|
+
acceptCache?: boolean;
|
|
28951
|
+
/**
|
|
28952
|
+
* Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
28953
|
+
*/
|
|
28954
|
+
'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
|
|
28955
|
+
/**
|
|
28956
|
+
* Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
28957
|
+
*/
|
|
28958
|
+
name?: string;
|
|
28959
|
+
}
|
|
28960
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch extends StandardParameters {
|
|
28961
|
+
/**
|
|
28962
|
+
* Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
28963
|
+
*/
|
|
28964
|
+
name?: string;
|
|
28965
|
+
/**
|
|
28966
|
+
* Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
28967
|
+
*/
|
|
28968
|
+
updateMask?: string;
|
|
28969
|
+
/**
|
|
28970
|
+
* Request body metadata
|
|
28971
|
+
*/
|
|
28972
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1WidgetConfig;
|
|
28973
|
+
}
|
|
27319
28974
|
export class Resource$Projects$Locations$Collections$Operations {
|
|
27320
28975
|
context: APIRequestContext;
|
|
27321
28976
|
constructor(context: APIRequestContext);
|
|
@@ -27505,6 +29160,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27505
29160
|
siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
|
|
27506
29161
|
suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries;
|
|
27507
29162
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
29163
|
+
widgetConfigs: Resource$Projects$Locations$Datastores$Widgetconfigs;
|
|
27508
29164
|
constructor(context: APIRequestContext);
|
|
27509
29165
|
/**
|
|
27510
29166
|
* Completes the specified user input with keyword suggestions.
|
|
@@ -27551,7 +29207,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27551
29207
|
* query: 'placeholder-value',
|
|
27552
29208
|
* // Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
27553
29209
|
* queryModel: 'placeholder-value',
|
|
27554
|
-
* // A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
29210
|
+
* // Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
27555
29211
|
* userPseudoId: 'placeholder-value',
|
|
27556
29212
|
* },
|
|
27557
29213
|
* );
|
|
@@ -27638,6 +29294,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27638
29294
|
* // "billingEstimation": {},
|
|
27639
29295
|
* // "cmekConfig": {},
|
|
27640
29296
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
29297
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
27641
29298
|
* // "contentConfig": "my_contentConfig",
|
|
27642
29299
|
* // "createTime": "my_createTime",
|
|
27643
29300
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -27799,6 +29456,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
27799
29456
|
* // "billingEstimation": {},
|
|
27800
29457
|
* // "cmekConfig": {},
|
|
27801
29458
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
29459
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
27802
29460
|
* // "contentConfig": "my_contentConfig",
|
|
27803
29461
|
* // "createTime": "my_createTime",
|
|
27804
29462
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -28017,6 +29675,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
28017
29675
|
* // "billingEstimation": {},
|
|
28018
29676
|
* // "cmekConfig": {},
|
|
28019
29677
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
29678
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
28020
29679
|
* // "contentConfig": "my_contentConfig",
|
|
28021
29680
|
* // "createTime": "my_createTime",
|
|
28022
29681
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -28044,6 +29703,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
28044
29703
|
* // "billingEstimation": {},
|
|
28045
29704
|
* // "cmekConfig": {},
|
|
28046
29705
|
* // "configurableBillingApproach": "my_configurableBillingApproach",
|
|
29706
|
+
* // "configurableBillingApproachUpdateTime": "my_configurableBillingApproachUpdateTime",
|
|
28047
29707
|
* // "contentConfig": "my_contentConfig",
|
|
28048
29708
|
* // "createTime": "my_createTime",
|
|
28049
29709
|
* // "defaultSchemaId": "my_defaultSchemaId",
|
|
@@ -28099,7 +29759,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
28099
29759
|
*/
|
|
28100
29760
|
queryModel?: string;
|
|
28101
29761
|
/**
|
|
28102
|
-
* A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
29762
|
+
* Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
28103
29763
|
*/
|
|
28104
29764
|
userPseudoId?: string;
|
|
28105
29765
|
}
|
|
@@ -31278,37 +32938,190 @@ export declare namespace discoveryengine_v1 {
|
|
|
31278
32938
|
*
|
|
31279
32939
|
* // Do the magic
|
|
31280
32940
|
* const res =
|
|
31281
|
-
* await discoveryengine.projects.locations.dataStores.servingConfigs.answer({
|
|
31282
|
-
* // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
31283
|
-
* servingConfig:
|
|
31284
|
-
* 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
32941
|
+
* await discoveryengine.projects.locations.dataStores.servingConfigs.answer({
|
|
32942
|
+
* // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
32943
|
+
* servingConfig:
|
|
32944
|
+
* 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
32945
|
+
*
|
|
32946
|
+
* // Request body metadata
|
|
32947
|
+
* requestBody: {
|
|
32948
|
+
* // request body parameters
|
|
32949
|
+
* // {
|
|
32950
|
+
* // "answerGenerationSpec": {},
|
|
32951
|
+
* // "asynchronousMode": false,
|
|
32952
|
+
* // "endUserSpec": {},
|
|
32953
|
+
* // "groundingSpec": {},
|
|
32954
|
+
* // "query": {},
|
|
32955
|
+
* // "queryUnderstandingSpec": {},
|
|
32956
|
+
* // "relatedQuestionsSpec": {},
|
|
32957
|
+
* // "safetySpec": {},
|
|
32958
|
+
* // "searchSpec": {},
|
|
32959
|
+
* // "session": "my_session",
|
|
32960
|
+
* // "userLabels": {},
|
|
32961
|
+
* // "userPseudoId": "my_userPseudoId"
|
|
32962
|
+
* // }
|
|
32963
|
+
* },
|
|
32964
|
+
* });
|
|
32965
|
+
* console.log(res.data);
|
|
32966
|
+
*
|
|
32967
|
+
* // Example response
|
|
32968
|
+
* // {
|
|
32969
|
+
* // "answer": {},
|
|
32970
|
+
* // "answerQueryToken": "my_answerQueryToken",
|
|
32971
|
+
* // "session": {}
|
|
32972
|
+
* // }
|
|
32973
|
+
* }
|
|
32974
|
+
*
|
|
32975
|
+
* main().catch(e => {
|
|
32976
|
+
* console.error(e);
|
|
32977
|
+
* throw e;
|
|
32978
|
+
* });
|
|
32979
|
+
*
|
|
32980
|
+
* ```
|
|
32981
|
+
*
|
|
32982
|
+
* @param params - Parameters for request
|
|
32983
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
32984
|
+
* @param callback - Optional callback that handles the response.
|
|
32985
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
32986
|
+
*/
|
|
32987
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
32988
|
+
answer(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>>;
|
|
32989
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
32990
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
32991
|
+
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
32992
|
+
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
32993
|
+
/**
|
|
32994
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
32995
|
+
* @example
|
|
32996
|
+
* ```js
|
|
32997
|
+
* // Before running the sample:
|
|
32998
|
+
* // - Enable the API at:
|
|
32999
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
33000
|
+
* // - Login into gcloud by running:
|
|
33001
|
+
* // ```sh
|
|
33002
|
+
* // $ gcloud auth application-default login
|
|
33003
|
+
* // ```
|
|
33004
|
+
* // - Install the npm module by running:
|
|
33005
|
+
* // ```sh
|
|
33006
|
+
* // $ npm install googleapis
|
|
33007
|
+
* // ```
|
|
33008
|
+
*
|
|
33009
|
+
* const {google} = require('googleapis');
|
|
33010
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
33011
|
+
*
|
|
33012
|
+
* async function main() {
|
|
33013
|
+
* const auth = new google.auth.GoogleAuth({
|
|
33014
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
33015
|
+
* scopes: [
|
|
33016
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
33017
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
33018
|
+
* ],
|
|
33019
|
+
* });
|
|
33020
|
+
*
|
|
33021
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
33022
|
+
* const authClient = await auth.getClient();
|
|
33023
|
+
* google.options({auth: authClient});
|
|
33024
|
+
*
|
|
33025
|
+
* // Do the magic
|
|
33026
|
+
* const res =
|
|
33027
|
+
* await discoveryengine.projects.locations.dataStores.servingConfigs.get({
|
|
33028
|
+
* // Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
33029
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
33030
|
+
* });
|
|
33031
|
+
* console.log(res.data);
|
|
31285
33032
|
*
|
|
31286
|
-
*
|
|
31287
|
-
*
|
|
31288
|
-
*
|
|
31289
|
-
*
|
|
31290
|
-
*
|
|
31291
|
-
*
|
|
31292
|
-
*
|
|
31293
|
-
*
|
|
31294
|
-
*
|
|
31295
|
-
*
|
|
31296
|
-
*
|
|
31297
|
-
*
|
|
31298
|
-
*
|
|
31299
|
-
*
|
|
31300
|
-
*
|
|
31301
|
-
*
|
|
31302
|
-
*
|
|
31303
|
-
*
|
|
33033
|
+
* // Example response
|
|
33034
|
+
* // {
|
|
33035
|
+
* // "answerGenerationSpec": {},
|
|
33036
|
+
* // "boostControlIds": [],
|
|
33037
|
+
* // "createTime": "my_createTime",
|
|
33038
|
+
* // "displayName": "my_displayName",
|
|
33039
|
+
* // "dissociateControlIds": [],
|
|
33040
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
33041
|
+
* // "filterControlIds": [],
|
|
33042
|
+
* // "genericConfig": {},
|
|
33043
|
+
* // "ignoreControlIds": [],
|
|
33044
|
+
* // "mediaConfig": {},
|
|
33045
|
+
* // "modelId": "my_modelId",
|
|
33046
|
+
* // "name": "my_name",
|
|
33047
|
+
* // "onewaySynonymsControlIds": [],
|
|
33048
|
+
* // "promoteControlIds": [],
|
|
33049
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
33050
|
+
* // "redirectControlIds": [],
|
|
33051
|
+
* // "replacementControlIds": [],
|
|
33052
|
+
* // "solutionType": "my_solutionType",
|
|
33053
|
+
* // "synonymsControlIds": [],
|
|
33054
|
+
* // "updateTime": "my_updateTime"
|
|
33055
|
+
* // }
|
|
33056
|
+
* }
|
|
33057
|
+
*
|
|
33058
|
+
* main().catch(e => {
|
|
33059
|
+
* console.error(e);
|
|
33060
|
+
* throw e;
|
|
33061
|
+
* });
|
|
33062
|
+
*
|
|
33063
|
+
* ```
|
|
33064
|
+
*
|
|
33065
|
+
* @param params - Parameters for request
|
|
33066
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
33067
|
+
* @param callback - Optional callback that handles the response.
|
|
33068
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
33069
|
+
*/
|
|
33070
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
33071
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ServingConfig>>;
|
|
33072
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
33073
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
33074
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
33075
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
33076
|
+
/**
|
|
33077
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
33078
|
+
* @example
|
|
33079
|
+
* ```js
|
|
33080
|
+
* // Before running the sample:
|
|
33081
|
+
* // - Enable the API at:
|
|
33082
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
33083
|
+
* // - Login into gcloud by running:
|
|
33084
|
+
* // ```sh
|
|
33085
|
+
* // $ gcloud auth application-default login
|
|
33086
|
+
* // ```
|
|
33087
|
+
* // - Install the npm module by running:
|
|
33088
|
+
* // ```sh
|
|
33089
|
+
* // $ npm install googleapis
|
|
33090
|
+
* // ```
|
|
33091
|
+
*
|
|
33092
|
+
* const {google} = require('googleapis');
|
|
33093
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
33094
|
+
*
|
|
33095
|
+
* async function main() {
|
|
33096
|
+
* const auth = new google.auth.GoogleAuth({
|
|
33097
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
33098
|
+
* scopes: [
|
|
33099
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
33100
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
33101
|
+
* ],
|
|
33102
|
+
* });
|
|
33103
|
+
*
|
|
33104
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
33105
|
+
* const authClient = await auth.getClient();
|
|
33106
|
+
* google.options({auth: authClient});
|
|
33107
|
+
*
|
|
33108
|
+
* // Do the magic
|
|
33109
|
+
* const res =
|
|
33110
|
+
* await discoveryengine.projects.locations.dataStores.servingConfigs.list({
|
|
33111
|
+
* // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
33112
|
+
* pageSize: 'placeholder-value',
|
|
33113
|
+
* // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
33114
|
+
* pageToken: 'placeholder-value',
|
|
33115
|
+
* // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
33116
|
+
* parent:
|
|
33117
|
+
* 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
31304
33118
|
* });
|
|
31305
33119
|
* console.log(res.data);
|
|
31306
33120
|
*
|
|
31307
33121
|
* // Example response
|
|
31308
33122
|
* // {
|
|
31309
|
-
* // "
|
|
31310
|
-
* // "
|
|
31311
|
-
* // "session": {}
|
|
33123
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
33124
|
+
* // "servingConfigs": []
|
|
31312
33125
|
* // }
|
|
31313
33126
|
* }
|
|
31314
33127
|
*
|
|
@@ -31324,12 +33137,12 @@ export declare namespace discoveryengine_v1 {
|
|
|
31324
33137
|
* @param callback - Optional callback that handles the response.
|
|
31325
33138
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31326
33139
|
*/
|
|
31327
|
-
|
|
31328
|
-
|
|
31329
|
-
|
|
31330
|
-
|
|
31331
|
-
|
|
31332
|
-
|
|
33140
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
33141
|
+
list(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse>>;
|
|
33142
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
33143
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse>): void;
|
|
33144
|
+
list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse>): void;
|
|
33145
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListServingConfigsResponse>): void;
|
|
31333
33146
|
/**
|
|
31334
33147
|
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
31335
33148
|
* @example
|
|
@@ -31854,6 +33667,26 @@ export declare namespace discoveryengine_v1 {
|
|
|
31854
33667
|
*/
|
|
31855
33668
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
31856
33669
|
}
|
|
33670
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
33671
|
+
/**
|
|
33672
|
+
* Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
33673
|
+
*/
|
|
33674
|
+
name?: string;
|
|
33675
|
+
}
|
|
33676
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List extends StandardParameters {
|
|
33677
|
+
/**
|
|
33678
|
+
* Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
33679
|
+
*/
|
|
33680
|
+
pageSize?: number;
|
|
33681
|
+
/**
|
|
33682
|
+
* Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
33683
|
+
*/
|
|
33684
|
+
pageToken?: string;
|
|
33685
|
+
/**
|
|
33686
|
+
* Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
33687
|
+
*/
|
|
33688
|
+
parent?: string;
|
|
33689
|
+
}
|
|
31857
33690
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch extends StandardParameters {
|
|
31858
33691
|
/**
|
|
31859
33692
|
* Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}`
|
|
@@ -34098,6 +35931,288 @@ export declare namespace discoveryengine_v1 {
|
|
|
34098
35931
|
*/
|
|
34099
35932
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1UserEvent;
|
|
34100
35933
|
}
|
|
35934
|
+
export class Resource$Projects$Locations$Datastores$Widgetconfigs {
|
|
35935
|
+
context: APIRequestContext;
|
|
35936
|
+
constructor(context: APIRequestContext);
|
|
35937
|
+
/**
|
|
35938
|
+
* Gets a WidgetConfig.
|
|
35939
|
+
* @example
|
|
35940
|
+
* ```js
|
|
35941
|
+
* // Before running the sample:
|
|
35942
|
+
* // - Enable the API at:
|
|
35943
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
35944
|
+
* // - Login into gcloud by running:
|
|
35945
|
+
* // ```sh
|
|
35946
|
+
* // $ gcloud auth application-default login
|
|
35947
|
+
* // ```
|
|
35948
|
+
* // - Install the npm module by running:
|
|
35949
|
+
* // ```sh
|
|
35950
|
+
* // $ npm install googleapis
|
|
35951
|
+
* // ```
|
|
35952
|
+
*
|
|
35953
|
+
* const {google} = require('googleapis');
|
|
35954
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
35955
|
+
*
|
|
35956
|
+
* async function main() {
|
|
35957
|
+
* const auth = new google.auth.GoogleAuth({
|
|
35958
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
35959
|
+
* scopes: [
|
|
35960
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
35961
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
35962
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
35963
|
+
* ],
|
|
35964
|
+
* });
|
|
35965
|
+
*
|
|
35966
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
35967
|
+
* const authClient = await auth.getClient();
|
|
35968
|
+
* google.options({auth: authClient});
|
|
35969
|
+
*
|
|
35970
|
+
* // Do the magic
|
|
35971
|
+
* const res =
|
|
35972
|
+
* await discoveryengine.projects.locations.dataStores.widgetConfigs.get({
|
|
35973
|
+
* // Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
35974
|
+
* acceptCache: 'placeholder-value',
|
|
35975
|
+
* // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
35976
|
+
* 'getWidgetConfigRequestOption.turnOffCollectionComponents':
|
|
35977
|
+
* 'placeholder-value',
|
|
35978
|
+
* // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
35979
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
35980
|
+
* });
|
|
35981
|
+
* console.log(res.data);
|
|
35982
|
+
*
|
|
35983
|
+
* // Example response
|
|
35984
|
+
* // {
|
|
35985
|
+
* // "accessSettings": {},
|
|
35986
|
+
* // "allowPublicAccess": false,
|
|
35987
|
+
* // "allowlistedDomains": [],
|
|
35988
|
+
* // "assistantSettings": {},
|
|
35989
|
+
* // "collectionComponents": [],
|
|
35990
|
+
* // "configId": "my_configId",
|
|
35991
|
+
* // "contentSearchSpec": {},
|
|
35992
|
+
* // "createTime": "my_createTime",
|
|
35993
|
+
* // "customerProvidedConfig": {},
|
|
35994
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
35995
|
+
* // "dataStoreUiConfigs": [],
|
|
35996
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
35997
|
+
* // "displayName": "my_displayName",
|
|
35998
|
+
* // "enableAutocomplete": false,
|
|
35999
|
+
* // "enableConversationalSearch": false,
|
|
36000
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
36001
|
+
* // "enableQualityFeedback": false,
|
|
36002
|
+
* // "enableResultScore": false,
|
|
36003
|
+
* // "enableSafeSearch": false,
|
|
36004
|
+
* // "enableSearchAsYouType": false,
|
|
36005
|
+
* // "enableSnippetResultSummary": false,
|
|
36006
|
+
* // "enableSummarization": false,
|
|
36007
|
+
* // "enableWebApp": false,
|
|
36008
|
+
* // "facetField": [],
|
|
36009
|
+
* // "fieldsUiComponentsMap": {},
|
|
36010
|
+
* // "geminiBundle": false,
|
|
36011
|
+
* // "homepageSetting": {},
|
|
36012
|
+
* // "industryVertical": "my_industryVertical",
|
|
36013
|
+
* // "llmEnabled": false,
|
|
36014
|
+
* // "minimumDataTermAccepted": false,
|
|
36015
|
+
* // "name": "my_name",
|
|
36016
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
36017
|
+
* // "solutionType": "my_solutionType",
|
|
36018
|
+
* // "uiBranding": {},
|
|
36019
|
+
* // "uiSettings": {},
|
|
36020
|
+
* // "updateTime": "my_updateTime"
|
|
36021
|
+
* // }
|
|
36022
|
+
* }
|
|
36023
|
+
*
|
|
36024
|
+
* main().catch(e => {
|
|
36025
|
+
* console.error(e);
|
|
36026
|
+
* throw e;
|
|
36027
|
+
* });
|
|
36028
|
+
*
|
|
36029
|
+
* ```
|
|
36030
|
+
*
|
|
36031
|
+
* @param params - Parameters for request
|
|
36032
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
36033
|
+
* @param callback - Optional callback that handles the response.
|
|
36034
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
36035
|
+
*/
|
|
36036
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
36037
|
+
get(params?: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
36038
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
36039
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36040
|
+
get(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36041
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36042
|
+
/**
|
|
36043
|
+
* Update a WidgetConfig.
|
|
36044
|
+
* @example
|
|
36045
|
+
* ```js
|
|
36046
|
+
* // Before running the sample:
|
|
36047
|
+
* // - Enable the API at:
|
|
36048
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
36049
|
+
* // - Login into gcloud by running:
|
|
36050
|
+
* // ```sh
|
|
36051
|
+
* // $ gcloud auth application-default login
|
|
36052
|
+
* // ```
|
|
36053
|
+
* // - Install the npm module by running:
|
|
36054
|
+
* // ```sh
|
|
36055
|
+
* // $ npm install googleapis
|
|
36056
|
+
* // ```
|
|
36057
|
+
*
|
|
36058
|
+
* const {google} = require('googleapis');
|
|
36059
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
36060
|
+
*
|
|
36061
|
+
* async function main() {
|
|
36062
|
+
* const auth = new google.auth.GoogleAuth({
|
|
36063
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
36064
|
+
* scopes: [
|
|
36065
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
36066
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
36067
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
36068
|
+
* ],
|
|
36069
|
+
* });
|
|
36070
|
+
*
|
|
36071
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
36072
|
+
* const authClient = await auth.getClient();
|
|
36073
|
+
* google.options({auth: authClient});
|
|
36074
|
+
*
|
|
36075
|
+
* // Do the magic
|
|
36076
|
+
* const res =
|
|
36077
|
+
* await discoveryengine.projects.locations.dataStores.widgetConfigs.patch({
|
|
36078
|
+
* // Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
36079
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
|
|
36080
|
+
* // Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
36081
|
+
* updateMask: 'placeholder-value',
|
|
36082
|
+
*
|
|
36083
|
+
* // Request body metadata
|
|
36084
|
+
* requestBody: {
|
|
36085
|
+
* // request body parameters
|
|
36086
|
+
* // {
|
|
36087
|
+
* // "accessSettings": {},
|
|
36088
|
+
* // "allowPublicAccess": false,
|
|
36089
|
+
* // "allowlistedDomains": [],
|
|
36090
|
+
* // "assistantSettings": {},
|
|
36091
|
+
* // "collectionComponents": [],
|
|
36092
|
+
* // "configId": "my_configId",
|
|
36093
|
+
* // "contentSearchSpec": {},
|
|
36094
|
+
* // "createTime": "my_createTime",
|
|
36095
|
+
* // "customerProvidedConfig": {},
|
|
36096
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
36097
|
+
* // "dataStoreUiConfigs": [],
|
|
36098
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
36099
|
+
* // "displayName": "my_displayName",
|
|
36100
|
+
* // "enableAutocomplete": false,
|
|
36101
|
+
* // "enableConversationalSearch": false,
|
|
36102
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
36103
|
+
* // "enableQualityFeedback": false,
|
|
36104
|
+
* // "enableResultScore": false,
|
|
36105
|
+
* // "enableSafeSearch": false,
|
|
36106
|
+
* // "enableSearchAsYouType": false,
|
|
36107
|
+
* // "enableSnippetResultSummary": false,
|
|
36108
|
+
* // "enableSummarization": false,
|
|
36109
|
+
* // "enableWebApp": false,
|
|
36110
|
+
* // "facetField": [],
|
|
36111
|
+
* // "fieldsUiComponentsMap": {},
|
|
36112
|
+
* // "geminiBundle": false,
|
|
36113
|
+
* // "homepageSetting": {},
|
|
36114
|
+
* // "industryVertical": "my_industryVertical",
|
|
36115
|
+
* // "llmEnabled": false,
|
|
36116
|
+
* // "minimumDataTermAccepted": false,
|
|
36117
|
+
* // "name": "my_name",
|
|
36118
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
36119
|
+
* // "solutionType": "my_solutionType",
|
|
36120
|
+
* // "uiBranding": {},
|
|
36121
|
+
* // "uiSettings": {},
|
|
36122
|
+
* // "updateTime": "my_updateTime"
|
|
36123
|
+
* // }
|
|
36124
|
+
* },
|
|
36125
|
+
* });
|
|
36126
|
+
* console.log(res.data);
|
|
36127
|
+
*
|
|
36128
|
+
* // Example response
|
|
36129
|
+
* // {
|
|
36130
|
+
* // "accessSettings": {},
|
|
36131
|
+
* // "allowPublicAccess": false,
|
|
36132
|
+
* // "allowlistedDomains": [],
|
|
36133
|
+
* // "assistantSettings": {},
|
|
36134
|
+
* // "collectionComponents": [],
|
|
36135
|
+
* // "configId": "my_configId",
|
|
36136
|
+
* // "contentSearchSpec": {},
|
|
36137
|
+
* // "createTime": "my_createTime",
|
|
36138
|
+
* // "customerProvidedConfig": {},
|
|
36139
|
+
* // "dataStoreType": "my_dataStoreType",
|
|
36140
|
+
* // "dataStoreUiConfigs": [],
|
|
36141
|
+
* // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
|
|
36142
|
+
* // "displayName": "my_displayName",
|
|
36143
|
+
* // "enableAutocomplete": false,
|
|
36144
|
+
* // "enableConversationalSearch": false,
|
|
36145
|
+
* // "enablePrivateKnowledgeGraph": false,
|
|
36146
|
+
* // "enableQualityFeedback": false,
|
|
36147
|
+
* // "enableResultScore": false,
|
|
36148
|
+
* // "enableSafeSearch": false,
|
|
36149
|
+
* // "enableSearchAsYouType": false,
|
|
36150
|
+
* // "enableSnippetResultSummary": false,
|
|
36151
|
+
* // "enableSummarization": false,
|
|
36152
|
+
* // "enableWebApp": false,
|
|
36153
|
+
* // "facetField": [],
|
|
36154
|
+
* // "fieldsUiComponentsMap": {},
|
|
36155
|
+
* // "geminiBundle": false,
|
|
36156
|
+
* // "homepageSetting": {},
|
|
36157
|
+
* // "industryVertical": "my_industryVertical",
|
|
36158
|
+
* // "llmEnabled": false,
|
|
36159
|
+
* // "minimumDataTermAccepted": false,
|
|
36160
|
+
* // "name": "my_name",
|
|
36161
|
+
* // "resultDisplayType": "my_resultDisplayType",
|
|
36162
|
+
* // "solutionType": "my_solutionType",
|
|
36163
|
+
* // "uiBranding": {},
|
|
36164
|
+
* // "uiSettings": {},
|
|
36165
|
+
* // "updateTime": "my_updateTime"
|
|
36166
|
+
* // }
|
|
36167
|
+
* }
|
|
36168
|
+
*
|
|
36169
|
+
* main().catch(e => {
|
|
36170
|
+
* console.error(e);
|
|
36171
|
+
* throw e;
|
|
36172
|
+
* });
|
|
36173
|
+
*
|
|
36174
|
+
* ```
|
|
36175
|
+
*
|
|
36176
|
+
* @param params - Parameters for request
|
|
36177
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
36178
|
+
* @param callback - Optional callback that handles the response.
|
|
36179
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
36180
|
+
*/
|
|
36181
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
36182
|
+
patch(params?: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>>;
|
|
36183
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
36184
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36185
|
+
patch(params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36186
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>): void;
|
|
36187
|
+
}
|
|
36188
|
+
export interface Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get extends StandardParameters {
|
|
36189
|
+
/**
|
|
36190
|
+
* Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
|
|
36191
|
+
*/
|
|
36192
|
+
acceptCache?: boolean;
|
|
36193
|
+
/**
|
|
36194
|
+
* Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
|
|
36195
|
+
*/
|
|
36196
|
+
'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
|
|
36197
|
+
/**
|
|
36198
|
+
* Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
|
|
36199
|
+
*/
|
|
36200
|
+
name?: string;
|
|
36201
|
+
}
|
|
36202
|
+
export interface Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch extends StandardParameters {
|
|
36203
|
+
/**
|
|
36204
|
+
* Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
36205
|
+
*/
|
|
36206
|
+
name?: string;
|
|
36207
|
+
/**
|
|
36208
|
+
* Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
|
|
36209
|
+
*/
|
|
36210
|
+
updateMask?: string;
|
|
36211
|
+
/**
|
|
36212
|
+
* Request body metadata
|
|
36213
|
+
*/
|
|
36214
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1WidgetConfig;
|
|
36215
|
+
}
|
|
34101
36216
|
export class Resource$Projects$Locations$Groundingconfigs {
|
|
34102
36217
|
context: APIRequestContext;
|
|
34103
36218
|
constructor(context: APIRequestContext);
|
|
@@ -35924,6 +38039,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
35924
38039
|
}
|
|
35925
38040
|
export class Resource$Projects$Locations$Userstores {
|
|
35926
38041
|
context: APIRequestContext;
|
|
38042
|
+
licenseConfigsUsageStats: Resource$Projects$Locations$Userstores$Licenseconfigsusagestats;
|
|
35927
38043
|
userLicenses: Resource$Projects$Locations$Userstores$Userlicenses;
|
|
35928
38044
|
constructor(context: APIRequestContext);
|
|
35929
38045
|
/**
|
|
@@ -36006,6 +38122,302 @@ export declare namespace discoveryengine_v1 {
|
|
|
36006
38122
|
batchUpdateUserLicenses(params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
36007
38123
|
batchUpdateUserLicenses(params: Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
36008
38124
|
batchUpdateUserLicenses(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
38125
|
+
/**
|
|
38126
|
+
* Creates a new User Store.
|
|
38127
|
+
* @example
|
|
38128
|
+
* ```js
|
|
38129
|
+
* // Before running the sample:
|
|
38130
|
+
* // - Enable the API at:
|
|
38131
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
38132
|
+
* // - Login into gcloud by running:
|
|
38133
|
+
* // ```sh
|
|
38134
|
+
* // $ gcloud auth application-default login
|
|
38135
|
+
* // ```
|
|
38136
|
+
* // - Install the npm module by running:
|
|
38137
|
+
* // ```sh
|
|
38138
|
+
* // $ npm install googleapis
|
|
38139
|
+
* // ```
|
|
38140
|
+
*
|
|
38141
|
+
* const {google} = require('googleapis');
|
|
38142
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
38143
|
+
*
|
|
38144
|
+
* async function main() {
|
|
38145
|
+
* const auth = new google.auth.GoogleAuth({
|
|
38146
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
38147
|
+
* scopes: [
|
|
38148
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
38149
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
38150
|
+
* ],
|
|
38151
|
+
* });
|
|
38152
|
+
*
|
|
38153
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
38154
|
+
* const authClient = await auth.getClient();
|
|
38155
|
+
* google.options({auth: authClient});
|
|
38156
|
+
*
|
|
38157
|
+
* // Do the magic
|
|
38158
|
+
* const res = await discoveryengine.projects.locations.userStores.create({
|
|
38159
|
+
* // Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`.
|
|
38160
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
38161
|
+
* // Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.
|
|
38162
|
+
* userStoreId: 'placeholder-value',
|
|
38163
|
+
*
|
|
38164
|
+
* // Request body metadata
|
|
38165
|
+
* requestBody: {
|
|
38166
|
+
* // request body parameters
|
|
38167
|
+
* // {
|
|
38168
|
+
* // "defaultLicenseConfig": "my_defaultLicenseConfig",
|
|
38169
|
+
* // "displayName": "my_displayName",
|
|
38170
|
+
* // "enableExpiredLicenseAutoUpdate": false,
|
|
38171
|
+
* // "enableLicenseAutoRegister": false,
|
|
38172
|
+
* // "name": "my_name"
|
|
38173
|
+
* // }
|
|
38174
|
+
* },
|
|
38175
|
+
* });
|
|
38176
|
+
* console.log(res.data);
|
|
38177
|
+
*
|
|
38178
|
+
* // Example response
|
|
38179
|
+
* // {
|
|
38180
|
+
* // "defaultLicenseConfig": "my_defaultLicenseConfig",
|
|
38181
|
+
* // "displayName": "my_displayName",
|
|
38182
|
+
* // "enableExpiredLicenseAutoUpdate": false,
|
|
38183
|
+
* // "enableLicenseAutoRegister": false,
|
|
38184
|
+
* // "name": "my_name"
|
|
38185
|
+
* // }
|
|
38186
|
+
* }
|
|
38187
|
+
*
|
|
38188
|
+
* main().catch(e => {
|
|
38189
|
+
* console.error(e);
|
|
38190
|
+
* throw e;
|
|
38191
|
+
* });
|
|
38192
|
+
*
|
|
38193
|
+
* ```
|
|
38194
|
+
*
|
|
38195
|
+
* @param params - Parameters for request
|
|
38196
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
38197
|
+
* @param callback - Optional callback that handles the response.
|
|
38198
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
38199
|
+
*/
|
|
38200
|
+
create(params: Params$Resource$Projects$Locations$Userstores$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
38201
|
+
create(params?: Params$Resource$Projects$Locations$Userstores$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1UserStore>>;
|
|
38202
|
+
create(params: Params$Resource$Projects$Locations$Userstores$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
38203
|
+
create(params: Params$Resource$Projects$Locations$Userstores$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserStore>): void;
|
|
38204
|
+
create(params: Params$Resource$Projects$Locations$Userstores$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserStore>): void;
|
|
38205
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserStore>): void;
|
|
38206
|
+
/**
|
|
38207
|
+
* Deletes the User Store.
|
|
38208
|
+
* @example
|
|
38209
|
+
* ```js
|
|
38210
|
+
* // Before running the sample:
|
|
38211
|
+
* // - Enable the API at:
|
|
38212
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
38213
|
+
* // - Login into gcloud by running:
|
|
38214
|
+
* // ```sh
|
|
38215
|
+
* // $ gcloud auth application-default login
|
|
38216
|
+
* // ```
|
|
38217
|
+
* // - Install the npm module by running:
|
|
38218
|
+
* // ```sh
|
|
38219
|
+
* // $ npm install googleapis
|
|
38220
|
+
* // ```
|
|
38221
|
+
*
|
|
38222
|
+
* const {google} = require('googleapis');
|
|
38223
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
38224
|
+
*
|
|
38225
|
+
* async function main() {
|
|
38226
|
+
* const auth = new google.auth.GoogleAuth({
|
|
38227
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
38228
|
+
* scopes: [
|
|
38229
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
38230
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
38231
|
+
* ],
|
|
38232
|
+
* });
|
|
38233
|
+
*
|
|
38234
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
38235
|
+
* const authClient = await auth.getClient();
|
|
38236
|
+
* google.options({auth: authClient});
|
|
38237
|
+
*
|
|
38238
|
+
* // Do the magic
|
|
38239
|
+
* const res = await discoveryengine.projects.locations.userStores.delete({
|
|
38240
|
+
* // Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
|
|
38241
|
+
* name: 'projects/my-project/locations/my-location/userStores/my-userStore',
|
|
38242
|
+
* });
|
|
38243
|
+
* console.log(res.data);
|
|
38244
|
+
*
|
|
38245
|
+
* // Example response
|
|
38246
|
+
* // {
|
|
38247
|
+
* // "done": false,
|
|
38248
|
+
* // "error": {},
|
|
38249
|
+
* // "metadata": {},
|
|
38250
|
+
* // "name": "my_name",
|
|
38251
|
+
* // "response": {}
|
|
38252
|
+
* // }
|
|
38253
|
+
* }
|
|
38254
|
+
*
|
|
38255
|
+
* main().catch(e => {
|
|
38256
|
+
* console.error(e);
|
|
38257
|
+
* throw e;
|
|
38258
|
+
* });
|
|
38259
|
+
*
|
|
38260
|
+
* ```
|
|
38261
|
+
*
|
|
38262
|
+
* @param params - Parameters for request
|
|
38263
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
38264
|
+
* @param callback - Optional callback that handles the response.
|
|
38265
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
38266
|
+
*/
|
|
38267
|
+
delete(params: Params$Resource$Projects$Locations$Userstores$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
38268
|
+
delete(params?: Params$Resource$Projects$Locations$Userstores$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
38269
|
+
delete(params: Params$Resource$Projects$Locations$Userstores$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
38270
|
+
delete(params: Params$Resource$Projects$Locations$Userstores$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
38271
|
+
delete(params: Params$Resource$Projects$Locations$Userstores$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
38272
|
+
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
38273
|
+
/**
|
|
38274
|
+
* Gets the User Store.
|
|
38275
|
+
* @example
|
|
38276
|
+
* ```js
|
|
38277
|
+
* // Before running the sample:
|
|
38278
|
+
* // - Enable the API at:
|
|
38279
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
38280
|
+
* // - Login into gcloud by running:
|
|
38281
|
+
* // ```sh
|
|
38282
|
+
* // $ gcloud auth application-default login
|
|
38283
|
+
* // ```
|
|
38284
|
+
* // - Install the npm module by running:
|
|
38285
|
+
* // ```sh
|
|
38286
|
+
* // $ npm install googleapis
|
|
38287
|
+
* // ```
|
|
38288
|
+
*
|
|
38289
|
+
* const {google} = require('googleapis');
|
|
38290
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
38291
|
+
*
|
|
38292
|
+
* async function main() {
|
|
38293
|
+
* const auth = new google.auth.GoogleAuth({
|
|
38294
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
38295
|
+
* scopes: [
|
|
38296
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
38297
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
38298
|
+
* ],
|
|
38299
|
+
* });
|
|
38300
|
+
*
|
|
38301
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
38302
|
+
* const authClient = await auth.getClient();
|
|
38303
|
+
* google.options({auth: authClient});
|
|
38304
|
+
*
|
|
38305
|
+
* // Do the magic
|
|
38306
|
+
* const res = await discoveryengine.projects.locations.userStores.get({
|
|
38307
|
+
* // Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
|
|
38308
|
+
* name: 'projects/my-project/locations/my-location/userStores/my-userStore',
|
|
38309
|
+
* });
|
|
38310
|
+
* console.log(res.data);
|
|
38311
|
+
*
|
|
38312
|
+
* // Example response
|
|
38313
|
+
* // {
|
|
38314
|
+
* // "defaultLicenseConfig": "my_defaultLicenseConfig",
|
|
38315
|
+
* // "displayName": "my_displayName",
|
|
38316
|
+
* // "enableExpiredLicenseAutoUpdate": false,
|
|
38317
|
+
* // "enableLicenseAutoRegister": false,
|
|
38318
|
+
* // "name": "my_name"
|
|
38319
|
+
* // }
|
|
38320
|
+
* }
|
|
38321
|
+
*
|
|
38322
|
+
* main().catch(e => {
|
|
38323
|
+
* console.error(e);
|
|
38324
|
+
* throw e;
|
|
38325
|
+
* });
|
|
38326
|
+
*
|
|
38327
|
+
* ```
|
|
38328
|
+
*
|
|
38329
|
+
* @param params - Parameters for request
|
|
38330
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
38331
|
+
* @param callback - Optional callback that handles the response.
|
|
38332
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
38333
|
+
*/
|
|
38334
|
+
get(params: Params$Resource$Projects$Locations$Userstores$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
38335
|
+
get(params?: Params$Resource$Projects$Locations$Userstores$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1UserStore>>;
|
|
38336
|
+
get(params: Params$Resource$Projects$Locations$Userstores$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
38337
|
+
get(params: Params$Resource$Projects$Locations$Userstores$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserStore>): void;
|
|
38338
|
+
get(params: Params$Resource$Projects$Locations$Userstores$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserStore>): void;
|
|
38339
|
+
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserStore>): void;
|
|
38340
|
+
/**
|
|
38341
|
+
* Updates the User Store.
|
|
38342
|
+
* @example
|
|
38343
|
+
* ```js
|
|
38344
|
+
* // Before running the sample:
|
|
38345
|
+
* // - Enable the API at:
|
|
38346
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
38347
|
+
* // - Login into gcloud by running:
|
|
38348
|
+
* // ```sh
|
|
38349
|
+
* // $ gcloud auth application-default login
|
|
38350
|
+
* // ```
|
|
38351
|
+
* // - Install the npm module by running:
|
|
38352
|
+
* // ```sh
|
|
38353
|
+
* // $ npm install googleapis
|
|
38354
|
+
* // ```
|
|
38355
|
+
*
|
|
38356
|
+
* const {google} = require('googleapis');
|
|
38357
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
38358
|
+
*
|
|
38359
|
+
* async function main() {
|
|
38360
|
+
* const auth = new google.auth.GoogleAuth({
|
|
38361
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
38362
|
+
* scopes: [
|
|
38363
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
38364
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
38365
|
+
* ],
|
|
38366
|
+
* });
|
|
38367
|
+
*
|
|
38368
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
38369
|
+
* const authClient = await auth.getClient();
|
|
38370
|
+
* google.options({auth: authClient});
|
|
38371
|
+
*
|
|
38372
|
+
* // Do the magic
|
|
38373
|
+
* const res = await discoveryengine.projects.locations.userStores.patch({
|
|
38374
|
+
* // Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
38375
|
+
* name: 'projects/my-project/locations/my-location/userStores/my-userStore',
|
|
38376
|
+
* // Optional. The list of fields to update.
|
|
38377
|
+
* updateMask: 'placeholder-value',
|
|
38378
|
+
*
|
|
38379
|
+
* // Request body metadata
|
|
38380
|
+
* requestBody: {
|
|
38381
|
+
* // request body parameters
|
|
38382
|
+
* // {
|
|
38383
|
+
* // "defaultLicenseConfig": "my_defaultLicenseConfig",
|
|
38384
|
+
* // "displayName": "my_displayName",
|
|
38385
|
+
* // "enableExpiredLicenseAutoUpdate": false,
|
|
38386
|
+
* // "enableLicenseAutoRegister": false,
|
|
38387
|
+
* // "name": "my_name"
|
|
38388
|
+
* // }
|
|
38389
|
+
* },
|
|
38390
|
+
* });
|
|
38391
|
+
* console.log(res.data);
|
|
38392
|
+
*
|
|
38393
|
+
* // Example response
|
|
38394
|
+
* // {
|
|
38395
|
+
* // "defaultLicenseConfig": "my_defaultLicenseConfig",
|
|
38396
|
+
* // "displayName": "my_displayName",
|
|
38397
|
+
* // "enableExpiredLicenseAutoUpdate": false,
|
|
38398
|
+
* // "enableLicenseAutoRegister": false,
|
|
38399
|
+
* // "name": "my_name"
|
|
38400
|
+
* // }
|
|
38401
|
+
* }
|
|
38402
|
+
*
|
|
38403
|
+
* main().catch(e => {
|
|
38404
|
+
* console.error(e);
|
|
38405
|
+
* throw e;
|
|
38406
|
+
* });
|
|
38407
|
+
*
|
|
38408
|
+
* ```
|
|
38409
|
+
*
|
|
38410
|
+
* @param params - Parameters for request
|
|
38411
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
38412
|
+
* @param callback - Optional callback that handles the response.
|
|
38413
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
38414
|
+
*/
|
|
38415
|
+
patch(params: Params$Resource$Projects$Locations$Userstores$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
38416
|
+
patch(params?: Params$Resource$Projects$Locations$Userstores$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1UserStore>>;
|
|
38417
|
+
patch(params: Params$Resource$Projects$Locations$Userstores$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
38418
|
+
patch(params: Params$Resource$Projects$Locations$Userstores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserStore>): void;
|
|
38419
|
+
patch(params: Params$Resource$Projects$Locations$Userstores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserStore>): void;
|
|
38420
|
+
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserStore>): void;
|
|
36009
38421
|
}
|
|
36010
38422
|
export interface Params$Resource$Projects$Locations$Userstores$Batchupdateuserlicenses extends StandardParameters {
|
|
36011
38423
|
/**
|
|
@@ -36017,6 +38429,123 @@ export declare namespace discoveryengine_v1 {
|
|
|
36017
38429
|
*/
|
|
36018
38430
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest;
|
|
36019
38431
|
}
|
|
38432
|
+
export interface Params$Resource$Projects$Locations$Userstores$Create extends StandardParameters {
|
|
38433
|
+
/**
|
|
38434
|
+
* Required. The parent collection resource name, such as `projects/{project\}/locations/{location\}`.
|
|
38435
|
+
*/
|
|
38436
|
+
parent?: string;
|
|
38437
|
+
/**
|
|
38438
|
+
* Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.
|
|
38439
|
+
*/
|
|
38440
|
+
userStoreId?: string;
|
|
38441
|
+
/**
|
|
38442
|
+
* Request body metadata
|
|
38443
|
+
*/
|
|
38444
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1UserStore;
|
|
38445
|
+
}
|
|
38446
|
+
export interface Params$Resource$Projects$Locations$Userstores$Delete extends StandardParameters {
|
|
38447
|
+
/**
|
|
38448
|
+
* Required. The name of the User Store to delete. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
|
|
38449
|
+
*/
|
|
38450
|
+
name?: string;
|
|
38451
|
+
}
|
|
38452
|
+
export interface Params$Resource$Projects$Locations$Userstores$Get extends StandardParameters {
|
|
38453
|
+
/**
|
|
38454
|
+
* Required. The name of the User Store to get. Format: `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`
|
|
38455
|
+
*/
|
|
38456
|
+
name?: string;
|
|
38457
|
+
}
|
|
38458
|
+
export interface Params$Resource$Projects$Locations$Userstores$Patch extends StandardParameters {
|
|
38459
|
+
/**
|
|
38460
|
+
* Immutable. The full resource name of the User Store, in the format of `projects/{project\}/locations/{location\}/userStores/{user_store\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
38461
|
+
*/
|
|
38462
|
+
name?: string;
|
|
38463
|
+
/**
|
|
38464
|
+
* Optional. The list of fields to update.
|
|
38465
|
+
*/
|
|
38466
|
+
updateMask?: string;
|
|
38467
|
+
/**
|
|
38468
|
+
* Request body metadata
|
|
38469
|
+
*/
|
|
38470
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1UserStore;
|
|
38471
|
+
}
|
|
38472
|
+
export class Resource$Projects$Locations$Userstores$Licenseconfigsusagestats {
|
|
38473
|
+
context: APIRequestContext;
|
|
38474
|
+
constructor(context: APIRequestContext);
|
|
38475
|
+
/**
|
|
38476
|
+
* Lists all the LicenseConfigUsageStatss associated with the project.
|
|
38477
|
+
* @example
|
|
38478
|
+
* ```js
|
|
38479
|
+
* // Before running the sample:
|
|
38480
|
+
* // - Enable the API at:
|
|
38481
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
38482
|
+
* // - Login into gcloud by running:
|
|
38483
|
+
* // ```sh
|
|
38484
|
+
* // $ gcloud auth application-default login
|
|
38485
|
+
* // ```
|
|
38486
|
+
* // - Install the npm module by running:
|
|
38487
|
+
* // ```sh
|
|
38488
|
+
* // $ npm install googleapis
|
|
38489
|
+
* // ```
|
|
38490
|
+
*
|
|
38491
|
+
* const {google} = require('googleapis');
|
|
38492
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
38493
|
+
*
|
|
38494
|
+
* async function main() {
|
|
38495
|
+
* const auth = new google.auth.GoogleAuth({
|
|
38496
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
38497
|
+
* scopes: [
|
|
38498
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
38499
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
38500
|
+
* ],
|
|
38501
|
+
* });
|
|
38502
|
+
*
|
|
38503
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
38504
|
+
* const authClient = await auth.getClient();
|
|
38505
|
+
* google.options({auth: authClient});
|
|
38506
|
+
*
|
|
38507
|
+
* // Do the magic
|
|
38508
|
+
* const res =
|
|
38509
|
+
* await discoveryengine.projects.locations.userStores.licenseConfigsUsageStats.list(
|
|
38510
|
+
* {
|
|
38511
|
+
* // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
|
|
38512
|
+
* parent:
|
|
38513
|
+
* 'projects/my-project/locations/my-location/userStores/my-userStore',
|
|
38514
|
+
* },
|
|
38515
|
+
* );
|
|
38516
|
+
* console.log(res.data);
|
|
38517
|
+
*
|
|
38518
|
+
* // Example response
|
|
38519
|
+
* // {
|
|
38520
|
+
* // "licenseConfigUsageStats": []
|
|
38521
|
+
* // }
|
|
38522
|
+
* }
|
|
38523
|
+
*
|
|
38524
|
+
* main().catch(e => {
|
|
38525
|
+
* console.error(e);
|
|
38526
|
+
* throw e;
|
|
38527
|
+
* });
|
|
38528
|
+
*
|
|
38529
|
+
* ```
|
|
38530
|
+
*
|
|
38531
|
+
* @param params - Parameters for request
|
|
38532
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
38533
|
+
* @param callback - Optional callback that handles the response.
|
|
38534
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
38535
|
+
*/
|
|
38536
|
+
list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
38537
|
+
list(params?: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>>;
|
|
38538
|
+
list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
38539
|
+
list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>): void;
|
|
38540
|
+
list(params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>): void;
|
|
38541
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>): void;
|
|
38542
|
+
}
|
|
38543
|
+
export interface Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List extends StandardParameters {
|
|
38544
|
+
/**
|
|
38545
|
+
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
|
|
38546
|
+
*/
|
|
38547
|
+
parent?: string;
|
|
38548
|
+
}
|
|
36020
38549
|
export class Resource$Projects$Locations$Userstores$Userlicenses {
|
|
36021
38550
|
context: APIRequestContext;
|
|
36022
38551
|
constructor(context: APIRequestContext);
|
|
@@ -36055,7 +38584,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
36055
38584
|
* // Do the magic
|
|
36056
38585
|
* const res =
|
|
36057
38586
|
* await discoveryengine.projects.locations.userStores.userLicenses.list({
|
|
36058
|
-
* // Optional. Filter for the list request. Supported fields: * `
|
|
38587
|
+
* // Optional. Filter for the list request. Supported fields: * `license`_`assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.
|
|
36059
38588
|
* filter: 'placeholder-value',
|
|
36060
38589
|
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.
|
|
36061
38590
|
* pageSize: 'placeholder-value',
|
|
@@ -36095,7 +38624,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
36095
38624
|
}
|
|
36096
38625
|
export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List extends StandardParameters {
|
|
36097
38626
|
/**
|
|
36098
|
-
* Optional. Filter for the list request. Supported fields: * `
|
|
38627
|
+
* Optional. Filter for the list request. Supported fields: * `license`_`assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.
|
|
36099
38628
|
*/
|
|
36100
38629
|
filter?: string;
|
|
36101
38630
|
/**
|