Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

WidgetConfig captures configs at the Widget level.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaWidgetConfig

Returns a new instance of GoogleCloudDiscoveryengineV1alphaWidgetConfig.



4500
4501
4502
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4500

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allow_public_access ⇒ Boolean Also known as: allow_public_access?

Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server. Corresponds to the JSON property allowPublicAccess

Returns:

  • (Boolean) 


4383
4384
4385
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4383

def allow_public_access
  @allow_public_access
end

#allowlisted_domains ⇒ Array<String>

Allowlisted domains that can load this widget. Corresponds to the JSON property allowlistedDomains

Returns:

  • (Array<String>) 


4389
4390
4391
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4389

def allowlisted_domains
  @allowlisted_domains
end

#config_id ⇒ String

Output only. Unique obfuscated identifier of a WidgetConfig. Corresponds to the JSON property configId

Returns:

  • (String) 


4394
4395
4396
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4394

def config_id
  @config_id
end

#content_search_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec

A specification for configuring the behavior of content search. Corresponds to the JSON property contentSearchSpec

Returns:



4399
4400
4401
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4399

def content_search_spec
  @content_search_spec
end

#create_time ⇒ String

Output only. Timestamp the WidgetConfig was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


4404
4405
4406
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4404

def create_time
  @create_time
end

#data_store_type ⇒ String

Output only. The type of the parent data store. Corresponds to the JSON property dataStoreType

Returns:

  • (String) 


4409
4410
4411
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4409

def data_store_type
  @data_store_type
end

#display_name ⇒ String

Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property displayName

Returns:

  • (String) 


4416
4417
4418
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4416

def display_name
  @display_name
end

#enable_autocomplete ⇒ Boolean Also known as: enable_autocomplete?

Whether or not to enable autocomplete. Corresponds to the JSON property enableAutocomplete

Returns:

  • (Boolean) 


4421
4422
4423
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4421

def enable_autocomplete
  @enable_autocomplete
end

#enable_conversational_search ⇒ Boolean Also known as: enable_conversational_search?

Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn). Corresponds to the JSON property enableConversationalSearch

Returns:

  • (Boolean) 


4428
4429
4430
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4428

def enable_conversational_search
  @enable_conversational_search
end

#enable_quality_feedback ⇒ Boolean Also known as: enable_quality_feedback?

Turn on or off collecting the search result quality feedback from end users. Corresponds to the JSON property enableQualityFeedback

Returns:

  • (Boolean) 


4434
4435
4436
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4434

def enable_quality_feedback
  @enable_quality_feedback
end

#enable_result_score ⇒ Boolean Also known as: enable_result_score?

Whether to show the result score. Corresponds to the JSON property enableResultScore

Returns:

  • (Boolean) 


4440
4441
4442
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4440

def enable_result_score
  @enable_result_score
end

#enable_safe_search ⇒ Boolean Also known as: enable_safe_search?

Whether to enable safe search. Corresponds to the JSON property enableSafeSearch

Returns:

  • (Boolean) 


4446
4447
4448
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4446

def enable_safe_search
  @enable_safe_search
end

#enable_snippet_result_summary ⇒ Boolean Also known as: enable_snippet_result_summary?

Turn on or off summary for each snippets result. Corresponds to the JSON property enableSnippetResultSummary

Returns:

  • (Boolean) 


4452
4453
4454
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4452

def enable_snippet_result_summary
  @enable_snippet_result_summary
end

#enable_summarization ⇒ Boolean Also known as: enable_summarization?

Turn on or off summarization for the search response. Corresponds to the JSON property enableSummarization

Returns:

  • (Boolean) 


4458
4459
4460
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4458

def enable_summarization
  @enable_summarization
end

#facet_field ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField>

The configuration and appearance of facets in the end user view. Corresponds to the JSON property facetField

Returns:



4464
4465
4466
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4464

def facet_field
  @facet_field
end

#fields_ui_components_map ⇒ Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField>

The key is the UI component. Mock. Currently supported title, thumbnail, url, custom1, custom2, custom3. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. title, thumbnail, url are required UI components that cannot be removed. Corresponds to the JSON property fieldsUiComponentsMap

Returns:



4473
4474
4475
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4473

def fields_ui_components_map
  @fields_ui_components_map
end

#llm_enabled ⇒ Boolean Also known as: llm_enabled?

Output only. Whether LLM is enabled in the corresponding data store. Corresponds to the JSON property llmEnabled

Returns:

  • (Boolean) 


4478
4479
4480
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4478

def llm_enabled
  @llm_enabled
end

#name ⇒ String

Immutable. The full resource name of the widget config. Format: projects/ project/locations/location/collections/collection_id/dataStores/ data_store_id/widgetConfigs/widget_config_id`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Corresponds to the JSON propertyname`

Returns:

  • (String) 


4487
4488
4489
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4487

def name
  @name
end

#solution_type ⇒ String

Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. Corresponds to the JSON property solutionType

Returns:

  • (String) 


4493
4494
4495
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4493

def solution_type
  @solution_type
end

#update_time ⇒ String

Output only. Timestamp the WidgetConfig was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


4498
4499
4500
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4498

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4505

def update!(**args)
  @allow_public_access = args[:allow_public_access] if args.key?(:allow_public_access)
  @allowlisted_domains = args[:allowlisted_domains] if args.key?(:allowlisted_domains)
  @config_id = args[:config_id] if args.key?(:config_id)
  @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data_store_type = args[:data_store_type] if args.key?(:data_store_type)
  @display_name = args[:display_name] if args.key?(:display_name)
  @enable_autocomplete = args[:enable_autocomplete] if args.key?(:enable_autocomplete)
  @enable_conversational_search = args[:enable_conversational_search] if args.key?(:enable_conversational_search)
  @enable_quality_feedback = args[:enable_quality_feedback] if args.key?(:enable_quality_feedback)
  @enable_result_score = args[:enable_result_score] if args.key?(:enable_result_score)
  @enable_safe_search = args[:enable_safe_search] if args.key?(:enable_safe_search)
  @enable_snippet_result_summary = args[:enable_snippet_result_summary] if args.key?(:enable_snippet_result_summary)
  @enable_summarization = args[:enable_summarization] if args.key?(:enable_summarization)
  @facet_field = args[:facet_field] if args.key?(:facet_field)
  @fields_ui_components_map = args[:fields_ui_components_map] if args.key?(:fields_ui_components_map)
  @llm_enabled = args[:llm_enabled] if args.key?(:llm_enabled)
  @name = args[:name] if args.key?(:name)
  @solution_type = args[:solution_type] if args.key?(:solution_type)
  @update_time = args[:update_time] if args.key?(:update_time)
end