StopwordsTokenFilter interface

  • Reference
Package:
@azure/search-documents

Removes stop words from a token stream. This token filter is implemented using Apache Lucene.

Extends
BaseTokenFilter

Properties

ignoreCase

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

Polymorphic discriminator, which specifies the different types this object can be
removeTrailingStopWords

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

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

A predefined list of stopwords to use. This property and the stopwords property cannot both be set. Default is English.

Inherited Properties

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.

Property Details

ignoreCase

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

ignoreCase?: boolean

Property Value

boolean

odatatype

Polymorphic discriminator, which specifies the different types this object can be

odatatype: "#Microsoft.Azure.Search.StopwordsTokenFilter"

Property Value

"#Microsoft.Azure.Search.StopwordsTokenFilter"

removeTrailingStopWords

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

removeTrailingStopWords?: boolean

Property Value

boolean

stopwords

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

stopwords?: string[]

Property Value

string[]

stopwordsList

A predefined list of stopwords to use. This property and the stopwords property cannot both be set. Default is English.

stopwordsList?: StopwordsList

Property Value

StopwordsList

Inherited Property Details

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.

name: string

Property Value

string

Inherited From BaseTokenFilter.name