Class: Google::Apis::CloudsearchV1::QueryInterpretationOptions

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

Options to interpret user query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ QueryInterpretationOptions

Returns a new instance of QueryInterpretationOptions.



6173
6174
6175
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6173

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

Instance Attribute Details

#disable_nl_interpretationBoolean Also known as: disable_nl_interpretation?

Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources. Corresponds to the JSON property disableNlInterpretation

Returns:

  • (Boolean)


6153
6154
6155
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6153

def disable_nl_interpretation
  @disable_nl_interpretation
end

#disable_supplemental_resultsBoolean Also known as: disable_supplemental_results?

Use this flag to disable supplemental results for a query. Supplemental results setting chosen at SearchApplication level will take precedence if set to True. Corresponds to the JSON property disableSupplementalResults

Returns:

  • (Boolean)


6161
6162
6163
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6161

def disable_supplemental_results
  @disable_supplemental_results
end

#enable_verbatim_modeBoolean Also known as: enable_verbatim_mode?

Enable this flag to turn off all internal optimizations like natural language ( NL) interpretation of queries, supplemental result retrieval, and usage of synonyms including custom ones. Nl interpretation will be disabled if either one of the two flags is true. Corresponds to the JSON property enableVerbatimMode

Returns:

  • (Boolean)


6170
6171
6172
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6170

def enable_verbatim_mode
  @enable_verbatim_mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6178
6179
6180
6181
6182
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 6178

def update!(**args)
  @disable_nl_interpretation = args[:disable_nl_interpretation] if args.key?(:disable_nl_interpretation)
  @disable_supplemental_results = args[:disable_supplemental_results] if args.key?(:disable_supplemental_results)
  @enable_verbatim_mode = args[:enable_verbatim_mode] if args.key?(:enable_verbatim_mode)
end