SearchModelFactory.SynonymTokenFilter Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene.
public static Azure.Search.Documents.Indexes.Models.SynonymTokenFilter SynonymTokenFilter(string name = default, System.Collections.Generic.IEnumerable<string> synonyms = default, bool? ignoreCase = default, bool? expand = default);static member SynonymTokenFilter : string * seq<string> * Nullable<bool> * Nullable<bool> -> Azure.Search.Documents.Indexes.Models.SynonymTokenFilterPublic Shared Function SynonymTokenFilter (Optional name As String = Nothing, Optional synonyms As IEnumerable(Of String) = Nothing, Optional ignoreCase As Nullable(Of Boolean) = Nothing, Optional expand As Nullable(Of Boolean) = Nothing) As SynonymTokenFilterParameters
- name
- String
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.
- synonyms
- IEnumerable<String>
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.
A value indicating whether to case-fold input for matching. Default is false.
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.
Returns
A new SynonymTokenFilter instance for mocking.
