ShingleTokenFilter Constructors

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Service.dll

Package:

Microsoft.Azure.Search.Service v10.1.0

Overloads

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.

ShingleTokenFilter()

Source:

ShingleTokenFilter.cs

Initializes a new instance of the ShingleTokenFilter class.

public ShingleTokenFilter ();

Public Sub New ()

ShingleTokenFilter(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, String, String)

Source:

ShingleTokenFilter.cs

Initializes a new instance of the ShingleTokenFilter class.

public ShingleTokenFilter (string name, int? maxShingleSize = default, int? minShingleSize = default, bool? outputUnigrams = default, bool? outputUnigramsIfNoShingles = default, string tokenSeparator = default, string filterToken = default);

new Microsoft.Azure.Search.Models.ShingleTokenFilter : string * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * string * string -> Microsoft.Azure.Search.Models.ShingleTokenFilter

Public Sub New (name As String, Optional maxShingleSize As Nullable(Of Integer) = Nothing, Optional minShingleSize As Nullable(Of Integer) = Nothing, Optional outputUnigrams As Nullable(Of Boolean) = Nothing, Optional outputUnigramsIfNoShingles As Nullable(Of Boolean) = Nothing, Optional tokenSeparator As String = Nothing, Optional filterToken As String = Nothing)

Parameters

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.

maxShingleSize

Nullable<Int32>

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

minShingleSize

Nullable<Int32>

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

outputUnigrams

Nullable<Boolean>

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

outputUnigramsIfNoShingles

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

tokenSeparator

String

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

filterToken

String

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