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.
-
#industry_vertical ⇒ String
Output only.
-
#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.
7778 7779 7780 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7778 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
7642 7643 7644 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7642 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
7648 7649 7650 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7648 def allowlisted_domains @allowlisted_domains end |
#config_id ⇒ String
Output only. Unique obfuscated identifier of a WidgetConfig.
Corresponds to the JSON property configId
7653 7654 7655 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7653 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
7658 7659 7660 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7658 def content_search_spec @content_search_spec end |
#create_time ⇒ String
Output only. Timestamp the WidgetConfig was created.
Corresponds to the JSON property createTime
7663 7664 7665 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7663 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
7668 7669 7670 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7668 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
7675 7676 7677 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7675 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
7680 7681 7682 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7680 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
7687 7688 7689 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7687 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
7693 7694 7695 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7693 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
7699 7700 7701 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7699 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
7705 7706 7707 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7705 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
7711 7712 7713 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7711 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
7717 7718 7719 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7717 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
7723 7724 7725 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7723 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
7732 7733 7734 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7732 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
7738 7739 7740 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7738 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
7743 7744 7745 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7743 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
7749 7750 7751 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7749 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`
7758 7759 7760 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7758 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
7765 7766 7767 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7765 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
7771 7772 7773 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7771 def solution_type @solution_type end |
#update_time ⇒ String
Output only. Timestamp the WidgetConfig was updated.
Corresponds to the JSON property updateTime
7776 7777 7778 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7776 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7783 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 |