replaceSynonymsInHighlight property

  1. @JsonKey(name: r'replaceSynonymsInHighlight')
bool? replaceSynonymsInHighlight
final

Whether to replace a highlighted word with the matched synonym. By default, the original words are highlighted even if a synonym matches. For example, with home as a synonym for house and a search for home, records matching either "home" or "house" are included in the search results, and either "home" or "house" are highlighted. With replaceSynonymsInHighlight set to true, a search for home still matches the same records, but all occurrences of "house" are replaced by "home" in the highlighted response.

Implementation

@JsonKey(name: r'replaceSynonymsInHighlight')
final bool? replaceSynonymsInHighlight;