Class SynonymTokenFilter
Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene.
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Search.Documents.dll
Syntax
public class SynonymTokenFilter : Azure.Search.Documents.Indexes.Models.TokenFilterConstructors
SynonymTokenFilter(String, IEnumerable<String>)
Initializes a new instance of SynonymTokenFilter.
Declaration
public SynonymTokenFilter (string name, System.Collections.Generic.IEnumerable<string> synonyms);Parameters
|
System.String
name
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. |
|
System.Collections.Generic.IEnumerable<System.String>
synonyms
A list of synonyms in following one of two formats: 1. incredible, unbelievable, fabulous => amazing - all terms on the left side of => 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. |
Exceptions
|
System.ArgumentNullException
|
Properties
Expand
A value indicating whether all words in the list of synonyms (if => notation is not used) will map to one another. If true, all words in the list of synonyms (if => notation is not used) will map to one another. The following list: incredible, unbelievable, fabulous, amazing is equivalent to: incredible, unbelievable, fabulous, amazing => incredible, unbelievable, fabulous, amazing. If false, the following list: incredible, unbelievable, fabulous, amazing will be equivalent to: incredible, unbelievable, fabulous, amazing => incredible. Default is true.
Declaration
public Nullable<bool> Expand { get; set; }Property Value
|
System.Nullable<System.Boolean>
|
IgnoreCase
A value indicating whether to case-fold input for matching. Default is false.
Declaration
public Nullable<bool> IgnoreCase { get; set; }Property Value
|
System.Nullable<System.Boolean>
|
Synonyms
A list of synonyms in following one of two formats: 1. incredible, unbelievable, fabulous => amazing - all terms on the left side of => 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.
Declaration
public System.Collections.Generic.IList<string> Synonyms { get; }Property Value
|
System.Collections.Generic.IList<System.String>
|