Retail V2 API - Class Google::Cloud::Retail::V2::CompletionConfig (v0.21.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::CompletionConfig.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#allowlist_input_config

def allowlist_input_config() -> ::Google::Cloud::Retail::V2::CompletionDataInputConfig
Returns

#auto_learning

def auto_learning() -> ::Boolean
Returns
  • (::Boolean) — 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.

#auto_learning=

def auto_learning=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#denylist_input_config

def denylist_input_config() -> ::Google::Cloud::Retail::V2::CompletionDataInputConfig
Returns

#last_allowlist_import_operation

def last_allowlist_import_operation() -> ::String
Returns
  • (::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.

#last_denylist_import_operation

def last_denylist_import_operation() -> ::String
Returns
  • (::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.

#last_suggestions_import_operation

def last_suggestions_import_operation() -> ::String
Returns
  • (::String) — Output only. Name of the LRO corresponding to the latest suggestion terms list import.

    Can use GetOperation API method to retrieve the latest state of the Long Running Operation.

#matching_order

def matching_order() -> ::String
Returns
  • (::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'.

#matching_order=

def matching_order=(value) -> ::String
Parameter
  • value (::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'.

Returns
  • (::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'.

#max_suggestions

def max_suggestions() -> ::Integer
Returns
  • (::Integer) — 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.

#max_suggestions=

def max_suggestions=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

Returns
  • (::Integer) — 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.

#min_prefix_length

def min_prefix_length() -> ::Integer
Returns
  • (::Integer) — 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.

#min_prefix_length=

def min_prefix_length=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

Returns
  • (::Integer) — 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.

#name

def name() -> ::String
Returns
  • (::String) — Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig
Returns
  • (::String) — Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig

#suggestions_input_config

def suggestions_input_config() -> ::Google::Cloud::Retail::V2::CompletionDataInputConfig
Returns