google-apis-discoveryengine_v1 0.56.0 → 0.58.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/discoveryengine_v1/classes.rb +1342 -96
- data/lib/google/apis/discoveryengine_v1/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1/representations.rb +420 -0
- data/lib/google/apis/discoveryengine_v1/service.rb +513 -13
- metadata +2 -2
|
@@ -1572,9 +1572,9 @@ module Google
|
|
|
1572
1572
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1UserInfo]
|
|
1573
1573
|
attr_accessor :user_info
|
|
1574
1574
|
|
|
1575
|
-
# A unique identifier for tracking visitors. For example, this could
|
|
1576
|
-
# implemented with an HTTP cookie, which should be able to uniquely identify
|
|
1577
|
-
# visitor on a single device. This unique identifier should not change if the
|
|
1575
|
+
# Optional. A unique identifier for tracking visitors. For example, this could
|
|
1576
|
+
# be implemented with an HTTP cookie, which should be able to uniquely identify
|
|
1577
|
+
# a visitor on a single device. This unique identifier should not change if the
|
|
1578
1578
|
# visitor logs in or out of the website. This field should NOT have a fixed
|
|
1579
1579
|
# value such as `unknown_visitor`. This should be the same identifier as
|
|
1580
1580
|
# UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a
|
|
@@ -7299,6 +7299,11 @@ module Google
|
|
|
7299
7299
|
# @return [String]
|
|
7300
7300
|
attr_accessor :configurable_billing_approach
|
|
7301
7301
|
|
|
7302
|
+
# Output only. The timestamp when configurable_billing_approach was last updated.
|
|
7303
|
+
# Corresponds to the JSON property `configurableBillingApproachUpdateTime`
|
|
7304
|
+
# @return [String]
|
|
7305
|
+
attr_accessor :configurable_billing_approach_update_time
|
|
7306
|
+
|
|
7302
7307
|
# Immutable. The content config of the data store. If this field is unset, the
|
|
7303
7308
|
# server behavior defaults to ContentConfig.NO_CONTENT.
|
|
7304
7309
|
# Corresponds to the JSON property `contentConfig`
|
|
@@ -7403,6 +7408,7 @@ module Google
|
|
|
7403
7408
|
@billing_estimation = args[:billing_estimation] if args.key?(:billing_estimation)
|
|
7404
7409
|
@cmek_config = args[:cmek_config] if args.key?(:cmek_config)
|
|
7405
7410
|
@configurable_billing_approach = args[:configurable_billing_approach] if args.key?(:configurable_billing_approach)
|
|
7411
|
+
@configurable_billing_approach_update_time = args[:configurable_billing_approach_update_time] if args.key?(:configurable_billing_approach_update_time)
|
|
7406
7412
|
@content_config = args[:content_config] if args.key?(:content_config)
|
|
7407
7413
|
@create_time = args[:create_time] if args.key?(:create_time)
|
|
7408
7414
|
@default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
|
|
@@ -8280,6 +8286,12 @@ module Google
|
|
|
8280
8286
|
attr_accessor :enable_image_annotation
|
|
8281
8287
|
alias_method :enable_image_annotation?, :enable_image_annotation
|
|
8282
8288
|
|
|
8289
|
+
# Optional. If true, the pdf layout will be refined using an LLM.
|
|
8290
|
+
# Corresponds to the JSON property `enableLlmLayoutParsing`
|
|
8291
|
+
# @return [Boolean]
|
|
8292
|
+
attr_accessor :enable_llm_layout_parsing
|
|
8293
|
+
alias_method :enable_llm_layout_parsing?, :enable_llm_layout_parsing
|
|
8294
|
+
|
|
8283
8295
|
# Optional. If true, the LLM based annotation is added to the table during
|
|
8284
8296
|
# parsing.
|
|
8285
8297
|
# Corresponds to the JSON property `enableTableAnnotation`
|
|
@@ -8316,6 +8328,7 @@ module Google
|
|
|
8316
8328
|
def update!(**args)
|
|
8317
8329
|
@enable_get_processed_document = args[:enable_get_processed_document] if args.key?(:enable_get_processed_document)
|
|
8318
8330
|
@enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
|
|
8331
|
+
@enable_llm_layout_parsing = args[:enable_llm_layout_parsing] if args.key?(:enable_llm_layout_parsing)
|
|
8319
8332
|
@enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
|
|
8320
8333
|
@exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
|
|
8321
8334
|
@exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
|
|
@@ -8447,6 +8460,11 @@ module Google
|
|
|
8447
8460
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EngineChatEngineMetadata]
|
|
8448
8461
|
attr_accessor :chat_engine_metadata
|
|
8449
8462
|
|
|
8463
|
+
# Configurations used to enable CMEK data encryption with Cloud KMS keys.
|
|
8464
|
+
# Corresponds to the JSON property `cmekConfig`
|
|
8465
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CmekConfig]
|
|
8466
|
+
attr_accessor :cmek_config
|
|
8467
|
+
|
|
8450
8468
|
# Common configurations for an Engine.
|
|
8451
8469
|
# Corresponds to the JSON property `commonConfig`
|
|
8452
8470
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EngineCommonConfig]
|
|
@@ -8508,6 +8526,17 @@ module Google
|
|
|
8508
8526
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig]
|
|
8509
8527
|
attr_accessor :media_recommendation_engine_config
|
|
8510
8528
|
|
|
8529
|
+
# Optional. Maps a model name to its specific configuration for this engine.
|
|
8530
|
+
# This allows admin users to turn on/off individual models. This only stores
|
|
8531
|
+
# models whose states are overridden by the admin. When the state is unspecified,
|
|
8532
|
+
# or model_configs is empty for this model, the system will decide if this
|
|
8533
|
+
# model should be available or not based on the default configuration. For
|
|
8534
|
+
# example, a preview model should be disabled by default if the admin has not
|
|
8535
|
+
# chosen to enable it.
|
|
8536
|
+
# Corresponds to the JSON property `modelConfigs`
|
|
8537
|
+
# @return [Hash<String,String>]
|
|
8538
|
+
attr_accessor :model_configs
|
|
8539
|
+
|
|
8511
8540
|
# Immutable. Identifier. The fully qualified resource name of the engine. This
|
|
8512
8541
|
# field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
8513
8542
|
# Format: `projects/`project`/locations/`location`/collections/`collection`/
|
|
@@ -8541,6 +8570,7 @@ module Google
|
|
|
8541
8570
|
@app_type = args[:app_type] if args.key?(:app_type)
|
|
8542
8571
|
@chat_engine_config = args[:chat_engine_config] if args.key?(:chat_engine_config)
|
|
8543
8572
|
@chat_engine_metadata = args[:chat_engine_metadata] if args.key?(:chat_engine_metadata)
|
|
8573
|
+
@cmek_config = args[:cmek_config] if args.key?(:cmek_config)
|
|
8544
8574
|
@common_config = args[:common_config] if args.key?(:common_config)
|
|
8545
8575
|
@configurable_billing_approach = args[:configurable_billing_approach] if args.key?(:configurable_billing_approach)
|
|
8546
8576
|
@create_time = args[:create_time] if args.key?(:create_time)
|
|
@@ -8550,6 +8580,7 @@ module Google
|
|
|
8550
8580
|
@features = args[:features] if args.key?(:features)
|
|
8551
8581
|
@industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
|
|
8552
8582
|
@media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
|
|
8583
|
+
@model_configs = args[:model_configs] if args.key?(:model_configs)
|
|
8553
8584
|
@name = args[:name] if args.key?(:name)
|
|
8554
8585
|
@search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
|
|
8555
8586
|
@solution_type = args[:solution_type] if args.key?(:solution_type)
|
|
@@ -10173,6 +10204,31 @@ module Google
|
|
|
10173
10204
|
end
|
|
10174
10205
|
end
|
|
10175
10206
|
|
|
10207
|
+
# Stats about users' licenses.
|
|
10208
|
+
class GoogleCloudDiscoveryengineV1LicenseConfigUsageStats
|
|
10209
|
+
include Google::Apis::Core::Hashable
|
|
10210
|
+
|
|
10211
|
+
# Required. The LicenseConfig name.
|
|
10212
|
+
# Corresponds to the JSON property `licenseConfig`
|
|
10213
|
+
# @return [String]
|
|
10214
|
+
attr_accessor :license_config
|
|
10215
|
+
|
|
10216
|
+
# Required. The number of licenses used.
|
|
10217
|
+
# Corresponds to the JSON property `usedLicenseCount`
|
|
10218
|
+
# @return [Fixnum]
|
|
10219
|
+
attr_accessor :used_license_count
|
|
10220
|
+
|
|
10221
|
+
def initialize(**args)
|
|
10222
|
+
update!(**args)
|
|
10223
|
+
end
|
|
10224
|
+
|
|
10225
|
+
# Update properties of this object
|
|
10226
|
+
def update!(**args)
|
|
10227
|
+
@license_config = args[:license_config] if args.key?(:license_config)
|
|
10228
|
+
@used_license_count = args[:used_license_count] if args.key?(:used_license_count)
|
|
10229
|
+
end
|
|
10230
|
+
end
|
|
10231
|
+
|
|
10176
10232
|
# Response message for CmekConfigService.ListCmekConfigs method.
|
|
10177
10233
|
class GoogleCloudDiscoveryengineV1ListCmekConfigsResponse
|
|
10178
10234
|
include Google::Apis::Core::Hashable
|
|
@@ -10390,6 +10446,25 @@ module Google
|
|
|
10390
10446
|
end
|
|
10391
10447
|
end
|
|
10392
10448
|
|
|
10449
|
+
# Response message for UserLicenseService.ListLicenseConfigUsageStats method.
|
|
10450
|
+
class GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse
|
|
10451
|
+
include Google::Apis::Core::Hashable
|
|
10452
|
+
|
|
10453
|
+
# All the customer's LicenseConfigUsageStats.
|
|
10454
|
+
# Corresponds to the JSON property `licenseConfigUsageStats`
|
|
10455
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1LicenseConfigUsageStats>]
|
|
10456
|
+
attr_accessor :license_config_usage_stats
|
|
10457
|
+
|
|
10458
|
+
def initialize(**args)
|
|
10459
|
+
update!(**args)
|
|
10460
|
+
end
|
|
10461
|
+
|
|
10462
|
+
# Update properties of this object
|
|
10463
|
+
def update!(**args)
|
|
10464
|
+
@license_config_usage_stats = args[:license_config_usage_stats] if args.key?(:license_config_usage_stats)
|
|
10465
|
+
end
|
|
10466
|
+
end
|
|
10467
|
+
|
|
10393
10468
|
# Response message for SchemaService.ListSchemas method.
|
|
10394
10469
|
class GoogleCloudDiscoveryengineV1ListSchemasResponse
|
|
10395
10470
|
include Google::Apis::Core::Hashable
|
|
@@ -10416,6 +10491,31 @@ module Google
|
|
|
10416
10491
|
end
|
|
10417
10492
|
end
|
|
10418
10493
|
|
|
10494
|
+
# Response for ListServingConfigs method.
|
|
10495
|
+
class GoogleCloudDiscoveryengineV1ListServingConfigsResponse
|
|
10496
|
+
include Google::Apis::Core::Hashable
|
|
10497
|
+
|
|
10498
|
+
# Pagination token, if not returned indicates the last page.
|
|
10499
|
+
# Corresponds to the JSON property `nextPageToken`
|
|
10500
|
+
# @return [String]
|
|
10501
|
+
attr_accessor :next_page_token
|
|
10502
|
+
|
|
10503
|
+
# All the ServingConfigs for a given dataStore.
|
|
10504
|
+
# Corresponds to the JSON property `servingConfigs`
|
|
10505
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ServingConfig>]
|
|
10506
|
+
attr_accessor :serving_configs
|
|
10507
|
+
|
|
10508
|
+
def initialize(**args)
|
|
10509
|
+
update!(**args)
|
|
10510
|
+
end
|
|
10511
|
+
|
|
10512
|
+
# Update properties of this object
|
|
10513
|
+
def update!(**args)
|
|
10514
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
|
10515
|
+
@serving_configs = args[:serving_configs] if args.key?(:serving_configs)
|
|
10516
|
+
end
|
|
10517
|
+
end
|
|
10518
|
+
|
|
10419
10519
|
# Response for ListSessions method.
|
|
10420
10520
|
class GoogleCloudDiscoveryengineV1ListSessionsResponse
|
|
10421
10521
|
include Google::Apis::Core::Hashable
|
|
@@ -10672,6 +10772,16 @@ module Google
|
|
|
10672
10772
|
class GoogleCloudDiscoveryengineV1Project
|
|
10673
10773
|
include Google::Apis::Core::Hashable
|
|
10674
10774
|
|
|
10775
|
+
# Represents the currently effective configurable billing parameters. These
|
|
10776
|
+
# values are derived from the customer's subscription history stored internally
|
|
10777
|
+
# and reflect the thresholds actively being used for billing purposes at the
|
|
10778
|
+
# time of the GetProject call. This includes the start_time of the subscription
|
|
10779
|
+
# and may differ from the values in `customer_provided_config` due to billing
|
|
10780
|
+
# rules (e.g., scale-downs taking effect only at the start of a new month).
|
|
10781
|
+
# Corresponds to the JSON property `configurableBillingStatus`
|
|
10782
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus]
|
|
10783
|
+
attr_accessor :configurable_billing_status
|
|
10784
|
+
|
|
10675
10785
|
# Output only. The timestamp when this project is created.
|
|
10676
10786
|
# Corresponds to the JSON property `createTime`
|
|
10677
10787
|
# @return [String]
|
|
@@ -10706,6 +10816,7 @@ module Google
|
|
|
10706
10816
|
|
|
10707
10817
|
# Update properties of this object
|
|
10708
10818
|
def update!(**args)
|
|
10819
|
+
@configurable_billing_status = args[:configurable_billing_status] if args.key?(:configurable_billing_status)
|
|
10709
10820
|
@create_time = args[:create_time] if args.key?(:create_time)
|
|
10710
10821
|
@customer_provided_config = args[:customer_provided_config] if args.key?(:customer_provided_config)
|
|
10711
10822
|
@name = args[:name] if args.key?(:name)
|
|
@@ -10714,6 +10825,46 @@ module Google
|
|
|
10714
10825
|
end
|
|
10715
10826
|
end
|
|
10716
10827
|
|
|
10828
|
+
# Represents the currently effective configurable billing parameters. These
|
|
10829
|
+
# values are derived from the customer's subscription history stored internally
|
|
10830
|
+
# and reflect the thresholds actively being used for billing purposes at the
|
|
10831
|
+
# time of the GetProject call. This includes the start_time of the subscription
|
|
10832
|
+
# and may differ from the values in `customer_provided_config` due to billing
|
|
10833
|
+
# rules (e.g., scale-downs taking effect only at the start of a new month).
|
|
10834
|
+
class GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus
|
|
10835
|
+
include Google::Apis::Core::Hashable
|
|
10836
|
+
|
|
10837
|
+
# Optional. The currently effective Indexing Core threshold. This is the
|
|
10838
|
+
# threshold against which Indexing Core usage is compared for overage
|
|
10839
|
+
# calculations.
|
|
10840
|
+
# Corresponds to the JSON property `effectiveIndexingCoreThreshold`
|
|
10841
|
+
# @return [Fixnum]
|
|
10842
|
+
attr_accessor :effective_indexing_core_threshold
|
|
10843
|
+
|
|
10844
|
+
# Optional. The currently effective Search QPM threshold in queries per minute.
|
|
10845
|
+
# This is the threshold against which QPM usage is compared for overage
|
|
10846
|
+
# calculations.
|
|
10847
|
+
# Corresponds to the JSON property `effectiveSearchQpmThreshold`
|
|
10848
|
+
# @return [Fixnum]
|
|
10849
|
+
attr_accessor :effective_search_qpm_threshold
|
|
10850
|
+
|
|
10851
|
+
# Optional. The start time of the currently active billing subscription.
|
|
10852
|
+
# Corresponds to the JSON property `startTime`
|
|
10853
|
+
# @return [String]
|
|
10854
|
+
attr_accessor :start_time
|
|
10855
|
+
|
|
10856
|
+
def initialize(**args)
|
|
10857
|
+
update!(**args)
|
|
10858
|
+
end
|
|
10859
|
+
|
|
10860
|
+
# Update properties of this object
|
|
10861
|
+
def update!(**args)
|
|
10862
|
+
@effective_indexing_core_threshold = args[:effective_indexing_core_threshold] if args.key?(:effective_indexing_core_threshold)
|
|
10863
|
+
@effective_search_qpm_threshold = args[:effective_search_qpm_threshold] if args.key?(:effective_search_qpm_threshold)
|
|
10864
|
+
@start_time = args[:start_time] if args.key?(:start_time)
|
|
10865
|
+
end
|
|
10866
|
+
end
|
|
10867
|
+
|
|
10717
10868
|
# Customer provided configurations.
|
|
10718
10869
|
class GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig
|
|
10719
10870
|
include Google::Apis::Core::Hashable
|
|
@@ -12154,9 +12305,9 @@ module Google
|
|
|
12154
12305
|
# @return [Hash<String,String>]
|
|
12155
12306
|
attr_accessor :user_labels
|
|
12156
12307
|
|
|
12157
|
-
# A unique identifier for tracking visitors. For example, this could
|
|
12158
|
-
# implemented with an HTTP cookie, which should be able to uniquely identify
|
|
12159
|
-
# visitor on a single device. This unique identifier should not change if the
|
|
12308
|
+
# Optional. A unique identifier for tracking visitors. For example, this could
|
|
12309
|
+
# be implemented with an HTTP cookie, which should be able to uniquely identify
|
|
12310
|
+
# a visitor on a single device. This unique identifier should not change if the
|
|
12160
12311
|
# visitor logs in or out of the website. This field should NOT have a fixed
|
|
12161
12312
|
# value such as `unknown_visitor`. This should be the same identifier as
|
|
12162
12313
|
# UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field
|
|
@@ -15427,109 +15578,305 @@ module Google
|
|
|
15427
15578
|
end
|
|
15428
15579
|
end
|
|
15429
15580
|
|
|
15430
|
-
#
|
|
15431
|
-
class
|
|
15581
|
+
# WidgetConfig captures configs at the Widget level.
|
|
15582
|
+
class GoogleCloudDiscoveryengineV1WidgetConfig
|
|
15432
15583
|
include Google::Apis::Core::Hashable
|
|
15433
15584
|
|
|
15434
|
-
#
|
|
15435
|
-
# Corresponds to the JSON property `
|
|
15585
|
+
# Describes widget access settings.
|
|
15586
|
+
# Corresponds to the JSON property `accessSettings`
|
|
15587
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings]
|
|
15588
|
+
attr_accessor :access_settings
|
|
15589
|
+
|
|
15590
|
+
# Whether allow no-auth integration with widget. If set true, public access to
|
|
15591
|
+
# search or other solutions from widget is allowed without authenication token
|
|
15592
|
+
# provided by customer hosted backend server.
|
|
15593
|
+
# Corresponds to the JSON property `allowPublicAccess`
|
|
15594
|
+
# @return [Boolean]
|
|
15595
|
+
attr_accessor :allow_public_access
|
|
15596
|
+
alias_method :allow_public_access?, :allow_public_access
|
|
15597
|
+
|
|
15598
|
+
# Allowlisted domains that can load this widget.
|
|
15599
|
+
# Corresponds to the JSON property `allowlistedDomains`
|
|
15600
|
+
# @return [Array<String>]
|
|
15601
|
+
attr_accessor :allowlisted_domains
|
|
15602
|
+
|
|
15603
|
+
# Describes the assistant settings of the widget.
|
|
15604
|
+
# Corresponds to the JSON property `assistantSettings`
|
|
15605
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings]
|
|
15606
|
+
attr_accessor :assistant_settings
|
|
15607
|
+
|
|
15608
|
+
# Output only. Collection components that lists all collections and child data
|
|
15609
|
+
# stores associated with the widget config, those data sources can be used for
|
|
15610
|
+
# filtering in widget service APIs, users can return results that from selected
|
|
15611
|
+
# data sources.
|
|
15612
|
+
# Corresponds to the JSON property `collectionComponents`
|
|
15613
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent>]
|
|
15614
|
+
attr_accessor :collection_components
|
|
15615
|
+
|
|
15616
|
+
# Output only. Unique obfuscated identifier of a WidgetConfig.
|
|
15617
|
+
# Corresponds to the JSON property `configId`
|
|
15436
15618
|
# @return [String]
|
|
15437
|
-
attr_accessor :
|
|
15619
|
+
attr_accessor :config_id
|
|
15438
15620
|
|
|
15439
|
-
#
|
|
15440
|
-
#
|
|
15441
|
-
#
|
|
15442
|
-
|
|
15621
|
+
# A specification for configuring the behavior of content search.
|
|
15622
|
+
# Corresponds to the JSON property `contentSearchSpec`
|
|
15623
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec]
|
|
15624
|
+
attr_accessor :content_search_spec
|
|
15625
|
+
|
|
15626
|
+
# Output only. Timestamp the WidgetConfig was created.
|
|
15627
|
+
# Corresponds to the JSON property `createTime`
|
|
15443
15628
|
# @return [String]
|
|
15444
|
-
attr_accessor :
|
|
15629
|
+
attr_accessor :create_time
|
|
15445
15630
|
|
|
15446
|
-
#
|
|
15447
|
-
#
|
|
15448
|
-
#
|
|
15449
|
-
|
|
15631
|
+
# Customer provided configurations.
|
|
15632
|
+
# Corresponds to the JSON property `customerProvidedConfig`
|
|
15633
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig]
|
|
15634
|
+
attr_accessor :customer_provided_config
|
|
15635
|
+
|
|
15636
|
+
# Output only. The type of the parent data store.
|
|
15637
|
+
# Corresponds to the JSON property `dataStoreType`
|
|
15450
15638
|
# @return [String]
|
|
15451
|
-
attr_accessor :
|
|
15639
|
+
attr_accessor :data_store_type
|
|
15452
15640
|
|
|
15453
|
-
#
|
|
15454
|
-
# Corresponds to the JSON property `
|
|
15641
|
+
# Configurable UI configurations per data store.
|
|
15642
|
+
# Corresponds to the JSON property `dataStoreUiConfigs`
|
|
15643
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig>]
|
|
15644
|
+
attr_accessor :data_store_ui_configs
|
|
15645
|
+
|
|
15646
|
+
# The default ordering for search results if specified. Used to set
|
|
15647
|
+
# SearchRequest#order_by on applicable requests. https://cloud.google.com/
|
|
15648
|
+
# generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.
|
|
15649
|
+
# dataStores.servingConfigs/search#request-body
|
|
15650
|
+
# Corresponds to the JSON property `defaultSearchRequestOrderBy`
|
|
15455
15651
|
# @return [String]
|
|
15456
|
-
attr_accessor :
|
|
15652
|
+
attr_accessor :default_search_request_order_by
|
|
15457
15653
|
|
|
15458
|
-
|
|
15459
|
-
|
|
15460
|
-
|
|
15654
|
+
# Required. The human readable widget config display name. Used in Discovery UI.
|
|
15655
|
+
# This field must be a UTF-8 encoded string with a length limit of 128
|
|
15656
|
+
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
15657
|
+
# Corresponds to the JSON property `displayName`
|
|
15658
|
+
# @return [String]
|
|
15659
|
+
attr_accessor :display_name
|
|
15461
15660
|
|
|
15462
|
-
#
|
|
15463
|
-
|
|
15464
|
-
|
|
15465
|
-
|
|
15466
|
-
|
|
15467
|
-
@type = args[:type] if args.key?(:type)
|
|
15468
|
-
end
|
|
15469
|
-
end
|
|
15661
|
+
# Whether or not to enable autocomplete.
|
|
15662
|
+
# Corresponds to the JSON property `enableAutocomplete`
|
|
15663
|
+
# @return [Boolean]
|
|
15664
|
+
attr_accessor :enable_autocomplete
|
|
15665
|
+
alias_method :enable_autocomplete?, :enable_autocomplete
|
|
15470
15666
|
|
|
15471
|
-
|
|
15472
|
-
|
|
15473
|
-
|
|
15667
|
+
# Whether to allow conversational search (LLM, multi-turn) or not (non-LLM,
|
|
15668
|
+
# single-turn).
|
|
15669
|
+
# Corresponds to the JSON property `enableConversationalSearch`
|
|
15670
|
+
# @return [Boolean]
|
|
15671
|
+
attr_accessor :enable_conversational_search
|
|
15672
|
+
alias_method :enable_conversational_search?, :enable_conversational_search
|
|
15474
15673
|
|
|
15475
|
-
#
|
|
15476
|
-
# Corresponds to the JSON property `
|
|
15477
|
-
# @return [
|
|
15478
|
-
attr_accessor :
|
|
15674
|
+
# Optional. Output only. Whether to enable private knowledge graph.
|
|
15675
|
+
# Corresponds to the JSON property `enablePrivateKnowledgeGraph`
|
|
15676
|
+
# @return [Boolean]
|
|
15677
|
+
attr_accessor :enable_private_knowledge_graph
|
|
15678
|
+
alias_method :enable_private_knowledge_graph?, :enable_private_knowledge_graph
|
|
15479
15679
|
|
|
15480
|
-
#
|
|
15481
|
-
#
|
|
15482
|
-
#
|
|
15680
|
+
# Turn on or off collecting the search result quality feedback from end users.
|
|
15681
|
+
# Corresponds to the JSON property `enableQualityFeedback`
|
|
15682
|
+
# @return [Boolean]
|
|
15683
|
+
attr_accessor :enable_quality_feedback
|
|
15684
|
+
alias_method :enable_quality_feedback?, :enable_quality_feedback
|
|
15685
|
+
|
|
15686
|
+
# Whether to show the result score.
|
|
15687
|
+
# Corresponds to the JSON property `enableResultScore`
|
|
15688
|
+
# @return [Boolean]
|
|
15689
|
+
attr_accessor :enable_result_score
|
|
15690
|
+
alias_method :enable_result_score?, :enable_result_score
|
|
15691
|
+
|
|
15692
|
+
# Whether to enable safe search.
|
|
15693
|
+
# Corresponds to the JSON property `enableSafeSearch`
|
|
15694
|
+
# @return [Boolean]
|
|
15695
|
+
attr_accessor :enable_safe_search
|
|
15696
|
+
alias_method :enable_safe_search?, :enable_safe_search
|
|
15697
|
+
|
|
15698
|
+
# Whether to enable search-as-you-type behavior for the search widget
|
|
15699
|
+
# Corresponds to the JSON property `enableSearchAsYouType`
|
|
15700
|
+
# @return [Boolean]
|
|
15701
|
+
attr_accessor :enable_search_as_you_type
|
|
15702
|
+
alias_method :enable_search_as_you_type?, :enable_search_as_you_type
|
|
15703
|
+
|
|
15704
|
+
# Turn on or off summary for each snippets result.
|
|
15705
|
+
# Corresponds to the JSON property `enableSnippetResultSummary`
|
|
15706
|
+
# @return [Boolean]
|
|
15707
|
+
attr_accessor :enable_snippet_result_summary
|
|
15708
|
+
alias_method :enable_snippet_result_summary?, :enable_snippet_result_summary
|
|
15709
|
+
|
|
15710
|
+
# Turn on or off summarization for the search response.
|
|
15711
|
+
# Corresponds to the JSON property `enableSummarization`
|
|
15712
|
+
# @return [Boolean]
|
|
15713
|
+
attr_accessor :enable_summarization
|
|
15714
|
+
alias_method :enable_summarization?, :enable_summarization
|
|
15715
|
+
|
|
15716
|
+
# Whether to enable standalone web app.
|
|
15717
|
+
# Corresponds to the JSON property `enableWebApp`
|
|
15718
|
+
# @return [Boolean]
|
|
15719
|
+
attr_accessor :enable_web_app
|
|
15720
|
+
alias_method :enable_web_app?, :enable_web_app
|
|
15721
|
+
|
|
15722
|
+
# The configuration and appearance of facets in the end user view.
|
|
15723
|
+
# Corresponds to the JSON property `facetField`
|
|
15724
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigFacetField>]
|
|
15725
|
+
attr_accessor :facet_field
|
|
15726
|
+
|
|
15727
|
+
# The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `
|
|
15728
|
+
# url`, `custom1`, `custom2`, `custom3`. The value is the name of the field
|
|
15729
|
+
# along with its device visibility. The 3 custom fields are optional and can be
|
|
15730
|
+
# added or removed. `title`, `thumbnail`, `url` are required UI components that
|
|
15731
|
+
# cannot be removed.
|
|
15732
|
+
# Corresponds to the JSON property `fieldsUiComponentsMap`
|
|
15733
|
+
# @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigUiComponentField>]
|
|
15734
|
+
attr_accessor :fields_ui_components_map
|
|
15735
|
+
|
|
15736
|
+
# Output only. Whether the subscription is gemini bundle or not.
|
|
15737
|
+
# Corresponds to the JSON property `geminiBundle`
|
|
15738
|
+
# @return [Boolean]
|
|
15739
|
+
attr_accessor :gemini_bundle
|
|
15740
|
+
alias_method :gemini_bundle?, :gemini_bundle
|
|
15741
|
+
|
|
15742
|
+
# Describes the homepage setting of the widget. It includes all homepage related
|
|
15743
|
+
# settings and configurations, such as shortcuts.
|
|
15744
|
+
# Corresponds to the JSON property `homepageSetting`
|
|
15745
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting]
|
|
15746
|
+
attr_accessor :homepage_setting
|
|
15747
|
+
|
|
15748
|
+
# Output only. The industry vertical that the WidgetConfig registers. The
|
|
15749
|
+
# WidgetConfig industry vertical is based on the associated Engine.
|
|
15750
|
+
# Corresponds to the JSON property `industryVertical`
|
|
15751
|
+
# @return [String]
|
|
15752
|
+
attr_accessor :industry_vertical
|
|
15753
|
+
|
|
15754
|
+
# Output only. Whether LLM is enabled in the corresponding data store.
|
|
15755
|
+
# Corresponds to the JSON property `llmEnabled`
|
|
15756
|
+
# @return [Boolean]
|
|
15757
|
+
attr_accessor :llm_enabled
|
|
15758
|
+
alias_method :llm_enabled?, :llm_enabled
|
|
15759
|
+
|
|
15760
|
+
# Output only. Whether the customer accepted data use terms.
|
|
15761
|
+
# Corresponds to the JSON property `minimumDataTermAccepted`
|
|
15762
|
+
# @return [Boolean]
|
|
15763
|
+
attr_accessor :minimum_data_term_accepted
|
|
15764
|
+
alias_method :minimum_data_term_accepted?, :minimum_data_term_accepted
|
|
15765
|
+
|
|
15766
|
+
# Immutable. The full resource name of the widget config. Format: `projects/`
|
|
15767
|
+
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
|
15768
|
+
# data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
|
|
15769
|
+
# encoded string with a length limit of 1024 characters.
|
|
15483
15770
|
# Corresponds to the JSON property `name`
|
|
15484
15771
|
# @return [String]
|
|
15485
15772
|
attr_accessor :name
|
|
15486
15773
|
|
|
15774
|
+
# The type of snippet to display in UCS widget. -
|
|
15775
|
+
# RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-
|
|
15776
|
+
# enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
|
|
15777
|
+
# Corresponds to the JSON property `resultDisplayType`
|
|
15778
|
+
# @return [String]
|
|
15779
|
+
attr_accessor :result_display_type
|
|
15780
|
+
|
|
15781
|
+
# Required. Immutable. Specifies the solution type that this WidgetConfig can be
|
|
15782
|
+
# used for.
|
|
15783
|
+
# Corresponds to the JSON property `solutionType`
|
|
15784
|
+
# @return [String]
|
|
15785
|
+
attr_accessor :solution_type
|
|
15786
|
+
|
|
15787
|
+
# Describes widget UI branding settings.
|
|
15788
|
+
# Corresponds to the JSON property `uiBranding`
|
|
15789
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings]
|
|
15790
|
+
attr_accessor :ui_branding
|
|
15791
|
+
|
|
15792
|
+
# Describes general widget (or web app) UI settings as seen in the cloud console
|
|
15793
|
+
# UI configuration page.
|
|
15794
|
+
# Corresponds to the JSON property `uiSettings`
|
|
15795
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigUiSettings]
|
|
15796
|
+
attr_accessor :ui_settings
|
|
15797
|
+
|
|
15798
|
+
# Output only. Timestamp the WidgetConfig was updated.
|
|
15799
|
+
# Corresponds to the JSON property `updateTime`
|
|
15800
|
+
# @return [String]
|
|
15801
|
+
attr_accessor :update_time
|
|
15802
|
+
|
|
15487
15803
|
def initialize(**args)
|
|
15488
15804
|
update!(**args)
|
|
15489
15805
|
end
|
|
15490
15806
|
|
|
15491
15807
|
# Update properties of this object
|
|
15492
15808
|
def update!(**args)
|
|
15493
|
-
@
|
|
15809
|
+
@access_settings = args[:access_settings] if args.key?(:access_settings)
|
|
15810
|
+
@allow_public_access = args[:allow_public_access] if args.key?(:allow_public_access)
|
|
15811
|
+
@allowlisted_domains = args[:allowlisted_domains] if args.key?(:allowlisted_domains)
|
|
15812
|
+
@assistant_settings = args[:assistant_settings] if args.key?(:assistant_settings)
|
|
15813
|
+
@collection_components = args[:collection_components] if args.key?(:collection_components)
|
|
15814
|
+
@config_id = args[:config_id] if args.key?(:config_id)
|
|
15815
|
+
@content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
|
|
15816
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
|
15817
|
+
@customer_provided_config = args[:customer_provided_config] if args.key?(:customer_provided_config)
|
|
15818
|
+
@data_store_type = args[:data_store_type] if args.key?(:data_store_type)
|
|
15819
|
+
@data_store_ui_configs = args[:data_store_ui_configs] if args.key?(:data_store_ui_configs)
|
|
15820
|
+
@default_search_request_order_by = args[:default_search_request_order_by] if args.key?(:default_search_request_order_by)
|
|
15821
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
|
15822
|
+
@enable_autocomplete = args[:enable_autocomplete] if args.key?(:enable_autocomplete)
|
|
15823
|
+
@enable_conversational_search = args[:enable_conversational_search] if args.key?(:enable_conversational_search)
|
|
15824
|
+
@enable_private_knowledge_graph = args[:enable_private_knowledge_graph] if args.key?(:enable_private_knowledge_graph)
|
|
15825
|
+
@enable_quality_feedback = args[:enable_quality_feedback] if args.key?(:enable_quality_feedback)
|
|
15826
|
+
@enable_result_score = args[:enable_result_score] if args.key?(:enable_result_score)
|
|
15827
|
+
@enable_safe_search = args[:enable_safe_search] if args.key?(:enable_safe_search)
|
|
15828
|
+
@enable_search_as_you_type = args[:enable_search_as_you_type] if args.key?(:enable_search_as_you_type)
|
|
15829
|
+
@enable_snippet_result_summary = args[:enable_snippet_result_summary] if args.key?(:enable_snippet_result_summary)
|
|
15830
|
+
@enable_summarization = args[:enable_summarization] if args.key?(:enable_summarization)
|
|
15831
|
+
@enable_web_app = args[:enable_web_app] if args.key?(:enable_web_app)
|
|
15832
|
+
@facet_field = args[:facet_field] if args.key?(:facet_field)
|
|
15833
|
+
@fields_ui_components_map = args[:fields_ui_components_map] if args.key?(:fields_ui_components_map)
|
|
15834
|
+
@gemini_bundle = args[:gemini_bundle] if args.key?(:gemini_bundle)
|
|
15835
|
+
@homepage_setting = args[:homepage_setting] if args.key?(:homepage_setting)
|
|
15836
|
+
@industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
|
|
15837
|
+
@llm_enabled = args[:llm_enabled] if args.key?(:llm_enabled)
|
|
15838
|
+
@minimum_data_term_accepted = args[:minimum_data_term_accepted] if args.key?(:minimum_data_term_accepted)
|
|
15494
15839
|
@name = args[:name] if args.key?(:name)
|
|
15840
|
+
@result_display_type = args[:result_display_type] if args.key?(:result_display_type)
|
|
15841
|
+
@solution_type = args[:solution_type] if args.key?(:solution_type)
|
|
15842
|
+
@ui_branding = args[:ui_branding] if args.key?(:ui_branding)
|
|
15843
|
+
@ui_settings = args[:ui_settings] if args.key?(:ui_settings)
|
|
15844
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
|
15495
15845
|
end
|
|
15496
15846
|
end
|
|
15497
15847
|
|
|
15498
|
-
#
|
|
15499
|
-
class
|
|
15848
|
+
# Describes widget access settings.
|
|
15849
|
+
class GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings
|
|
15500
15850
|
include Google::Apis::Core::Hashable
|
|
15501
15851
|
|
|
15502
|
-
#
|
|
15503
|
-
# Corresponds to the JSON property `
|
|
15504
|
-
# @return [
|
|
15505
|
-
attr_accessor :
|
|
15852
|
+
# Whether public unauthenticated access is allowed.
|
|
15853
|
+
# Corresponds to the JSON property `allowPublicAccess`
|
|
15854
|
+
# @return [Boolean]
|
|
15855
|
+
attr_accessor :allow_public_access
|
|
15856
|
+
alias_method :allow_public_access?, :allow_public_access
|
|
15506
15857
|
|
|
15507
|
-
#
|
|
15508
|
-
# to
|
|
15509
|
-
#
|
|
15858
|
+
# List of domains that are allowed to integrate the search widget.
|
|
15859
|
+
# Corresponds to the JSON property `allowlistedDomains`
|
|
15860
|
+
# @return [Array<String>]
|
|
15861
|
+
attr_accessor :allowlisted_domains
|
|
15862
|
+
|
|
15863
|
+
# Whether web app access is enabled.
|
|
15864
|
+
# Corresponds to the JSON property `enableWebApp`
|
|
15510
15865
|
# @return [Boolean]
|
|
15511
|
-
attr_accessor :
|
|
15512
|
-
alias_method :
|
|
15866
|
+
attr_accessor :enable_web_app
|
|
15867
|
+
alias_method :enable_web_app?, :enable_web_app
|
|
15513
15868
|
|
|
15514
|
-
# Optional.
|
|
15515
|
-
#
|
|
15869
|
+
# Optional. Language code for user interface. Use language tags defined by [
|
|
15870
|
+
# BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default
|
|
15871
|
+
# language code is "en-US".
|
|
15872
|
+
# Corresponds to the JSON property `languageCode`
|
|
15516
15873
|
# @return [String]
|
|
15517
|
-
attr_accessor :
|
|
15874
|
+
attr_accessor :language_code
|
|
15518
15875
|
|
|
15519
|
-
# Optional. The
|
|
15520
|
-
#
|
|
15521
|
-
# to the data source's `instance_uri`, defined in DataConnector.params. Required
|
|
15522
|
-
# when VPC Service Controls are enabled.
|
|
15523
|
-
# Corresponds to the JSON property `serviceName`
|
|
15876
|
+
# Optional. The workforce identity pool provider used to access the widget.
|
|
15877
|
+
# Corresponds to the JSON property `workforceIdentityPoolProvider`
|
|
15524
15878
|
# @return [String]
|
|
15525
|
-
attr_accessor :
|
|
15526
|
-
|
|
15527
|
-
# Optional. Whether to use static secrets for the connector. If true, the
|
|
15528
|
-
# secrets provided in the action_params will be ignored.
|
|
15529
|
-
# Corresponds to the JSON property `useStaticSecrets`
|
|
15530
|
-
# @return [Boolean]
|
|
15531
|
-
attr_accessor :use_static_secrets
|
|
15532
|
-
alias_method :use_static_secrets?, :use_static_secrets
|
|
15879
|
+
attr_accessor :workforce_identity_pool_provider
|
|
15533
15880
|
|
|
15534
15881
|
def initialize(**args)
|
|
15535
15882
|
update!(**args)
|
|
@@ -15537,32 +15884,740 @@ module Google
|
|
|
15537
15884
|
|
|
15538
15885
|
# Update properties of this object
|
|
15539
15886
|
def update!(**args)
|
|
15540
|
-
@
|
|
15541
|
-
@
|
|
15542
|
-
@
|
|
15543
|
-
@
|
|
15544
|
-
@
|
|
15887
|
+
@allow_public_access = args[:allow_public_access] if args.key?(:allow_public_access)
|
|
15888
|
+
@allowlisted_domains = args[:allowlisted_domains] if args.key?(:allowlisted_domains)
|
|
15889
|
+
@enable_web_app = args[:enable_web_app] if args.key?(:enable_web_app)
|
|
15890
|
+
@language_code = args[:language_code] if args.key?(:language_code)
|
|
15891
|
+
@workforce_identity_pool_provider = args[:workforce_identity_pool_provider] if args.key?(:workforce_identity_pool_provider)
|
|
15545
15892
|
end
|
|
15546
15893
|
end
|
|
15547
15894
|
|
|
15548
|
-
#
|
|
15549
|
-
class
|
|
15895
|
+
# Describes the assistant settings of the widget.
|
|
15896
|
+
class GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings
|
|
15550
15897
|
include Google::Apis::Core::Hashable
|
|
15551
15898
|
|
|
15552
|
-
#
|
|
15553
|
-
#
|
|
15899
|
+
# Output only. This field controls the default web grounding toggle for end
|
|
15900
|
+
# users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `
|
|
15901
|
+
# WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to
|
|
15902
|
+
# false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `
|
|
15903
|
+
# WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding
|
|
15904
|
+
# enabled by default on UI. If true, grounding toggle will be disabled by
|
|
15905
|
+
# default on UI. End users can still enable web grounding in the UI if web
|
|
15906
|
+
# grounding is enabled.
|
|
15907
|
+
# Corresponds to the JSON property `defaultWebGroundingToggleOff`
|
|
15554
15908
|
# @return [Boolean]
|
|
15555
|
-
attr_accessor :
|
|
15556
|
-
alias_method :
|
|
15909
|
+
attr_accessor :default_web_grounding_toggle_off
|
|
15910
|
+
alias_method :default_web_grounding_toggle_off?, :default_web_grounding_toggle_off
|
|
15557
15911
|
|
|
15558
|
-
#
|
|
15559
|
-
# Corresponds to the JSON property `
|
|
15912
|
+
# Optional. Output only. Whether to disable user location context.
|
|
15913
|
+
# Corresponds to the JSON property `disableLocationContext`
|
|
15560
15914
|
# @return [Boolean]
|
|
15561
|
-
attr_accessor :
|
|
15562
|
-
alias_method :
|
|
15915
|
+
attr_accessor :disable_location_context
|
|
15916
|
+
alias_method :disable_location_context?, :disable_location_context
|
|
15563
15917
|
|
|
15564
|
-
|
|
15565
|
-
|
|
15918
|
+
# Whether or not the Google search grounding toggle is shown. Deprecated. Use
|
|
15919
|
+
# web_grounding_type instead.
|
|
15920
|
+
# Corresponds to the JSON property `googleSearchGroundingEnabled`
|
|
15921
|
+
# @return [Boolean]
|
|
15922
|
+
attr_accessor :google_search_grounding_enabled
|
|
15923
|
+
alias_method :google_search_grounding_enabled?, :google_search_grounding_enabled
|
|
15924
|
+
|
|
15925
|
+
# Optional. The type of web grounding to use.
|
|
15926
|
+
# Corresponds to the JSON property `webGroundingType`
|
|
15927
|
+
# @return [String]
|
|
15928
|
+
attr_accessor :web_grounding_type
|
|
15929
|
+
|
|
15930
|
+
def initialize(**args)
|
|
15931
|
+
update!(**args)
|
|
15932
|
+
end
|
|
15933
|
+
|
|
15934
|
+
# Update properties of this object
|
|
15935
|
+
def update!(**args)
|
|
15936
|
+
@default_web_grounding_toggle_off = args[:default_web_grounding_toggle_off] if args.key?(:default_web_grounding_toggle_off)
|
|
15937
|
+
@disable_location_context = args[:disable_location_context] if args.key?(:disable_location_context)
|
|
15938
|
+
@google_search_grounding_enabled = args[:google_search_grounding_enabled] if args.key?(:google_search_grounding_enabled)
|
|
15939
|
+
@web_grounding_type = args[:web_grounding_type] if args.key?(:web_grounding_type)
|
|
15940
|
+
end
|
|
15941
|
+
end
|
|
15942
|
+
|
|
15943
|
+
# Read-only collection component that contains data store collections fields
|
|
15944
|
+
# that may be used for filtering
|
|
15945
|
+
class GoogleCloudDiscoveryengineV1WidgetConfigCollectionComponent
|
|
15946
|
+
include Google::Apis::Core::Hashable
|
|
15947
|
+
|
|
15948
|
+
# Output only. The icon link of the connector source.
|
|
15949
|
+
# Corresponds to the JSON property `connectorIconLink`
|
|
15950
|
+
# @return [String]
|
|
15951
|
+
attr_accessor :connector_icon_link
|
|
15952
|
+
|
|
15953
|
+
# The name of the data source, retrieved from `Collection.data_connector.
|
|
15954
|
+
# data_source`.
|
|
15955
|
+
# Corresponds to the JSON property `dataSource`
|
|
15956
|
+
# @return [String]
|
|
15957
|
+
attr_accessor :data_source
|
|
15958
|
+
|
|
15959
|
+
# Output only. The display name of the data source.
|
|
15960
|
+
# Corresponds to the JSON property `dataSourceDisplayName`
|
|
15961
|
+
# @return [String]
|
|
15962
|
+
attr_accessor :data_source_display_name
|
|
15963
|
+
|
|
15964
|
+
# For the data store collection, list of the children data stores.
|
|
15965
|
+
# Corresponds to the JSON property `dataStoreComponents`
|
|
15966
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent>]
|
|
15967
|
+
attr_accessor :data_store_components
|
|
15968
|
+
|
|
15969
|
+
# The display name of the collection.
|
|
15970
|
+
# Corresponds to the JSON property `displayName`
|
|
15971
|
+
# @return [String]
|
|
15972
|
+
attr_accessor :display_name
|
|
15973
|
+
|
|
15974
|
+
# Output only. the identifier of the collection, used for widget service. For
|
|
15975
|
+
# now it refers to collection_id, in the future we will migrate the field to
|
|
15976
|
+
# encrypted collection name UUID.
|
|
15977
|
+
# Corresponds to the JSON property `id`
|
|
15978
|
+
# @return [String]
|
|
15979
|
+
attr_accessor :id
|
|
15980
|
+
|
|
15981
|
+
# The name of the collection. It should be collection resource name. Format: `
|
|
15982
|
+
# projects/`project`/locations/`location`/collections/`collection_id``. For APIs
|
|
15983
|
+
# under WidgetService, such as WidgetService.LookUpWidgetConfig, the project
|
|
15984
|
+
# number and location part is erased in this field.
|
|
15985
|
+
# Corresponds to the JSON property `name`
|
|
15986
|
+
# @return [String]
|
|
15987
|
+
attr_accessor :name
|
|
15988
|
+
|
|
15989
|
+
def initialize(**args)
|
|
15990
|
+
update!(**args)
|
|
15991
|
+
end
|
|
15992
|
+
|
|
15993
|
+
# Update properties of this object
|
|
15994
|
+
def update!(**args)
|
|
15995
|
+
@connector_icon_link = args[:connector_icon_link] if args.key?(:connector_icon_link)
|
|
15996
|
+
@data_source = args[:data_source] if args.key?(:data_source)
|
|
15997
|
+
@data_source_display_name = args[:data_source_display_name] if args.key?(:data_source_display_name)
|
|
15998
|
+
@data_store_components = args[:data_store_components] if args.key?(:data_store_components)
|
|
15999
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
|
16000
|
+
@id = args[:id] if args.key?(:id)
|
|
16001
|
+
@name = args[:name] if args.key?(:name)
|
|
16002
|
+
end
|
|
16003
|
+
end
|
|
16004
|
+
|
|
16005
|
+
# Customer provided configurations.
|
|
16006
|
+
class GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig
|
|
16007
|
+
include Google::Apis::Core::Hashable
|
|
16008
|
+
|
|
16009
|
+
# Customer type.
|
|
16010
|
+
# Corresponds to the JSON property `customerType`
|
|
16011
|
+
# @return [String]
|
|
16012
|
+
attr_accessor :customer_type
|
|
16013
|
+
|
|
16014
|
+
def initialize(**args)
|
|
16015
|
+
update!(**args)
|
|
16016
|
+
end
|
|
16017
|
+
|
|
16018
|
+
# Update properties of this object
|
|
16019
|
+
def update!(**args)
|
|
16020
|
+
@customer_type = args[:customer_type] if args.key?(:customer_type)
|
|
16021
|
+
end
|
|
16022
|
+
end
|
|
16023
|
+
|
|
16024
|
+
# Read-only data store component that contains data stores fields that may be
|
|
16025
|
+
# used for filtering, it's the child of `CollectionComponent`.
|
|
16026
|
+
class GoogleCloudDiscoveryengineV1WidgetConfigDataStoreComponent
|
|
16027
|
+
include Google::Apis::Core::Hashable
|
|
16028
|
+
|
|
16029
|
+
# Output only. The type of the data store config.
|
|
16030
|
+
# Corresponds to the JSON property `dataStoreConfigType`
|
|
16031
|
+
# @return [String]
|
|
16032
|
+
attr_accessor :data_store_config_type
|
|
16033
|
+
|
|
16034
|
+
# The display name of the data store.
|
|
16035
|
+
# Corresponds to the JSON property `displayName`
|
|
16036
|
+
# @return [String]
|
|
16037
|
+
attr_accessor :display_name
|
|
16038
|
+
|
|
16039
|
+
# The name of the entity, retrieved from `Collection.data_connector.entities.
|
|
16040
|
+
# entityName`.
|
|
16041
|
+
# Corresponds to the JSON property `entityName`
|
|
16042
|
+
# @return [String]
|
|
16043
|
+
attr_accessor :entity_name
|
|
16044
|
+
|
|
16045
|
+
# Output only. the identifier of the data store, used for widget service. For
|
|
16046
|
+
# now it refers to data_store_id, in the future we will migrate the field to
|
|
16047
|
+
# encrypted data store name UUID.
|
|
16048
|
+
# Corresponds to the JSON property `id`
|
|
16049
|
+
# @return [String]
|
|
16050
|
+
attr_accessor :id
|
|
16051
|
+
|
|
16052
|
+
# The name of the data store. It should be data store resource name Format: `
|
|
16053
|
+
# projects/`project`/locations/`location`/collections/`collection_id`/dataStores/
|
|
16054
|
+
# `data_store_id``. For APIs under WidgetService, such as WidgetService.
|
|
16055
|
+
# LookUpWidgetConfig, the project number and location part is erased in this
|
|
16056
|
+
# field.
|
|
16057
|
+
# Corresponds to the JSON property `name`
|
|
16058
|
+
# @return [String]
|
|
16059
|
+
attr_accessor :name
|
|
16060
|
+
|
|
16061
|
+
def initialize(**args)
|
|
16062
|
+
update!(**args)
|
|
16063
|
+
end
|
|
16064
|
+
|
|
16065
|
+
# Update properties of this object
|
|
16066
|
+
def update!(**args)
|
|
16067
|
+
@data_store_config_type = args[:data_store_config_type] if args.key?(:data_store_config_type)
|
|
16068
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
|
16069
|
+
@entity_name = args[:entity_name] if args.key?(:entity_name)
|
|
16070
|
+
@id = args[:id] if args.key?(:id)
|
|
16071
|
+
@name = args[:name] if args.key?(:name)
|
|
16072
|
+
end
|
|
16073
|
+
end
|
|
16074
|
+
|
|
16075
|
+
# UI component configuration for data store.
|
|
16076
|
+
class GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig
|
|
16077
|
+
include Google::Apis::Core::Hashable
|
|
16078
|
+
|
|
16079
|
+
# Facet fields that store the mapping of fields to end user widget appearance.
|
|
16080
|
+
# Corresponds to the JSON property `facetField`
|
|
16081
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigFacetField>]
|
|
16082
|
+
attr_accessor :facet_field
|
|
16083
|
+
|
|
16084
|
+
# The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `
|
|
16085
|
+
# url`, `custom1`, `custom2`, `custom3`. The value is the name of the field
|
|
16086
|
+
# along with its device visibility. The 3 custom fields are optional and can be
|
|
16087
|
+
# added or removed. `title`, `thumbnail`, `url` are required UI components that
|
|
16088
|
+
# cannot be removed.
|
|
16089
|
+
# Corresponds to the JSON property `fieldsUiComponentsMap`
|
|
16090
|
+
# @return [Hash<String,Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigUiComponentField>]
|
|
16091
|
+
attr_accessor :fields_ui_components_map
|
|
16092
|
+
|
|
16093
|
+
# Output only. the identifier of the data store, used for widget service. For
|
|
16094
|
+
# now it refers to data_store_id, in the future we will migrate the field to
|
|
16095
|
+
# encrypted data store name UUID.
|
|
16096
|
+
# Corresponds to the JSON property `id`
|
|
16097
|
+
# @return [String]
|
|
16098
|
+
attr_accessor :id
|
|
16099
|
+
|
|
16100
|
+
# The name of the data store. It should be data store resource name Format: `
|
|
16101
|
+
# projects/`project`/locations/`location`/collections/`collection_id`/dataStores/
|
|
16102
|
+
# `data_store_id``. For APIs under WidgetService, such as WidgetService.
|
|
16103
|
+
# LookUpWidgetConfig, the project number and location part is erased in this
|
|
16104
|
+
# field.
|
|
16105
|
+
# Corresponds to the JSON property `name`
|
|
16106
|
+
# @return [String]
|
|
16107
|
+
attr_accessor :name
|
|
16108
|
+
|
|
16109
|
+
def initialize(**args)
|
|
16110
|
+
update!(**args)
|
|
16111
|
+
end
|
|
16112
|
+
|
|
16113
|
+
# Update properties of this object
|
|
16114
|
+
def update!(**args)
|
|
16115
|
+
@facet_field = args[:facet_field] if args.key?(:facet_field)
|
|
16116
|
+
@fields_ui_components_map = args[:fields_ui_components_map] if args.key?(:fields_ui_components_map)
|
|
16117
|
+
@id = args[:id] if args.key?(:id)
|
|
16118
|
+
@name = args[:name] if args.key?(:name)
|
|
16119
|
+
end
|
|
16120
|
+
end
|
|
16121
|
+
|
|
16122
|
+
# Facet fields that store the mapping of fields to end user widget appearance.
|
|
16123
|
+
class GoogleCloudDiscoveryengineV1WidgetConfigFacetField
|
|
16124
|
+
include Google::Apis::Core::Hashable
|
|
16125
|
+
|
|
16126
|
+
# Optional. The field name that end users will see.
|
|
16127
|
+
# Corresponds to the JSON property `displayName`
|
|
16128
|
+
# @return [String]
|
|
16129
|
+
attr_accessor :display_name
|
|
16130
|
+
|
|
16131
|
+
# Required. Registered field name. The format is `field.abc`.
|
|
16132
|
+
# Corresponds to the JSON property `field`
|
|
16133
|
+
# @return [String]
|
|
16134
|
+
attr_accessor :field
|
|
16135
|
+
|
|
16136
|
+
def initialize(**args)
|
|
16137
|
+
update!(**args)
|
|
16138
|
+
end
|
|
16139
|
+
|
|
16140
|
+
# Update properties of this object
|
|
16141
|
+
def update!(**args)
|
|
16142
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
|
16143
|
+
@field = args[:field] if args.key?(:field)
|
|
16144
|
+
end
|
|
16145
|
+
end
|
|
16146
|
+
|
|
16147
|
+
# Describes the homepage setting of the widget. It includes all homepage related
|
|
16148
|
+
# settings and configurations, such as shortcuts.
|
|
16149
|
+
class GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting
|
|
16150
|
+
include Google::Apis::Core::Hashable
|
|
16151
|
+
|
|
16152
|
+
# Optional. The shortcuts to display on the homepage.
|
|
16153
|
+
# Corresponds to the JSON property `shortcuts`
|
|
16154
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut>]
|
|
16155
|
+
attr_accessor :shortcuts
|
|
16156
|
+
|
|
16157
|
+
def initialize(**args)
|
|
16158
|
+
update!(**args)
|
|
16159
|
+
end
|
|
16160
|
+
|
|
16161
|
+
# Update properties of this object
|
|
16162
|
+
def update!(**args)
|
|
16163
|
+
@shortcuts = args[:shortcuts] if args.key?(:shortcuts)
|
|
16164
|
+
end
|
|
16165
|
+
end
|
|
16166
|
+
|
|
16167
|
+
# Describes an entity of shortcut (aka pinned content) on the homepage. The home
|
|
16168
|
+
# page will render these shortcuts in the same order as what the API returns. If
|
|
16169
|
+
# a customer wants to reorder or remove a shortcut, the UI should always provide
|
|
16170
|
+
# the new full list of shortcuts.
|
|
16171
|
+
class GoogleCloudDiscoveryengineV1WidgetConfigHomepageSettingShortcut
|
|
16172
|
+
include Google::Apis::Core::Hashable
|
|
16173
|
+
|
|
16174
|
+
# Optional. Destination URL of shortcut.
|
|
16175
|
+
# Corresponds to the JSON property `destinationUri`
|
|
16176
|
+
# @return [String]
|
|
16177
|
+
attr_accessor :destination_uri
|
|
16178
|
+
|
|
16179
|
+
# Options to store an image.
|
|
16180
|
+
# Corresponds to the JSON property `icon`
|
|
16181
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigImage]
|
|
16182
|
+
attr_accessor :icon
|
|
16183
|
+
|
|
16184
|
+
# Optional. Title of the shortcut.
|
|
16185
|
+
# Corresponds to the JSON property `title`
|
|
16186
|
+
# @return [String]
|
|
16187
|
+
attr_accessor :title
|
|
16188
|
+
|
|
16189
|
+
def initialize(**args)
|
|
16190
|
+
update!(**args)
|
|
16191
|
+
end
|
|
16192
|
+
|
|
16193
|
+
# Update properties of this object
|
|
16194
|
+
def update!(**args)
|
|
16195
|
+
@destination_uri = args[:destination_uri] if args.key?(:destination_uri)
|
|
16196
|
+
@icon = args[:icon] if args.key?(:icon)
|
|
16197
|
+
@title = args[:title] if args.key?(:title)
|
|
16198
|
+
end
|
|
16199
|
+
end
|
|
16200
|
+
|
|
16201
|
+
# Options to store an image.
|
|
16202
|
+
class GoogleCloudDiscoveryengineV1WidgetConfigImage
|
|
16203
|
+
include Google::Apis::Core::Hashable
|
|
16204
|
+
|
|
16205
|
+
# Image URL.
|
|
16206
|
+
# Corresponds to the JSON property `url`
|
|
16207
|
+
# @return [String]
|
|
16208
|
+
attr_accessor :url
|
|
16209
|
+
|
|
16210
|
+
def initialize(**args)
|
|
16211
|
+
update!(**args)
|
|
16212
|
+
end
|
|
16213
|
+
|
|
16214
|
+
# Update properties of this object
|
|
16215
|
+
def update!(**args)
|
|
16216
|
+
@url = args[:url] if args.key?(:url)
|
|
16217
|
+
end
|
|
16218
|
+
end
|
|
16219
|
+
|
|
16220
|
+
# Facet field that maps to a UI Component.
|
|
16221
|
+
class GoogleCloudDiscoveryengineV1WidgetConfigUiComponentField
|
|
16222
|
+
include Google::Apis::Core::Hashable
|
|
16223
|
+
|
|
16224
|
+
# The field visibility on different types of devices.
|
|
16225
|
+
# Corresponds to the JSON property `deviceVisibility`
|
|
16226
|
+
# @return [Array<String>]
|
|
16227
|
+
attr_accessor :device_visibility
|
|
16228
|
+
|
|
16229
|
+
# The template to customize how the field is displayed. An example value would
|
|
16230
|
+
# be a string that looks like: "Price: `value`".
|
|
16231
|
+
# Corresponds to the JSON property `displayTemplate`
|
|
16232
|
+
# @return [String]
|
|
16233
|
+
attr_accessor :display_template
|
|
16234
|
+
|
|
16235
|
+
# Required. Registered field name. The format is `field.abc`.
|
|
16236
|
+
# Corresponds to the JSON property `field`
|
|
16237
|
+
# @return [String]
|
|
16238
|
+
attr_accessor :field
|
|
16239
|
+
|
|
16240
|
+
def initialize(**args)
|
|
16241
|
+
update!(**args)
|
|
16242
|
+
end
|
|
16243
|
+
|
|
16244
|
+
# Update properties of this object
|
|
16245
|
+
def update!(**args)
|
|
16246
|
+
@device_visibility = args[:device_visibility] if args.key?(:device_visibility)
|
|
16247
|
+
@display_template = args[:display_template] if args.key?(:display_template)
|
|
16248
|
+
@field = args[:field] if args.key?(:field)
|
|
16249
|
+
end
|
|
16250
|
+
end
|
|
16251
|
+
|
|
16252
|
+
# Describes widget UI branding settings.
|
|
16253
|
+
class GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings
|
|
16254
|
+
include Google::Apis::Core::Hashable
|
|
16255
|
+
|
|
16256
|
+
# Options to store an image.
|
|
16257
|
+
# Corresponds to the JSON property `logo`
|
|
16258
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigImage]
|
|
16259
|
+
attr_accessor :logo
|
|
16260
|
+
|
|
16261
|
+
def initialize(**args)
|
|
16262
|
+
update!(**args)
|
|
16263
|
+
end
|
|
16264
|
+
|
|
16265
|
+
# Update properties of this object
|
|
16266
|
+
def update!(**args)
|
|
16267
|
+
@logo = args[:logo] if args.key?(:logo)
|
|
16268
|
+
end
|
|
16269
|
+
end
|
|
16270
|
+
|
|
16271
|
+
# Describes general widget (or web app) UI settings as seen in the cloud console
|
|
16272
|
+
# UI configuration page.
|
|
16273
|
+
class GoogleCloudDiscoveryengineV1WidgetConfigUiSettings
|
|
16274
|
+
include Google::Apis::Core::Hashable
|
|
16275
|
+
|
|
16276
|
+
# Per data store configuration.
|
|
16277
|
+
# Corresponds to the JSON property `dataStoreUiConfigs`
|
|
16278
|
+
# @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigDataStoreUiConfig>]
|
|
16279
|
+
attr_accessor :data_store_ui_configs
|
|
16280
|
+
|
|
16281
|
+
# The default ordering for search results if specified. Used to set
|
|
16282
|
+
# SearchRequest#order_by on applicable requests. https://cloud.google.com/
|
|
16283
|
+
# generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.
|
|
16284
|
+
# dataStores.servingConfigs/search#request-body
|
|
16285
|
+
# Corresponds to the JSON property `defaultSearchRequestOrderBy`
|
|
16286
|
+
# @return [String]
|
|
16287
|
+
attr_accessor :default_search_request_order_by
|
|
16288
|
+
|
|
16289
|
+
# If set to true, the widget will not collect user events.
|
|
16290
|
+
# Corresponds to the JSON property `disableUserEventsCollection`
|
|
16291
|
+
# @return [Boolean]
|
|
16292
|
+
attr_accessor :disable_user_events_collection
|
|
16293
|
+
alias_method :disable_user_events_collection?, :disable_user_events_collection
|
|
16294
|
+
|
|
16295
|
+
# Whether or not to enable autocomplete.
|
|
16296
|
+
# Corresponds to the JSON property `enableAutocomplete`
|
|
16297
|
+
# @return [Boolean]
|
|
16298
|
+
attr_accessor :enable_autocomplete
|
|
16299
|
+
alias_method :enable_autocomplete?, :enable_autocomplete
|
|
16300
|
+
|
|
16301
|
+
# Optional. If set to true, the widget will enable the create agent button.
|
|
16302
|
+
# Corresponds to the JSON property `enableCreateAgentButton`
|
|
16303
|
+
# @return [Boolean]
|
|
16304
|
+
attr_accessor :enable_create_agent_button
|
|
16305
|
+
alias_method :enable_create_agent_button?, :enable_create_agent_button
|
|
16306
|
+
|
|
16307
|
+
# Optional. If set to true, the widget will enable people search.
|
|
16308
|
+
# Corresponds to the JSON property `enablePeopleSearch`
|
|
16309
|
+
# @return [Boolean]
|
|
16310
|
+
attr_accessor :enable_people_search
|
|
16311
|
+
alias_method :enable_people_search?, :enable_people_search
|
|
16312
|
+
|
|
16313
|
+
# Turn on or off collecting the search result quality feedback from end users.
|
|
16314
|
+
# Corresponds to the JSON property `enableQualityFeedback`
|
|
16315
|
+
# @return [Boolean]
|
|
16316
|
+
attr_accessor :enable_quality_feedback
|
|
16317
|
+
alias_method :enable_quality_feedback?, :enable_quality_feedback
|
|
16318
|
+
|
|
16319
|
+
# Whether to enable safe search.
|
|
16320
|
+
# Corresponds to the JSON property `enableSafeSearch`
|
|
16321
|
+
# @return [Boolean]
|
|
16322
|
+
attr_accessor :enable_safe_search
|
|
16323
|
+
alias_method :enable_safe_search?, :enable_safe_search
|
|
16324
|
+
|
|
16325
|
+
# Whether to enable search-as-you-type behavior for the search widget.
|
|
16326
|
+
# Corresponds to the JSON property `enableSearchAsYouType`
|
|
16327
|
+
# @return [Boolean]
|
|
16328
|
+
attr_accessor :enable_search_as_you_type
|
|
16329
|
+
alias_method :enable_search_as_you_type?, :enable_search_as_you_type
|
|
16330
|
+
|
|
16331
|
+
# If set to true, the widget will enable visual content summary on applicable
|
|
16332
|
+
# search requests. Only used by healthcare search.
|
|
16333
|
+
# Corresponds to the JSON property `enableVisualContentSummary`
|
|
16334
|
+
# @return [Boolean]
|
|
16335
|
+
attr_accessor :enable_visual_content_summary
|
|
16336
|
+
alias_method :enable_visual_content_summary?, :enable_visual_content_summary
|
|
16337
|
+
|
|
16338
|
+
# Output only. Feature config for the engine to opt in or opt out of features.
|
|
16339
|
+
# Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery`
|
|
16340
|
+
# * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-
|
|
16341
|
+
# chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `
|
|
16342
|
+
# personalization-memory` * `disable-agent-sharing` * `disable-image-generation`
|
|
16343
|
+
# * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-
|
|
16344
|
+
# content` * `disable-google-drive-upload`
|
|
16345
|
+
# Corresponds to the JSON property `features`
|
|
16346
|
+
# @return [Hash<String,String>]
|
|
16347
|
+
attr_accessor :features
|
|
16348
|
+
|
|
16349
|
+
# Describes configuration for generative answer.
|
|
16350
|
+
# Corresponds to the JSON property `generativeAnswerConfig`
|
|
16351
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig]
|
|
16352
|
+
attr_accessor :generative_answer_config
|
|
16353
|
+
|
|
16354
|
+
# Describes widget (or web app) interaction type
|
|
16355
|
+
# Corresponds to the JSON property `interactionType`
|
|
16356
|
+
# @return [String]
|
|
16357
|
+
attr_accessor :interaction_type
|
|
16358
|
+
|
|
16359
|
+
# Output only. Maps a model name to its specific configuration for this engine.
|
|
16360
|
+
# This allows admin users to turn on/off individual models. This only stores
|
|
16361
|
+
# models whose states are overridden by the admin. When the state is unspecified,
|
|
16362
|
+
# or model_configs is empty for this model, the system will decide if this
|
|
16363
|
+
# model should be available or not based on the default configuration. For
|
|
16364
|
+
# example, a preview model should be disabled by default if the admin has not
|
|
16365
|
+
# chosen to enable it.
|
|
16366
|
+
# Corresponds to the JSON property `modelConfigs`
|
|
16367
|
+
# @return [Hash<String,String>]
|
|
16368
|
+
attr_accessor :model_configs
|
|
16369
|
+
|
|
16370
|
+
# Controls whether result extract is display and how (snippet or extractive
|
|
16371
|
+
# answer). Default to no result if unspecified.
|
|
16372
|
+
# Corresponds to the JSON property `resultDescriptionType`
|
|
16373
|
+
# @return [String]
|
|
16374
|
+
attr_accessor :result_description_type
|
|
16375
|
+
|
|
16376
|
+
def initialize(**args)
|
|
16377
|
+
update!(**args)
|
|
16378
|
+
end
|
|
16379
|
+
|
|
16380
|
+
# Update properties of this object
|
|
16381
|
+
def update!(**args)
|
|
16382
|
+
@data_store_ui_configs = args[:data_store_ui_configs] if args.key?(:data_store_ui_configs)
|
|
16383
|
+
@default_search_request_order_by = args[:default_search_request_order_by] if args.key?(:default_search_request_order_by)
|
|
16384
|
+
@disable_user_events_collection = args[:disable_user_events_collection] if args.key?(:disable_user_events_collection)
|
|
16385
|
+
@enable_autocomplete = args[:enable_autocomplete] if args.key?(:enable_autocomplete)
|
|
16386
|
+
@enable_create_agent_button = args[:enable_create_agent_button] if args.key?(:enable_create_agent_button)
|
|
16387
|
+
@enable_people_search = args[:enable_people_search] if args.key?(:enable_people_search)
|
|
16388
|
+
@enable_quality_feedback = args[:enable_quality_feedback] if args.key?(:enable_quality_feedback)
|
|
16389
|
+
@enable_safe_search = args[:enable_safe_search] if args.key?(:enable_safe_search)
|
|
16390
|
+
@enable_search_as_you_type = args[:enable_search_as_you_type] if args.key?(:enable_search_as_you_type)
|
|
16391
|
+
@enable_visual_content_summary = args[:enable_visual_content_summary] if args.key?(:enable_visual_content_summary)
|
|
16392
|
+
@features = args[:features] if args.key?(:features)
|
|
16393
|
+
@generative_answer_config = args[:generative_answer_config] if args.key?(:generative_answer_config)
|
|
16394
|
+
@interaction_type = args[:interaction_type] if args.key?(:interaction_type)
|
|
16395
|
+
@model_configs = args[:model_configs] if args.key?(:model_configs)
|
|
16396
|
+
@result_description_type = args[:result_description_type] if args.key?(:result_description_type)
|
|
16397
|
+
end
|
|
16398
|
+
end
|
|
16399
|
+
|
|
16400
|
+
# Describes configuration for generative answer.
|
|
16401
|
+
class GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig
|
|
16402
|
+
include Google::Apis::Core::Hashable
|
|
16403
|
+
|
|
16404
|
+
# Whether generated answer contains suggested related questions.
|
|
16405
|
+
# Corresponds to the JSON property `disableRelatedQuestions`
|
|
16406
|
+
# @return [Boolean]
|
|
16407
|
+
attr_accessor :disable_related_questions
|
|
16408
|
+
alias_method :disable_related_questions?, :disable_related_questions
|
|
16409
|
+
|
|
16410
|
+
# Optional. Specifies whether to filter out queries that are adversarial.
|
|
16411
|
+
# Corresponds to the JSON property `ignoreAdversarialQuery`
|
|
16412
|
+
# @return [Boolean]
|
|
16413
|
+
attr_accessor :ignore_adversarial_query
|
|
16414
|
+
alias_method :ignore_adversarial_query?, :ignore_adversarial_query
|
|
16415
|
+
|
|
16416
|
+
# Optional. Specifies whether to filter out queries that are not relevant to the
|
|
16417
|
+
# content.
|
|
16418
|
+
# Corresponds to the JSON property `ignoreLowRelevantContent`
|
|
16419
|
+
# @return [Boolean]
|
|
16420
|
+
attr_accessor :ignore_low_relevant_content
|
|
16421
|
+
alias_method :ignore_low_relevant_content?, :ignore_low_relevant_content
|
|
16422
|
+
|
|
16423
|
+
# Optional. Specifies whether to filter out queries that are not answer-seeking.
|
|
16424
|
+
# The default value is `false`. No answer is returned if the search query is
|
|
16425
|
+
# classified as a non-answer seeking query. If this field is set to `true`, we
|
|
16426
|
+
# skip generating answers for non-answer seeking queries and return fallback
|
|
16427
|
+
# messages instead.
|
|
16428
|
+
# Corresponds to the JSON property `ignoreNonAnswerSeekingQuery`
|
|
16429
|
+
# @return [Boolean]
|
|
16430
|
+
attr_accessor :ignore_non_answer_seeking_query
|
|
16431
|
+
alias_method :ignore_non_answer_seeking_query?, :ignore_non_answer_seeking_query
|
|
16432
|
+
|
|
16433
|
+
# Optional. Source of image returned in the answer.
|
|
16434
|
+
# Corresponds to the JSON property `imageSource`
|
|
16435
|
+
# @return [String]
|
|
16436
|
+
attr_accessor :image_source
|
|
16437
|
+
|
|
16438
|
+
# Language code for Summary. Use language tags defined by [BCP47](https://www.
|
|
16439
|
+
# rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
|
|
16440
|
+
# Corresponds to the JSON property `languageCode`
|
|
16441
|
+
# @return [String]
|
|
16442
|
+
attr_accessor :language_code
|
|
16443
|
+
|
|
16444
|
+
# Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it
|
|
16445
|
+
# will be set to 1 by default.
|
|
16446
|
+
# Corresponds to the JSON property `maxRephraseSteps`
|
|
16447
|
+
# @return [Fixnum]
|
|
16448
|
+
attr_accessor :max_rephrase_steps
|
|
16449
|
+
|
|
16450
|
+
# Text at the beginning of the prompt that instructs the model that generates
|
|
16451
|
+
# the answer.
|
|
16452
|
+
# Corresponds to the JSON property `modelPromptPreamble`
|
|
16453
|
+
# @return [String]
|
|
16454
|
+
attr_accessor :model_prompt_preamble
|
|
16455
|
+
|
|
16456
|
+
# The model version used to generate the answer.
|
|
16457
|
+
# Corresponds to the JSON property `modelVersion`
|
|
16458
|
+
# @return [String]
|
|
16459
|
+
attr_accessor :model_version
|
|
16460
|
+
|
|
16461
|
+
# The number of top results to generate the answer from. Up to 10.
|
|
16462
|
+
# Corresponds to the JSON property `resultCount`
|
|
16463
|
+
# @return [Fixnum]
|
|
16464
|
+
attr_accessor :result_count
|
|
16465
|
+
|
|
16466
|
+
def initialize(**args)
|
|
16467
|
+
update!(**args)
|
|
16468
|
+
end
|
|
16469
|
+
|
|
16470
|
+
# Update properties of this object
|
|
16471
|
+
def update!(**args)
|
|
16472
|
+
@disable_related_questions = args[:disable_related_questions] if args.key?(:disable_related_questions)
|
|
16473
|
+
@ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
|
|
16474
|
+
@ignore_low_relevant_content = args[:ignore_low_relevant_content] if args.key?(:ignore_low_relevant_content)
|
|
16475
|
+
@ignore_non_answer_seeking_query = args[:ignore_non_answer_seeking_query] if args.key?(:ignore_non_answer_seeking_query)
|
|
16476
|
+
@image_source = args[:image_source] if args.key?(:image_source)
|
|
16477
|
+
@language_code = args[:language_code] if args.key?(:language_code)
|
|
16478
|
+
@max_rephrase_steps = args[:max_rephrase_steps] if args.key?(:max_rephrase_steps)
|
|
16479
|
+
@model_prompt_preamble = args[:model_prompt_preamble] if args.key?(:model_prompt_preamble)
|
|
16480
|
+
@model_version = args[:model_version] if args.key?(:model_version)
|
|
16481
|
+
@result_count = args[:result_count] if args.key?(:result_count)
|
|
16482
|
+
end
|
|
16483
|
+
end
|
|
16484
|
+
|
|
16485
|
+
# Config to store data store type configuration for workspace data
|
|
16486
|
+
class GoogleCloudDiscoveryengineV1WorkspaceConfig
|
|
16487
|
+
include Google::Apis::Core::Hashable
|
|
16488
|
+
|
|
16489
|
+
# Obfuscated Dasher customer ID.
|
|
16490
|
+
# Corresponds to the JSON property `dasherCustomerId`
|
|
16491
|
+
# @return [String]
|
|
16492
|
+
attr_accessor :dasher_customer_id
|
|
16493
|
+
|
|
16494
|
+
# Optional. The super admin email address for the workspace that will be used
|
|
16495
|
+
# for access token generation. For now we only use it for Native Google Drive
|
|
16496
|
+
# connector data ingestion.
|
|
16497
|
+
# Corresponds to the JSON property `superAdminEmailAddress`
|
|
16498
|
+
# @return [String]
|
|
16499
|
+
attr_accessor :super_admin_email_address
|
|
16500
|
+
|
|
16501
|
+
# Optional. The super admin service account for the workspace that will be used
|
|
16502
|
+
# for access token generation. For now we only use it for Native Google Drive
|
|
16503
|
+
# connector data ingestion.
|
|
16504
|
+
# Corresponds to the JSON property `superAdminServiceAccount`
|
|
16505
|
+
# @return [String]
|
|
16506
|
+
attr_accessor :super_admin_service_account
|
|
16507
|
+
|
|
16508
|
+
# The Google Workspace data source.
|
|
16509
|
+
# Corresponds to the JSON property `type`
|
|
16510
|
+
# @return [String]
|
|
16511
|
+
attr_accessor :type
|
|
16512
|
+
|
|
16513
|
+
def initialize(**args)
|
|
16514
|
+
update!(**args)
|
|
16515
|
+
end
|
|
16516
|
+
|
|
16517
|
+
# Update properties of this object
|
|
16518
|
+
def update!(**args)
|
|
16519
|
+
@dasher_customer_id = args[:dasher_customer_id] if args.key?(:dasher_customer_id)
|
|
16520
|
+
@super_admin_email_address = args[:super_admin_email_address] if args.key?(:super_admin_email_address)
|
|
16521
|
+
@super_admin_service_account = args[:super_admin_service_account] if args.key?(:super_admin_service_account)
|
|
16522
|
+
@type = args[:type] if args.key?(:type)
|
|
16523
|
+
end
|
|
16524
|
+
end
|
|
16525
|
+
|
|
16526
|
+
# Access Control Configuration.
|
|
16527
|
+
class GoogleCloudDiscoveryengineV1alphaAclConfig
|
|
16528
|
+
include Google::Apis::Core::Hashable
|
|
16529
|
+
|
|
16530
|
+
# Identity Provider Config.
|
|
16531
|
+
# Corresponds to the JSON property `idpConfig`
|
|
16532
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaIdpConfig]
|
|
16533
|
+
attr_accessor :idp_config
|
|
16534
|
+
|
|
16535
|
+
# Immutable. The full resource name of the acl configuration. Format: `projects/`
|
|
16536
|
+
# project`/locations/`location`/aclConfig`. This field must be a UTF-8 encoded
|
|
16537
|
+
# string with a length limit of 1024 characters.
|
|
16538
|
+
# Corresponds to the JSON property `name`
|
|
16539
|
+
# @return [String]
|
|
16540
|
+
attr_accessor :name
|
|
16541
|
+
|
|
16542
|
+
def initialize(**args)
|
|
16543
|
+
update!(**args)
|
|
16544
|
+
end
|
|
16545
|
+
|
|
16546
|
+
# Update properties of this object
|
|
16547
|
+
def update!(**args)
|
|
16548
|
+
@idp_config = args[:idp_config] if args.key?(:idp_config)
|
|
16549
|
+
@name = args[:name] if args.key?(:name)
|
|
16550
|
+
end
|
|
16551
|
+
end
|
|
16552
|
+
|
|
16553
|
+
# Informations to support actions on the connector.
|
|
16554
|
+
class GoogleCloudDiscoveryengineV1alphaActionConfig
|
|
16555
|
+
include Google::Apis::Core::Hashable
|
|
16556
|
+
|
|
16557
|
+
# Optional. Action parameters in structured json format.
|
|
16558
|
+
# Corresponds to the JSON property `actionParams`
|
|
16559
|
+
# @return [Hash<String,Object>]
|
|
16560
|
+
attr_accessor :action_params
|
|
16561
|
+
|
|
16562
|
+
# Output only. The connector contains the necessary parameters and is configured
|
|
16563
|
+
# to support actions.
|
|
16564
|
+
# Corresponds to the JSON property `isActionConfigured`
|
|
16565
|
+
# @return [Boolean]
|
|
16566
|
+
attr_accessor :is_action_configured
|
|
16567
|
+
alias_method :is_action_configured?, :is_action_configured
|
|
16568
|
+
|
|
16569
|
+
# Optional. Action parameters in json string format.
|
|
16570
|
+
# Corresponds to the JSON property `jsonActionParams`
|
|
16571
|
+
# @return [String]
|
|
16572
|
+
attr_accessor :json_action_params
|
|
16573
|
+
|
|
16574
|
+
# Optional. The Service Directory resource name (projects/*/locations/*/
|
|
16575
|
+
# namespaces/*/services/*) representing a VPC network endpoint used to connect
|
|
16576
|
+
# to the data source's `instance_uri`, defined in DataConnector.params. Required
|
|
16577
|
+
# when VPC Service Controls are enabled.
|
|
16578
|
+
# Corresponds to the JSON property `serviceName`
|
|
16579
|
+
# @return [String]
|
|
16580
|
+
attr_accessor :service_name
|
|
16581
|
+
|
|
16582
|
+
# Optional. Whether to use static secrets for the connector. If true, the
|
|
16583
|
+
# secrets provided in the action_params will be ignored.
|
|
16584
|
+
# Corresponds to the JSON property `useStaticSecrets`
|
|
16585
|
+
# @return [Boolean]
|
|
16586
|
+
attr_accessor :use_static_secrets
|
|
16587
|
+
alias_method :use_static_secrets?, :use_static_secrets
|
|
16588
|
+
|
|
16589
|
+
def initialize(**args)
|
|
16590
|
+
update!(**args)
|
|
16591
|
+
end
|
|
16592
|
+
|
|
16593
|
+
# Update properties of this object
|
|
16594
|
+
def update!(**args)
|
|
16595
|
+
@action_params = args[:action_params] if args.key?(:action_params)
|
|
16596
|
+
@is_action_configured = args[:is_action_configured] if args.key?(:is_action_configured)
|
|
16597
|
+
@json_action_params = args[:json_action_params] if args.key?(:json_action_params)
|
|
16598
|
+
@service_name = args[:service_name] if args.key?(:service_name)
|
|
16599
|
+
@use_static_secrets = args[:use_static_secrets] if args.key?(:use_static_secrets)
|
|
16600
|
+
end
|
|
16601
|
+
end
|
|
16602
|
+
|
|
16603
|
+
# Configuration data for advance site search.
|
|
16604
|
+
class GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig
|
|
16605
|
+
include Google::Apis::Core::Hashable
|
|
16606
|
+
|
|
16607
|
+
# If set true, automatic refresh is disabled for the DataStore.
|
|
16608
|
+
# Corresponds to the JSON property `disableAutomaticRefresh`
|
|
16609
|
+
# @return [Boolean]
|
|
16610
|
+
attr_accessor :disable_automatic_refresh
|
|
16611
|
+
alias_method :disable_automatic_refresh?, :disable_automatic_refresh
|
|
16612
|
+
|
|
16613
|
+
# If set true, initial indexing is disabled for the DataStore.
|
|
16614
|
+
# Corresponds to the JSON property `disableInitialIndex`
|
|
16615
|
+
# @return [Boolean]
|
|
16616
|
+
attr_accessor :disable_initial_index
|
|
16617
|
+
alias_method :disable_initial_index?, :disable_initial_index
|
|
16618
|
+
|
|
16619
|
+
def initialize(**args)
|
|
16620
|
+
update!(**args)
|
|
15566
16621
|
end
|
|
15567
16622
|
|
|
15568
16623
|
# Update properties of this object
|
|
@@ -18670,6 +19725,11 @@ module Google
|
|
|
18670
19725
|
# @return [String]
|
|
18671
19726
|
attr_accessor :configurable_billing_approach
|
|
18672
19727
|
|
|
19728
|
+
# Output only. The timestamp when configurable_billing_approach was last updated.
|
|
19729
|
+
# Corresponds to the JSON property `configurableBillingApproachUpdateTime`
|
|
19730
|
+
# @return [String]
|
|
19731
|
+
attr_accessor :configurable_billing_approach_update_time
|
|
19732
|
+
|
|
18673
19733
|
# Immutable. The content config of the data store. If this field is unset, the
|
|
18674
19734
|
# server behavior defaults to ContentConfig.NO_CONTENT.
|
|
18675
19735
|
# Corresponds to the JSON property `contentConfig`
|
|
@@ -18789,6 +19849,7 @@ module Google
|
|
|
18789
19849
|
@billing_estimation = args[:billing_estimation] if args.key?(:billing_estimation)
|
|
18790
19850
|
@cmek_config = args[:cmek_config] if args.key?(:cmek_config)
|
|
18791
19851
|
@configurable_billing_approach = args[:configurable_billing_approach] if args.key?(:configurable_billing_approach)
|
|
19852
|
+
@configurable_billing_approach_update_time = args[:configurable_billing_approach_update_time] if args.key?(:configurable_billing_approach_update_time)
|
|
18792
19853
|
@content_config = args[:content_config] if args.key?(:content_config)
|
|
18793
19854
|
@create_time = args[:create_time] if args.key?(:create_time)
|
|
18794
19855
|
@default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
|
|
@@ -18919,6 +19980,33 @@ module Google
|
|
|
18919
19980
|
end
|
|
18920
19981
|
end
|
|
18921
19982
|
|
|
19983
|
+
# Metadata related to the progress of the AgentService.DeleteAgent operation.
|
|
19984
|
+
# This will be returned by the google.longrunning.Operation.metadata field.
|
|
19985
|
+
class GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata
|
|
19986
|
+
include Google::Apis::Core::Hashable
|
|
19987
|
+
|
|
19988
|
+
# Operation create time.
|
|
19989
|
+
# Corresponds to the JSON property `createTime`
|
|
19990
|
+
# @return [String]
|
|
19991
|
+
attr_accessor :create_time
|
|
19992
|
+
|
|
19993
|
+
# Operation last update time. If the operation is done, this is also the finish
|
|
19994
|
+
# time.
|
|
19995
|
+
# Corresponds to the JSON property `updateTime`
|
|
19996
|
+
# @return [String]
|
|
19997
|
+
attr_accessor :update_time
|
|
19998
|
+
|
|
19999
|
+
def initialize(**args)
|
|
20000
|
+
update!(**args)
|
|
20001
|
+
end
|
|
20002
|
+
|
|
20003
|
+
# Update properties of this object
|
|
20004
|
+
def update!(**args)
|
|
20005
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
|
20006
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
|
20007
|
+
end
|
|
20008
|
+
end
|
|
20009
|
+
|
|
18922
20010
|
# Metadata related to the progress of the CmekConfigService.DeleteCmekConfig
|
|
18923
20011
|
# operation. This will be returned by the google.longrunning.Operation.metadata
|
|
18924
20012
|
# field.
|
|
@@ -19452,6 +20540,12 @@ module Google
|
|
|
19452
20540
|
attr_accessor :enable_image_annotation
|
|
19453
20541
|
alias_method :enable_image_annotation?, :enable_image_annotation
|
|
19454
20542
|
|
|
20543
|
+
# Optional. If true, the pdf layout will be refined using an LLM.
|
|
20544
|
+
# Corresponds to the JSON property `enableLlmLayoutParsing`
|
|
20545
|
+
# @return [Boolean]
|
|
20546
|
+
attr_accessor :enable_llm_layout_parsing
|
|
20547
|
+
alias_method :enable_llm_layout_parsing?, :enable_llm_layout_parsing
|
|
20548
|
+
|
|
19455
20549
|
# Optional. If true, the LLM based annotation is added to the table during
|
|
19456
20550
|
# parsing.
|
|
19457
20551
|
# Corresponds to the JSON property `enableTableAnnotation`
|
|
@@ -19488,6 +20582,7 @@ module Google
|
|
|
19488
20582
|
def update!(**args)
|
|
19489
20583
|
@enable_get_processed_document = args[:enable_get_processed_document] if args.key?(:enable_get_processed_document)
|
|
19490
20584
|
@enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
|
|
20585
|
+
@enable_llm_layout_parsing = args[:enable_llm_layout_parsing] if args.key?(:enable_llm_layout_parsing)
|
|
19491
20586
|
@enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
|
|
19492
20587
|
@exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
|
|
19493
20588
|
@exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
|
|
@@ -19587,6 +20682,11 @@ module Google
|
|
|
19587
20682
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata]
|
|
19588
20683
|
attr_accessor :chat_engine_metadata
|
|
19589
20684
|
|
|
20685
|
+
# Configurations used to enable CMEK data encryption with Cloud KMS keys.
|
|
20686
|
+
# Corresponds to the JSON property `cmekConfig`
|
|
20687
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCmekConfig]
|
|
20688
|
+
attr_accessor :cmek_config
|
|
20689
|
+
|
|
19590
20690
|
# Common configurations for an Engine.
|
|
19591
20691
|
# Corresponds to the JSON property `commonConfig`
|
|
19592
20692
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngineCommonConfig]
|
|
@@ -19648,6 +20748,17 @@ module Google
|
|
|
19648
20748
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig]
|
|
19649
20749
|
attr_accessor :media_recommendation_engine_config
|
|
19650
20750
|
|
|
20751
|
+
# Optional. Maps a model name to its specific configuration for this engine.
|
|
20752
|
+
# This allows admin users to turn on/off individual models. This only stores
|
|
20753
|
+
# models whose states are overridden by the admin. When the state is unspecified,
|
|
20754
|
+
# or model_configs is empty for this model, the system will decide if this
|
|
20755
|
+
# model should be available or not based on the default configuration. For
|
|
20756
|
+
# example, a preview model should be disabled by default if the admin has not
|
|
20757
|
+
# chosen to enable it.
|
|
20758
|
+
# Corresponds to the JSON property `modelConfigs`
|
|
20759
|
+
# @return [Hash<String,String>]
|
|
20760
|
+
attr_accessor :model_configs
|
|
20761
|
+
|
|
19651
20762
|
# Immutable. Identifier. The fully qualified resource name of the engine. This
|
|
19652
20763
|
# field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
19653
20764
|
# Format: `projects/`project`/locations/`location`/collections/`collection`/
|
|
@@ -19691,6 +20802,7 @@ module Google
|
|
|
19691
20802
|
@app_type = args[:app_type] if args.key?(:app_type)
|
|
19692
20803
|
@chat_engine_config = args[:chat_engine_config] if args.key?(:chat_engine_config)
|
|
19693
20804
|
@chat_engine_metadata = args[:chat_engine_metadata] if args.key?(:chat_engine_metadata)
|
|
20805
|
+
@cmek_config = args[:cmek_config] if args.key?(:cmek_config)
|
|
19694
20806
|
@common_config = args[:common_config] if args.key?(:common_config)
|
|
19695
20807
|
@configurable_billing_approach = args[:configurable_billing_approach] if args.key?(:configurable_billing_approach)
|
|
19696
20808
|
@create_time = args[:create_time] if args.key?(:create_time)
|
|
@@ -19700,6 +20812,7 @@ module Google
|
|
|
19700
20812
|
@features = args[:features] if args.key?(:features)
|
|
19701
20813
|
@industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
|
|
19702
20814
|
@media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
|
|
20815
|
+
@model_configs = args[:model_configs] if args.key?(:model_configs)
|
|
19703
20816
|
@name = args[:name] if args.key?(:name)
|
|
19704
20817
|
@recommendation_metadata = args[:recommendation_metadata] if args.key?(:recommendation_metadata)
|
|
19705
20818
|
@search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
|
|
@@ -21385,6 +22498,16 @@ module Google
|
|
|
21385
22498
|
class GoogleCloudDiscoveryengineV1alphaProject
|
|
21386
22499
|
include Google::Apis::Core::Hashable
|
|
21387
22500
|
|
|
22501
|
+
# Represents the currently effective configurable billing parameters. These
|
|
22502
|
+
# values are derived from the customer's subscription history stored internally
|
|
22503
|
+
# and reflect the thresholds actively being used for billing purposes at the
|
|
22504
|
+
# time of the GetProject call. This includes the start_time of the subscription
|
|
22505
|
+
# and may differ from the values in `customer_provided_config` due to billing
|
|
22506
|
+
# rules (e.g., scale-downs taking effect only at the start of a new month).
|
|
22507
|
+
# Corresponds to the JSON property `configurableBillingStatus`
|
|
22508
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus]
|
|
22509
|
+
attr_accessor :configurable_billing_status
|
|
22510
|
+
|
|
21388
22511
|
# Output only. The timestamp when this project is created.
|
|
21389
22512
|
# Corresponds to the JSON property `createTime`
|
|
21390
22513
|
# @return [String]
|
|
@@ -21419,6 +22542,7 @@ module Google
|
|
|
21419
22542
|
|
|
21420
22543
|
# Update properties of this object
|
|
21421
22544
|
def update!(**args)
|
|
22545
|
+
@configurable_billing_status = args[:configurable_billing_status] if args.key?(:configurable_billing_status)
|
|
21422
22546
|
@create_time = args[:create_time] if args.key?(:create_time)
|
|
21423
22547
|
@customer_provided_config = args[:customer_provided_config] if args.key?(:customer_provided_config)
|
|
21424
22548
|
@name = args[:name] if args.key?(:name)
|
|
@@ -21427,6 +22551,46 @@ module Google
|
|
|
21427
22551
|
end
|
|
21428
22552
|
end
|
|
21429
22553
|
|
|
22554
|
+
# Represents the currently effective configurable billing parameters. These
|
|
22555
|
+
# values are derived from the customer's subscription history stored internally
|
|
22556
|
+
# and reflect the thresholds actively being used for billing purposes at the
|
|
22557
|
+
# time of the GetProject call. This includes the start_time of the subscription
|
|
22558
|
+
# and may differ from the values in `customer_provided_config` due to billing
|
|
22559
|
+
# rules (e.g., scale-downs taking effect only at the start of a new month).
|
|
22560
|
+
class GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus
|
|
22561
|
+
include Google::Apis::Core::Hashable
|
|
22562
|
+
|
|
22563
|
+
# Optional. The currently effective Indexing Core threshold. This is the
|
|
22564
|
+
# threshold against which Indexing Core usage is compared for overage
|
|
22565
|
+
# calculations.
|
|
22566
|
+
# Corresponds to the JSON property `effectiveIndexingCoreThreshold`
|
|
22567
|
+
# @return [Fixnum]
|
|
22568
|
+
attr_accessor :effective_indexing_core_threshold
|
|
22569
|
+
|
|
22570
|
+
# Optional. The currently effective Search QPM threshold in queries per minute.
|
|
22571
|
+
# This is the threshold against which QPM usage is compared for overage
|
|
22572
|
+
# calculations.
|
|
22573
|
+
# Corresponds to the JSON property `effectiveSearchQpmThreshold`
|
|
22574
|
+
# @return [Fixnum]
|
|
22575
|
+
attr_accessor :effective_search_qpm_threshold
|
|
22576
|
+
|
|
22577
|
+
# Optional. The start time of the currently active billing subscription.
|
|
22578
|
+
# Corresponds to the JSON property `startTime`
|
|
22579
|
+
# @return [String]
|
|
22580
|
+
attr_accessor :start_time
|
|
22581
|
+
|
|
22582
|
+
def initialize(**args)
|
|
22583
|
+
update!(**args)
|
|
22584
|
+
end
|
|
22585
|
+
|
|
22586
|
+
# Update properties of this object
|
|
22587
|
+
def update!(**args)
|
|
22588
|
+
@effective_indexing_core_threshold = args[:effective_indexing_core_threshold] if args.key?(:effective_indexing_core_threshold)
|
|
22589
|
+
@effective_search_qpm_threshold = args[:effective_search_qpm_threshold] if args.key?(:effective_search_qpm_threshold)
|
|
22590
|
+
@start_time = args[:start_time] if args.key?(:start_time)
|
|
22591
|
+
end
|
|
22592
|
+
end
|
|
22593
|
+
|
|
21430
22594
|
# Customer provided configurations.
|
|
21431
22595
|
class GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig
|
|
21432
22596
|
include Google::Apis::Core::Hashable
|
|
@@ -22621,9 +23785,9 @@ module Google
|
|
|
22621
23785
|
# @return [Hash<String,String>]
|
|
22622
23786
|
attr_accessor :user_labels
|
|
22623
23787
|
|
|
22624
|
-
# A unique identifier for tracking visitors. For example, this could
|
|
22625
|
-
# implemented with an HTTP cookie, which should be able to uniquely identify
|
|
22626
|
-
# visitor on a single device. This unique identifier should not change if the
|
|
23788
|
+
# Optional. A unique identifier for tracking visitors. For example, this could
|
|
23789
|
+
# be implemented with an HTTP cookie, which should be able to uniquely identify
|
|
23790
|
+
# a visitor on a single device. This unique identifier should not change if the
|
|
22627
23791
|
# visitor logs in or out of the website. This field should NOT have a fixed
|
|
22628
23792
|
# value such as `unknown_visitor`. This should be the same identifier as
|
|
22629
23793
|
# UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field
|
|
@@ -25432,6 +26596,11 @@ module Google
|
|
|
25432
26596
|
# @return [String]
|
|
25433
26597
|
attr_accessor :configurable_billing_approach
|
|
25434
26598
|
|
|
26599
|
+
# Output only. The timestamp when configurable_billing_approach was last updated.
|
|
26600
|
+
# Corresponds to the JSON property `configurableBillingApproachUpdateTime`
|
|
26601
|
+
# @return [String]
|
|
26602
|
+
attr_accessor :configurable_billing_approach_update_time
|
|
26603
|
+
|
|
25435
26604
|
# Immutable. The content config of the data store. If this field is unset, the
|
|
25436
26605
|
# server behavior defaults to ContentConfig.NO_CONTENT.
|
|
25437
26606
|
# Corresponds to the JSON property `contentConfig`
|
|
@@ -25546,6 +26715,7 @@ module Google
|
|
|
25546
26715
|
@billing_estimation = args[:billing_estimation] if args.key?(:billing_estimation)
|
|
25547
26716
|
@cmek_config = args[:cmek_config] if args.key?(:cmek_config)
|
|
25548
26717
|
@configurable_billing_approach = args[:configurable_billing_approach] if args.key?(:configurable_billing_approach)
|
|
26718
|
+
@configurable_billing_approach_update_time = args[:configurable_billing_approach_update_time] if args.key?(:configurable_billing_approach_update_time)
|
|
25549
26719
|
@content_config = args[:content_config] if args.key?(:content_config)
|
|
25550
26720
|
@create_time = args[:create_time] if args.key?(:create_time)
|
|
25551
26721
|
@default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
|
|
@@ -26039,6 +27209,12 @@ module Google
|
|
|
26039
27209
|
attr_accessor :enable_image_annotation
|
|
26040
27210
|
alias_method :enable_image_annotation?, :enable_image_annotation
|
|
26041
27211
|
|
|
27212
|
+
# Optional. If true, the pdf layout will be refined using an LLM.
|
|
27213
|
+
# Corresponds to the JSON property `enableLlmLayoutParsing`
|
|
27214
|
+
# @return [Boolean]
|
|
27215
|
+
attr_accessor :enable_llm_layout_parsing
|
|
27216
|
+
alias_method :enable_llm_layout_parsing?, :enable_llm_layout_parsing
|
|
27217
|
+
|
|
26042
27218
|
# Optional. If true, the LLM based annotation is added to the table during
|
|
26043
27219
|
# parsing.
|
|
26044
27220
|
# Corresponds to the JSON property `enableTableAnnotation`
|
|
@@ -26075,6 +27251,7 @@ module Google
|
|
|
26075
27251
|
def update!(**args)
|
|
26076
27252
|
@enable_get_processed_document = args[:enable_get_processed_document] if args.key?(:enable_get_processed_document)
|
|
26077
27253
|
@enable_image_annotation = args[:enable_image_annotation] if args.key?(:enable_image_annotation)
|
|
27254
|
+
@enable_llm_layout_parsing = args[:enable_llm_layout_parsing] if args.key?(:enable_llm_layout_parsing)
|
|
26078
27255
|
@enable_table_annotation = args[:enable_table_annotation] if args.key?(:enable_table_annotation)
|
|
26079
27256
|
@exclude_html_classes = args[:exclude_html_classes] if args.key?(:exclude_html_classes)
|
|
26080
27257
|
@exclude_html_elements = args[:exclude_html_elements] if args.key?(:exclude_html_elements)
|
|
@@ -26174,6 +27351,11 @@ module Google
|
|
|
26174
27351
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata]
|
|
26175
27352
|
attr_accessor :chat_engine_metadata
|
|
26176
27353
|
|
|
27354
|
+
# Configurations used to enable CMEK data encryption with Cloud KMS keys.
|
|
27355
|
+
# Corresponds to the JSON property `cmekConfig`
|
|
27356
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaCmekConfig]
|
|
27357
|
+
attr_accessor :cmek_config
|
|
27358
|
+
|
|
26177
27359
|
# Common configurations for an Engine.
|
|
26178
27360
|
# Corresponds to the JSON property `commonConfig`
|
|
26179
27361
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEngineCommonConfig]
|
|
@@ -26235,6 +27417,17 @@ module Google
|
|
|
26235
27417
|
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig]
|
|
26236
27418
|
attr_accessor :media_recommendation_engine_config
|
|
26237
27419
|
|
|
27420
|
+
# Optional. Maps a model name to its specific configuration for this engine.
|
|
27421
|
+
# This allows admin users to turn on/off individual models. This only stores
|
|
27422
|
+
# models whose states are overridden by the admin. When the state is unspecified,
|
|
27423
|
+
# or model_configs is empty for this model, the system will decide if this
|
|
27424
|
+
# model should be available or not based on the default configuration. For
|
|
27425
|
+
# example, a preview model should be disabled by default if the admin has not
|
|
27426
|
+
# chosen to enable it.
|
|
27427
|
+
# Corresponds to the JSON property `modelConfigs`
|
|
27428
|
+
# @return [Hash<String,String>]
|
|
27429
|
+
attr_accessor :model_configs
|
|
27430
|
+
|
|
26238
27431
|
# Immutable. Identifier. The fully qualified resource name of the engine. This
|
|
26239
27432
|
# field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
26240
27433
|
# Format: `projects/`project`/locations/`location`/collections/`collection`/
|
|
@@ -26268,6 +27461,7 @@ module Google
|
|
|
26268
27461
|
@app_type = args[:app_type] if args.key?(:app_type)
|
|
26269
27462
|
@chat_engine_config = args[:chat_engine_config] if args.key?(:chat_engine_config)
|
|
26270
27463
|
@chat_engine_metadata = args[:chat_engine_metadata] if args.key?(:chat_engine_metadata)
|
|
27464
|
+
@cmek_config = args[:cmek_config] if args.key?(:cmek_config)
|
|
26271
27465
|
@common_config = args[:common_config] if args.key?(:common_config)
|
|
26272
27466
|
@configurable_billing_approach = args[:configurable_billing_approach] if args.key?(:configurable_billing_approach)
|
|
26273
27467
|
@create_time = args[:create_time] if args.key?(:create_time)
|
|
@@ -26277,6 +27471,7 @@ module Google
|
|
|
26277
27471
|
@features = args[:features] if args.key?(:features)
|
|
26278
27472
|
@industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
|
|
26279
27473
|
@media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
|
|
27474
|
+
@model_configs = args[:model_configs] if args.key?(:model_configs)
|
|
26280
27475
|
@name = args[:name] if args.key?(:name)
|
|
26281
27476
|
@search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
|
|
26282
27477
|
@solution_type = args[:solution_type] if args.key?(:solution_type)
|
|
@@ -27478,6 +28673,16 @@ module Google
|
|
|
27478
28673
|
class GoogleCloudDiscoveryengineV1betaProject
|
|
27479
28674
|
include Google::Apis::Core::Hashable
|
|
27480
28675
|
|
|
28676
|
+
# Represents the currently effective configurable billing parameters. These
|
|
28677
|
+
# values are derived from the customer's subscription history stored internally
|
|
28678
|
+
# and reflect the thresholds actively being used for billing purposes at the
|
|
28679
|
+
# time of the GetProject call. This includes the start_time of the subscription
|
|
28680
|
+
# and may differ from the values in `customer_provided_config` due to billing
|
|
28681
|
+
# rules (e.g., scale-downs taking effect only at the start of a new month).
|
|
28682
|
+
# Corresponds to the JSON property `configurableBillingStatus`
|
|
28683
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus]
|
|
28684
|
+
attr_accessor :configurable_billing_status
|
|
28685
|
+
|
|
27481
28686
|
# Output only. The timestamp when this project is created.
|
|
27482
28687
|
# Corresponds to the JSON property `createTime`
|
|
27483
28688
|
# @return [String]
|
|
@@ -27512,6 +28717,7 @@ module Google
|
|
|
27512
28717
|
|
|
27513
28718
|
# Update properties of this object
|
|
27514
28719
|
def update!(**args)
|
|
28720
|
+
@configurable_billing_status = args[:configurable_billing_status] if args.key?(:configurable_billing_status)
|
|
27515
28721
|
@create_time = args[:create_time] if args.key?(:create_time)
|
|
27516
28722
|
@customer_provided_config = args[:customer_provided_config] if args.key?(:customer_provided_config)
|
|
27517
28723
|
@name = args[:name] if args.key?(:name)
|
|
@@ -27520,6 +28726,46 @@ module Google
|
|
|
27520
28726
|
end
|
|
27521
28727
|
end
|
|
27522
28728
|
|
|
28729
|
+
# Represents the currently effective configurable billing parameters. These
|
|
28730
|
+
# values are derived from the customer's subscription history stored internally
|
|
28731
|
+
# and reflect the thresholds actively being used for billing purposes at the
|
|
28732
|
+
# time of the GetProject call. This includes the start_time of the subscription
|
|
28733
|
+
# and may differ from the values in `customer_provided_config` due to billing
|
|
28734
|
+
# rules (e.g., scale-downs taking effect only at the start of a new month).
|
|
28735
|
+
class GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus
|
|
28736
|
+
include Google::Apis::Core::Hashable
|
|
28737
|
+
|
|
28738
|
+
# Optional. The currently effective Indexing Core threshold. This is the
|
|
28739
|
+
# threshold against which Indexing Core usage is compared for overage
|
|
28740
|
+
# calculations.
|
|
28741
|
+
# Corresponds to the JSON property `effectiveIndexingCoreThreshold`
|
|
28742
|
+
# @return [Fixnum]
|
|
28743
|
+
attr_accessor :effective_indexing_core_threshold
|
|
28744
|
+
|
|
28745
|
+
# Optional. The currently effective Search QPM threshold in queries per minute.
|
|
28746
|
+
# This is the threshold against which QPM usage is compared for overage
|
|
28747
|
+
# calculations.
|
|
28748
|
+
# Corresponds to the JSON property `effectiveSearchQpmThreshold`
|
|
28749
|
+
# @return [Fixnum]
|
|
28750
|
+
attr_accessor :effective_search_qpm_threshold
|
|
28751
|
+
|
|
28752
|
+
# Optional. The start time of the currently active billing subscription.
|
|
28753
|
+
# Corresponds to the JSON property `startTime`
|
|
28754
|
+
# @return [String]
|
|
28755
|
+
attr_accessor :start_time
|
|
28756
|
+
|
|
28757
|
+
def initialize(**args)
|
|
28758
|
+
update!(**args)
|
|
28759
|
+
end
|
|
28760
|
+
|
|
28761
|
+
# Update properties of this object
|
|
28762
|
+
def update!(**args)
|
|
28763
|
+
@effective_indexing_core_threshold = args[:effective_indexing_core_threshold] if args.key?(:effective_indexing_core_threshold)
|
|
28764
|
+
@effective_search_qpm_threshold = args[:effective_search_qpm_threshold] if args.key?(:effective_search_qpm_threshold)
|
|
28765
|
+
@start_time = args[:start_time] if args.key?(:start_time)
|
|
28766
|
+
end
|
|
28767
|
+
end
|
|
28768
|
+
|
|
27523
28769
|
# Customer provided configurations.
|
|
27524
28770
|
class GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig
|
|
27525
28771
|
include Google::Apis::Core::Hashable
|
|
@@ -28338,9 +29584,9 @@ module Google
|
|
|
28338
29584
|
# @return [Hash<String,String>]
|
|
28339
29585
|
attr_accessor :user_labels
|
|
28340
29586
|
|
|
28341
|
-
# A unique identifier for tracking visitors. For example, this could
|
|
28342
|
-
# implemented with an HTTP cookie, which should be able to uniquely identify
|
|
28343
|
-
# visitor on a single device. This unique identifier should not change if the
|
|
29587
|
+
# Optional. A unique identifier for tracking visitors. For example, this could
|
|
29588
|
+
# be implemented with an HTTP cookie, which should be able to uniquely identify
|
|
29589
|
+
# a visitor on a single device. This unique identifier should not change if the
|
|
28344
29590
|
# visitor logs in or out of the website. This field should NOT have a fixed
|
|
28345
29591
|
# value such as `unknown_visitor`. This should be the same identifier as
|
|
28346
29592
|
# UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field
|