Class: Google::Apis::JobsV4::SpellingCorrection

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

Overview

Spell check result.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SpellingCorrection

Returns a new instance of SpellingCorrection.



2580
2581
2582
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2580

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

Instance Attribute Details

#corrected ⇒ Boolean Also known as: corrected?

Indicates if the query was corrected by the spell checker. Corresponds to the JSON property corrected

Returns:

  • (Boolean) 


2563
2564
2565
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2563

def corrected
  @corrected
end

#corrected_html ⇒ String

Corrected output with html tags to highlight the corrected words. Corrected words are called out with the "..." html tags. For example, the user input query is "software enginear", where the second word, "enginear," is incorrect. It should be "engineer". When spelling correction is enabled, this value is " software engineer". Corresponds to the JSON property correctedHtml

Returns:

  • (String) 


2573
2574
2575
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2573

def corrected_html
  @corrected_html
end

#corrected_text ⇒ String

Correction output consisting of the corrected keyword string. Corresponds to the JSON property correctedText

Returns:

  • (String) 


2578
2579
2580
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2578

def corrected_text
  @corrected_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2585
2586
2587
2588
2589
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2585

def update!(**args)
  @corrected = args[:corrected] if args.key?(:corrected)
  @corrected_html = args[:corrected_html] if args.key?(:corrected_html)
  @corrected_text = args[:corrected_text] if args.key?(:corrected_text)
end