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.



8164
8165
8166
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8164

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) 


8022
8023
8024
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8022

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


8028
8029
8030
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8028

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) 


8033
8034
8035
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8033

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:



8038
8039
8040
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8038

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) 


8043
8044
8045
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8043

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) 


8048
8049
8050
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8048

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) 


8055
8056
8057
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8055

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) 


8060
8061
8062
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8060

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) 


8067
8068
8069
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8067

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) 


8073
8074
8075
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8073

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) 


8079
8080
8081
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8079

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) 


8085
8086
8087
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8085

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) 


8091
8092
8093
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8091

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) 


8097
8098
8099
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8097

def enable_summarization
  @enable_summarization
end

#enable_web_app ⇒ Boolean Also known as: enable_web_app?

Whether to enable standalone web app. Corresponds to the JSON property enableWebApp

Returns:

  • (Boolean) 


8103
8104
8105
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8103

def enable_web_app
  @enable_web_app
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:



8109
8110
8111
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8109

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:



8118
8119
8120
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8118

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) 


8124
8125
8126
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8124

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) 


8129
8130
8131
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8129

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) 


8135
8136
8137
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8135

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) 


8144
8145
8146
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8144

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) 


8151
8152
8153
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8151

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) 


8157
8158
8159
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8157

def solution_type
  @solution_type
end

#update_time ⇒ String

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

Returns:

  • (String) 


8162
8163
8164
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8162

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8169

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)
  @enable_web_app = args[:enable_web_app] if args.key?(:enable_web_app)
  @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