SearchModelFactory.CommonGramTokenFilter Method

Definition

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.

public static Azure.Search.Documents.Indexes.Models.CommonGramTokenFilter CommonGramTokenFilter(string name = default, System.Collections.Generic.IEnumerable<string> commonWords = default, bool? ignoreCase = default, bool? useQueryMode = default);
static member CommonGramTokenFilter : string * seq<string> * Nullable<bool> * Nullable<bool> -> Azure.Search.Documents.Indexes.Models.CommonGramTokenFilter
Public Shared Function CommonGramTokenFilter (Optional name As String = Nothing, Optional commonWords As IEnumerable(Of String) = Nothing, Optional ignoreCase As Nullable(Of Boolean) = Nothing, Optional useQueryMode As Nullable(Of Boolean) = Nothing) As CommonGramTokenFilter

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.

commonWords
IEnumerable<String>

The set of common words.

ignoreCase
Nullable<Boolean>

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

useQueryMode
Nullable<Boolean>

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.

Returns

A new CommonGramTokenFilter instance for mocking.

Applies to