Interface IWordDelimiterGraphTokenFilter

Named word_delimiter, it Splits words into subwords and performs optional transformations on subword groups. Unlike the word_delimiter this token filter named word_delimiter_graph correctly handles multi terms expansion at query time.

Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IWordDelimiterGraphTokenFilter : ITokenFilter

Properties

| Edit this page View Source

AdjustOffsets

By default, the filter tries to output subtokens with adjusted offsets to reflect their actual position in the token stream. However, when used in combination with other filters that alter the length or starting position of tokens without changing their offsets (e.g. TrimTokenFilter) this can cause tokens with illegal offsets to be emitted. Setting AdjustOffsets to false will stop WordDelimiterGraphTokenFilter from adjusting these internal offsets.

Declaration
[DataMember(Name = "adjust_offsets")]
bool? AdjustOffsets { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

CatenateAll

If true causes all subword parts to be catenated: "wi-fi-4000" ⇒ "wifi4000". Defaults to false.

Declaration
[DataMember(Name = "catenate_all")]
bool? CatenateAll { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

CatenateNumbers

If true causes maximum runs of number parts to be catenated: "500-42" ⇒ "50042". Defaults to false.

Declaration
[DataMember(Name = "catenate_numbers")]
bool? CatenateNumbers { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

CatenateWords

If true causes maximum runs of word parts to be catenated: "wi-fi" ⇒ "wifi". Defaults to false.

Declaration
[DataMember(Name = "catenate_words")]
bool? CatenateWords { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

GenerateNumberParts

If true causes number subwords to be generated: "500-42" ⇒ "500" "42". Defaults to true.

Declaration
[DataMember(Name = "generate_number_parts")]
bool? GenerateNumberParts { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

GenerateWordParts

If true causes parts of words to be generated: "PowerShot" ⇒ "Power" "Shot". Defaults to true.

Declaration
[DataMember(Name = "generate_word_parts")]
bool? GenerateWordParts { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

IgnoreKeywords

If true, the filter skips tokens with a keyword attribute of true. Defaults to false.

Declaration
[DataMember(Name = "ignore_keywords")]
bool? IgnoreKeywords { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

PreserveOriginal

If true includes original words in subwords: "500-42" ⇒ "500-42" "500" "42". Defaults to false.

Declaration
[DataMember(Name = "preserve_original")]
bool? PreserveOriginal { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

ProtectedWords

A list of protected words from being delimiter.

Declaration
[DataMember(Name = "protected_words")]
IEnumerable<string> ProtectedWords { get; set; }
Property Value
Type Description
IEnumerable<string>
| Edit this page View Source

ProtectedWordsPath

protected_words_path which resolved to a file configured with protected words (one on each line). Automatically resolves to config/ based location if exists.

Declaration
[DataMember(Name = "protected_words_path ")]
string ProtectedWordsPath { get; set; }
Property Value
Type Description
string
| Edit this page View Source

SplitOnCaseChange

If true causes "PowerShot" to be two tokens; ("Power-Shot" remains two parts regards). Defaults to true.

Declaration
[DataMember(Name = "split_on_case_change")]
bool? SplitOnCaseChange { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

SplitOnNumerics

If true causes "j2se" to be three tokens; "j" "2" "se". Defaults to true.

Declaration
[DataMember(Name = "split_on_numerics")]
bool? SplitOnNumerics { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

StemEnglishPossessive

If true causes trailing "'s" to be removed for each subword: "O’Neil’s" ⇒ "O", "Neil". Defaults to true.

Declaration
[DataMember(Name = "stem_english_possessive")]
bool? StemEnglishPossessive { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

TypeTable

A custom type mapping table

Declaration
[DataMember(Name = "type_table")]
IEnumerable<string> TypeTable { get; set; }
Property Value
Type Description
IEnumerable<string>
| Edit this page View Source

TypeTablePath

A path to a custom type mapping table file

Declaration
[DataMember(Name = "type_table_path")]
string TypeTablePath { get; set; }
Property Value
Type Description
string

Extension Methods