Class: Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/search_service.rb

Overview

The specification for query spell correction.

Defined Under Namespace

Modules: Mode

Instance Attribute Summary collapse

Instance Attribute Details

#mode ⇒ ::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec::Mode

Returns The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO.

Returns:



722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 722

class SpellCorrectionSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum describing under which mode spell correction should occur.
  module Mode
    # Unspecified spell correction mode. In this case, server behavior
    # defaults to
    # {::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
    MODE_UNSPECIFIED = 0

    # Google Retail Search will try to find a spell suggestion if there
    # is any and put in the
    # {::Google::Cloud::Retail::V2::SearchResponse#corrected_query SearchResponse.corrected_query}.
    # The spell suggestion will not be used as the search query.
    SUGGESTION_ONLY = 1

    # Automatic spell correction built by Google Retail Search. Search will
    # be based on the corrected query if found.
    AUTO = 2
  end
end