CommonGramTokenFilter Class

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.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.search.documents.indexes._generated.models._models_py3.TokenFilter

CommonGramTokenFilter

Constructor

CommonGramTokenFilter(*, name: str, common_words: List[str], ignore_case: Optional[bool] = False, use_query_mode: Optional[bool] = False, **kwargs)

Parameters

odata_type

str

Required

Required. Identifies the concrete type of the token filter.Constant filled by server.

name

str

Required

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

common_words

list[str]

Required

Required. The set of common words.

ignore_case

bool

Required

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

use_query_mode

bool

Required

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.