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.



9078
9079
9080
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9078

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) 


8917
8918
8919
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8917

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


8923
8924
8925
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8923

def allowlisted_domains
  @allowlisted_domains
end

#collection_components ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent>

Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. Corresponds to the JSON property collectionComponents

Returns:



8931
8932
8933
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8931

def collection_components
  @collection_components
end

#config_id ⇒ String

Output only. Unique obfuscated identifier of a WidgetConfig. Corresponds to the JSON property configId

Returns:

  • (String) 


8936
8937
8938
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8936

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:



8941
8942
8943
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8941

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) 


8946
8947
8948
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8946

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) 


8951
8952
8953
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8951

def data_store_type
  @data_store_type
end

#data_store_ui_configs ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig>

Configurable UI configurations per data store. Corresponds to the JSON property dataStoreUiConfigs

Returns:



8956
8957
8958
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8956

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


8963
8964
8965
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8963

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) 


8968
8969
8970
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8968

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) 


8975
8976
8977
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8975

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) 


8981
8982
8983
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8981

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) 


8987
8988
8989
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8987

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) 


8993
8994
8995
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8993

def enable_safe_search
  @enable_safe_search
end

#enable_search_as_you_type ⇒ Boolean Also known as: enable_search_as_you_type?

Whether to enable search-as-you-type behavior for the search widget Corresponds to the JSON property enableSearchAsYouType

Returns:

  • (Boolean) 


8999
9000
9001
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8999

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


9005
9006
9007
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9005

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) 


9011
9012
9013
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9011

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) 


9017
9018
9019
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9017

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:



9023
9024
9025
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9023

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:



9032
9033
9034
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9032

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) 


9038
9039
9040
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9038

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) 


9043
9044
9045
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9043

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) 


9049
9050
9051
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9049

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) 


9058
9059
9060
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9058

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) 


9065
9066
9067
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9065

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) 


9071
9072
9073
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9071

def solution_type
  @solution_type
end

#update_time ⇒ String

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

Returns:

  • (String) 


9076
9077
9078
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9076

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9083

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