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.



2554
2555
2556
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2554

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) 


2537
2538
2539
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2537

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) 


2547
2548
2549
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2547

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) 


2552
2553
2554
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2552

def corrected_text
  @corrected_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2559
2560
2561
2562
2563
 
# File 'lib/google/apis/jobs_v4/classes.rb', line 2559

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