Class WordDelimiterTokenFilter

Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene.

Inheritance
System.Object
TokenFilter
WordDelimiterTokenFilter
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Search.Documents.dll
Syntax
public class WordDelimiterTokenFilter : Azure.Search.Documents.Indexes.Models.TokenFilter

Constructors

WordDelimiterTokenFilter(String)

Initializes a new instance of WordDelimiterTokenFilter.

Declaration
public WordDelimiterTokenFilter (string name);
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.
Exceptions
System.ArgumentNullException

name is null.

Properties

CatenateAll

A value indicating whether all subword parts will be catenated. For example, if this is set to true, "Azure-Search-1" becomes "AzureSearch1". Default is false.

Declaration
public Nullable<bool> CatenateAll { get; set; }
Property Value
System.Nullable<System.Boolean>

CatenateNumbers

A value indicating whether maximum runs of number parts will be catenated. For example, if this is set to true, "1-2" becomes "12". Default is false.

Declaration
public Nullable<bool> CatenateNumbers { get; set; }
Property Value
System.Nullable<System.Boolean>

CatenateWords

A value indicating whether maximum runs of word parts will be catenated. For example, if this is set to true, "Azure-Search" becomes "AzureSearch". Default is false.

Declaration
public Nullable<bool> CatenateWords { get; set; }
Property Value
System.Nullable<System.Boolean>

GenerateNumberParts

A value indicating whether to generate number subwords. Default is true.

Declaration
public Nullable<bool> GenerateNumberParts { get; set; }
Property Value
System.Nullable<System.Boolean>

GenerateWordParts

A value indicating whether to generate part words. If set, causes parts of words to be generated; for example "AzureSearch" becomes "Azure" "Search". Default is true.

Declaration
public Nullable<bool> GenerateWordParts { get; set; }
Property Value
System.Nullable<System.Boolean>

PreserveOriginal

A value indicating whether original words will be preserved and added to the subword list. Default is false.

Declaration
public Nullable<bool> PreserveOriginal { get; set; }
Property Value
System.Nullable<System.Boolean>

ProtectedWords

A list of tokens to protect from being delimited.

Declaration
public System.Collections.Generic.IList<string> ProtectedWords { get; }
Property Value
System.Collections.Generic.IList<System.String>

SplitOnCaseChange

A value indicating whether to split words on caseChange. For example, if this is set to true, "AzureSearch" becomes "Azure" "Search". Default is true.

Declaration
public Nullable<bool> SplitOnCaseChange { get; set; }
Property Value
System.Nullable<System.Boolean>

SplitOnNumerics

A value indicating whether to split on numbers. For example, if this is set to true, "Azure1Search" becomes "Azure" "1" "Search". Default is true.

Declaration
public Nullable<bool> SplitOnNumerics { get; set; }
Property Value
System.Nullable<System.Boolean>

StemEnglishPossessive

A value indicating whether to remove trailing "'s" for each subword. Default is true.

Declaration
public Nullable<bool> StemEnglishPossessive { get; set; }
Property Value
System.Nullable<System.Boolean>