NGramTokenFilter Class

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Service.dll

Package:

Microsoft.Azure.Search.Service v10.1.0

Source:

NGramTokenFilter.cs

Caution

This type is obsolete. Please use NGramTokenFilterV2 instead.

Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html

[Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.NGramTokenFilter")]
[System.Obsolete("This type is obsolete. Please use NGramTokenFilterV2 instead.")]
public class NGramTokenFilter : Microsoft.Azure.Search.Models.TokenFilter

[<Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.NGramTokenFilter")>]
[<System.Obsolete("This type is obsolete. Please use NGramTokenFilterV2 instead.")>]
type NGramTokenFilter = class
    inherit TokenFilter

Public Class NGramTokenFilter
Inherits TokenFilter

Inheritance

Object

TokenFilter

NGramTokenFilter

Attributes

Newtonsoft.Json.JsonObjectAttribute ObsoleteAttribute

Constructors

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

Properties

MaxGram	Gets or sets the maximum n-gram length. Default is 2.
MinGram	Gets or sets the minimum n-gram length. Default is 1. Must be less than the value of minGram.
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)

Methods

Validate()

Validate the object.