Search Results for

    Show / Hide Table of Contents

    Class AnalyzeTokenFiltersDescriptor

    Inheritance
    object
    DescriptorPromiseBase<AnalyzeTokenFiltersDescriptor, AnalyzeTokenFilters>
    AnalyzeTokenFiltersDescriptor
    Implements
    IDescriptor
    IPromise<AnalyzeTokenFilters>
    Inherited Members
    DescriptorPromiseBase<AnalyzeTokenFiltersDescriptor, AnalyzeTokenFilters>.Self
    DescriptorPromiseBase<AnalyzeTokenFiltersDescriptor, AnalyzeTokenFilters>.Assign(Action<AnalyzeTokenFilters>)
    DescriptorPromiseBase<AnalyzeTokenFiltersDescriptor, AnalyzeTokenFilters>.Assign<TNewValue>(TNewValue, Action<AnalyzeTokenFilters, TNewValue>)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public class AnalyzeTokenFiltersDescriptor : DescriptorPromiseBase<AnalyzeTokenFiltersDescriptor, AnalyzeTokenFilters>, IDescriptor, IPromise<AnalyzeTokenFilters>

    Constructors

    | Edit this page View Source

    AnalyzeTokenFiltersDescriptor()

    Declaration
    public AnalyzeTokenFiltersDescriptor()

    Methods

    | Edit this page View Source

    AsciiFolding(Func<AsciiFoldingTokenFilterDescriptor, IAsciiFoldingTokenFilter>)

    A token filter of type asciifolding that converts alphabetic, numeric, and symbolic Unicode characters which are

    not in the first 127 ASCII characters (the “Basic Latin” Unicode block) into their ASCII equivalents, if one exists.

    Declaration
    public AnalyzeTokenFiltersDescriptor AsciiFolding(Func<AsciiFoldingTokenFilterDescriptor, IAsciiFoldingTokenFilter> selector)
    Parameters
    Type Name Description
    Func<AsciiFoldingTokenFilterDescriptor, IAsciiFoldingTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    CommonGrams(Func<CommonGramsTokenFilterDescriptor, ICommonGramsTokenFilter>)

    Token filter that generates bigrams for frequently occuring terms. Single terms are still indexed.

    Note, common_words or common_words_path field is required.

    Declaration
    public AnalyzeTokenFiltersDescriptor CommonGrams(Func<CommonGramsTokenFilterDescriptor, ICommonGramsTokenFilter> selector)
    Parameters
    Type Name Description
    Func<CommonGramsTokenFilterDescriptor, ICommonGramsTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Condition(Func<ConditionTokenFilterDescriptor, IConditionTokenFilter>)

    The conditional token filter takes a predicate script and a list of subfilters, and only applies the subfilters to the current token if it matches the predicate.

    Declaration
    public AnalyzeTokenFiltersDescriptor Condition(Func<ConditionTokenFilterDescriptor, IConditionTokenFilter> selector)
    Parameters
    Type Name Description
    Func<ConditionTokenFilterDescriptor, IConditionTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    DelimitedPayload(Func<DelimitedPayloadTokenFilterDescriptor, IDelimitedPayloadTokenFilter>)

    Splits tokens into tokens and payload whenever a delimiter character is found.

    Declaration
    public AnalyzeTokenFiltersDescriptor DelimitedPayload(Func<DelimitedPayloadTokenFilterDescriptor, IDelimitedPayloadTokenFilter> selector)
    Parameters
    Type Name Description
    Func<DelimitedPayloadTokenFilterDescriptor, IDelimitedPayloadTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    DictionaryDecompounder(Func<DictionaryDecompounderTokenFilterDescriptor, IDictionaryDecompounderTokenFilter>)

    Token filters that allow to decompose compound words using a dictionary

    Declaration
    public AnalyzeTokenFiltersDescriptor DictionaryDecompounder(Func<DictionaryDecompounderTokenFilterDescriptor, IDictionaryDecompounderTokenFilter> selector)
    Parameters
    Type Name Description
    Func<DictionaryDecompounderTokenFilterDescriptor, IDictionaryDecompounderTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    EdgeNGram(Func<EdgeNGramTokenFilterDescriptor, IEdgeNGramTokenFilter>)

    A token filter of type edgeNGram.

    Declaration
    public AnalyzeTokenFiltersDescriptor EdgeNGram(Func<EdgeNGramTokenFilterDescriptor, IEdgeNGramTokenFilter> selector)
    Parameters
    Type Name Description
    Func<EdgeNGramTokenFilterDescriptor, IEdgeNGramTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Elision(Func<ElisionTokenFilterDescriptor, IElisionTokenFilter>)

    A token filter which removes elisions. For example, “l’avion” (the plane) will tokenized as “avion” (plane).

    Declaration
    public AnalyzeTokenFiltersDescriptor Elision(Func<ElisionTokenFilterDescriptor, IElisionTokenFilter> selector)
    Parameters
    Type Name Description
    Func<ElisionTokenFilterDescriptor, IElisionTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Fingerprint(Func<FingerprintTokenFilterDescriptor, IFingerprintTokenFilter>)

    A token filter of type fingerprint The fingerprint token filter that emits a single token which is useful for fingerprinting a body of text, and/or providing a token that can be clustered on. It does this by sorting the tokens, deduplicating and then concatenating them back into a single token.

    Declaration
    public AnalyzeTokenFiltersDescriptor Fingerprint(Func<FingerprintTokenFilterDescriptor, IFingerprintTokenFilter> selector = null)
    Parameters
    Type Name Description
    Func<FingerprintTokenFilterDescriptor, IFingerprintTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Hunspell(Func<HunspellTokenFilterDescriptor, IHunspellTokenFilter>)

    Basic support for hunspell stemming.

    Hunspell dictionaries will be picked up from a dedicated hunspell directory on the filesystem.

    Declaration
    public AnalyzeTokenFiltersDescriptor Hunspell(Func<HunspellTokenFilterDescriptor, IHunspellTokenFilter> selector)
    Parameters
    Type Name Description
    Func<HunspellTokenFilterDescriptor, IHunspellTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    HyphenationDecompounder(Func<HyphenationDecompounderTokenFilterDescriptor, IHyphenationDecompounderTokenFilter>)

    Token filters that allow to decompose compound words using FOP XML

    Declaration
    public AnalyzeTokenFiltersDescriptor HyphenationDecompounder(Func<HyphenationDecompounderTokenFilterDescriptor, IHyphenationDecompounderTokenFilter> selector)
    Parameters
    Type Name Description
    Func<HyphenationDecompounderTokenFilterDescriptor, IHyphenationDecompounderTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    IcuCollation(Func<IcuCollationTokenFilterDescriptor, IIcuCollationTokenFilter>)

    Collations are used for sorting documents in a language-specific word order. The icu_collation token filter is available to all indices and defaults to using the DUCET collation, which is a best-effort attempt at language-neutral sorting. Part of the analysis-icu plugin:

    Declaration
    public AnalyzeTokenFiltersDescriptor IcuCollation(Func<IcuCollationTokenFilterDescriptor, IIcuCollationTokenFilter> selector)
    Parameters
    Type Name Description
    Func<IcuCollationTokenFilterDescriptor, IIcuCollationTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    IcuFolding(Func<IcuFoldingTokenFilterDescriptor, IIcuFoldingTokenFilter>)

    Case folding of Unicode characters based on UTR#30, like the ASCII-folding token filter on steroids. Part of the analysis-icu plugin:

    Declaration
    public AnalyzeTokenFiltersDescriptor IcuFolding(Func<IcuFoldingTokenFilterDescriptor, IIcuFoldingTokenFilter> selector)
    Parameters
    Type Name Description
    Func<IcuFoldingTokenFilterDescriptor, IIcuFoldingTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    IcuNormalization(Func<IcuNormalizationTokenFilterDescriptor, IIcuNormalizationTokenFilter>)

    Normalizes as defined here: http://userguide.icu-project.org/transforms/normalization Part of the analysis-icu plugin:

    Declaration
    public AnalyzeTokenFiltersDescriptor IcuNormalization(Func<IcuNormalizationTokenFilterDescriptor, IIcuNormalizationTokenFilter> selector)
    Parameters
    Type Name Description
    Func<IcuNormalizationTokenFilterDescriptor, IIcuNormalizationTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    IcuTransform(Func<IcuTransformTokenFilterDescriptor, IIcuTransformTokenFilter>)

    Transforms are used to process Unicode text in many different ways, such as case mapping, normalization, transliteration and bidirectional text handling. Part of the analysis-icu plugin:

    Declaration
    public AnalyzeTokenFiltersDescriptor IcuTransform(Func<IcuTransformTokenFilterDescriptor, IIcuTransformTokenFilter> selector)
    Parameters
    Type Name Description
    Func<IcuTransformTokenFilterDescriptor, IIcuTransformTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    KStem(Func<KStemTokenFilterDescriptor, IKStemTokenFilter>)

    The kstem token filter is a high performance filter for english.

    All terms must already be lowercased (use lowercase filter) for this filter to work correctly.

    Declaration
    public AnalyzeTokenFiltersDescriptor KStem(Func<KStemTokenFilterDescriptor, IKStemTokenFilter> selector = null)
    Parameters
    Type Name Description
    Func<KStemTokenFilterDescriptor, IKStemTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    KeepTypes(Func<KeepTypesTokenFilterDescriptor, IKeepTypesTokenFilter>)

    A token filter of type keep that only keeps tokens with text contained in a predefined set of words.

    Declaration
    public AnalyzeTokenFiltersDescriptor KeepTypes(Func<KeepTypesTokenFilterDescriptor, IKeepTypesTokenFilter> selector)
    Parameters
    Type Name Description
    Func<KeepTypesTokenFilterDescriptor, IKeepTypesTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    KeepWords(Func<KeepWordsTokenFilterDescriptor, IKeepWordsTokenFilter>)

    A token filter of type keep that only keeps tokens with text contained in a predefined set of words.

    Declaration
    public AnalyzeTokenFiltersDescriptor KeepWords(Func<KeepWordsTokenFilterDescriptor, IKeepWordsTokenFilter> selector)
    Parameters
    Type Name Description
    Func<KeepWordsTokenFilterDescriptor, IKeepWordsTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    KeywordMarker(Func<KeywordMarkerTokenFilterDescriptor, IKeywordMarkerTokenFilter>)

    Protects words from being modified by stemmers. Must be placed before any stemming filters.

    Declaration
    public AnalyzeTokenFiltersDescriptor KeywordMarker(Func<KeywordMarkerTokenFilterDescriptor, IKeywordMarkerTokenFilter> selector)
    Parameters
    Type Name Description
    Func<KeywordMarkerTokenFilterDescriptor, IKeywordMarkerTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    KuromojiPartOfSpeech(Func<KuromojiPartOfSpeechTokenFilterDescriptor, IKuromojiPartOfSpeechTokenFilter>)

    The kuromoji_part_of_speech token filter removes tokens that match a set of part-of-speech tags. Part of the analysis-kuromoji plugin:

    Declaration
    public AnalyzeTokenFiltersDescriptor KuromojiPartOfSpeech(Func<KuromojiPartOfSpeechTokenFilterDescriptor, IKuromojiPartOfSpeechTokenFilter> selector)
    Parameters
    Type Name Description
    Func<KuromojiPartOfSpeechTokenFilterDescriptor, IKuromojiPartOfSpeechTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    KuromojiReadingForm(Func<KuromojiReadingFormTokenFilterDescriptor, IKuromojiReadingFormTokenFilter>)

    The kuromoji_readingform token filter replaces the token with its reading form in either katakana or romaji. Part of the analysis-kuromoji plugin:

    Declaration
    public AnalyzeTokenFiltersDescriptor KuromojiReadingForm(Func<KuromojiReadingFormTokenFilterDescriptor, IKuromojiReadingFormTokenFilter> selector)
    Parameters
    Type Name Description
    Func<KuromojiReadingFormTokenFilterDescriptor, IKuromojiReadingFormTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    KuromojiStemmer(Func<KuromojiStemmerTokenFilterDescriptor, IKuromojiStemmerTokenFilter>)

    The kuromoji_stemmer token filter normalizes common katakana spelling variations ending in a long sound character by removing this character (U+30FC). Only full-width katakana characters are supported. Part of the analysis-kuromoji plugin:

    Declaration
    public AnalyzeTokenFiltersDescriptor KuromojiStemmer(Func<KuromojiStemmerTokenFilterDescriptor, IKuromojiStemmerTokenFilter> selector = null)
    Parameters
    Type Name Description
    Func<KuromojiStemmerTokenFilterDescriptor, IKuromojiStemmerTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Length(Func<LengthTokenFilterDescriptor, ILengthTokenFilter>)

    A token filter of type length that removes words that are too long or too short for the stream.

    Declaration
    public AnalyzeTokenFiltersDescriptor Length(Func<LengthTokenFilterDescriptor, ILengthTokenFilter> selector)
    Parameters
    Type Name Description
    Func<LengthTokenFilterDescriptor, ILengthTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    LimitTokenCount(Func<LimitTokenCountTokenFilterDescriptor, ILimitTokenCountTokenFilter>)

    Limits the number of tokens that are indexed per document and field.

    Declaration
    public AnalyzeTokenFiltersDescriptor LimitTokenCount(Func<LimitTokenCountTokenFilterDescriptor, ILimitTokenCountTokenFilter> selector)
    Parameters
    Type Name Description
    Func<LimitTokenCountTokenFilterDescriptor, ILimitTokenCountTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Lowercase(Func<LowercaseTokenFilterDescriptor, ILowercaseTokenFilter>)

    A token filter of type lowercase that normalizes token text to lower case.

    Lowercase token filter supports Greek and Turkish lowercase token filters through the language parameter.

    Declaration
    public AnalyzeTokenFiltersDescriptor Lowercase(Func<LowercaseTokenFilterDescriptor, ILowercaseTokenFilter> selector = null)
    Parameters
    Type Name Description
    Func<LowercaseTokenFilterDescriptor, ILowercaseTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Multiplexer(Func<MultiplexerTokenFilterDescriptor, IMultiplexerTokenFilter>)

    A token filter of type multiplexer will emit multiple tokens at the same position, each version of the token having been run through a different filter. Identical output tokens at the same position will be removed.

    Declaration
    public AnalyzeTokenFiltersDescriptor Multiplexer(Func<MultiplexerTokenFilterDescriptor, IMultiplexerTokenFilter> selector)
    Parameters
    Type Name Description
    Func<MultiplexerTokenFilterDescriptor, IMultiplexerTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    NGram(Func<NGramTokenFilterDescriptor, INGramTokenFilter>)

    A token filter of type nGram.

    Declaration
    public AnalyzeTokenFiltersDescriptor NGram(Func<NGramTokenFilterDescriptor, INGramTokenFilter> selector)
    Parameters
    Type Name Description
    Func<NGramTokenFilterDescriptor, INGramTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Name(string)

    A reference to a token filter that is part of the mapping

    Declaration
    public AnalyzeTokenFiltersDescriptor Name(string tokenFilter)
    Parameters
    Type Name Description
    string tokenFilter
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    NoriPartOfSpeech(Func<NoriPartOfSpeechTokenFilterDescriptor, INoriPartOfSpeechTokenFilter>)

    The nori_part_of_speech token filter removes tokens that match a set of part-of-speech tags.

    Declaration
    public AnalyzeTokenFiltersDescriptor NoriPartOfSpeech(Func<NoriPartOfSpeechTokenFilterDescriptor, INoriPartOfSpeechTokenFilter> selector)
    Parameters
    Type Name Description
    Func<NoriPartOfSpeechTokenFilterDescriptor, INoriPartOfSpeechTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    PatternCapture(Func<PatternCaptureTokenFilterDescriptor, IPatternCaptureTokenFilter>)

    The pattern_capture token filter, unlike the pattern tokenizer, emits a token for every capture group in the regular expression.

    Declaration
    public AnalyzeTokenFiltersDescriptor PatternCapture(Func<PatternCaptureTokenFilterDescriptor, IPatternCaptureTokenFilter> selector)
    Parameters
    Type Name Description
    Func<PatternCaptureTokenFilterDescriptor, IPatternCaptureTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    PatternReplace(Func<PatternReplaceTokenFilterDescriptor, IPatternReplaceTokenFilter>)

    The pattern_replace token filter allows to easily handle string replacements based on a regular expression.

    Declaration
    public AnalyzeTokenFiltersDescriptor PatternReplace(Func<PatternReplaceTokenFilterDescriptor, IPatternReplaceTokenFilter> selector)
    Parameters
    Type Name Description
    Func<PatternReplaceTokenFilterDescriptor, IPatternReplaceTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Phonetic(Func<PhoneticTokenFilterDescriptor, IPhoneticTokenFilter>)

    The phonetic token filter is provided as a plugin.

    Declaration
    public AnalyzeTokenFiltersDescriptor Phonetic(Func<PhoneticTokenFilterDescriptor, IPhoneticTokenFilter> selector)
    Parameters
    Type Name Description
    Func<PhoneticTokenFilterDescriptor, IPhoneticTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    PorterStem(Func<PorterStemTokenFilterDescriptor, IPorterStemTokenFilter>)

    A token filter of type porterStem that transforms the token stream as per the Porter stemming algorithm.

    Declaration
    public AnalyzeTokenFiltersDescriptor PorterStem(Func<PorterStemTokenFilterDescriptor, IPorterStemTokenFilter> selector = null)
    Parameters
    Type Name Description
    Func<PorterStemTokenFilterDescriptor, IPorterStemTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Predicate(Func<PredicateTokenFilterDescriptor, IPredicateTokenFilter>)

    The predicate_token_filter token filter takes a predicate script, and removes tokens that do not match the predicate.

    Declaration
    public AnalyzeTokenFiltersDescriptor Predicate(Func<PredicateTokenFilterDescriptor, IPredicateTokenFilter> selector)
    Parameters
    Type Name Description
    Func<PredicateTokenFilterDescriptor, IPredicateTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    RemoveDuplicates(Func<RemoveDuplicatesTokenFilterDescriptor, IRemoveDuplicatesTokenFilter>)

    A token filter that drops identical tokens at the same position

    Declaration
    public AnalyzeTokenFiltersDescriptor RemoveDuplicates(Func<RemoveDuplicatesTokenFilterDescriptor, IRemoveDuplicatesTokenFilter> selector)
    Parameters
    Type Name Description
    Func<RemoveDuplicatesTokenFilterDescriptor, IRemoveDuplicatesTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Reverse(Func<ReverseTokenFilterDescriptor, IReverseTokenFilter>)

    A token filter of type reverse that simply reverses the tokens.

    Declaration
    public AnalyzeTokenFiltersDescriptor Reverse(Func<ReverseTokenFilterDescriptor, IReverseTokenFilter> selector = null)
    Parameters
    Type Name Description
    Func<ReverseTokenFilterDescriptor, IReverseTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Shingle(Func<ShingleTokenFilterDescriptor, IShingleTokenFilter>)

    A token filter of type shingle that constructs shingles (token n-grams) from a token stream.

    In other words, it creates combinations of tokens as a single token.

    Declaration
    public AnalyzeTokenFiltersDescriptor Shingle(Func<ShingleTokenFilterDescriptor, IShingleTokenFilter> selector)
    Parameters
    Type Name Description
    Func<ShingleTokenFilterDescriptor, IShingleTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Snowball(Func<SnowballTokenFilterDescriptor, ISnowballTokenFilter>)

    A filter that stems words using a Snowball-generated stemmer.

    Declaration
    public AnalyzeTokenFiltersDescriptor Snowball(Func<SnowballTokenFilterDescriptor, ISnowballTokenFilter> selector)
    Parameters
    Type Name Description
    Func<SnowballTokenFilterDescriptor, ISnowballTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Stemmer(Func<StemmerTokenFilterDescriptor, IStemmerTokenFilter>)

    A filter that stems words (similar to snowball, but with more options).

    Declaration
    public AnalyzeTokenFiltersDescriptor Stemmer(Func<StemmerTokenFilterDescriptor, IStemmerTokenFilter> selector)
    Parameters
    Type Name Description
    Func<StemmerTokenFilterDescriptor, IStemmerTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    StemmerOverride(Func<StemmerOverrideTokenFilterDescriptor, IStemmerOverrideTokenFilter>)

    Overrides stemming algorithms, by applying a custom mapping, then protecting these terms from being modified by stemmers. Must be placed before any stemming filters.

    Declaration
    public AnalyzeTokenFiltersDescriptor StemmerOverride(Func<StemmerOverrideTokenFilterDescriptor, IStemmerOverrideTokenFilter> selector)
    Parameters
    Type Name Description
    Func<StemmerOverrideTokenFilterDescriptor, IStemmerOverrideTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Stop(Func<StopTokenFilterDescriptor, IStopTokenFilter>)

    A token filter of type stop that removes stop words from token streams.

    Declaration
    public AnalyzeTokenFiltersDescriptor Stop(Func<StopTokenFilterDescriptor, IStopTokenFilter> selector)
    Parameters
    Type Name Description
    Func<StopTokenFilterDescriptor, IStopTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Synonym(Func<SynonymTokenFilterDescriptor, ISynonymTokenFilter>)

    The synonym token filter allows to easily handle synonyms during the analysis process.

    Declaration
    public AnalyzeTokenFiltersDescriptor Synonym(Func<SynonymTokenFilterDescriptor, ISynonymTokenFilter> selector)
    Parameters
    Type Name Description
    Func<SynonymTokenFilterDescriptor, ISynonymTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    SynonymGraph(Func<SynonymGraphTokenFilterDescriptor, ISynonymGraphTokenFilter>)

    The synonym_graph token filter allows to easily handle synonyms, including multi-word synonyms correctly during the analysis process.

    Declaration
    public AnalyzeTokenFiltersDescriptor SynonymGraph(Func<SynonymGraphTokenFilterDescriptor, ISynonymGraphTokenFilter> selector)
    Parameters
    Type Name Description
    Func<SynonymGraphTokenFilterDescriptor, ISynonymGraphTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Trim(Func<TrimTokenFilterDescriptor, ITrimTokenFilter>)

    The trim token filter trims surrounding whitespaces around a token.

    Declaration
    public AnalyzeTokenFiltersDescriptor Trim(Func<TrimTokenFilterDescriptor, ITrimTokenFilter> selector = null)
    Parameters
    Type Name Description
    Func<TrimTokenFilterDescriptor, ITrimTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Truncate(Func<TruncateTokenFilterDescriptor, ITruncateTokenFilter>)

    The truncate token filter can be used to truncate tokens into a specific length. This can come in handy with keyword (single token)

    based mapped fields that are used for sorting in order to reduce memory usage.

    Declaration
    public AnalyzeTokenFiltersDescriptor Truncate(Func<TruncateTokenFilterDescriptor, ITruncateTokenFilter> selector)
    Parameters
    Type Name Description
    Func<TruncateTokenFilterDescriptor, ITruncateTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Unique(Func<UniqueTokenFilterDescriptor, IUniqueTokenFilter>)

    The unique token filter can be used to only index unique tokens during analysis. By default it is applied on all the token stream

    Declaration
    public AnalyzeTokenFiltersDescriptor Unique(Func<UniqueTokenFilterDescriptor, IUniqueTokenFilter> selector = null)
    Parameters
    Type Name Description
    Func<UniqueTokenFilterDescriptor, IUniqueTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    Uppercase(Func<UppercaseTokenFilterDescriptor, IUppercaseTokenFilter>)

    A token filter of type uppercase that normalizes token text to upper case.

    Declaration
    public AnalyzeTokenFiltersDescriptor Uppercase(Func<UppercaseTokenFilterDescriptor, IUppercaseTokenFilter> selector = null)
    Parameters
    Type Name Description
    Func<UppercaseTokenFilterDescriptor, IUppercaseTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    WordDelimiter(Func<WordDelimiterTokenFilterDescriptor, IWordDelimiterTokenFilter>)

    A token filter of type asciifolding that converts alphabetic, numeric, and symbolic Unicode characters which are

    not in the first 127 ASCII characters (the “Basic Latin” Unicode block) into their ASCII equivalents, if one exists.

    Declaration
    public AnalyzeTokenFiltersDescriptor WordDelimiter(Func<WordDelimiterTokenFilterDescriptor, IWordDelimiterTokenFilter> selector)
    Parameters
    Type Name Description
    Func<WordDelimiterTokenFilterDescriptor, IWordDelimiterTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor
    | Edit this page View Source

    WordDelimiterGraph(Func<WordDelimiterGraphTokenFilterDescriptor, IWordDelimiterGraphTokenFilter>)

    A token filter of type asciifolding that converts alphabetic, numeric, and symbolic Unicode characters which are

    not in the first 127 ASCII characters (the “Basic Latin” Unicode block) into their ASCII equivalents, if one exists.

    Declaration
    public AnalyzeTokenFiltersDescriptor WordDelimiterGraph(Func<WordDelimiterGraphTokenFilterDescriptor, IWordDelimiterGraphTokenFilter> selector)
    Parameters
    Type Name Description
    Func<WordDelimiterGraphTokenFilterDescriptor, IWordDelimiterGraphTokenFilter> selector
    Returns
    Type Description
    AnalyzeTokenFiltersDescriptor

    Implements

    IDescriptor
    IPromise<TValue>

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • AnalyzeTokenFiltersDescriptor()
    • Methods
      • AsciiFolding(Func<AsciiFoldingTokenFilterDescriptor, IAsciiFoldingTokenFilter>)
      • CommonGrams(Func<CommonGramsTokenFilterDescriptor, ICommonGramsTokenFilter>)
      • Condition(Func<ConditionTokenFilterDescriptor, IConditionTokenFilter>)
      • DelimitedPayload(Func<DelimitedPayloadTokenFilterDescriptor, IDelimitedPayloadTokenFilter>)
      • DictionaryDecompounder(Func<DictionaryDecompounderTokenFilterDescriptor, IDictionaryDecompounderTokenFilter>)
      • EdgeNGram(Func<EdgeNGramTokenFilterDescriptor, IEdgeNGramTokenFilter>)
      • Elision(Func<ElisionTokenFilterDescriptor, IElisionTokenFilter>)
      • Fingerprint(Func<FingerprintTokenFilterDescriptor, IFingerprintTokenFilter>)
      • Hunspell(Func<HunspellTokenFilterDescriptor, IHunspellTokenFilter>)
      • HyphenationDecompounder(Func<HyphenationDecompounderTokenFilterDescriptor, IHyphenationDecompounderTokenFilter>)
      • IcuCollation(Func<IcuCollationTokenFilterDescriptor, IIcuCollationTokenFilter>)
      • IcuFolding(Func<IcuFoldingTokenFilterDescriptor, IIcuFoldingTokenFilter>)
      • IcuNormalization(Func<IcuNormalizationTokenFilterDescriptor, IIcuNormalizationTokenFilter>)
      • IcuTransform(Func<IcuTransformTokenFilterDescriptor, IIcuTransformTokenFilter>)
      • KStem(Func<KStemTokenFilterDescriptor, IKStemTokenFilter>)
      • KeepTypes(Func<KeepTypesTokenFilterDescriptor, IKeepTypesTokenFilter>)
      • KeepWords(Func<KeepWordsTokenFilterDescriptor, IKeepWordsTokenFilter>)
      • KeywordMarker(Func<KeywordMarkerTokenFilterDescriptor, IKeywordMarkerTokenFilter>)
      • KuromojiPartOfSpeech(Func<KuromojiPartOfSpeechTokenFilterDescriptor, IKuromojiPartOfSpeechTokenFilter>)
      • KuromojiReadingForm(Func<KuromojiReadingFormTokenFilterDescriptor, IKuromojiReadingFormTokenFilter>)
      • KuromojiStemmer(Func<KuromojiStemmerTokenFilterDescriptor, IKuromojiStemmerTokenFilter>)
      • Length(Func<LengthTokenFilterDescriptor, ILengthTokenFilter>)
      • LimitTokenCount(Func<LimitTokenCountTokenFilterDescriptor, ILimitTokenCountTokenFilter>)
      • Lowercase(Func<LowercaseTokenFilterDescriptor, ILowercaseTokenFilter>)
      • Multiplexer(Func<MultiplexerTokenFilterDescriptor, IMultiplexerTokenFilter>)
      • NGram(Func<NGramTokenFilterDescriptor, INGramTokenFilter>)
      • Name(string)
      • NoriPartOfSpeech(Func<NoriPartOfSpeechTokenFilterDescriptor, INoriPartOfSpeechTokenFilter>)
      • PatternCapture(Func<PatternCaptureTokenFilterDescriptor, IPatternCaptureTokenFilter>)
      • PatternReplace(Func<PatternReplaceTokenFilterDescriptor, IPatternReplaceTokenFilter>)
      • Phonetic(Func<PhoneticTokenFilterDescriptor, IPhoneticTokenFilter>)
      • PorterStem(Func<PorterStemTokenFilterDescriptor, IPorterStemTokenFilter>)
      • Predicate(Func<PredicateTokenFilterDescriptor, IPredicateTokenFilter>)
      • RemoveDuplicates(Func<RemoveDuplicatesTokenFilterDescriptor, IRemoveDuplicatesTokenFilter>)
      • Reverse(Func<ReverseTokenFilterDescriptor, IReverseTokenFilter>)
      • Shingle(Func<ShingleTokenFilterDescriptor, IShingleTokenFilter>)
      • Snowball(Func<SnowballTokenFilterDescriptor, ISnowballTokenFilter>)
      • Stemmer(Func<StemmerTokenFilterDescriptor, IStemmerTokenFilter>)
      • StemmerOverride(Func<StemmerOverrideTokenFilterDescriptor, IStemmerOverrideTokenFilter>)
      • Stop(Func<StopTokenFilterDescriptor, IStopTokenFilter>)
      • Synonym(Func<SynonymTokenFilterDescriptor, ISynonymTokenFilter>)
      • SynonymGraph(Func<SynonymGraphTokenFilterDescriptor, ISynonymGraphTokenFilter>)
      • Trim(Func<TrimTokenFilterDescriptor, ITrimTokenFilter>)
      • Truncate(Func<TruncateTokenFilterDescriptor, ITruncateTokenFilter>)
      • Unique(Func<UniqueTokenFilterDescriptor, IUniqueTokenFilter>)
      • Uppercase(Func<UppercaseTokenFilterDescriptor, IUppercaseTokenFilter>)
      • WordDelimiter(Func<WordDelimiterTokenFilterDescriptor, IWordDelimiterTokenFilter>)
      • WordDelimiterGraph(Func<WordDelimiterGraphTokenFilterDescriptor, IWordDelimiterGraphTokenFilter>)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX