Interface SpellingCorrectionOrBuilder (2.37.0)

Version 2.37.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.6
• 2.2.9

public interface SpellingCorrectionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCorrected()

public abstract boolean getCorrected()

Indicates if the query was corrected by the spell checker.

bool corrected = 1;

Returns
Type	Description
boolean	The corrected.

getCorrectedHtml()

public abstract String getCorrectedHtml()

Corrected output with html tags to highlight the corrected words. Corrected words are called out with the "<b><i>...</i></b>" 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 <b><i>engineer</i></b>".

string corrected_html = 3;

Returns
Type	Description
String	The correctedHtml.

getCorrectedHtmlBytes()

public abstract ByteString getCorrectedHtmlBytes()

Corrected output with html tags to highlight the corrected words. Corrected words are called out with the "<b><i>...</i></b>" 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 <b><i>engineer</i></b>".

string corrected_html = 3;

Returns
Type	Description
ByteString	The bytes for correctedHtml.

getCorrectedText()

public abstract String getCorrectedText()

Correction output consisting of the corrected keyword string.

string corrected_text = 2;

Returns
Type	Description
String	The correctedText.

getCorrectedTextBytes()

public abstract ByteString getCorrectedTextBytes()

Correction output consisting of the corrected keyword string.

string corrected_text = 2;

Returns
Type	Description
ByteString	The bytes for correctedText.