CommonGramTokenFilter Class

Definition

Namespace:

Microsoft.Azure.Search.Models

Assembly:

Microsoft.Azure.Search.Service.dll

Package:

Microsoft.Azure.Search.Service v10.1.0

Source:

CommonGramTokenFilter.cs

Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. This token filter is implemented using Apache Lucene. http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html

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

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

Public Class CommonGramTokenFilter
Inherits TokenFilter

Inheritance

Object

TokenFilter

CommonGramTokenFilter

Attributes

Newtonsoft.Json.JsonObjectAttribute

Constructors

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

Properties

CommonWords	Gets or sets the set of common words.
IgnoreCase	Gets or sets a value indicating whether common words matching will be case insensitive. Default is false.
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)
UseQueryMode	Gets or sets a value that indicates whether the token filter is in query mode. When in query mode, the token filter generates bigrams and then removes common words and single terms followed by a common word. Default is false.

Methods

Validate()

Validate the object.