Reference documentation and code samples for the Google Cloud Talent Solution V4 Client class SpellingCorrection.
Spell check result.
Generated from protobuf message google.cloud.talent.v4.SpellingCorrection
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ corrected |
bool
Indicates if the query was corrected by the spell checker. |
↳ corrected_text |
string
Correction output consisting of the corrected keyword string. |
↳ 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". |
getCorrected
Indicates if the query was corrected by the spell checker.
| Returns | |
|---|---|
| Type | Description |
bool | |
setCorrected
Indicates if the query was corrected by the spell checker.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCorrectedText
Correction output consisting of the corrected keyword string.
| Returns | |
|---|---|
| Type | Description |
string | |
setCorrectedText
Correction output consisting of the corrected keyword string.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCorrectedHtml
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".
| Returns | |
|---|---|
| Type | Description |
string | |
setCorrectedHtml
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".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |