Share via

ShingleTokenFilter Class

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
ShingleTokenFilter.cs
Source:
ShingleTokenFilter.cs

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

public class ShingleTokenFilter : Azure.Search.Documents.Indexes.Models.TokenFilter
type ShingleTokenFilter = class
    inherit TokenFilter
Public Class ShingleTokenFilter
Inherits TokenFilter
Inheritance
Object
TokenFilter
ShingleTokenFilter

Constructors

ShingleTokenFilter(String)

Initializes a new instance of ShingleTokenFilter.

Properties

FilterToken

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

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

The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize.
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.

(Inherited from TokenFilter)
OutputUnigrams

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

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.
TokenSeparator

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

Applies to