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.



1912
1913
1914
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1912

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:



1843
1844
1845
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1843

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) 


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

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:



1857
1858
1859
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1857

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) 


1863
1864
1865
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1863

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) 


1869
1870
1871
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1869

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) 


1876
1877
1878
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1876

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) 


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

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) 


1892
1893
1894
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1892

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) 


1899
1900
1901
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1899

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) 


1905
1906
1907
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1905

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:



1910
1911
1912
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1910

def suggestions_input_config
  @suggestions_input_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 1917

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