SynonymTokenFilter Class

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Service.dll

Package:

Microsoft.Azure.Search.Service v10.1.0

Source:

SynonymTokenFilter.cs

Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/synonym/SynonymFilter.html

[Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.SynonymTokenFilter")]
public class SynonymTokenFilter : Microsoft.Azure.Search.Models.TokenFilter

[<Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.SynonymTokenFilter")>]
type SynonymTokenFilter = class
    inherit TokenFilter

Public Class SynonymTokenFilter
Inherits TokenFilter

Inheritance

Object

TokenFilter

SynonymTokenFilter

Attributes

Newtonsoft.Json.JsonObjectAttribute

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 => 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.
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 => 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.

Methods

Validate()

Validate the object.