Package version:

Interface NGramTokenFilter

Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.

interface NGramTokenFilter {
    maxGram?: number;
    minGram?: number;
    name: string;
    odatatype: "#Microsoft.Azure.Search.NGramTokenFilter" | "#Microsoft.Azure.Search.NGramTokenFilterV2";
}

Properties

maxGram? minGram? name odatatype

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.NGramTokenFilter" | "#Microsoft.Azure.Search.NGramTokenFilterV2"

Polymorphic Discriminator

Settings

Member Visibility