Class: Google::Apis::RetailV2::GoogleCloudRetailV2CompletionConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/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) ⇒ GoogleCloudRetailV2CompletionConfig

Returns a new instance of GoogleCloudRetailV2CompletionConfig.



998
999
1000
 
# File 'lib/google/apis/retail_v2/classes.rb', line 998

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

Instance Attribute Details

#allowlist_input_config ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig

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

Returns:



927
928
929
 
# File 'lib/google/apis/retail_v2/classes.rb', line 927

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) 


935
936
937
 
# File 'lib/google/apis/retail_v2/classes.rb', line 935

def auto_learning
  @auto_learning
end

#denylist_input_config ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig

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

Returns:



941
942
943
 
# File 'lib/google/apis/retail_v2/classes.rb', line 941

def denylist_input_config
  @denylist_input_config
end

#last_allowlist_import_operation ⇒ String

Output only. Name of the 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) 


948
949
950
 
# File 'lib/google/apis/retail_v2/classes.rb', line 948

def last_allowlist_import_operation
  @last_allowlist_import_operation
end

#last_denylist_import_operation ⇒ String

Output only. Name of the 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) 


955
956
957
 
# File 'lib/google/apis/retail_v2/classes.rb', line 955

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) 


962
963
964
 
# File 'lib/google/apis/retail_v2/classes.rb', line 962

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) 


971
972
973
 
# File 'lib/google/apis/retail_v2/classes.rb', line 971

def matching_order
  @matching_order
end

#max_suggestions ⇒ Fixnum

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

Returns:

  • (Fixnum) 


978
979
980
 
# File 'lib/google/apis/retail_v2/classes.rb', line 978

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. Value range is 1 to 20. Corresponds to the JSON property minPrefixLength

Returns:

  • (Fixnum) 


985
986
987
 
# File 'lib/google/apis/retail_v2/classes.rb', line 985

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) 


991
992
993
 
# File 'lib/google/apis/retail_v2/classes.rb', line 991

def name
  @name
end

#suggestions_input_config ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2CompletionDataInputConfig

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

Returns:



996
997
998
 
# File 'lib/google/apis/retail_v2/classes.rb', line 996

def suggestions_input_config
  @suggestions_input_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1003

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