SynonymTokenFilter Class

Definition

Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene.

[Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.SynonymTokenFilter")]
public class SynonymTokenFilter : Microsoft.Azure.Search.Models.TokenFilter
type SynonymTokenFilter = class
    inherit TokenFilter
Public Class SynonymTokenFilter
Inherits TokenFilter
Inheritance
SynonymTokenFilter
Attributes

Constructors

SynonymTokenFilter()

Initializes a new instance of the SynonymTokenFilter class.

SynonymTokenFilter(String, IList<String>, Nullable<Boolean>, Nullable<Boolean>)

Initializes a new instance of the SynonymTokenFilter class.

Properties

Expand

Gets or sets a value indicating whether all words in the list of synonyms (if =&gt; notation is not used) will map to one another. If true, all words in the list of synonyms (if =&gt; notation is not used) will map to one another. The following list: incredible, unbelievable, fabulous, amazing is equivalent to: incredible, unbelievable, fabulous, amazing =&gt; incredible, unbelievable, fabulous, amazing. If false, the following list: incredible, unbelievable, fabulous, amazing will be equivalent to: incredible, unbelievable, fabulous, amazing =&gt; incredible. Default is true.

IgnoreCase

Gets or sets a value indicating whether to case-fold input for matching. Default is false.

Name

Gets or sets the name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters.

(Inherited from TokenFilter)
Synonyms

Gets or sets a list of synonyms in following one of two formats: 1. incredible, unbelievable, fabulous =&gt; amazing - all terms on the left side of =&gt; symbol will be replaced with all terms on its right side; 2. incredible, unbelievable, fabulous, amazing - comma separated list of equivalent words. Set the expand option to change how this list is interpreted.

Methods

Validate()

Validate the object.

Applies to