Package version:

Interface WordDelimiterTokenFilter

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

interface WordDelimiterTokenFilter {
    catenateAll?: boolean;
    catenateNumbers?: boolean;
    catenateWords?: boolean;
    generateNumberParts?: boolean;
    generateWordParts?: boolean;
    name: string;
    odatatype: "#Microsoft.Azure.Search.WordDelimiterTokenFilter";
    preserveOriginal?: boolean;
    protectedWords?: string[];
    splitOnCaseChange?: boolean;
    splitOnNumerics?: boolean;
    stemEnglishPossessive?: boolean;
}

Hierarchy (view full)

Properties

catenateAll? catenateNumbers? catenateWords? generateNumberParts? generateWordParts? name odatatype preserveOriginal? protectedWords? splitOnCaseChange? splitOnNumerics? stemEnglishPossessive?

Properties

OptionalcatenateAll

catenateAll?: boolean

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.

OptionalcatenateNumbers

catenateNumbers?: boolean

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.

OptionalcatenateWords

catenateWords?: boolean

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.

OptionalgenerateNumberParts

generateNumberParts?: boolean

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

OptionalgenerateWordParts

generateWordParts?: boolean

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.

name

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.

odatatype

odatatype

Polymorphic discriminator, which specifies the different types this object can be

OptionalpreserveOriginal

preserveOriginal?: boolean

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

OptionalprotectedWords

protectedWords?: string[]

A list of tokens to protect from being delimited.

OptionalsplitOnCaseChange

splitOnCaseChange?: boolean

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

OptionalsplitOnNumerics

splitOnNumerics?: boolean

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

OptionalstemEnglishPossessive

stemEnglishPossessive?: boolean

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

Settings

Member Visibility