Package version:

Interface EdgeNGramTokenFilter

Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.

interface EdgeNGramTokenFilter {
    maxGram?: number;
    minGram?: number;
    name: string;
    odatatype: "#Microsoft.Azure.Search.EdgeNGramTokenFilter" | "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2";
    side?: EdgeNGramTokenFilterSide;
}

Properties

maxGram? minGram? name odatatype side?

Properties

OptionalmaxGram

maxGram?: number

The maximum n-gram length. Default is 2. Maximum is 300. Default value: 2.

OptionalminGram

minGram?: number

The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram. Default value: 1.

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: "#Microsoft.Azure.Search.EdgeNGramTokenFilter" | "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2"

Polymorphic Discriminator

Optionalside

side?: EdgeNGramTokenFilterSide

Specifies which side of the input the n-gram should be generated from. Default is "front". Possible values include: 'Front', 'Back'

Settings

Member Visibility