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.
-
#name ⇒ String
Immutable.
-
#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.
4349 4350 4351 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4349 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
4232 4233 4234 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4232 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
4238 4239 4240 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4238 def allowlisted_domains @allowlisted_domains end |
#config_id ⇒ String
Output only. Unique obfuscated identifier of a WidgetConfig.
Corresponds to the JSON property configId
4243 4244 4245 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4243 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
4248 4249 4250 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4248 def content_search_spec @content_search_spec end |
#create_time ⇒ String
Output only. Timestamp the WidgetConfig was created.
Corresponds to the JSON property createTime
4253 4254 4255 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4253 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
4258 4259 4260 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4258 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
4265 4266 4267 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4265 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
4270 4271 4272 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4270 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
4277 4278 4279 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4277 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
4283 4284 4285 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4283 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
4289 4290 4291 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4289 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
4295 4296 4297 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4295 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
4301 4302 4303 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4301 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
4307 4308 4309 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4307 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
4313 4314 4315 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4313 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
4322 4323 4324 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4322 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
4327 4328 4329 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4327 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 property
name`
4336 4337 4338 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4336 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
4342 4343 4344 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4342 def solution_type @solution_type end |
#update_time ⇒ String
Output only. Timestamp the WidgetConfig was updated.
Corresponds to the JSON property updateTime
4347 4348 4349 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4347 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 4354 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 |