@googleapis/discoveryengine 27.0.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/v1.ts CHANGED
@@ -3130,6 +3130,10 @@ export namespace discoveryengine_v1 {
3130
3130
  * Optional. If true, the LLM based annotation is added to the image during parsing.
3131
3131
  */
3132
3132
  enableImageAnnotation?: boolean | null;
3133
+ /**
3134
+ * Optional. If true, the pdf layout will be refined using an LLM.
3135
+ */
3136
+ enableLlmLayoutParsing?: boolean | null;
3133
3137
  /**
3134
3138
  * Optional. If true, the LLM based annotation is added to the table during parsing.
3135
3139
  */
@@ -3197,6 +3201,10 @@ export namespace discoveryengine_v1 {
3197
3201
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
3198
3202
  */
3199
3203
  chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata;
3204
+ /**
3205
+ * Output only. CMEK-related information for the Engine.
3206
+ */
3207
+ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1alphaCmekConfig;
3200
3208
  /**
3201
3209
  * Common config spec that specifies the metadata of the engine.
3202
3210
  */
@@ -3233,6 +3241,10 @@ export namespace discoveryengine_v1 {
3233
3241
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
3234
3242
  */
3235
3243
  mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
3244
+ /**
3245
+ * 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.
3246
+ */
3247
+ modelConfigs?: {[key: string]: string} | null;
3236
3248
  /**
3237
3249
  * 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.
3238
3250
  */
@@ -7638,6 +7650,10 @@ export namespace discoveryengine_v1 {
7638
7650
  * Optional. If true, the LLM based annotation is added to the image during parsing.
7639
7651
  */
7640
7652
  enableImageAnnotation?: boolean | null;
7653
+ /**
7654
+ * Optional. If true, the pdf layout will be refined using an LLM.
7655
+ */
7656
+ enableLlmLayoutParsing?: boolean | null;
7641
7657
  /**
7642
7658
  * Optional. If true, the LLM based annotation is added to the table during parsing.
7643
7659
  */
@@ -7705,6 +7721,10 @@ export namespace discoveryengine_v1 {
7705
7721
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
7706
7722
  */
7707
7723
  chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata;
7724
+ /**
7725
+ * Output only. CMEK-related information for the Engine.
7726
+ */
7727
+ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1betaCmekConfig;
7708
7728
  /**
7709
7729
  * Common config spec that specifies the metadata of the engine.
7710
7730
  */
@@ -7741,6 +7761,10 @@ export namespace discoveryengine_v1 {
7741
7761
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
7742
7762
  */
7743
7763
  mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig;
7764
+ /**
7765
+ * 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.
7766
+ */
7767
+ modelConfigs?: {[key: string]: string} | null;
7744
7768
  /**
7745
7769
  * 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.
7746
7770
  */
@@ -11231,6 +11255,10 @@ export namespace discoveryengine_v1 {
11231
11255
  * Optional. If true, the LLM based annotation is added to the image during parsing.
11232
11256
  */
11233
11257
  enableImageAnnotation?: boolean | null;
11258
+ /**
11259
+ * Optional. If true, the pdf layout will be refined using an LLM.
11260
+ */
11261
+ enableLlmLayoutParsing?: boolean | null;
11234
11262
  /**
11235
11263
  * Optional. If true, the LLM based annotation is added to the table during parsing.
11236
11264
  */
@@ -11311,6 +11339,10 @@ export namespace discoveryengine_v1 {
11311
11339
  * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
11312
11340
  */
11313
11341
  chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata;
11342
+ /**
11343
+ * Output only. CMEK-related information for the Engine.
11344
+ */
11345
+ cmekConfig?: Schema$GoogleCloudDiscoveryengineV1CmekConfig;
11314
11346
  /**
11315
11347
  * Common config spec that specifies the metadata of the engine.
11316
11348
  */
@@ -11347,6 +11379,10 @@ export namespace discoveryengine_v1 {
11347
11379
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
11348
11380
  */
11349
11381
  mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig;
11382
+ /**
11383
+ * 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.
11384
+ */
11385
+ modelConfigs?: {[key: string]: string} | null;
11350
11386
  /**
11351
11387
  * 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.
11352
11388
  */
@@ -12139,6 +12175,19 @@ export namespace discoveryengine_v1 {
12139
12175
  */
12140
12176
  subscriptionTier?: string | null;
12141
12177
  }
12178
+ /**
12179
+ * Stats about users' licenses.
12180
+ */
12181
+ export interface Schema$GoogleCloudDiscoveryengineV1LicenseConfigUsageStats {
12182
+ /**
12183
+ * Required. The LicenseConfig name.
12184
+ */
12185
+ licenseConfig?: string | null;
12186
+ /**
12187
+ * Required. The number of licenses used.
12188
+ */
12189
+ usedLicenseCount?: string | null;
12190
+ }
12142
12191
  /**
12143
12192
  * Response message for CmekConfigService.ListCmekConfigs method.
12144
12193
  */
@@ -12248,6 +12297,15 @@ export namespace discoveryengine_v1 {
12248
12297
  */
12249
12298
  nextPageToken?: string | null;
12250
12299
  }
12300
+ /**
12301
+ * Response message for UserLicenseService.ListLicenseConfigUsageStats method.
12302
+ */
12303
+ export interface Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse {
12304
+ /**
12305
+ * All the customer's LicenseConfigUsageStats.
12306
+ */
12307
+ licenseConfigUsageStats?: Schema$GoogleCloudDiscoveryengineV1LicenseConfigUsageStats[];
12308
+ }
12251
12309
  /**
12252
12310
  * Response message for SchemaService.ListSchemas method.
12253
12311
  */
@@ -14586,6 +14644,481 @@ export namespace discoveryengine_v1 {
14586
14644
  */
14587
14645
  name?: string | null;
14588
14646
  }
14647
+ /**
14648
+ * WidgetConfig captures configs at the Widget level.
14649
+ */
14650
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfig {
14651
+ /**
14652
+ * Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.
14653
+ */
14654
+ accessSettings?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings;
14655
+ /**
14656
+ * Allowlisted domains that can load this widget.
14657
+ */
14658
+ allowlistedDomains?: string[] | null;
14659
+ /**
14660
+ * 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.
14661
+ */
14662
+ allowPublicAccess?: boolean | null;
14663
+ /**
14664
+ * Optional. Output only. Describes the assistant settings of the widget.
14665
+ */
14666
+ assistantSettings?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings;
14667
+ /**
14668
+ * 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.
14669
+ */
14670
+ collectionComponents?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent[];
14671
+ /**
14672
+ * Output only. Unique obfuscated identifier of a WidgetConfig.
14673
+ */
14674
+ configId?: string | null;
14675
+ /**
14676
+ * The content search spec that configs the desired behavior of content search.
14677
+ */
14678
+ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec;
14679
+ /**
14680
+ * Output only. Timestamp the WidgetConfig was created.
14681
+ */
14682
+ createTime?: string | null;
14683
+ /**
14684
+ * Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.
14685
+ */
14686
+ customerProvidedConfig?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig;
14687
+ /**
14688
+ * Output only. The type of the parent data store.
14689
+ */
14690
+ dataStoreType?: string | null;
14691
+ /**
14692
+ * Configurable UI configurations per data store.
14693
+ */
14694
+ dataStoreUiConfigs?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig[];
14695
+ /**
14696
+ * 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
14697
+ */
14698
+ defaultSearchRequestOrderBy?: string | null;
14699
+ /**
14700
+ * 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.
14701
+ */
14702
+ displayName?: string | null;
14703
+ /**
14704
+ * Whether or not to enable autocomplete.
14705
+ */
14706
+ enableAutocomplete?: boolean | null;
14707
+ /**
14708
+ * Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
14709
+ */
14710
+ enableConversationalSearch?: boolean | null;
14711
+ /**
14712
+ * Optional. Output only. Whether to enable private knowledge graph.
14713
+ */
14714
+ enablePrivateKnowledgeGraph?: boolean | null;
14715
+ /**
14716
+ * Turn on or off collecting the search result quality feedback from end users.
14717
+ */
14718
+ enableQualityFeedback?: boolean | null;
14719
+ /**
14720
+ * Whether to show the result score.
14721
+ */
14722
+ enableResultScore?: boolean | null;
14723
+ /**
14724
+ * Whether to enable safe search.
14725
+ */
14726
+ enableSafeSearch?: boolean | null;
14727
+ /**
14728
+ * Whether to enable search-as-you-type behavior for the search widget
14729
+ */
14730
+ enableSearchAsYouType?: boolean | null;
14731
+ /**
14732
+ * Turn on or off summary for each snippets result.
14733
+ */
14734
+ enableSnippetResultSummary?: boolean | null;
14735
+ /**
14736
+ * Turn on or off summarization for the search response.
14737
+ */
14738
+ enableSummarization?: boolean | null;
14739
+ /**
14740
+ * Whether to enable standalone web app.
14741
+ */
14742
+ enableWebApp?: boolean | null;
14743
+ /**
14744
+ * The configuration and appearance of facets in the end user view.
14745
+ */
14746
+ facetField?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigFacetField[];
14747
+ /**
14748
+ * 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.
14749
+ */
14750
+ fieldsUiComponentsMap?: {
14751
+ [
14752
+ key: string
14753
+ ]: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField;
14754
+ } | null;
14755
+ /**
14756
+ * Output only. Whether the subscription is gemini bundle or not.
14757
+ */
14758
+ geminiBundle?: boolean | null;
14759
+ /**
14760
+ * Optional. Describes the homepage settings of the widget.
14761
+ */
14762
+ homepageSetting?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting;
14763
+ /**
14764
+ * Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
14765
+ */
14766
+ industryVertical?: string | null;
14767
+ /**
14768
+ * Output only. Whether LLM is enabled in the corresponding data store.
14769
+ */
14770
+ llmEnabled?: boolean | null;
14771
+ /**
14772
+ * Output only. Whether the customer accepted data use terms.
14773
+ */
14774
+ minimumDataTermAccepted?: boolean | null;
14775
+ /**
14776
+ * 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.
14777
+ */
14778
+ name?: string | null;
14779
+ /**
14780
+ * 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.
14781
+ */
14782
+ resultDisplayType?: string | null;
14783
+ /**
14784
+ * Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
14785
+ */
14786
+ solutionType?: string | null;
14787
+ /**
14788
+ * Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
14789
+ */
14790
+ uiBranding?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings;
14791
+ /**
14792
+ * Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.
14793
+ */
14794
+ uiSettings?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettings;
14795
+ /**
14796
+ * Output only. Timestamp the WidgetConfig was updated.
14797
+ */
14798
+ updateTime?: string | null;
14799
+ }
14800
+ /**
14801
+ * Describes widget access settings.
14802
+ */
14803
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings {
14804
+ /**
14805
+ * List of domains that are allowed to integrate the search widget.
14806
+ */
14807
+ allowlistedDomains?: string[] | null;
14808
+ /**
14809
+ * Whether public unauthenticated access is allowed.
14810
+ */
14811
+ allowPublicAccess?: boolean | null;
14812
+ /**
14813
+ * Whether web app access is enabled.
14814
+ */
14815
+ enableWebApp?: boolean | null;
14816
+ /**
14817
+ * 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".
14818
+ */
14819
+ languageCode?: string | null;
14820
+ /**
14821
+ * Optional. The workforce identity pool provider used to access the widget.
14822
+ */
14823
+ workforceIdentityPoolProvider?: string | null;
14824
+ }
14825
+ /**
14826
+ * Describes the assistant settings of the widget.
14827
+ */
14828
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings {
14829
+ /**
14830
+ * 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.
14831
+ */
14832
+ defaultWebGroundingToggleOff?: boolean | null;
14833
+ /**
14834
+ * Optional. Output only. Whether to disable user location context.
14835
+ */
14836
+ disableLocationContext?: boolean | null;
14837
+ /**
14838
+ * Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead.
14839
+ */
14840
+ googleSearchGroundingEnabled?: boolean | null;
14841
+ /**
14842
+ * Optional. The type of web grounding to use.
14843
+ */
14844
+ webGroundingType?: string | null;
14845
+ }
14846
+ /**
14847
+ * Read-only collection component that contains data store collections fields that may be used for filtering
14848
+ */
14849
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent {
14850
+ /**
14851
+ * Output only. The icon link of the connector source.
14852
+ */
14853
+ connectorIconLink?: string | null;
14854
+ /**
14855
+ * The name of the data source, retrieved from `Collection.data_connector.data_source`.
14856
+ */
14857
+ dataSource?: string | null;
14858
+ /**
14859
+ * Output only. The display name of the data source.
14860
+ */
14861
+ dataSourceDisplayName?: string | null;
14862
+ /**
14863
+ * For the data store collection, list of the children data stores.
14864
+ */
14865
+ dataStoreComponents?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent[];
14866
+ /**
14867
+ * The display name of the collection.
14868
+ */
14869
+ displayName?: string | null;
14870
+ /**
14871
+ * 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.
14872
+ */
14873
+ id?: string | null;
14874
+ /**
14875
+ * 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.
14876
+ */
14877
+ name?: string | null;
14878
+ }
14879
+ /**
14880
+ * Customer provided configurations.
14881
+ */
14882
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig {
14883
+ /**
14884
+ * Customer type.
14885
+ */
14886
+ customerType?: string | null;
14887
+ }
14888
+ /**
14889
+ * Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.
14890
+ */
14891
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent {
14892
+ /**
14893
+ * Output only. The type of the data store config.
14894
+ */
14895
+ dataStoreConfigType?: string | null;
14896
+ /**
14897
+ * The display name of the data store.
14898
+ */
14899
+ displayName?: string | null;
14900
+ /**
14901
+ * The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.
14902
+ */
14903
+ entityName?: string | null;
14904
+ /**
14905
+ * 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.
14906
+ */
14907
+ id?: string | null;
14908
+ /**
14909
+ * 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.
14910
+ */
14911
+ name?: string | null;
14912
+ }
14913
+ /**
14914
+ * UI component configuration for data store.
14915
+ */
14916
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig {
14917
+ /**
14918
+ * Facet fields that store the mapping of fields to end user widget appearance.
14919
+ */
14920
+ facetField?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigFacetField[];
14921
+ /**
14922
+ * 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.
14923
+ */
14924
+ fieldsUiComponentsMap?: {
14925
+ [
14926
+ key: string
14927
+ ]: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField;
14928
+ } | null;
14929
+ /**
14930
+ * 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.
14931
+ */
14932
+ id?: string | null;
14933
+ /**
14934
+ * 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.
14935
+ */
14936
+ name?: string | null;
14937
+ }
14938
+ /**
14939
+ * Facet fields that store the mapping of fields to end user widget appearance.
14940
+ */
14941
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigFacetField {
14942
+ /**
14943
+ * Optional. The field name that end users will see.
14944
+ */
14945
+ displayName?: string | null;
14946
+ /**
14947
+ * Required. Registered field name. The format is `field.abc`.
14948
+ */
14949
+ field?: string | null;
14950
+ }
14951
+ /**
14952
+ * Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts.
14953
+ */
14954
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting {
14955
+ /**
14956
+ * Optional. The shortcuts to display on the homepage.
14957
+ */
14958
+ shortcuts?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut[];
14959
+ }
14960
+ /**
14961
+ * 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.
14962
+ */
14963
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut {
14964
+ /**
14965
+ * Optional. Destination URL of shortcut.
14966
+ */
14967
+ destinationUri?: string | null;
14968
+ /**
14969
+ * Optional. Icon URL of shortcut.
14970
+ */
14971
+ icon?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigImage;
14972
+ /**
14973
+ * Optional. Title of the shortcut.
14974
+ */
14975
+ title?: string | null;
14976
+ }
14977
+ /**
14978
+ * Options to store an image.
14979
+ */
14980
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigImage {
14981
+ /**
14982
+ * Image URL.
14983
+ */
14984
+ url?: string | null;
14985
+ }
14986
+ /**
14987
+ * Describes widget UI branding settings.
14988
+ */
14989
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings {
14990
+ /**
14991
+ * Logo image.
14992
+ */
14993
+ logo?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigImage;
14994
+ }
14995
+ /**
14996
+ * Facet field that maps to a UI Component.
14997
+ */
14998
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUIComponentField {
14999
+ /**
15000
+ * The field visibility on different types of devices.
15001
+ */
15002
+ deviceVisibility?: string[] | null;
15003
+ /**
15004
+ * The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value\}".
15005
+ */
15006
+ displayTemplate?: string | null;
15007
+ /**
15008
+ * Required. Registered field name. The format is `field.abc`.
15009
+ */
15010
+ field?: string | null;
15011
+ }
15012
+ /**
15013
+ * Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.
15014
+ */
15015
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettings {
15016
+ /**
15017
+ * Per data store configuration.
15018
+ */
15019
+ dataStoreUiConfigs?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig[];
15020
+ /**
15021
+ * 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
15022
+ */
15023
+ defaultSearchRequestOrderBy?: string | null;
15024
+ /**
15025
+ * If set to true, the widget will not collect user events.
15026
+ */
15027
+ disableUserEventsCollection?: boolean | null;
15028
+ /**
15029
+ * Whether or not to enable autocomplete.
15030
+ */
15031
+ enableAutocomplete?: boolean | null;
15032
+ /**
15033
+ * Optional. If set to true, the widget will enable the create agent button.
15034
+ */
15035
+ enableCreateAgentButton?: boolean | null;
15036
+ /**
15037
+ * Optional. If set to true, the widget will enable people search.
15038
+ */
15039
+ enablePeopleSearch?: boolean | null;
15040
+ /**
15041
+ * Turn on or off collecting the search result quality feedback from end users.
15042
+ */
15043
+ enableQualityFeedback?: boolean | null;
15044
+ /**
15045
+ * Whether to enable safe search.
15046
+ */
15047
+ enableSafeSearch?: boolean | null;
15048
+ /**
15049
+ * Whether to enable search-as-you-type behavior for the search widget.
15050
+ */
15051
+ enableSearchAsYouType?: boolean | null;
15052
+ /**
15053
+ * If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
15054
+ */
15055
+ enableVisualContentSummary?: boolean | null;
15056
+ /**
15057
+ * 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`
15058
+ */
15059
+ features?: {[key: string]: string} | null;
15060
+ /**
15061
+ * Describes generative answer configuration.
15062
+ */
15063
+ generativeAnswerConfig?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig;
15064
+ /**
15065
+ * Describes widget (or web app) interaction type
15066
+ */
15067
+ interactionType?: string | null;
15068
+ /**
15069
+ * 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.
15070
+ */
15071
+ modelConfigs?: {[key: string]: string} | null;
15072
+ /**
15073
+ * Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
15074
+ */
15075
+ resultDescriptionType?: string | null;
15076
+ }
15077
+ /**
15078
+ * Describes configuration for generative answer.
15079
+ */
15080
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig {
15081
+ /**
15082
+ * Whether generated answer contains suggested related questions.
15083
+ */
15084
+ disableRelatedQuestions?: boolean | null;
15085
+ /**
15086
+ * Optional. Specifies whether to filter out queries that are adversarial.
15087
+ */
15088
+ ignoreAdversarialQuery?: boolean | null;
15089
+ /**
15090
+ * Optional. Specifies whether to filter out queries that are not relevant to the content.
15091
+ */
15092
+ ignoreLowRelevantContent?: boolean | null;
15093
+ /**
15094
+ * 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.
15095
+ */
15096
+ ignoreNonAnswerSeekingQuery?: boolean | null;
15097
+ /**
15098
+ * Optional. Source of image returned in the answer.
15099
+ */
15100
+ imageSource?: string | null;
15101
+ /**
15102
+ * 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.
15103
+ */
15104
+ languageCode?: string | null;
15105
+ /**
15106
+ * Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
15107
+ */
15108
+ maxRephraseSteps?: number | null;
15109
+ /**
15110
+ * Text at the beginning of the prompt that instructs the model that generates the answer.
15111
+ */
15112
+ modelPromptPreamble?: string | null;
15113
+ /**
15114
+ * The model version used to generate the answer.
15115
+ */
15116
+ modelVersion?: string | null;
15117
+ /**
15118
+ * The number of top results to generate the answer from. Up to 10.
15119
+ */
15120
+ resultCount?: number | null;
15121
+ }
14589
15122
  /**
14590
15123
  * Config to store data store type configuration for workspace data
14591
15124
  */
@@ -17987,6 +18520,7 @@ export namespace discoveryengine_v1 {
17987
18520
  siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine;
17988
18521
  suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries;
17989
18522
  userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
18523
+ widgetConfigs: Resource$Projects$Locations$Collections$Datastores$Widgetconfigs;
17990
18524
  constructor(context: APIRequestContext) {
17991
18525
  this.context = context;
17992
18526
  this.branches =
@@ -18045,6 +18579,10 @@ export namespace discoveryengine_v1 {
18045
18579
  new Resource$Projects$Locations$Collections$Datastores$Userevents(
18046
18580
  this.context
18047
18581
  );
18582
+ this.widgetConfigs =
18583
+ new Resource$Projects$Locations$Collections$Datastores$Widgetconfigs(
18584
+ this.context
18585
+ );
18048
18586
  }
18049
18587
 
18050
18588
  /**
@@ -33072,49 +33610,14 @@ export namespace discoveryengine_v1 {
33072
33610
  requestBody?: Schema$GoogleCloudDiscoveryengineV1UserEvent;
33073
33611
  }
33074
33612
 
33075
- export class Resource$Projects$Locations$Collections$Engines {
33613
+ export class Resource$Projects$Locations$Collections$Datastores$Widgetconfigs {
33076
33614
  context: APIRequestContext;
33077
- assistants: Resource$Projects$Locations$Collections$Engines$Assistants;
33078
- completionConfig: Resource$Projects$Locations$Collections$Engines$Completionconfig;
33079
- controls: Resource$Projects$Locations$Collections$Engines$Controls;
33080
- conversations: Resource$Projects$Locations$Collections$Engines$Conversations;
33081
- operations: Resource$Projects$Locations$Collections$Engines$Operations;
33082
- servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
33083
- sessions: Resource$Projects$Locations$Collections$Engines$Sessions;
33084
33615
  constructor(context: APIRequestContext) {
33085
33616
  this.context = context;
33086
- this.assistants =
33087
- new Resource$Projects$Locations$Collections$Engines$Assistants(
33088
- this.context
33089
- );
33090
- this.completionConfig =
33091
- new Resource$Projects$Locations$Collections$Engines$Completionconfig(
33092
- this.context
33093
- );
33094
- this.controls =
33095
- new Resource$Projects$Locations$Collections$Engines$Controls(
33096
- this.context
33097
- );
33098
- this.conversations =
33099
- new Resource$Projects$Locations$Collections$Engines$Conversations(
33100
- this.context
33101
- );
33102
- this.operations =
33103
- new Resource$Projects$Locations$Collections$Engines$Operations(
33104
- this.context
33105
- );
33106
- this.servingConfigs =
33107
- new Resource$Projects$Locations$Collections$Engines$Servingconfigs(
33108
- this.context
33109
- );
33110
- this.sessions =
33111
- new Resource$Projects$Locations$Collections$Engines$Sessions(
33112
- this.context
33113
- );
33114
33617
  }
33115
33618
 
33116
33619
  /**
33117
- * Creates a Engine.
33620
+ * Gets a WidgetConfig.
33118
33621
  * @example
33119
33622
  * ```js
33120
33623
  * // Before running the sample:
@@ -33137,6 +33640,7 @@ export namespace discoveryengine_v1 {
33137
33640
  * // Scopes can be specified either as an array or as a single, space-delimited string.
33138
33641
  * scopes: [
33139
33642
  * 'https://www.googleapis.com/auth/cloud-platform',
33643
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
33140
33644
  * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
33141
33645
  * ],
33142
33646
  * });
@@ -33147,45 +33651,57 @@ export namespace discoveryengine_v1 {
33147
33651
  *
33148
33652
  * // Do the magic
33149
33653
  * const res =
33150
- * await discoveryengine.projects.locations.collections.engines.create({
33151
- * // Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
33152
- * engineId: 'placeholder-value',
33153
- * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`.
33154
- * parent:
33155
- * 'projects/my-project/locations/my-location/collections/my-collection',
33156
- *
33157
- * // Request body metadata
33158
- * requestBody: {
33159
- * // request body parameters
33160
- * // {
33161
- * // "appType": "my_appType",
33162
- * // "chatEngineConfig": {},
33163
- * // "chatEngineMetadata": {},
33164
- * // "commonConfig": {},
33165
- * // "configurableBillingApproach": "my_configurableBillingApproach",
33166
- * // "createTime": "my_createTime",
33167
- * // "dataStoreIds": [],
33168
- * // "disableAnalytics": false,
33169
- * // "displayName": "my_displayName",
33170
- * // "features": {},
33171
- * // "industryVertical": "my_industryVertical",
33172
- * // "mediaRecommendationEngineConfig": {},
33173
- * // "name": "my_name",
33174
- * // "searchEngineConfig": {},
33175
- * // "solutionType": "my_solutionType",
33176
- * // "updateTime": "my_updateTime"
33177
- * // }
33654
+ * await discoveryengine.projects.locations.collections.dataStores.widgetConfigs.get(
33655
+ * {
33656
+ * // 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.
33657
+ * acceptCache: 'placeholder-value',
33658
+ * // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
33659
+ * 'getWidgetConfigRequestOption.turnOffCollectionComponents':
33660
+ * 'placeholder-value',
33661
+ * // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
33662
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
33178
33663
  * },
33179
- * });
33664
+ * );
33180
33665
  * console.log(res.data);
33181
33666
  *
33182
33667
  * // Example response
33183
33668
  * // {
33184
- * // "done": false,
33185
- * // "error": {},
33186
- * // "metadata": {},
33669
+ * // "accessSettings": {},
33670
+ * // "allowPublicAccess": false,
33671
+ * // "allowlistedDomains": [],
33672
+ * // "assistantSettings": {},
33673
+ * // "collectionComponents": [],
33674
+ * // "configId": "my_configId",
33675
+ * // "contentSearchSpec": {},
33676
+ * // "createTime": "my_createTime",
33677
+ * // "customerProvidedConfig": {},
33678
+ * // "dataStoreType": "my_dataStoreType",
33679
+ * // "dataStoreUiConfigs": [],
33680
+ * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
33681
+ * // "displayName": "my_displayName",
33682
+ * // "enableAutocomplete": false,
33683
+ * // "enableConversationalSearch": false,
33684
+ * // "enablePrivateKnowledgeGraph": false,
33685
+ * // "enableQualityFeedback": false,
33686
+ * // "enableResultScore": false,
33687
+ * // "enableSafeSearch": false,
33688
+ * // "enableSearchAsYouType": false,
33689
+ * // "enableSnippetResultSummary": false,
33690
+ * // "enableSummarization": false,
33691
+ * // "enableWebApp": false,
33692
+ * // "facetField": [],
33693
+ * // "fieldsUiComponentsMap": {},
33694
+ * // "geminiBundle": false,
33695
+ * // "homepageSetting": {},
33696
+ * // "industryVertical": "my_industryVertical",
33697
+ * // "llmEnabled": false,
33698
+ * // "minimumDataTermAccepted": false,
33187
33699
  * // "name": "my_name",
33188
- * // "response": {}
33700
+ * // "resultDisplayType": "my_resultDisplayType",
33701
+ * // "solutionType": "my_solutionType",
33702
+ * // "uiBranding": {},
33703
+ * // "uiSettings": {},
33704
+ * // "updateTime": "my_updateTime"
33189
33705
  * // }
33190
33706
  * }
33191
33707
  *
@@ -33201,58 +33717,62 @@ export namespace discoveryengine_v1 {
33201
33717
  * @param callback - Optional callback that handles the response.
33202
33718
  * @returns A promise if used with async/await, or void if used with a callback.
33203
33719
  */
33204
- create(
33205
- params: Params$Resource$Projects$Locations$Collections$Engines$Create,
33720
+ get(
33721
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get,
33206
33722
  options: StreamMethodOptions
33207
33723
  ): Promise<GaxiosResponseWithHTTP2<Readable>>;
33208
- create(
33209
- params?: Params$Resource$Projects$Locations$Collections$Engines$Create,
33724
+ get(
33725
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get,
33210
33726
  options?: MethodOptions
33211
- ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
33212
- create(
33213
- params: Params$Resource$Projects$Locations$Collections$Engines$Create,
33727
+ ): Promise<
33728
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33729
+ >;
33730
+ get(
33731
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get,
33214
33732
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
33215
33733
  callback: BodyResponseCallback<Readable>
33216
33734
  ): void;
33217
- create(
33218
- params: Params$Resource$Projects$Locations$Collections$Engines$Create,
33735
+ get(
33736
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get,
33219
33737
  options:
33220
33738
  | MethodOptions
33221
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
33222
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
33739
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>,
33740
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33223
33741
  ): void;
33224
- create(
33225
- params: Params$Resource$Projects$Locations$Collections$Engines$Create,
33226
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
33742
+ get(
33743
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get,
33744
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33227
33745
  ): void;
33228
- create(
33229
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
33746
+ get(
33747
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33230
33748
  ): void;
33231
- create(
33749
+ get(
33232
33750
  paramsOrCallback?:
33233
- | Params$Resource$Projects$Locations$Collections$Engines$Create
33234
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
33751
+ | Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get
33752
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33235
33753
  | BodyResponseCallback<Readable>,
33236
33754
  optionsOrCallback?:
33237
33755
  | MethodOptions
33238
33756
  | StreamMethodOptions
33239
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
33757
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33240
33758
  | BodyResponseCallback<Readable>,
33241
33759
  callback?:
33242
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
33760
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33243
33761
  | BodyResponseCallback<Readable>
33244
33762
  ):
33245
33763
  | void
33246
- | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
33764
+ | Promise<
33765
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33766
+ >
33247
33767
  | Promise<GaxiosResponseWithHTTP2<Readable>> {
33248
33768
  let params = (paramsOrCallback ||
33249
- {}) as Params$Resource$Projects$Locations$Collections$Engines$Create;
33769
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get;
33250
33770
  let options = (optionsOrCallback || {}) as MethodOptions;
33251
33771
 
33252
33772
  if (typeof paramsOrCallback === 'function') {
33253
33773
  callback = paramsOrCallback;
33254
33774
  params =
33255
- {} as Params$Resource$Projects$Locations$Collections$Engines$Create;
33775
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get;
33256
33776
  options = {};
33257
33777
  }
33258
33778
 
@@ -33266,32 +33786,31 @@ export namespace discoveryengine_v1 {
33266
33786
  const parameters = {
33267
33787
  options: Object.assign(
33268
33788
  {
33269
- url: (rootUrl + '/v1/{+parent}/engines').replace(
33270
- /([^:]\/)\/+/g,
33271
- '$1'
33272
- ),
33273
- method: 'POST',
33789
+ url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
33790
+ method: 'GET',
33274
33791
  apiVersion: '',
33275
33792
  },
33276
33793
  options
33277
33794
  ),
33278
33795
  params,
33279
- requiredParams: ['parent'],
33280
- pathParams: ['parent'],
33796
+ requiredParams: ['name'],
33797
+ pathParams: ['name'],
33281
33798
  context: this.context,
33282
33799
  };
33283
33800
  if (callback) {
33284
- createAPIRequest<Schema$GoogleLongrunningOperation>(
33801
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>(
33285
33802
  parameters,
33286
33803
  callback as BodyResponseCallback<unknown>
33287
33804
  );
33288
33805
  } else {
33289
- return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
33806
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>(
33807
+ parameters
33808
+ );
33290
33809
  }
33291
33810
  }
33292
33811
 
33293
33812
  /**
33294
- * Deletes a Engine.
33813
+ * Update a WidgetConfig.
33295
33814
  * @example
33296
33815
  * ```js
33297
33816
  * // Before running the sample:
@@ -33314,6 +33833,7 @@ export namespace discoveryengine_v1 {
33314
33833
  * // Scopes can be specified either as an array or as a single, space-delimited string.
33315
33834
  * scopes: [
33316
33835
  * 'https://www.googleapis.com/auth/cloud-platform',
33836
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
33317
33837
  * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
33318
33838
  * ],
33319
33839
  * });
@@ -33324,19 +33844,97 @@ export namespace discoveryengine_v1 {
33324
33844
  *
33325
33845
  * // Do the magic
33326
33846
  * const res =
33327
- * await discoveryengine.projects.locations.collections.engines.delete({
33328
- * // Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned.
33329
- * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
33330
- * });
33847
+ * await discoveryengine.projects.locations.collections.dataStores.widgetConfigs.patch(
33848
+ * {
33849
+ * // 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.
33850
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
33851
+ * // 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.
33852
+ * updateMask: 'placeholder-value',
33853
+ *
33854
+ * // Request body metadata
33855
+ * requestBody: {
33856
+ * // request body parameters
33857
+ * // {
33858
+ * // "accessSettings": {},
33859
+ * // "allowPublicAccess": false,
33860
+ * // "allowlistedDomains": [],
33861
+ * // "assistantSettings": {},
33862
+ * // "collectionComponents": [],
33863
+ * // "configId": "my_configId",
33864
+ * // "contentSearchSpec": {},
33865
+ * // "createTime": "my_createTime",
33866
+ * // "customerProvidedConfig": {},
33867
+ * // "dataStoreType": "my_dataStoreType",
33868
+ * // "dataStoreUiConfigs": [],
33869
+ * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
33870
+ * // "displayName": "my_displayName",
33871
+ * // "enableAutocomplete": false,
33872
+ * // "enableConversationalSearch": false,
33873
+ * // "enablePrivateKnowledgeGraph": false,
33874
+ * // "enableQualityFeedback": false,
33875
+ * // "enableResultScore": false,
33876
+ * // "enableSafeSearch": false,
33877
+ * // "enableSearchAsYouType": false,
33878
+ * // "enableSnippetResultSummary": false,
33879
+ * // "enableSummarization": false,
33880
+ * // "enableWebApp": false,
33881
+ * // "facetField": [],
33882
+ * // "fieldsUiComponentsMap": {},
33883
+ * // "geminiBundle": false,
33884
+ * // "homepageSetting": {},
33885
+ * // "industryVertical": "my_industryVertical",
33886
+ * // "llmEnabled": false,
33887
+ * // "minimumDataTermAccepted": false,
33888
+ * // "name": "my_name",
33889
+ * // "resultDisplayType": "my_resultDisplayType",
33890
+ * // "solutionType": "my_solutionType",
33891
+ * // "uiBranding": {},
33892
+ * // "uiSettings": {},
33893
+ * // "updateTime": "my_updateTime"
33894
+ * // }
33895
+ * },
33896
+ * },
33897
+ * );
33331
33898
  * console.log(res.data);
33332
33899
  *
33333
33900
  * // Example response
33334
33901
  * // {
33335
- * // "done": false,
33336
- * // "error": {},
33337
- * // "metadata": {},
33902
+ * // "accessSettings": {},
33903
+ * // "allowPublicAccess": false,
33904
+ * // "allowlistedDomains": [],
33905
+ * // "assistantSettings": {},
33906
+ * // "collectionComponents": [],
33907
+ * // "configId": "my_configId",
33908
+ * // "contentSearchSpec": {},
33909
+ * // "createTime": "my_createTime",
33910
+ * // "customerProvidedConfig": {},
33911
+ * // "dataStoreType": "my_dataStoreType",
33912
+ * // "dataStoreUiConfigs": [],
33913
+ * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
33914
+ * // "displayName": "my_displayName",
33915
+ * // "enableAutocomplete": false,
33916
+ * // "enableConversationalSearch": false,
33917
+ * // "enablePrivateKnowledgeGraph": false,
33918
+ * // "enableQualityFeedback": false,
33919
+ * // "enableResultScore": false,
33920
+ * // "enableSafeSearch": false,
33921
+ * // "enableSearchAsYouType": false,
33922
+ * // "enableSnippetResultSummary": false,
33923
+ * // "enableSummarization": false,
33924
+ * // "enableWebApp": false,
33925
+ * // "facetField": [],
33926
+ * // "fieldsUiComponentsMap": {},
33927
+ * // "geminiBundle": false,
33928
+ * // "homepageSetting": {},
33929
+ * // "industryVertical": "my_industryVertical",
33930
+ * // "llmEnabled": false,
33931
+ * // "minimumDataTermAccepted": false,
33338
33932
  * // "name": "my_name",
33339
- * // "response": {}
33933
+ * // "resultDisplayType": "my_resultDisplayType",
33934
+ * // "solutionType": "my_solutionType",
33935
+ * // "uiBranding": {},
33936
+ * // "uiSettings": {},
33937
+ * // "updateTime": "my_updateTime"
33340
33938
  * // }
33341
33939
  * }
33342
33940
  *
@@ -33352,58 +33950,62 @@ export namespace discoveryengine_v1 {
33352
33950
  * @param callback - Optional callback that handles the response.
33353
33951
  * @returns A promise if used with async/await, or void if used with a callback.
33354
33952
  */
33355
- delete(
33356
- params: Params$Resource$Projects$Locations$Collections$Engines$Delete,
33953
+ patch(
33954
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch,
33357
33955
  options: StreamMethodOptions
33358
33956
  ): Promise<GaxiosResponseWithHTTP2<Readable>>;
33359
- delete(
33360
- params?: Params$Resource$Projects$Locations$Collections$Engines$Delete,
33957
+ patch(
33958
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch,
33361
33959
  options?: MethodOptions
33362
- ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
33363
- delete(
33364
- params: Params$Resource$Projects$Locations$Collections$Engines$Delete,
33960
+ ): Promise<
33961
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33962
+ >;
33963
+ patch(
33964
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch,
33365
33965
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
33366
33966
  callback: BodyResponseCallback<Readable>
33367
33967
  ): void;
33368
- delete(
33369
- params: Params$Resource$Projects$Locations$Collections$Engines$Delete,
33968
+ patch(
33969
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch,
33370
33970
  options:
33371
33971
  | MethodOptions
33372
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
33373
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
33972
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>,
33973
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33374
33974
  ): void;
33375
- delete(
33376
- params: Params$Resource$Projects$Locations$Collections$Engines$Delete,
33377
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
33975
+ patch(
33976
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch,
33977
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33378
33978
  ): void;
33379
- delete(
33380
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
33979
+ patch(
33980
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33381
33981
  ): void;
33382
- delete(
33982
+ patch(
33383
33983
  paramsOrCallback?:
33384
- | Params$Resource$Projects$Locations$Collections$Engines$Delete
33385
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
33984
+ | Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch
33985
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33386
33986
  | BodyResponseCallback<Readable>,
33387
33987
  optionsOrCallback?:
33388
33988
  | MethodOptions
33389
33989
  | StreamMethodOptions
33390
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
33990
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33391
33991
  | BodyResponseCallback<Readable>,
33392
33992
  callback?:
33393
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
33993
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33394
33994
  | BodyResponseCallback<Readable>
33395
33995
  ):
33396
33996
  | void
33397
- | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
33997
+ | Promise<
33998
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
33999
+ >
33398
34000
  | Promise<GaxiosResponseWithHTTP2<Readable>> {
33399
34001
  let params = (paramsOrCallback ||
33400
- {}) as Params$Resource$Projects$Locations$Collections$Engines$Delete;
34002
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch;
33401
34003
  let options = (optionsOrCallback || {}) as MethodOptions;
33402
34004
 
33403
34005
  if (typeof paramsOrCallback === 'function') {
33404
34006
  callback = paramsOrCallback;
33405
34007
  params =
33406
- {} as Params$Resource$Projects$Locations$Collections$Engines$Delete;
34008
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch;
33407
34009
  options = {};
33408
34010
  }
33409
34011
 
@@ -33418,7 +34020,7 @@ export namespace discoveryengine_v1 {
33418
34020
  options: Object.assign(
33419
34021
  {
33420
34022
  url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
33421
- method: 'DELETE',
34023
+ method: 'PATCH',
33422
34024
  apiVersion: '',
33423
34025
  },
33424
34026
  options
@@ -33429,17 +34031,425 @@ export namespace discoveryengine_v1 {
33429
34031
  context: this.context,
33430
34032
  };
33431
34033
  if (callback) {
33432
- createAPIRequest<Schema$GoogleLongrunningOperation>(
34034
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>(
33433
34035
  parameters,
33434
34036
  callback as BodyResponseCallback<unknown>
33435
34037
  );
33436
34038
  } else {
33437
- return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
34039
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>(
34040
+ parameters
34041
+ );
33438
34042
  }
33439
34043
  }
34044
+ }
33440
34045
 
34046
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Get
34047
+ extends StandardParameters {
33441
34048
  /**
33442
- * Gets a Engine.
34049
+ * 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.
34050
+ */
34051
+ acceptCache?: boolean;
34052
+ /**
34053
+ * Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
34054
+ */
34055
+ 'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
34056
+ /**
34057
+ * Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
34058
+ */
34059
+ name?: string;
34060
+ }
34061
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Widgetconfigs$Patch
34062
+ extends StandardParameters {
34063
+ /**
34064
+ * 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.
34065
+ */
34066
+ name?: string;
34067
+ /**
34068
+ * 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.
34069
+ */
34070
+ updateMask?: string;
34071
+
34072
+ /**
34073
+ * Request body metadata
34074
+ */
34075
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1WidgetConfig;
34076
+ }
34077
+
34078
+ export class Resource$Projects$Locations$Collections$Engines {
34079
+ context: APIRequestContext;
34080
+ assistants: Resource$Projects$Locations$Collections$Engines$Assistants;
34081
+ completionConfig: Resource$Projects$Locations$Collections$Engines$Completionconfig;
34082
+ controls: Resource$Projects$Locations$Collections$Engines$Controls;
34083
+ conversations: Resource$Projects$Locations$Collections$Engines$Conversations;
34084
+ operations: Resource$Projects$Locations$Collections$Engines$Operations;
34085
+ servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs;
34086
+ sessions: Resource$Projects$Locations$Collections$Engines$Sessions;
34087
+ widgetConfigs: Resource$Projects$Locations$Collections$Engines$Widgetconfigs;
34088
+ constructor(context: APIRequestContext) {
34089
+ this.context = context;
34090
+ this.assistants =
34091
+ new Resource$Projects$Locations$Collections$Engines$Assistants(
34092
+ this.context
34093
+ );
34094
+ this.completionConfig =
34095
+ new Resource$Projects$Locations$Collections$Engines$Completionconfig(
34096
+ this.context
34097
+ );
34098
+ this.controls =
34099
+ new Resource$Projects$Locations$Collections$Engines$Controls(
34100
+ this.context
34101
+ );
34102
+ this.conversations =
34103
+ new Resource$Projects$Locations$Collections$Engines$Conversations(
34104
+ this.context
34105
+ );
34106
+ this.operations =
34107
+ new Resource$Projects$Locations$Collections$Engines$Operations(
34108
+ this.context
34109
+ );
34110
+ this.servingConfigs =
34111
+ new Resource$Projects$Locations$Collections$Engines$Servingconfigs(
34112
+ this.context
34113
+ );
34114
+ this.sessions =
34115
+ new Resource$Projects$Locations$Collections$Engines$Sessions(
34116
+ this.context
34117
+ );
34118
+ this.widgetConfigs =
34119
+ new Resource$Projects$Locations$Collections$Engines$Widgetconfigs(
34120
+ this.context
34121
+ );
34122
+ }
34123
+
34124
+ /**
34125
+ * Creates a Engine.
34126
+ * @example
34127
+ * ```js
34128
+ * // Before running the sample:
34129
+ * // - Enable the API at:
34130
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
34131
+ * // - Login into gcloud by running:
34132
+ * // ```sh
34133
+ * // $ gcloud auth application-default login
34134
+ * // ```
34135
+ * // - Install the npm module by running:
34136
+ * // ```sh
34137
+ * // $ npm install googleapis
34138
+ * // ```
34139
+ *
34140
+ * const {google} = require('googleapis');
34141
+ * const discoveryengine = google.discoveryengine('v1');
34142
+ *
34143
+ * async function main() {
34144
+ * const auth = new google.auth.GoogleAuth({
34145
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
34146
+ * scopes: [
34147
+ * 'https://www.googleapis.com/auth/cloud-platform',
34148
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
34149
+ * ],
34150
+ * });
34151
+ *
34152
+ * // Acquire an auth client, and bind it to all future calls
34153
+ * const authClient = await auth.getClient();
34154
+ * google.options({auth: authClient});
34155
+ *
34156
+ * // Do the magic
34157
+ * const res =
34158
+ * await discoveryengine.projects.locations.collections.engines.create({
34159
+ * // Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
34160
+ * engineId: 'placeholder-value',
34161
+ * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`.
34162
+ * parent:
34163
+ * 'projects/my-project/locations/my-location/collections/my-collection',
34164
+ *
34165
+ * // Request body metadata
34166
+ * requestBody: {
34167
+ * // request body parameters
34168
+ * // {
34169
+ * // "appType": "my_appType",
34170
+ * // "chatEngineConfig": {},
34171
+ * // "chatEngineMetadata": {},
34172
+ * // "cmekConfig": {},
34173
+ * // "commonConfig": {},
34174
+ * // "configurableBillingApproach": "my_configurableBillingApproach",
34175
+ * // "createTime": "my_createTime",
34176
+ * // "dataStoreIds": [],
34177
+ * // "disableAnalytics": false,
34178
+ * // "displayName": "my_displayName",
34179
+ * // "features": {},
34180
+ * // "industryVertical": "my_industryVertical",
34181
+ * // "mediaRecommendationEngineConfig": {},
34182
+ * // "modelConfigs": {},
34183
+ * // "name": "my_name",
34184
+ * // "searchEngineConfig": {},
34185
+ * // "solutionType": "my_solutionType",
34186
+ * // "updateTime": "my_updateTime"
34187
+ * // }
34188
+ * },
34189
+ * });
34190
+ * console.log(res.data);
34191
+ *
34192
+ * // Example response
34193
+ * // {
34194
+ * // "done": false,
34195
+ * // "error": {},
34196
+ * // "metadata": {},
34197
+ * // "name": "my_name",
34198
+ * // "response": {}
34199
+ * // }
34200
+ * }
34201
+ *
34202
+ * main().catch(e => {
34203
+ * console.error(e);
34204
+ * throw e;
34205
+ * });
34206
+ *
34207
+ * ```
34208
+ *
34209
+ * @param params - Parameters for request
34210
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
34211
+ * @param callback - Optional callback that handles the response.
34212
+ * @returns A promise if used with async/await, or void if used with a callback.
34213
+ */
34214
+ create(
34215
+ params: Params$Resource$Projects$Locations$Collections$Engines$Create,
34216
+ options: StreamMethodOptions
34217
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
34218
+ create(
34219
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Create,
34220
+ options?: MethodOptions
34221
+ ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
34222
+ create(
34223
+ params: Params$Resource$Projects$Locations$Collections$Engines$Create,
34224
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
34225
+ callback: BodyResponseCallback<Readable>
34226
+ ): void;
34227
+ create(
34228
+ params: Params$Resource$Projects$Locations$Collections$Engines$Create,
34229
+ options:
34230
+ | MethodOptions
34231
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
34232
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
34233
+ ): void;
34234
+ create(
34235
+ params: Params$Resource$Projects$Locations$Collections$Engines$Create,
34236
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
34237
+ ): void;
34238
+ create(
34239
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
34240
+ ): void;
34241
+ create(
34242
+ paramsOrCallback?:
34243
+ | Params$Resource$Projects$Locations$Collections$Engines$Create
34244
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
34245
+ | BodyResponseCallback<Readable>,
34246
+ optionsOrCallback?:
34247
+ | MethodOptions
34248
+ | StreamMethodOptions
34249
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
34250
+ | BodyResponseCallback<Readable>,
34251
+ callback?:
34252
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
34253
+ | BodyResponseCallback<Readable>
34254
+ ):
34255
+ | void
34256
+ | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
34257
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
34258
+ let params = (paramsOrCallback ||
34259
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Create;
34260
+ let options = (optionsOrCallback || {}) as MethodOptions;
34261
+
34262
+ if (typeof paramsOrCallback === 'function') {
34263
+ callback = paramsOrCallback;
34264
+ params =
34265
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Create;
34266
+ options = {};
34267
+ }
34268
+
34269
+ if (typeof optionsOrCallback === 'function') {
34270
+ callback = optionsOrCallback;
34271
+ options = {};
34272
+ }
34273
+
34274
+ const rootUrl =
34275
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
34276
+ const parameters = {
34277
+ options: Object.assign(
34278
+ {
34279
+ url: (rootUrl + '/v1/{+parent}/engines').replace(
34280
+ /([^:]\/)\/+/g,
34281
+ '$1'
34282
+ ),
34283
+ method: 'POST',
34284
+ apiVersion: '',
34285
+ },
34286
+ options
34287
+ ),
34288
+ params,
34289
+ requiredParams: ['parent'],
34290
+ pathParams: ['parent'],
34291
+ context: this.context,
34292
+ };
34293
+ if (callback) {
34294
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
34295
+ parameters,
34296
+ callback as BodyResponseCallback<unknown>
34297
+ );
34298
+ } else {
34299
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
34300
+ }
34301
+ }
34302
+
34303
+ /**
34304
+ * Deletes a Engine.
34305
+ * @example
34306
+ * ```js
34307
+ * // Before running the sample:
34308
+ * // - Enable the API at:
34309
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
34310
+ * // - Login into gcloud by running:
34311
+ * // ```sh
34312
+ * // $ gcloud auth application-default login
34313
+ * // ```
34314
+ * // - Install the npm module by running:
34315
+ * // ```sh
34316
+ * // $ npm install googleapis
34317
+ * // ```
34318
+ *
34319
+ * const {google} = require('googleapis');
34320
+ * const discoveryengine = google.discoveryengine('v1');
34321
+ *
34322
+ * async function main() {
34323
+ * const auth = new google.auth.GoogleAuth({
34324
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
34325
+ * scopes: [
34326
+ * 'https://www.googleapis.com/auth/cloud-platform',
34327
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
34328
+ * ],
34329
+ * });
34330
+ *
34331
+ * // Acquire an auth client, and bind it to all future calls
34332
+ * const authClient = await auth.getClient();
34333
+ * google.options({auth: authClient});
34334
+ *
34335
+ * // Do the magic
34336
+ * const res =
34337
+ * await discoveryengine.projects.locations.collections.engines.delete({
34338
+ * // Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned.
34339
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
34340
+ * });
34341
+ * console.log(res.data);
34342
+ *
34343
+ * // Example response
34344
+ * // {
34345
+ * // "done": false,
34346
+ * // "error": {},
34347
+ * // "metadata": {},
34348
+ * // "name": "my_name",
34349
+ * // "response": {}
34350
+ * // }
34351
+ * }
34352
+ *
34353
+ * main().catch(e => {
34354
+ * console.error(e);
34355
+ * throw e;
34356
+ * });
34357
+ *
34358
+ * ```
34359
+ *
34360
+ * @param params - Parameters for request
34361
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
34362
+ * @param callback - Optional callback that handles the response.
34363
+ * @returns A promise if used with async/await, or void if used with a callback.
34364
+ */
34365
+ delete(
34366
+ params: Params$Resource$Projects$Locations$Collections$Engines$Delete,
34367
+ options: StreamMethodOptions
34368
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
34369
+ delete(
34370
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Delete,
34371
+ options?: MethodOptions
34372
+ ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
34373
+ delete(
34374
+ params: Params$Resource$Projects$Locations$Collections$Engines$Delete,
34375
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
34376
+ callback: BodyResponseCallback<Readable>
34377
+ ): void;
34378
+ delete(
34379
+ params: Params$Resource$Projects$Locations$Collections$Engines$Delete,
34380
+ options:
34381
+ | MethodOptions
34382
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
34383
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
34384
+ ): void;
34385
+ delete(
34386
+ params: Params$Resource$Projects$Locations$Collections$Engines$Delete,
34387
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
34388
+ ): void;
34389
+ delete(
34390
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
34391
+ ): void;
34392
+ delete(
34393
+ paramsOrCallback?:
34394
+ | Params$Resource$Projects$Locations$Collections$Engines$Delete
34395
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
34396
+ | BodyResponseCallback<Readable>,
34397
+ optionsOrCallback?:
34398
+ | MethodOptions
34399
+ | StreamMethodOptions
34400
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
34401
+ | BodyResponseCallback<Readable>,
34402
+ callback?:
34403
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
34404
+ | BodyResponseCallback<Readable>
34405
+ ):
34406
+ | void
34407
+ | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
34408
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
34409
+ let params = (paramsOrCallback ||
34410
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Delete;
34411
+ let options = (optionsOrCallback || {}) as MethodOptions;
34412
+
34413
+ if (typeof paramsOrCallback === 'function') {
34414
+ callback = paramsOrCallback;
34415
+ params =
34416
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Delete;
34417
+ options = {};
34418
+ }
34419
+
34420
+ if (typeof optionsOrCallback === 'function') {
34421
+ callback = optionsOrCallback;
34422
+ options = {};
34423
+ }
34424
+
34425
+ const rootUrl =
34426
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
34427
+ const parameters = {
34428
+ options: Object.assign(
34429
+ {
34430
+ url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
34431
+ method: 'DELETE',
34432
+ apiVersion: '',
34433
+ },
34434
+ options
34435
+ ),
34436
+ params,
34437
+ requiredParams: ['name'],
34438
+ pathParams: ['name'],
34439
+ context: this.context,
34440
+ };
34441
+ if (callback) {
34442
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
34443
+ parameters,
34444
+ callback as BodyResponseCallback<unknown>
34445
+ );
34446
+ } else {
34447
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
34448
+ }
34449
+ }
34450
+
34451
+ /**
34452
+ * Gets a Engine.
33443
34453
  * @example
33444
34454
  * ```js
33445
34455
  * // Before running the sample:
@@ -33482,6 +34492,7 @@ export namespace discoveryengine_v1 {
33482
34492
  * // "appType": "my_appType",
33483
34493
  * // "chatEngineConfig": {},
33484
34494
  * // "chatEngineMetadata": {},
34495
+ * // "cmekConfig": {},
33485
34496
  * // "commonConfig": {},
33486
34497
  * // "configurableBillingApproach": "my_configurableBillingApproach",
33487
34498
  * // "createTime": "my_createTime",
@@ -33491,6 +34502,7 @@ export namespace discoveryengine_v1 {
33491
34502
  * // "features": {},
33492
34503
  * // "industryVertical": "my_industryVertical",
33493
34504
  * // "mediaRecommendationEngineConfig": {},
34505
+ * // "modelConfigs": {},
33494
34506
  * // "name": "my_name",
33495
34507
  * // "searchEngineConfig": {},
33496
34508
  * // "solutionType": "my_solutionType",
@@ -33811,6 +34823,7 @@ export namespace discoveryengine_v1 {
33811
34823
  * // "appType": "my_appType",
33812
34824
  * // "chatEngineConfig": {},
33813
34825
  * // "chatEngineMetadata": {},
34826
+ * // "cmekConfig": {},
33814
34827
  * // "commonConfig": {},
33815
34828
  * // "configurableBillingApproach": "my_configurableBillingApproach",
33816
34829
  * // "createTime": "my_createTime",
@@ -33820,6 +34833,7 @@ export namespace discoveryengine_v1 {
33820
34833
  * // "features": {},
33821
34834
  * // "industryVertical": "my_industryVertical",
33822
34835
  * // "mediaRecommendationEngineConfig": {},
34836
+ * // "modelConfigs": {},
33823
34837
  * // "name": "my_name",
33824
34838
  * // "searchEngineConfig": {},
33825
34839
  * // "solutionType": "my_solutionType",
@@ -33834,6 +34848,7 @@ export namespace discoveryengine_v1 {
33834
34848
  * // "appType": "my_appType",
33835
34849
  * // "chatEngineConfig": {},
33836
34850
  * // "chatEngineMetadata": {},
34851
+ * // "cmekConfig": {},
33837
34852
  * // "commonConfig": {},
33838
34853
  * // "configurableBillingApproach": "my_configurableBillingApproach",
33839
34854
  * // "createTime": "my_createTime",
@@ -33843,6 +34858,7 @@ export namespace discoveryengine_v1 {
33843
34858
  * // "features": {},
33844
34859
  * // "industryVertical": "my_industryVertical",
33845
34860
  * // "mediaRecommendationEngineConfig": {},
34861
+ * // "modelConfigs": {},
33846
34862
  * // "name": "my_name",
33847
34863
  * // "searchEngineConfig": {},
33848
34864
  * // "solutionType": "my_solutionType",
@@ -39900,6 +40916,471 @@ export namespace discoveryengine_v1 {
39900
40916
  name?: string;
39901
40917
  }
39902
40918
 
40919
+ export class Resource$Projects$Locations$Collections$Engines$Widgetconfigs {
40920
+ context: APIRequestContext;
40921
+ constructor(context: APIRequestContext) {
40922
+ this.context = context;
40923
+ }
40924
+
40925
+ /**
40926
+ * Gets a WidgetConfig.
40927
+ * @example
40928
+ * ```js
40929
+ * // Before running the sample:
40930
+ * // - Enable the API at:
40931
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
40932
+ * // - Login into gcloud by running:
40933
+ * // ```sh
40934
+ * // $ gcloud auth application-default login
40935
+ * // ```
40936
+ * // - Install the npm module by running:
40937
+ * // ```sh
40938
+ * // $ npm install googleapis
40939
+ * // ```
40940
+ *
40941
+ * const {google} = require('googleapis');
40942
+ * const discoveryengine = google.discoveryengine('v1');
40943
+ *
40944
+ * async function main() {
40945
+ * const auth = new google.auth.GoogleAuth({
40946
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
40947
+ * scopes: [
40948
+ * 'https://www.googleapis.com/auth/cloud-platform',
40949
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
40950
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
40951
+ * ],
40952
+ * });
40953
+ *
40954
+ * // Acquire an auth client, and bind it to all future calls
40955
+ * const authClient = await auth.getClient();
40956
+ * google.options({auth: authClient});
40957
+ *
40958
+ * // Do the magic
40959
+ * const res =
40960
+ * await discoveryengine.projects.locations.collections.engines.widgetConfigs.get(
40961
+ * {
40962
+ * // 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.
40963
+ * acceptCache: 'placeholder-value',
40964
+ * // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
40965
+ * 'getWidgetConfigRequestOption.turnOffCollectionComponents':
40966
+ * 'placeholder-value',
40967
+ * // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
40968
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/widgetConfigs/my-widgetConfig',
40969
+ * },
40970
+ * );
40971
+ * console.log(res.data);
40972
+ *
40973
+ * // Example response
40974
+ * // {
40975
+ * // "accessSettings": {},
40976
+ * // "allowPublicAccess": false,
40977
+ * // "allowlistedDomains": [],
40978
+ * // "assistantSettings": {},
40979
+ * // "collectionComponents": [],
40980
+ * // "configId": "my_configId",
40981
+ * // "contentSearchSpec": {},
40982
+ * // "createTime": "my_createTime",
40983
+ * // "customerProvidedConfig": {},
40984
+ * // "dataStoreType": "my_dataStoreType",
40985
+ * // "dataStoreUiConfigs": [],
40986
+ * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
40987
+ * // "displayName": "my_displayName",
40988
+ * // "enableAutocomplete": false,
40989
+ * // "enableConversationalSearch": false,
40990
+ * // "enablePrivateKnowledgeGraph": false,
40991
+ * // "enableQualityFeedback": false,
40992
+ * // "enableResultScore": false,
40993
+ * // "enableSafeSearch": false,
40994
+ * // "enableSearchAsYouType": false,
40995
+ * // "enableSnippetResultSummary": false,
40996
+ * // "enableSummarization": false,
40997
+ * // "enableWebApp": false,
40998
+ * // "facetField": [],
40999
+ * // "fieldsUiComponentsMap": {},
41000
+ * // "geminiBundle": false,
41001
+ * // "homepageSetting": {},
41002
+ * // "industryVertical": "my_industryVertical",
41003
+ * // "llmEnabled": false,
41004
+ * // "minimumDataTermAccepted": false,
41005
+ * // "name": "my_name",
41006
+ * // "resultDisplayType": "my_resultDisplayType",
41007
+ * // "solutionType": "my_solutionType",
41008
+ * // "uiBranding": {},
41009
+ * // "uiSettings": {},
41010
+ * // "updateTime": "my_updateTime"
41011
+ * // }
41012
+ * }
41013
+ *
41014
+ * main().catch(e => {
41015
+ * console.error(e);
41016
+ * throw e;
41017
+ * });
41018
+ *
41019
+ * ```
41020
+ *
41021
+ * @param params - Parameters for request
41022
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
41023
+ * @param callback - Optional callback that handles the response.
41024
+ * @returns A promise if used with async/await, or void if used with a callback.
41025
+ */
41026
+ get(
41027
+ params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get,
41028
+ options: StreamMethodOptions
41029
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
41030
+ get(
41031
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get,
41032
+ options?: MethodOptions
41033
+ ): Promise<
41034
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41035
+ >;
41036
+ get(
41037
+ params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get,
41038
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
41039
+ callback: BodyResponseCallback<Readable>
41040
+ ): void;
41041
+ get(
41042
+ params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get,
41043
+ options:
41044
+ | MethodOptions
41045
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>,
41046
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41047
+ ): void;
41048
+ get(
41049
+ params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get,
41050
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41051
+ ): void;
41052
+ get(
41053
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41054
+ ): void;
41055
+ get(
41056
+ paramsOrCallback?:
41057
+ | Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get
41058
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41059
+ | BodyResponseCallback<Readable>,
41060
+ optionsOrCallback?:
41061
+ | MethodOptions
41062
+ | StreamMethodOptions
41063
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41064
+ | BodyResponseCallback<Readable>,
41065
+ callback?:
41066
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41067
+ | BodyResponseCallback<Readable>
41068
+ ):
41069
+ | void
41070
+ | Promise<
41071
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41072
+ >
41073
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
41074
+ let params = (paramsOrCallback ||
41075
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get;
41076
+ let options = (optionsOrCallback || {}) as MethodOptions;
41077
+
41078
+ if (typeof paramsOrCallback === 'function') {
41079
+ callback = paramsOrCallback;
41080
+ params =
41081
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get;
41082
+ options = {};
41083
+ }
41084
+
41085
+ if (typeof optionsOrCallback === 'function') {
41086
+ callback = optionsOrCallback;
41087
+ options = {};
41088
+ }
41089
+
41090
+ const rootUrl =
41091
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
41092
+ const parameters = {
41093
+ options: Object.assign(
41094
+ {
41095
+ url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
41096
+ method: 'GET',
41097
+ apiVersion: '',
41098
+ },
41099
+ options
41100
+ ),
41101
+ params,
41102
+ requiredParams: ['name'],
41103
+ pathParams: ['name'],
41104
+ context: this.context,
41105
+ };
41106
+ if (callback) {
41107
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>(
41108
+ parameters,
41109
+ callback as BodyResponseCallback<unknown>
41110
+ );
41111
+ } else {
41112
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>(
41113
+ parameters
41114
+ );
41115
+ }
41116
+ }
41117
+
41118
+ /**
41119
+ * Update a WidgetConfig.
41120
+ * @example
41121
+ * ```js
41122
+ * // Before running the sample:
41123
+ * // - Enable the API at:
41124
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
41125
+ * // - Login into gcloud by running:
41126
+ * // ```sh
41127
+ * // $ gcloud auth application-default login
41128
+ * // ```
41129
+ * // - Install the npm module by running:
41130
+ * // ```sh
41131
+ * // $ npm install googleapis
41132
+ * // ```
41133
+ *
41134
+ * const {google} = require('googleapis');
41135
+ * const discoveryengine = google.discoveryengine('v1');
41136
+ *
41137
+ * async function main() {
41138
+ * const auth = new google.auth.GoogleAuth({
41139
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
41140
+ * scopes: [
41141
+ * 'https://www.googleapis.com/auth/cloud-platform',
41142
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
41143
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
41144
+ * ],
41145
+ * });
41146
+ *
41147
+ * // Acquire an auth client, and bind it to all future calls
41148
+ * const authClient = await auth.getClient();
41149
+ * google.options({auth: authClient});
41150
+ *
41151
+ * // Do the magic
41152
+ * const res =
41153
+ * await discoveryengine.projects.locations.collections.engines.widgetConfigs.patch(
41154
+ * {
41155
+ * // 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.
41156
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/widgetConfigs/my-widgetConfig',
41157
+ * // 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.
41158
+ * updateMask: 'placeholder-value',
41159
+ *
41160
+ * // Request body metadata
41161
+ * requestBody: {
41162
+ * // request body parameters
41163
+ * // {
41164
+ * // "accessSettings": {},
41165
+ * // "allowPublicAccess": false,
41166
+ * // "allowlistedDomains": [],
41167
+ * // "assistantSettings": {},
41168
+ * // "collectionComponents": [],
41169
+ * // "configId": "my_configId",
41170
+ * // "contentSearchSpec": {},
41171
+ * // "createTime": "my_createTime",
41172
+ * // "customerProvidedConfig": {},
41173
+ * // "dataStoreType": "my_dataStoreType",
41174
+ * // "dataStoreUiConfigs": [],
41175
+ * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
41176
+ * // "displayName": "my_displayName",
41177
+ * // "enableAutocomplete": false,
41178
+ * // "enableConversationalSearch": false,
41179
+ * // "enablePrivateKnowledgeGraph": false,
41180
+ * // "enableQualityFeedback": false,
41181
+ * // "enableResultScore": false,
41182
+ * // "enableSafeSearch": false,
41183
+ * // "enableSearchAsYouType": false,
41184
+ * // "enableSnippetResultSummary": false,
41185
+ * // "enableSummarization": false,
41186
+ * // "enableWebApp": false,
41187
+ * // "facetField": [],
41188
+ * // "fieldsUiComponentsMap": {},
41189
+ * // "geminiBundle": false,
41190
+ * // "homepageSetting": {},
41191
+ * // "industryVertical": "my_industryVertical",
41192
+ * // "llmEnabled": false,
41193
+ * // "minimumDataTermAccepted": false,
41194
+ * // "name": "my_name",
41195
+ * // "resultDisplayType": "my_resultDisplayType",
41196
+ * // "solutionType": "my_solutionType",
41197
+ * // "uiBranding": {},
41198
+ * // "uiSettings": {},
41199
+ * // "updateTime": "my_updateTime"
41200
+ * // }
41201
+ * },
41202
+ * },
41203
+ * );
41204
+ * console.log(res.data);
41205
+ *
41206
+ * // Example response
41207
+ * // {
41208
+ * // "accessSettings": {},
41209
+ * // "allowPublicAccess": false,
41210
+ * // "allowlistedDomains": [],
41211
+ * // "assistantSettings": {},
41212
+ * // "collectionComponents": [],
41213
+ * // "configId": "my_configId",
41214
+ * // "contentSearchSpec": {},
41215
+ * // "createTime": "my_createTime",
41216
+ * // "customerProvidedConfig": {},
41217
+ * // "dataStoreType": "my_dataStoreType",
41218
+ * // "dataStoreUiConfigs": [],
41219
+ * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
41220
+ * // "displayName": "my_displayName",
41221
+ * // "enableAutocomplete": false,
41222
+ * // "enableConversationalSearch": false,
41223
+ * // "enablePrivateKnowledgeGraph": false,
41224
+ * // "enableQualityFeedback": false,
41225
+ * // "enableResultScore": false,
41226
+ * // "enableSafeSearch": false,
41227
+ * // "enableSearchAsYouType": false,
41228
+ * // "enableSnippetResultSummary": false,
41229
+ * // "enableSummarization": false,
41230
+ * // "enableWebApp": false,
41231
+ * // "facetField": [],
41232
+ * // "fieldsUiComponentsMap": {},
41233
+ * // "geminiBundle": false,
41234
+ * // "homepageSetting": {},
41235
+ * // "industryVertical": "my_industryVertical",
41236
+ * // "llmEnabled": false,
41237
+ * // "minimumDataTermAccepted": false,
41238
+ * // "name": "my_name",
41239
+ * // "resultDisplayType": "my_resultDisplayType",
41240
+ * // "solutionType": "my_solutionType",
41241
+ * // "uiBranding": {},
41242
+ * // "uiSettings": {},
41243
+ * // "updateTime": "my_updateTime"
41244
+ * // }
41245
+ * }
41246
+ *
41247
+ * main().catch(e => {
41248
+ * console.error(e);
41249
+ * throw e;
41250
+ * });
41251
+ *
41252
+ * ```
41253
+ *
41254
+ * @param params - Parameters for request
41255
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
41256
+ * @param callback - Optional callback that handles the response.
41257
+ * @returns A promise if used with async/await, or void if used with a callback.
41258
+ */
41259
+ patch(
41260
+ params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch,
41261
+ options: StreamMethodOptions
41262
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
41263
+ patch(
41264
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch,
41265
+ options?: MethodOptions
41266
+ ): Promise<
41267
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41268
+ >;
41269
+ patch(
41270
+ params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch,
41271
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
41272
+ callback: BodyResponseCallback<Readable>
41273
+ ): void;
41274
+ patch(
41275
+ params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch,
41276
+ options:
41277
+ | MethodOptions
41278
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>,
41279
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41280
+ ): void;
41281
+ patch(
41282
+ params: Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch,
41283
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41284
+ ): void;
41285
+ patch(
41286
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41287
+ ): void;
41288
+ patch(
41289
+ paramsOrCallback?:
41290
+ | Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch
41291
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41292
+ | BodyResponseCallback<Readable>,
41293
+ optionsOrCallback?:
41294
+ | MethodOptions
41295
+ | StreamMethodOptions
41296
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41297
+ | BodyResponseCallback<Readable>,
41298
+ callback?:
41299
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41300
+ | BodyResponseCallback<Readable>
41301
+ ):
41302
+ | void
41303
+ | Promise<
41304
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
41305
+ >
41306
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
41307
+ let params = (paramsOrCallback ||
41308
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch;
41309
+ let options = (optionsOrCallback || {}) as MethodOptions;
41310
+
41311
+ if (typeof paramsOrCallback === 'function') {
41312
+ callback = paramsOrCallback;
41313
+ params =
41314
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch;
41315
+ options = {};
41316
+ }
41317
+
41318
+ if (typeof optionsOrCallback === 'function') {
41319
+ callback = optionsOrCallback;
41320
+ options = {};
41321
+ }
41322
+
41323
+ const rootUrl =
41324
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
41325
+ const parameters = {
41326
+ options: Object.assign(
41327
+ {
41328
+ url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
41329
+ method: 'PATCH',
41330
+ apiVersion: '',
41331
+ },
41332
+ options
41333
+ ),
41334
+ params,
41335
+ requiredParams: ['name'],
41336
+ pathParams: ['name'],
41337
+ context: this.context,
41338
+ };
41339
+ if (callback) {
41340
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>(
41341
+ parameters,
41342
+ callback as BodyResponseCallback<unknown>
41343
+ );
41344
+ } else {
41345
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>(
41346
+ parameters
41347
+ );
41348
+ }
41349
+ }
41350
+ }
41351
+
41352
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Get
41353
+ extends StandardParameters {
41354
+ /**
41355
+ * 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.
41356
+ */
41357
+ acceptCache?: boolean;
41358
+ /**
41359
+ * Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
41360
+ */
41361
+ 'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
41362
+ /**
41363
+ * Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
41364
+ */
41365
+ name?: string;
41366
+ }
41367
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Widgetconfigs$Patch
41368
+ extends StandardParameters {
41369
+ /**
41370
+ * 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.
41371
+ */
41372
+ name?: string;
41373
+ /**
41374
+ * 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.
41375
+ */
41376
+ updateMask?: string;
41377
+
41378
+ /**
41379
+ * Request body metadata
41380
+ */
41381
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1WidgetConfig;
41382
+ }
41383
+
39903
41384
  export class Resource$Projects$Locations$Collections$Operations {
39904
41385
  context: APIRequestContext;
39905
41386
  constructor(context: APIRequestContext) {
@@ -40264,6 +41745,7 @@ export namespace discoveryengine_v1 {
40264
41745
  siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine;
40265
41746
  suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries;
40266
41747
  userEvents: Resource$Projects$Locations$Datastores$Userevents;
41748
+ widgetConfigs: Resource$Projects$Locations$Datastores$Widgetconfigs;
40267
41749
  constructor(context: APIRequestContext) {
40268
41750
  this.context = context;
40269
41751
  this.branches = new Resource$Projects$Locations$Datastores$Branches(
@@ -40307,6 +41789,8 @@ export namespace discoveryengine_v1 {
40307
41789
  this.userEvents = new Resource$Projects$Locations$Datastores$Userevents(
40308
41790
  this.context
40309
41791
  );
41792
+ this.widgetConfigs =
41793
+ new Resource$Projects$Locations$Datastores$Widgetconfigs(this.context);
40310
41794
  }
40311
41795
 
40312
41796
  /**
@@ -53241,39 +54725,517 @@ export namespace discoveryengine_v1 {
53241
54725
  *
53242
54726
  * // Do the magic
53243
54727
  * const res =
53244
- * await discoveryengine.projects.locations.dataStores.userEvents.write({
53245
- * // 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\}`.
53246
- * parent:
53247
- * 'projects/my-project/locations/my-location/dataStores/my-dataStore',
53248
- * // If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.
53249
- * writeAsync: 'placeholder-value',
54728
+ * await discoveryengine.projects.locations.dataStores.userEvents.write({
54729
+ * // 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\}`.
54730
+ * parent:
54731
+ * 'projects/my-project/locations/my-location/dataStores/my-dataStore',
54732
+ * // If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.
54733
+ * writeAsync: 'placeholder-value',
54734
+ *
54735
+ * // Request body metadata
54736
+ * requestBody: {
54737
+ * // request body parameters
54738
+ * // {
54739
+ * // "attributes": {},
54740
+ * // "attributionToken": "my_attributionToken",
54741
+ * // "completionInfo": {},
54742
+ * // "conversionType": "my_conversionType",
54743
+ * // "dataStore": "my_dataStore",
54744
+ * // "directUserRequest": false,
54745
+ * // "documents": [],
54746
+ * // "engine": "my_engine",
54747
+ * // "eventTime": "my_eventTime",
54748
+ * // "eventType": "my_eventType",
54749
+ * // "filter": "my_filter",
54750
+ * // "mediaInfo": {},
54751
+ * // "pageInfo": {},
54752
+ * // "panel": {},
54753
+ * // "panels": [],
54754
+ * // "promotionIds": [],
54755
+ * // "searchInfo": {},
54756
+ * // "sessionId": "my_sessionId",
54757
+ * // "tagIds": [],
54758
+ * // "transactionInfo": {},
54759
+ * // "userInfo": {},
54760
+ * // "userPseudoId": "my_userPseudoId"
54761
+ * // }
54762
+ * },
54763
+ * });
54764
+ * console.log(res.data);
54765
+ *
54766
+ * // Example response
54767
+ * // {
54768
+ * // "attributes": {},
54769
+ * // "attributionToken": "my_attributionToken",
54770
+ * // "completionInfo": {},
54771
+ * // "conversionType": "my_conversionType",
54772
+ * // "dataStore": "my_dataStore",
54773
+ * // "directUserRequest": false,
54774
+ * // "documents": [],
54775
+ * // "engine": "my_engine",
54776
+ * // "eventTime": "my_eventTime",
54777
+ * // "eventType": "my_eventType",
54778
+ * // "filter": "my_filter",
54779
+ * // "mediaInfo": {},
54780
+ * // "pageInfo": {},
54781
+ * // "panel": {},
54782
+ * // "panels": [],
54783
+ * // "promotionIds": [],
54784
+ * // "searchInfo": {},
54785
+ * // "sessionId": "my_sessionId",
54786
+ * // "tagIds": [],
54787
+ * // "transactionInfo": {},
54788
+ * // "userInfo": {},
54789
+ * // "userPseudoId": "my_userPseudoId"
54790
+ * // }
54791
+ * }
54792
+ *
54793
+ * main().catch(e => {
54794
+ * console.error(e);
54795
+ * throw e;
54796
+ * });
54797
+ *
54798
+ * ```
54799
+ *
54800
+ * @param params - Parameters for request
54801
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
54802
+ * @param callback - Optional callback that handles the response.
54803
+ * @returns A promise if used with async/await, or void if used with a callback.
54804
+ */
54805
+ write(
54806
+ params: Params$Resource$Projects$Locations$Datastores$Userevents$Write,
54807
+ options: StreamMethodOptions
54808
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
54809
+ write(
54810
+ params?: Params$Resource$Projects$Locations$Datastores$Userevents$Write,
54811
+ options?: MethodOptions
54812
+ ): Promise<
54813
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1UserEvent>
54814
+ >;
54815
+ write(
54816
+ params: Params$Resource$Projects$Locations$Datastores$Userevents$Write,
54817
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
54818
+ callback: BodyResponseCallback<Readable>
54819
+ ): void;
54820
+ write(
54821
+ params: Params$Resource$Projects$Locations$Datastores$Userevents$Write,
54822
+ options:
54823
+ | MethodOptions
54824
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>,
54825
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>
54826
+ ): void;
54827
+ write(
54828
+ params: Params$Resource$Projects$Locations$Datastores$Userevents$Write,
54829
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>
54830
+ ): void;
54831
+ write(
54832
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>
54833
+ ): void;
54834
+ write(
54835
+ paramsOrCallback?:
54836
+ | Params$Resource$Projects$Locations$Datastores$Userevents$Write
54837
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>
54838
+ | BodyResponseCallback<Readable>,
54839
+ optionsOrCallback?:
54840
+ | MethodOptions
54841
+ | StreamMethodOptions
54842
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>
54843
+ | BodyResponseCallback<Readable>,
54844
+ callback?:
54845
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>
54846
+ | BodyResponseCallback<Readable>
54847
+ ):
54848
+ | void
54849
+ | Promise<
54850
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1UserEvent>
54851
+ >
54852
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
54853
+ let params = (paramsOrCallback ||
54854
+ {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Write;
54855
+ let options = (optionsOrCallback || {}) as MethodOptions;
54856
+
54857
+ if (typeof paramsOrCallback === 'function') {
54858
+ callback = paramsOrCallback;
54859
+ params =
54860
+ {} as Params$Resource$Projects$Locations$Datastores$Userevents$Write;
54861
+ options = {};
54862
+ }
54863
+
54864
+ if (typeof optionsOrCallback === 'function') {
54865
+ callback = optionsOrCallback;
54866
+ options = {};
54867
+ }
54868
+
54869
+ const rootUrl =
54870
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
54871
+ const parameters = {
54872
+ options: Object.assign(
54873
+ {
54874
+ url: (rootUrl + '/v1/{+parent}/userEvents:write').replace(
54875
+ /([^:]\/)\/+/g,
54876
+ '$1'
54877
+ ),
54878
+ method: 'POST',
54879
+ apiVersion: '',
54880
+ },
54881
+ options
54882
+ ),
54883
+ params,
54884
+ requiredParams: ['parent'],
54885
+ pathParams: ['parent'],
54886
+ context: this.context,
54887
+ };
54888
+ if (callback) {
54889
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1UserEvent>(
54890
+ parameters,
54891
+ callback as BodyResponseCallback<unknown>
54892
+ );
54893
+ } else {
54894
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1UserEvent>(
54895
+ parameters
54896
+ );
54897
+ }
54898
+ }
54899
+ }
54900
+
54901
+ export interface Params$Resource$Projects$Locations$Datastores$Userevents$Collect
54902
+ extends StandardParameters {
54903
+ /**
54904
+ * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
54905
+ */
54906
+ ets?: string;
54907
+ /**
54908
+ * 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\}`.
54909
+ */
54910
+ parent?: string;
54911
+ /**
54912
+ * 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.
54913
+ */
54914
+ uri?: string;
54915
+ /**
54916
+ * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
54917
+ */
54918
+ userEvent?: string;
54919
+ }
54920
+ export interface Params$Resource$Projects$Locations$Datastores$Userevents$Import
54921
+ extends StandardParameters {
54922
+ /**
54923
+ * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
54924
+ */
54925
+ parent?: string;
54926
+
54927
+ /**
54928
+ * Request body metadata
54929
+ */
54930
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1ImportUserEventsRequest;
54931
+ }
54932
+ export interface Params$Resource$Projects$Locations$Datastores$Userevents$Purge
54933
+ extends StandardParameters {
54934
+ /**
54935
+ * Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`.
54936
+ */
54937
+ parent?: string;
54938
+
54939
+ /**
54940
+ * Request body metadata
54941
+ */
54942
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1PurgeUserEventsRequest;
54943
+ }
54944
+ export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write
54945
+ extends StandardParameters {
54946
+ /**
54947
+ * 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\}`.
54948
+ */
54949
+ parent?: string;
54950
+ /**
54951
+ * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.
54952
+ */
54953
+ writeAsync?: boolean;
54954
+
54955
+ /**
54956
+ * Request body metadata
54957
+ */
54958
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1UserEvent;
54959
+ }
54960
+
54961
+ export class Resource$Projects$Locations$Datastores$Widgetconfigs {
54962
+ context: APIRequestContext;
54963
+ constructor(context: APIRequestContext) {
54964
+ this.context = context;
54965
+ }
54966
+
54967
+ /**
54968
+ * Gets a WidgetConfig.
54969
+ * @example
54970
+ * ```js
54971
+ * // Before running the sample:
54972
+ * // - Enable the API at:
54973
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
54974
+ * // - Login into gcloud by running:
54975
+ * // ```sh
54976
+ * // $ gcloud auth application-default login
54977
+ * // ```
54978
+ * // - Install the npm module by running:
54979
+ * // ```sh
54980
+ * // $ npm install googleapis
54981
+ * // ```
54982
+ *
54983
+ * const {google} = require('googleapis');
54984
+ * const discoveryengine = google.discoveryengine('v1');
54985
+ *
54986
+ * async function main() {
54987
+ * const auth = new google.auth.GoogleAuth({
54988
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
54989
+ * scopes: [
54990
+ * 'https://www.googleapis.com/auth/cloud-platform',
54991
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
54992
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
54993
+ * ],
54994
+ * });
54995
+ *
54996
+ * // Acquire an auth client, and bind it to all future calls
54997
+ * const authClient = await auth.getClient();
54998
+ * google.options({auth: authClient});
54999
+ *
55000
+ * // Do the magic
55001
+ * const res =
55002
+ * await discoveryengine.projects.locations.dataStores.widgetConfigs.get({
55003
+ * // 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.
55004
+ * acceptCache: 'placeholder-value',
55005
+ * // Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
55006
+ * 'getWidgetConfigRequestOption.turnOffCollectionComponents':
55007
+ * 'placeholder-value',
55008
+ * // Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
55009
+ * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
55010
+ * });
55011
+ * console.log(res.data);
55012
+ *
55013
+ * // Example response
55014
+ * // {
55015
+ * // "accessSettings": {},
55016
+ * // "allowPublicAccess": false,
55017
+ * // "allowlistedDomains": [],
55018
+ * // "assistantSettings": {},
55019
+ * // "collectionComponents": [],
55020
+ * // "configId": "my_configId",
55021
+ * // "contentSearchSpec": {},
55022
+ * // "createTime": "my_createTime",
55023
+ * // "customerProvidedConfig": {},
55024
+ * // "dataStoreType": "my_dataStoreType",
55025
+ * // "dataStoreUiConfigs": [],
55026
+ * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
55027
+ * // "displayName": "my_displayName",
55028
+ * // "enableAutocomplete": false,
55029
+ * // "enableConversationalSearch": false,
55030
+ * // "enablePrivateKnowledgeGraph": false,
55031
+ * // "enableQualityFeedback": false,
55032
+ * // "enableResultScore": false,
55033
+ * // "enableSafeSearch": false,
55034
+ * // "enableSearchAsYouType": false,
55035
+ * // "enableSnippetResultSummary": false,
55036
+ * // "enableSummarization": false,
55037
+ * // "enableWebApp": false,
55038
+ * // "facetField": [],
55039
+ * // "fieldsUiComponentsMap": {},
55040
+ * // "geminiBundle": false,
55041
+ * // "homepageSetting": {},
55042
+ * // "industryVertical": "my_industryVertical",
55043
+ * // "llmEnabled": false,
55044
+ * // "minimumDataTermAccepted": false,
55045
+ * // "name": "my_name",
55046
+ * // "resultDisplayType": "my_resultDisplayType",
55047
+ * // "solutionType": "my_solutionType",
55048
+ * // "uiBranding": {},
55049
+ * // "uiSettings": {},
55050
+ * // "updateTime": "my_updateTime"
55051
+ * // }
55052
+ * }
55053
+ *
55054
+ * main().catch(e => {
55055
+ * console.error(e);
55056
+ * throw e;
55057
+ * });
55058
+ *
55059
+ * ```
55060
+ *
55061
+ * @param params - Parameters for request
55062
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
55063
+ * @param callback - Optional callback that handles the response.
55064
+ * @returns A promise if used with async/await, or void if used with a callback.
55065
+ */
55066
+ get(
55067
+ params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get,
55068
+ options: StreamMethodOptions
55069
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
55070
+ get(
55071
+ params?: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get,
55072
+ options?: MethodOptions
55073
+ ): Promise<
55074
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
55075
+ >;
55076
+ get(
55077
+ params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get,
55078
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
55079
+ callback: BodyResponseCallback<Readable>
55080
+ ): void;
55081
+ get(
55082
+ params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get,
55083
+ options:
55084
+ | MethodOptions
55085
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>,
55086
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
55087
+ ): void;
55088
+ get(
55089
+ params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get,
55090
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
55091
+ ): void;
55092
+ get(
55093
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
55094
+ ): void;
55095
+ get(
55096
+ paramsOrCallback?:
55097
+ | Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get
55098
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
55099
+ | BodyResponseCallback<Readable>,
55100
+ optionsOrCallback?:
55101
+ | MethodOptions
55102
+ | StreamMethodOptions
55103
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
55104
+ | BodyResponseCallback<Readable>,
55105
+ callback?:
55106
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
55107
+ | BodyResponseCallback<Readable>
55108
+ ):
55109
+ | void
55110
+ | Promise<
55111
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
55112
+ >
55113
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
55114
+ let params = (paramsOrCallback ||
55115
+ {}) as Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get;
55116
+ let options = (optionsOrCallback || {}) as MethodOptions;
55117
+
55118
+ if (typeof paramsOrCallback === 'function') {
55119
+ callback = paramsOrCallback;
55120
+ params =
55121
+ {} as Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get;
55122
+ options = {};
55123
+ }
55124
+
55125
+ if (typeof optionsOrCallback === 'function') {
55126
+ callback = optionsOrCallback;
55127
+ options = {};
55128
+ }
55129
+
55130
+ const rootUrl =
55131
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
55132
+ const parameters = {
55133
+ options: Object.assign(
55134
+ {
55135
+ url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
55136
+ method: 'GET',
55137
+ apiVersion: '',
55138
+ },
55139
+ options
55140
+ ),
55141
+ params,
55142
+ requiredParams: ['name'],
55143
+ pathParams: ['name'],
55144
+ context: this.context,
55145
+ };
55146
+ if (callback) {
55147
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>(
55148
+ parameters,
55149
+ callback as BodyResponseCallback<unknown>
55150
+ );
55151
+ } else {
55152
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>(
55153
+ parameters
55154
+ );
55155
+ }
55156
+ }
55157
+
55158
+ /**
55159
+ * Update a WidgetConfig.
55160
+ * @example
55161
+ * ```js
55162
+ * // Before running the sample:
55163
+ * // - Enable the API at:
55164
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
55165
+ * // - Login into gcloud by running:
55166
+ * // ```sh
55167
+ * // $ gcloud auth application-default login
55168
+ * // ```
55169
+ * // - Install the npm module by running:
55170
+ * // ```sh
55171
+ * // $ npm install googleapis
55172
+ * // ```
55173
+ *
55174
+ * const {google} = require('googleapis');
55175
+ * const discoveryengine = google.discoveryengine('v1');
55176
+ *
55177
+ * async function main() {
55178
+ * const auth = new google.auth.GoogleAuth({
55179
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
55180
+ * scopes: [
55181
+ * 'https://www.googleapis.com/auth/cloud-platform',
55182
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
55183
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
55184
+ * ],
55185
+ * });
55186
+ *
55187
+ * // Acquire an auth client, and bind it to all future calls
55188
+ * const authClient = await auth.getClient();
55189
+ * google.options({auth: authClient});
55190
+ *
55191
+ * // Do the magic
55192
+ * const res =
55193
+ * await discoveryengine.projects.locations.dataStores.widgetConfigs.patch({
55194
+ * // 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.
55195
+ * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/widgetConfigs/my-widgetConfig',
55196
+ * // 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.
55197
+ * updateMask: 'placeholder-value',
53250
55198
  *
53251
55199
  * // Request body metadata
53252
55200
  * requestBody: {
53253
55201
  * // request body parameters
53254
55202
  * // {
53255
- * // "attributes": {},
53256
- * // "attributionToken": "my_attributionToken",
53257
- * // "completionInfo": {},
53258
- * // "conversionType": "my_conversionType",
53259
- * // "dataStore": "my_dataStore",
53260
- * // "directUserRequest": false,
53261
- * // "documents": [],
53262
- * // "engine": "my_engine",
53263
- * // "eventTime": "my_eventTime",
53264
- * // "eventType": "my_eventType",
53265
- * // "filter": "my_filter",
53266
- * // "mediaInfo": {},
53267
- * // "pageInfo": {},
53268
- * // "panel": {},
53269
- * // "panels": [],
53270
- * // "promotionIds": [],
53271
- * // "searchInfo": {},
53272
- * // "sessionId": "my_sessionId",
53273
- * // "tagIds": [],
53274
- * // "transactionInfo": {},
53275
- * // "userInfo": {},
53276
- * // "userPseudoId": "my_userPseudoId"
55203
+ * // "accessSettings": {},
55204
+ * // "allowPublicAccess": false,
55205
+ * // "allowlistedDomains": [],
55206
+ * // "assistantSettings": {},
55207
+ * // "collectionComponents": [],
55208
+ * // "configId": "my_configId",
55209
+ * // "contentSearchSpec": {},
55210
+ * // "createTime": "my_createTime",
55211
+ * // "customerProvidedConfig": {},
55212
+ * // "dataStoreType": "my_dataStoreType",
55213
+ * // "dataStoreUiConfigs": [],
55214
+ * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
55215
+ * // "displayName": "my_displayName",
55216
+ * // "enableAutocomplete": false,
55217
+ * // "enableConversationalSearch": false,
55218
+ * // "enablePrivateKnowledgeGraph": false,
55219
+ * // "enableQualityFeedback": false,
55220
+ * // "enableResultScore": false,
55221
+ * // "enableSafeSearch": false,
55222
+ * // "enableSearchAsYouType": false,
55223
+ * // "enableSnippetResultSummary": false,
55224
+ * // "enableSummarization": false,
55225
+ * // "enableWebApp": false,
55226
+ * // "facetField": [],
55227
+ * // "fieldsUiComponentsMap": {},
55228
+ * // "geminiBundle": false,
55229
+ * // "homepageSetting": {},
55230
+ * // "industryVertical": "my_industryVertical",
55231
+ * // "llmEnabled": false,
55232
+ * // "minimumDataTermAccepted": false,
55233
+ * // "name": "my_name",
55234
+ * // "resultDisplayType": "my_resultDisplayType",
55235
+ * // "solutionType": "my_solutionType",
55236
+ * // "uiBranding": {},
55237
+ * // "uiSettings": {},
55238
+ * // "updateTime": "my_updateTime"
53277
55239
  * // }
53278
55240
  * },
53279
55241
  * });
@@ -53281,28 +55243,42 @@ export namespace discoveryengine_v1 {
53281
55243
  *
53282
55244
  * // Example response
53283
55245
  * // {
53284
- * // "attributes": {},
53285
- * // "attributionToken": "my_attributionToken",
53286
- * // "completionInfo": {},
53287
- * // "conversionType": "my_conversionType",
53288
- * // "dataStore": "my_dataStore",
53289
- * // "directUserRequest": false,
53290
- * // "documents": [],
53291
- * // "engine": "my_engine",
53292
- * // "eventTime": "my_eventTime",
53293
- * // "eventType": "my_eventType",
53294
- * // "filter": "my_filter",
53295
- * // "mediaInfo": {},
53296
- * // "pageInfo": {},
53297
- * // "panel": {},
53298
- * // "panels": [],
53299
- * // "promotionIds": [],
53300
- * // "searchInfo": {},
53301
- * // "sessionId": "my_sessionId",
53302
- * // "tagIds": [],
53303
- * // "transactionInfo": {},
53304
- * // "userInfo": {},
53305
- * // "userPseudoId": "my_userPseudoId"
55246
+ * // "accessSettings": {},
55247
+ * // "allowPublicAccess": false,
55248
+ * // "allowlistedDomains": [],
55249
+ * // "assistantSettings": {},
55250
+ * // "collectionComponents": [],
55251
+ * // "configId": "my_configId",
55252
+ * // "contentSearchSpec": {},
55253
+ * // "createTime": "my_createTime",
55254
+ * // "customerProvidedConfig": {},
55255
+ * // "dataStoreType": "my_dataStoreType",
55256
+ * // "dataStoreUiConfigs": [],
55257
+ * // "defaultSearchRequestOrderBy": "my_defaultSearchRequestOrderBy",
55258
+ * // "displayName": "my_displayName",
55259
+ * // "enableAutocomplete": false,
55260
+ * // "enableConversationalSearch": false,
55261
+ * // "enablePrivateKnowledgeGraph": false,
55262
+ * // "enableQualityFeedback": false,
55263
+ * // "enableResultScore": false,
55264
+ * // "enableSafeSearch": false,
55265
+ * // "enableSearchAsYouType": false,
55266
+ * // "enableSnippetResultSummary": false,
55267
+ * // "enableSummarization": false,
55268
+ * // "enableWebApp": false,
55269
+ * // "facetField": [],
55270
+ * // "fieldsUiComponentsMap": {},
55271
+ * // "geminiBundle": false,
55272
+ * // "homepageSetting": {},
55273
+ * // "industryVertical": "my_industryVertical",
55274
+ * // "llmEnabled": false,
55275
+ * // "minimumDataTermAccepted": false,
55276
+ * // "name": "my_name",
55277
+ * // "resultDisplayType": "my_resultDisplayType",
55278
+ * // "solutionType": "my_solutionType",
55279
+ * // "uiBranding": {},
55280
+ * // "uiSettings": {},
55281
+ * // "updateTime": "my_updateTime"
53306
55282
  * // }
53307
55283
  * }
53308
55284
  *
@@ -53318,62 +55294,62 @@ export namespace discoveryengine_v1 {
53318
55294
  * @param callback - Optional callback that handles the response.
53319
55295
  * @returns A promise if used with async/await, or void if used with a callback.
53320
55296
  */
53321
- write(
53322
- params: Params$Resource$Projects$Locations$Datastores$Userevents$Write,
55297
+ patch(
55298
+ params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch,
53323
55299
  options: StreamMethodOptions
53324
55300
  ): Promise<GaxiosResponseWithHTTP2<Readable>>;
53325
- write(
53326
- params?: Params$Resource$Projects$Locations$Datastores$Userevents$Write,
55301
+ patch(
55302
+ params?: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch,
53327
55303
  options?: MethodOptions
53328
55304
  ): Promise<
53329
- GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1UserEvent>
55305
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
53330
55306
  >;
53331
- write(
53332
- params: Params$Resource$Projects$Locations$Datastores$Userevents$Write,
55307
+ patch(
55308
+ params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch,
53333
55309
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
53334
55310
  callback: BodyResponseCallback<Readable>
53335
55311
  ): void;
53336
- write(
53337
- params: Params$Resource$Projects$Locations$Datastores$Userevents$Write,
55312
+ patch(
55313
+ params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch,
53338
55314
  options:
53339
55315
  | MethodOptions
53340
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>,
53341
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>
55316
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>,
55317
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
53342
55318
  ): void;
53343
- write(
53344
- params: Params$Resource$Projects$Locations$Datastores$Userevents$Write,
53345
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>
55319
+ patch(
55320
+ params: Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch,
55321
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
53346
55322
  ): void;
53347
- write(
53348
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>
55323
+ patch(
55324
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
53349
55325
  ): void;
53350
- write(
55326
+ patch(
53351
55327
  paramsOrCallback?:
53352
- | Params$Resource$Projects$Locations$Datastores$Userevents$Write
53353
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>
55328
+ | Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch
55329
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
53354
55330
  | BodyResponseCallback<Readable>,
53355
55331
  optionsOrCallback?:
53356
55332
  | MethodOptions
53357
55333
  | StreamMethodOptions
53358
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>
55334
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
53359
55335
  | BodyResponseCallback<Readable>,
53360
55336
  callback?:
53361
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1UserEvent>
55337
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
53362
55338
  | BodyResponseCallback<Readable>
53363
55339
  ):
53364
55340
  | void
53365
55341
  | Promise<
53366
- GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1UserEvent>
55342
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>
53367
55343
  >
53368
55344
  | Promise<GaxiosResponseWithHTTP2<Readable>> {
53369
55345
  let params = (paramsOrCallback ||
53370
- {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Write;
55346
+ {}) as Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch;
53371
55347
  let options = (optionsOrCallback || {}) as MethodOptions;
53372
55348
 
53373
55349
  if (typeof paramsOrCallback === 'function') {
53374
55350
  callback = paramsOrCallback;
53375
55351
  params =
53376
- {} as Params$Resource$Projects$Locations$Datastores$Userevents$Write;
55352
+ {} as Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch;
53377
55353
  options = {};
53378
55354
  }
53379
55355
 
@@ -53387,91 +55363,60 @@ export namespace discoveryengine_v1 {
53387
55363
  const parameters = {
53388
55364
  options: Object.assign(
53389
55365
  {
53390
- url: (rootUrl + '/v1/{+parent}/userEvents:write').replace(
53391
- /([^:]\/)\/+/g,
53392
- '$1'
53393
- ),
53394
- method: 'POST',
55366
+ url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
55367
+ method: 'PATCH',
53395
55368
  apiVersion: '',
53396
55369
  },
53397
55370
  options
53398
55371
  ),
53399
55372
  params,
53400
- requiredParams: ['parent'],
53401
- pathParams: ['parent'],
55373
+ requiredParams: ['name'],
55374
+ pathParams: ['name'],
53402
55375
  context: this.context,
53403
55376
  };
53404
55377
  if (callback) {
53405
- createAPIRequest<Schema$GoogleCloudDiscoveryengineV1UserEvent>(
55378
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>(
53406
55379
  parameters,
53407
55380
  callback as BodyResponseCallback<unknown>
53408
55381
  );
53409
55382
  } else {
53410
- return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1UserEvent>(
55383
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1WidgetConfig>(
53411
55384
  parameters
53412
55385
  );
53413
55386
  }
53414
55387
  }
53415
55388
  }
53416
55389
 
53417
- export interface Params$Resource$Projects$Locations$Datastores$Userevents$Collect
55390
+ export interface Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Get
53418
55391
  extends StandardParameters {
53419
55392
  /**
53420
- * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
55393
+ * 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.
53421
55394
  */
53422
- ets?: string;
55395
+ acceptCache?: boolean;
53423
55396
  /**
53424
- * 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\}`.
55397
+ * Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
53425
55398
  */
53426
- parent?: string;
53427
- /**
53428
- * 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.
53429
- */
53430
- uri?: string;
55399
+ 'getWidgetConfigRequestOption.turnOffCollectionComponents'?: boolean;
53431
55400
  /**
53432
- * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
55401
+ * Required. Full WidgetConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`
53433
55402
  */
53434
- userEvent?: string;
53435
- }
53436
- export interface Params$Resource$Projects$Locations$Datastores$Userevents$Import
53437
- extends StandardParameters {
53438
- /**
53439
- * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
53440
- */
53441
- parent?: string;
53442
-
53443
- /**
53444
- * Request body metadata
53445
- */
53446
- requestBody?: Schema$GoogleCloudDiscoveryengineV1ImportUserEventsRequest;
53447
- }
53448
- export interface Params$Resource$Projects$Locations$Datastores$Userevents$Purge
53449
- extends StandardParameters {
53450
- /**
53451
- * Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`.
53452
- */
53453
- parent?: string;
53454
-
53455
- /**
53456
- * Request body metadata
53457
- */
53458
- requestBody?: Schema$GoogleCloudDiscoveryengineV1PurgeUserEventsRequest;
55403
+ name?: string;
53459
55404
  }
53460
- export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write
55405
+ export interface Params$Resource$Projects$Locations$Datastores$Widgetconfigs$Patch
53461
55406
  extends StandardParameters {
53462
55407
  /**
53463
- * 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\}`.
55408
+ * 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.
53464
55409
  */
53465
- parent?: string;
55410
+ name?: string;
53466
55411
  /**
53467
- * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.
55412
+ * 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.
53468
55413
  */
53469
- writeAsync?: boolean;
55414
+ updateMask?: string;
53470
55415
 
53471
55416
  /**
53472
55417
  * Request body metadata
53473
55418
  */
53474
- requestBody?: Schema$GoogleCloudDiscoveryengineV1UserEvent;
55419
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1WidgetConfig;
53475
55420
  }
53476
55421
 
53477
55422
  export class Resource$Projects$Locations$Groundingconfigs {
@@ -57066,9 +59011,14 @@ export namespace discoveryengine_v1 {
57066
59011
 
57067
59012
  export class Resource$Projects$Locations$Userstores {
57068
59013
  context: APIRequestContext;
59014
+ licenseConfigsUsageStats: Resource$Projects$Locations$Userstores$Licenseconfigsusagestats;
57069
59015
  userLicenses: Resource$Projects$Locations$Userstores$Userlicenses;
57070
59016
  constructor(context: APIRequestContext) {
57071
59017
  this.context = context;
59018
+ this.licenseConfigsUsageStats =
59019
+ new Resource$Projects$Locations$Userstores$Licenseconfigsusagestats(
59020
+ this.context
59021
+ );
57072
59022
  this.userLicenses =
57073
59023
  new Resource$Projects$Locations$Userstores$Userlicenses(this.context);
57074
59024
  }
@@ -57929,6 +59879,177 @@ export namespace discoveryengine_v1 {
57929
59879
  requestBody?: Schema$GoogleCloudDiscoveryengineV1UserStore;
57930
59880
  }
57931
59881
 
59882
+ export class Resource$Projects$Locations$Userstores$Licenseconfigsusagestats {
59883
+ context: APIRequestContext;
59884
+ constructor(context: APIRequestContext) {
59885
+ this.context = context;
59886
+ }
59887
+
59888
+ /**
59889
+ * Lists all the LicenseConfigUsageStatss associated with the project.
59890
+ * @example
59891
+ * ```js
59892
+ * // Before running the sample:
59893
+ * // - Enable the API at:
59894
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
59895
+ * // - Login into gcloud by running:
59896
+ * // ```sh
59897
+ * // $ gcloud auth application-default login
59898
+ * // ```
59899
+ * // - Install the npm module by running:
59900
+ * // ```sh
59901
+ * // $ npm install googleapis
59902
+ * // ```
59903
+ *
59904
+ * const {google} = require('googleapis');
59905
+ * const discoveryengine = google.discoveryengine('v1');
59906
+ *
59907
+ * async function main() {
59908
+ * const auth = new google.auth.GoogleAuth({
59909
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
59910
+ * scopes: [
59911
+ * 'https://www.googleapis.com/auth/cloud-platform',
59912
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
59913
+ * ],
59914
+ * });
59915
+ *
59916
+ * // Acquire an auth client, and bind it to all future calls
59917
+ * const authClient = await auth.getClient();
59918
+ * google.options({auth: authClient});
59919
+ *
59920
+ * // Do the magic
59921
+ * const res =
59922
+ * await discoveryengine.projects.locations.userStores.licenseConfigsUsageStats.list(
59923
+ * {
59924
+ * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
59925
+ * parent:
59926
+ * 'projects/my-project/locations/my-location/userStores/my-userStore',
59927
+ * },
59928
+ * );
59929
+ * console.log(res.data);
59930
+ *
59931
+ * // Example response
59932
+ * // {
59933
+ * // "licenseConfigUsageStats": []
59934
+ * // }
59935
+ * }
59936
+ *
59937
+ * main().catch(e => {
59938
+ * console.error(e);
59939
+ * throw e;
59940
+ * });
59941
+ *
59942
+ * ```
59943
+ *
59944
+ * @param params - Parameters for request
59945
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
59946
+ * @param callback - Optional callback that handles the response.
59947
+ * @returns A promise if used with async/await, or void if used with a callback.
59948
+ */
59949
+ list(
59950
+ params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List,
59951
+ options: StreamMethodOptions
59952
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
59953
+ list(
59954
+ params?: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List,
59955
+ options?: MethodOptions
59956
+ ): Promise<
59957
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>
59958
+ >;
59959
+ list(
59960
+ params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List,
59961
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
59962
+ callback: BodyResponseCallback<Readable>
59963
+ ): void;
59964
+ list(
59965
+ params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List,
59966
+ options:
59967
+ | MethodOptions
59968
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>,
59969
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>
59970
+ ): void;
59971
+ list(
59972
+ params: Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List,
59973
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>
59974
+ ): void;
59975
+ list(
59976
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>
59977
+ ): void;
59978
+ list(
59979
+ paramsOrCallback?:
59980
+ | Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List
59981
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>
59982
+ | BodyResponseCallback<Readable>,
59983
+ optionsOrCallback?:
59984
+ | MethodOptions
59985
+ | StreamMethodOptions
59986
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>
59987
+ | BodyResponseCallback<Readable>,
59988
+ callback?:
59989
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>
59990
+ | BodyResponseCallback<Readable>
59991
+ ):
59992
+ | void
59993
+ | Promise<
59994
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>
59995
+ >
59996
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
59997
+ let params = (paramsOrCallback ||
59998
+ {}) as Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List;
59999
+ let options = (optionsOrCallback || {}) as MethodOptions;
60000
+
60001
+ if (typeof paramsOrCallback === 'function') {
60002
+ callback = paramsOrCallback;
60003
+ params =
60004
+ {} as Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List;
60005
+ options = {};
60006
+ }
60007
+
60008
+ if (typeof optionsOrCallback === 'function') {
60009
+ callback = optionsOrCallback;
60010
+ options = {};
60011
+ }
60012
+
60013
+ const rootUrl =
60014
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
60015
+ const parameters = {
60016
+ options: Object.assign(
60017
+ {
60018
+ url: (rootUrl + '/v1/{+parent}/licenseConfigsUsageStats').replace(
60019
+ /([^:]\/)\/+/g,
60020
+ '$1'
60021
+ ),
60022
+ method: 'GET',
60023
+ apiVersion: '',
60024
+ },
60025
+ options
60026
+ ),
60027
+ params,
60028
+ requiredParams: ['parent'],
60029
+ pathParams: ['parent'],
60030
+ context: this.context,
60031
+ };
60032
+ if (callback) {
60033
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>(
60034
+ parameters,
60035
+ callback as BodyResponseCallback<unknown>
60036
+ );
60037
+ } else {
60038
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse>(
60039
+ parameters
60040
+ );
60041
+ }
60042
+ }
60043
+ }
60044
+
60045
+ export interface Params$Resource$Projects$Locations$Userstores$Licenseconfigsusagestats$List
60046
+ extends StandardParameters {
60047
+ /**
60048
+ * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/userStores/{user_store_id\}`.
60049
+ */
60050
+ parent?: string;
60051
+ }
60052
+
57932
60053
  export class Resource$Projects$Locations$Userstores$Userlicenses {
57933
60054
  context: APIRequestContext;
57934
60055
  constructor(context: APIRequestContext) {
@@ -57970,7 +60091,7 @@ export namespace discoveryengine_v1 {
57970
60091
  * // Do the magic
57971
60092
  * const res =
57972
60093
  * await discoveryengine.projects.locations.userStores.userLicenses.list({
57973
- * // Optional. Filter for the list request. Supported fields: * `license_assignment_state` 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.
60094
+ * // 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.
57974
60095
  * filter: 'placeholder-value',
57975
60096
  * // 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.
57976
60097
  * pageSize: 'placeholder-value',
@@ -58100,7 +60221,7 @@ export namespace discoveryengine_v1 {
58100
60221
  export interface Params$Resource$Projects$Locations$Userstores$Userlicenses$List
58101
60222
  extends StandardParameters {
58102
60223
  /**
58103
- * Optional. Filter for the list request. Supported fields: * `license_assignment_state` 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.
60224
+ * 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.
58104
60225
  */
58105
60226
  filter?: string;
58106
60227
  /**