Class: Google::Cloud::Retail::V2::CompletionConfig

Inherits:

Object

• Object
• Google::Cloud::Retail::V2::CompletionConfig

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/retail/v2/catalog.rb

Overview

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

Instance Attribute Summary

• #allowlist_input_config ⇒ ::Google::Cloud::Retail::V2::CompletionDataInputConfig readonly

  Output only.

• #auto_learning ⇒ ::Boolean

  If set to true, the auto learning function is enabled.

• #denylist_input_config ⇒ ::Google::Cloud::Retail::V2::CompletionDataInputConfig readonly

  Output only.

• #last_allowlist_import_operation ⇒ ::String readonly

  Output only.

• #last_denylist_import_operation ⇒ ::String readonly

  Output only.

• #last_suggestions_import_operation ⇒ ::String readonly

  Output only.

• #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".

• #max_suggestions ⇒ ::Integer

  The maximum number of autocomplete suggestions returned per term.

• #min_prefix_length ⇒ ::Integer

  The minimum number of characters needed to be typed in order to get suggestions.

• #name ⇒ ::String

  Required.

• #suggestions_input_config ⇒ ::Google::Cloud::Retail::V2::CompletionDataInputConfig readonly

  Output only.

Instance Attribute Details

#allowlist_input_config ⇒ ::Google::Cloud::Retail::V2::CompletionDataInputConfig (readonly)

Returns Output only. The source data for the latest import of the autocomplete allowlist phrases.

Returns:

• (::Google::Cloud::Retail::V2::CompletionDataInputConfig) —

  Output only. The source data for the latest import of the autocomplete allowlist phrases.

# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 491

class CompletionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#auto_learning ⇒ ::Boolean

Returns 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.

# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 491

class CompletionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#denylist_input_config ⇒ ::Google::Cloud::Retail::V2::CompletionDataInputConfig (readonly)

Returns Output only. The source data for the latest import of the autocomplete denylist phrases.

Returns:

• (::Google::Cloud::Retail::V2::CompletionDataInputConfig) —

  Output only. The source data for the latest import of the autocomplete denylist phrases.

# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 491

class CompletionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#last_allowlist_import_operation ⇒ ::String (readonly)

Returns 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.

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.

# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 491

class CompletionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#last_denylist_import_operation ⇒ ::String (readonly)

Returns 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.

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.

# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 491

class CompletionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#last_suggestions_import_operation ⇒ ::String (readonly)

Returns 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.

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.

# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 491

class CompletionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#matching_order ⇒ ::String

Returns 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'.

# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 491

class CompletionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#max_suggestions ⇒ ::Integer

Returns 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.

# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 491

class CompletionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#min_prefix_length ⇒ ::Integer

Returns 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.

# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 491

class CompletionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig.

Returns:

• (::String) —

  Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig

# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 491

class CompletionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#suggestions_input_config ⇒ ::Google::Cloud::Retail::V2::CompletionDataInputConfig (readonly)

Returns Output only. The source data for the latest import of the autocomplete suggestion phrases.

Returns:

• (::Google::Cloud::Retail::V2::CompletionDataInputConfig) —

  Output only. The source data for the latest import of the autocomplete suggestion phrases.

# File 'proto_docs/google/cloud/retail/v2/catalog.rb', line 491

class CompletionConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end