Feedback Edit

NGramTokenFilter Class

  • Reference

Generates n-grams of the given size(s). 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
NGramTokenFilter

Constructor

NGramTokenFilter(*, name: str, min_gram: Optional[int] = 1, max_gram: Optional[int] = 2, **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.

min_gram
int
Required

The minimum n-gram length. Default is 1. Must be less than the value of maxGram.

max_gram
int
Required

The maximum n-gram length. Default is 2.