Class: Google::Cloud::DiscoveryEngine::V1::SearchRequest::SpellCorrectionSpec

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/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::DiscoveryEngine::V1::SearchRequest::SpellCorrectionSpec::Mode

Returns The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.

Returns:



609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 609

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::DiscoveryEngine::V1::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
    MODE_UNSPECIFIED = 0

    # Search API tries to find a spelling suggestion. If a suggestion is
    # found, it is put in the
    # {::Google::Cloud::DiscoveryEngine::V1::SearchResponse#corrected_query SearchResponse.corrected_query}.
    # The spelling suggestion won't be used as the search query.
    SUGGESTION_ONLY = 1

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