Package version:

Interface ShingleTokenFilter

Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene.

interface ShingleTokenFilter {
    filterToken?: string;
    maxShingleSize?: number;
    minShingleSize?: number;
    name: string;
    odatatype: "#Microsoft.Azure.Search.ShingleTokenFilter";
    outputUnigrams?: boolean;
    outputUnigramsIfNoShingles?: boolean;
    tokenSeparator?: string;
}

Hierarchy (view full)

Properties

filterToken? maxShingleSize? minShingleSize? name odatatype outputUnigrams? outputUnigramsIfNoShingles? tokenSeparator?

Properties

OptionalfilterToken

filterToken?: string

The string to insert for each position at which there is no token. Default is an underscore ("_").

OptionalmaxShingleSize

maxShingleSize?: number

The maximum shingle size. Default and minimum value is 2.

OptionalminShingleSize

minShingleSize?: number

The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize.

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

OptionaloutputUnigrams

outputUnigrams?: boolean

A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true.

OptionaloutputUnigramsIfNoShingles

outputUnigramsIfNoShingles?: boolean

A value indicating whether to output unigrams for those times when no shingles are available. This property takes precedence when outputUnigrams is set to false. Default is false.

OptionaltokenSeparator

tokenSeparator?: string

The string to use when joining adjacent tokens to form a shingle. Default is a single space (" ").

Settings

Member Visibility