Class ShingleTokenFilter

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

Inheritance
System.Object
TokenFilter
ShingleTokenFilter
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Search.Documents.dll
Syntax
public class ShingleTokenFilter : Azure.Search.Documents.Indexes.Models.TokenFilter

Constructors

ShingleTokenFilter(String)

Initializes a new instance of ShingleTokenFilter.

Declaration
public ShingleTokenFilter (string name);
Parameters
System.String 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.
Exceptions
System.ArgumentNullException

name is null.

Properties

FilterToken

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

Declaration
public string FilterToken { get; set; }
Property Value
System.String

MaxShingleSize

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

Declaration
public Nullable<int> MaxShingleSize { get; set; }
Property Value
System.Nullable<System.Int32>

MinShingleSize

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

Declaration
public Nullable<int> MinShingleSize { get; set; }
Property Value
System.Nullable<System.Int32>

OutputUnigrams

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

Declaration
public Nullable<bool> OutputUnigrams { get; set; }
Property Value
System.Nullable<System.Boolean>

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.

Declaration
public Nullable<bool> OutputUnigramsIfNoShingles { get; set; }
Property Value
System.Nullable<System.Boolean>

TokenSeparator

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

Declaration
public string TokenSeparator { get; set; }
Property Value
System.String