Class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2beta/classes.rb,
lib/google/apis/retail_v2beta/representations.rb,
lib/google/apis/retail_v2beta/representations.rb

Overview

Catalog level autocomplete config for customers to customize autocomplete feature's settings.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2betaCompletionConfig

Returns a new instance of GoogleCloudRetailV2betaCompletionConfig.



1921
1922
1923
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1921

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allowlist_input_config ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionDataInputConfig

The input config source for completion data. Corresponds to the JSON property allowlistInputConfig

Returns:



1852
1853
1854
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1852

def allowlist_input_config
  @allowlist_input_config
end

#auto_learning ⇒ Boolean Also known as: auto_learning?

If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use cloud-retail data in CompleteQueryRequest. Corresponds to the JSON property autoLearning

Returns:

  • (Boolean) 


1860
1861
1862
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1860

def auto_learning
  @auto_learning
end

#denylist_input_config ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionDataInputConfig

The input config source for completion data. Corresponds to the JSON property denylistInputConfig

Returns:



1866
1867
1868
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1866

def denylist_input_config
  @denylist_input_config
end

#last_allowlist_import_operation ⇒ String

Output only. LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. Corresponds to the JSON property lastAllowlistImportOperation

Returns:

  • (String) 


1872
1873
1874
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1872

def last_allowlist_import_operation
  @last_allowlist_import_operation
end

#last_denylist_import_operation ⇒ String

Output only. LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. Corresponds to the JSON property lastDenylistImportOperation

Returns:

  • (String) 


1878
1879
1880
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1878

def last_denylist_import_operation
  @last_denylist_import_operation
end

#last_suggestions_import_operation ⇒ String

Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. Corresponds to the JSON property lastSuggestionsImportOperation

Returns:

  • (String) 


1885
1886
1887
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1885

def last_suggestions_import_operation
  @last_suggestions_import_operation
end

#matching_order ⇒ String

Specifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s' with 'exact-prefix' specified would suggest "red shoes". Currently supported values: * 'out-of-order' * 'exact-prefix' Default value: 'exact-prefix'. Corresponds to the JSON property matchingOrder

Returns:

  • (String) 


1894
1895
1896
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1894

def matching_order
  @matching_order
end

#max_suggestions ⇒ Fixnum

The maximum number of autocomplete suggestions returned per term. The maximum allowed max suggestions is 20. Default value is 20. If left unset or set to 0, then will fallback to default value. Corresponds to the JSON property maxSuggestions

Returns:

  • (Fixnum) 


1901
1902
1903
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1901

def max_suggestions
  @max_suggestions
end

#min_prefix_length ⇒ Fixnum

The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Corresponds to the JSON property minPrefixLength

Returns:

  • (Fixnum) 


1908
1909
1910
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1908

def min_prefix_length
  @min_prefix_length
end

#name ⇒ String

Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/ completionConfig Corresponds to the JSON property name

Returns:

  • (String) 


1914
1915
1916
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1914

def name
  @name
end

#suggestions_input_config ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionDataInputConfig

The input config source for completion data. Corresponds to the JSON property suggestionsInputConfig

Returns:



1919
1920
1921
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1919

def suggestions_input_config
  @suggestions_input_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1926

def update!(**args)
  @allowlist_input_config = args[:allowlist_input_config] if args.key?(:allowlist_input_config)
  @auto_learning = args[:auto_learning] if args.key?(:auto_learning)
  @denylist_input_config = args[:denylist_input_config] if args.key?(:denylist_input_config)
  @last_allowlist_import_operation = args[:last_allowlist_import_operation] if args.key?(:last_allowlist_import_operation)
  @last_denylist_import_operation = args[:last_denylist_import_operation] if args.key?(:last_denylist_import_operation)
  @last_suggestions_import_operation = args[:last_suggestions_import_operation] if args.key?(:last_suggestions_import_operation)
  @matching_order = args[:matching_order] if args.key?(:matching_order)
  @max_suggestions = args[:max_suggestions] if args.key?(:max_suggestions)
  @min_prefix_length = args[:min_prefix_length] if args.key?(:min_prefix_length)
  @name = args[:name] if args.key?(:name)
  @suggestions_input_config = args[:suggestions_input_config] if args.key?(:suggestions_input_config)
end