Share via

PatternAnalyzer interface

  • Reference
Package:
@azure/search-documents

Flexibly separates text into terms via a regular expression pattern. This analyzer is implemented using Apache Lucene.

Properties

flags

Regular expression flags. Possible values include: 'CANON_EQ', 'CASE_INSENSITIVE', 'COMMENTS', 'DOTALL', 'LITERAL', 'MULTILINE', 'UNICODE_CASE', 'UNIX_LINES'
lowerCaseTerms

A value indicating whether terms should be lower-cased. Default is true. Default value: true.
name

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

Polymorphic Discriminator
pattern

A regular expression pattern to match token separators. Default is an expression that matches one or more whitespace characters. Default value: \W+.
stopwords

A list of stopwords.

Property Details

flags

Regular expression flags. Possible values include: 'CANON_EQ', 'CASE_INSENSITIVE', 'COMMENTS', 'DOTALL', 'LITERAL', 'MULTILINE', 'UNICODE_CASE', 'UNIX_LINES'

flags?: ("CANON_EQ" | "CASE_INSENSITIVE" | "COMMENTS" | "DOTALL" | "LITERAL" | "MULTILINE" | "UNICODE_CASE" | "UNIX_LINES")[]

Property Value

("CANON_EQ" | "CASE_INSENSITIVE" | "COMMENTS" | "DOTALL" | "LITERAL" | "MULTILINE" | "UNICODE_CASE" | "UNIX_LINES")[]

lowerCaseTerms

A value indicating whether terms should be lower-cased. Default is true. Default value: true.

lowerCaseTerms?: boolean

Property Value

boolean

name

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

odatatype

Polymorphic Discriminator

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

Property Value

"#Microsoft.Azure.Search.PatternAnalyzer"

pattern

A regular expression pattern to match token separators. Default is an expression that matches one or more whitespace characters. Default value: \W+.

pattern?: string

Property Value

string

stopwords

A list of stopwords.

stopwords?: string[]

Property Value

string[]