StopwordsTokenFilter Class

Removes stop words from a token stream. 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

StopwordsTokenFilter

Constructor

StopwordsTokenFilter(*, name: str, stopwords: Optional[List[str]] = None, stopwords_list: Optional[Union[str, azure.search.documents.indexes._generated.models._search_client_enums.StopwordsList]] = None, ignore_case: Optional[bool] = False, remove_trailing_stop_words: Optional[bool] = True, **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.

stopwords

list[str]

Required

The list of stopwords. This property and the stopwords list property cannot both be set.

stopwords_list

str or StopwordsList

Required

A predefined list of stopwords to use. This property and the stopwords property cannot both be set. Default is English. Possible values include: "arabic", "armenian", "basque", "brazilian", "bulgarian", "catalan", "czech", "danish", "dutch", "english", "finnish", "french", "galician", "german", "greek", "hindi", "hungarian", "indonesian", "irish", "italian", "latvian", "norwegian", "persian", "portuguese", "romanian", "russian", "sorani", "spanish", "swedish", "thai", "turkish".

ignore_case

bool

Required

A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false.

remove_trailing_stop_words

bool

Required

A value indicating whether to ignore the last search term if it's a stop word. Default is true.