Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SynonymTokenFilter

Package version

Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene.

Hierarchy

  • SynonymTokenFilter

Index

Properties

Optional expand

expand: undefined | false | true

A value indicating whether all words in the list of synonyms (if => notation is not used) will map to one another. If true, all words in the list of synonyms (if => notation is not used) will map to one another. The following list: incredible, unbelievable, fabulous, amazing is equivalent to: incredible, unbelievable, fabulous, amazing => incredible, unbelievable, fabulous, amazing. If false, the following list: incredible, unbelievable, fabulous, amazing will be equivalent to: incredible, unbelievable, fabulous, amazing => incredible. Default is true. Default value: true.

Optional ignoreCase

ignoreCase: undefined | false | true

A value indicating whether to case-fold input for matching. Default is false. Default value: false.

name

name: string

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.

odatatype

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

Polymorphic Discriminator

synonyms

synonyms: string[]

A list of synonyms in following one of two formats: 1. incredible, unbelievable, fabulous => amazing - all terms on the left side of => symbol will be replaced with all terms on its right side; 2. incredible, unbelievable, fabulous, amazing - comma separated list of equivalent words. Set the expand option to change how this list is interpreted.

Generated using TypeDoc