PatternReplaceCharFilter interface

  • Reference
Package:
@azure/search-documents

A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text "aa bb aa bb", pattern "(aa)\s+(bb)", and replacement "$1#$2", the result would be "aa#bb aa#bb". This character filter is implemented using Apache Lucene.

Extends
BaseCharFilter

Properties

odatatype

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

A regular expression pattern.
replacement

The replacement text.

Inherited Properties

name

The name of the char 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

odatatype

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

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

Property Value

"#Microsoft.Azure.Search.PatternReplaceCharFilter"

pattern

A regular expression pattern.

pattern: string

Property Value

string

replacement

The replacement text.

replacement: string

Property Value

string

Inherited Property Details

name

The name of the char 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 BaseCharFilter.name