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.



7405
7406
7407
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7405

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) 


7269
7270
7271
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7269

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>) 


7275
7276
7277
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7275

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) 


7280
7281
7282
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7280

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:



7285
7286
7287
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7285

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) 


7290
7291
7292
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7290

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) 


7295
7296
7297
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7295

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) 


7302
7303
7304
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7302

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) 


7307
7308
7309
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7307

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) 


7314
7315
7316
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7314

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) 


7320
7321
7322
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7320

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) 


7326
7327
7328
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7326

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) 


7332
7333
7334
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7332

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) 


7338
7339
7340
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7338

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) 


7344
7345
7346
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7344

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:



7350
7351
7352
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7350

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:



7359
7360
7361
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7359

def fields_ui_components_map
  @fields_ui_components_map
end

#industry_vertical ⇒ String

Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine. Corresponds to the JSON property industryVertical

Returns:

  • (String) 


7365
7366
7367
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7365

def industry_vertical
  @industry_vertical
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) 


7370
7371
7372
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7370

def llm_enabled
  @llm_enabled
end

#minimum_data_term_accepted ⇒ Boolean Also known as: minimum_data_term_accepted?

Output only. Whether the customer accepted data use terms. Corresponds to the JSON property minimumDataTermAccepted

Returns:

  • (Boolean) 


7376
7377
7378
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7376

def minimum_data_term_accepted
  @minimum_data_term_accepted
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) 


7385
7386
7387
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7385

def name
  @name
end

#result_display_type ⇒ String

The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non- enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users. Corresponds to the JSON property resultDisplayType

Returns:

  • (String) 


7392
7393
7394
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7392

def result_display_type
  @result_display_type
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) 


7398
7399
7400
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7398

def solution_type
  @solution_type
end

#update_time ⇒ String

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

Returns:

  • (String) 


7403
7404
7405
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7403

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7410

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)
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
  @llm_enabled = args[:llm_enabled] if args.key?(:llm_enabled)
  @minimum_data_term_accepted = args[:minimum_data_term_accepted] if args.key?(:minimum_data_term_accepted)
  @name = args[:name] if args.key?(:name)
  @result_display_type = args[:result_display_type] if args.key?(:result_display_type)
  @solution_type = args[:solution_type] if args.key?(:solution_type)
  @update_time = args[:update_time] if args.key?(:update_time)
end