Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfig
- 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
-
#allow_public_access ⇒ Boolean
(also: #allow_public_access?)
Whether allow no-auth integration with widget.
-
#allowlisted_domains ⇒ Array<String>
Allowlisted domains that can load this widget.
-
#config_id ⇒ String
Output only.
-
#content_search_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec
A specification for configuring the behavior of content search.
-
#create_time ⇒ String
Output only.
-
#data_store_type ⇒ String
Output only.
-
#display_name ⇒ String
Required.
-
#enable_autocomplete ⇒ Boolean
(also: #enable_autocomplete?)
Whether or not to enable autocomplete.
-
#enable_conversational_search ⇒ Boolean
(also: #enable_conversational_search?)
Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
-
#enable_quality_feedback ⇒ Boolean
(also: #enable_quality_feedback?)
Turn on or off collecting the search result quality feedback from end users.
-
#enable_result_score ⇒ Boolean
(also: #enable_result_score?)
Whether to show the result score.
-
#enable_safe_search ⇒ Boolean
(also: #enable_safe_search?)
Whether to enable safe search.
-
#enable_snippet_result_summary ⇒ Boolean
(also: #enable_snippet_result_summary?)
Turn on or off summary for each snippets result.
-
#enable_summarization ⇒ Boolean
(also: #enable_summarization?)
Turn on or off summarization for the search response.
-
#facet_field ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField>
The configuration and appearance of facets in the end user view.
-
#fields_ui_components_map ⇒ Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField>
The key is the UI component.
-
#llm_enabled ⇒ Boolean
(also: #llm_enabled?)
Output only.
-
#minimum_data_term_accepted ⇒ Boolean
(also: #minimum_data_term_accepted?)
Output only.
-
#name ⇒ String
Immutable.
-
#result_display_type ⇒ String
The type of snippet to display in UCS widget.
-
#solution_type ⇒ String
Required.
-
#update_time ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaWidgetConfig
constructor
A new instance of GoogleCloudDiscoveryengineV1alphaWidgetConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaWidgetConfig
Returns a new instance of GoogleCloudDiscoveryengineV1alphaWidgetConfig.
4541 4542 4543 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4541 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
4411 4412 4413 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4411 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
4417 4418 4419 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4417 def allowlisted_domains @allowlisted_domains end |
#config_id ⇒ String
Output only. Unique obfuscated identifier of a WidgetConfig.
Corresponds to the JSON property configId
4422 4423 4424 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4422 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
4427 4428 4429 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4427 def content_search_spec @content_search_spec end |
#create_time ⇒ String
Output only. Timestamp the WidgetConfig was created.
Corresponds to the JSON property createTime
4432 4433 4434 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4432 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
4437 4438 4439 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4437 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
4444 4445 4446 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4444 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
4449 4450 4451 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4449 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
4456 4457 4458 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4456 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
4462 4463 4464 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4462 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
4468 4469 4470 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4468 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
4474 4475 4476 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4474 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
4480 4481 4482 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4480 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
4486 4487 4488 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4486 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
4492 4493 4494 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4492 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
4501 4502 4503 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4501 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
4506 4507 4508 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4506 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
4512 4513 4514 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4512 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 property
name`
4521 4522 4523 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4521 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
4528 4529 4530 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4528 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
4534 4535 4536 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4534 def solution_type @solution_type end |
#update_time ⇒ String
Output only. Timestamp the WidgetConfig was updated.
Corresponds to the JSON property updateTime
4539 4540 4541 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4539 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4546 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) @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 |