Share via

KeepTokenFilter interface

  • Reference
Package:
@azure/search-documents

A token filter that only keeps tokens with text contained in a specified list of words. This token filter is implemented using Apache Lucene.

Extends
BaseTokenFilter

Properties

keepWords

The list of words to keep.
lowerCaseKeepWords

A value indicating whether to lower case all words first. Default is false.
odatatype

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

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

keepWords

The list of words to keep.

keepWords: string[]

Property Value

string[]

lowerCaseKeepWords

A value indicating whether to lower case all words first. Default is false.

lowerCaseKeepWords?: boolean

Property Value

boolean

odatatype

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

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

Property Value

"#Microsoft.Azure.Search.KeepTokenFilter"

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