Class CommonGramTokenFilter

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.

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

Constructors

CommonGramTokenFilter(String, IEnumerable<String>)

Initializes a new instance of CommonGramTokenFilter.

Declaration
public CommonGramTokenFilter (string name, System.Collections.Generic.IEnumerable<string> commonWords);
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.
System.Collections.Generic.IEnumerable<System.String> commonWords

The set of common words.
Exceptions
System.ArgumentNullException

name or commonWords is null.

Properties

CommonWords

The set of common words.

Declaration
public System.Collections.Generic.IList<string> CommonWords { get; }
Property Value
System.Collections.Generic.IList<System.String>

IgnoreCase

A value indicating whether common words matching will be case insensitive. Default is false.

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

UseQueryMode

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.

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