ShingleTokenFilter Class

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Service.dll

Package:

Microsoft.Azure.Search.Service v10.1.0

Source:

ShingleTokenFilter.cs

Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html

[Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.ShingleTokenFilter")]
public class ShingleTokenFilter : Microsoft.Azure.Search.Models.TokenFilter

[<Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.ShingleTokenFilter")>]
type ShingleTokenFilter = class
    inherit TokenFilter

Public Class ShingleTokenFilter
Inherits TokenFilter

Inheritance

Object

TokenFilter

ShingleTokenFilter

Attributes

Newtonsoft.Json.JsonObjectAttribute

Constructors

ShingleTokenFilter()	Initializes a new instance of the ShingleTokenFilter class.
ShingleTokenFilter(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, String, String)	Initializes a new instance of the ShingleTokenFilter class.

Properties

FilterToken	Gets or sets the string to insert for each position at which there is no token. Default is an underscore ("_").
MaxShingleSize	Gets or sets the maximum shingle size. Default and minimum value is 2.
MinShingleSize	Gets or sets the minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize.
Name	Gets or sets 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	Gets or sets a value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true.
OutputUnigramsIfNoShingles	Gets or sets 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	Gets or sets the string to use when joining adjacent tokens to form a shingle. Default is a single space (" ").

Methods

Validate()

Validate the object.