Search Results for

    Show / Hide Table of Contents

    Interface 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.

    Inherited Members
    ITokenFilter.Type
    ITokenFilter.Version
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public interface IShingleTokenFilter : ITokenFilter

    Properties

    | Edit this page View Source

    FillerToken

    The string to use as a replacement for each position at which there is no actual token in the stream. For instance this string is used if the position increment is greater than one when a stop filter is used together with the shingle filter. Defaults to "_"

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

    MaxShingleSize

    The maximum shingle size. Defaults to 2.

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

    MinShingleSize

    The minimum shingle size. Defaults to 2.

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

    OutputUnigrams

    If true the output will contain the input tokens (unigrams) as well as the shingles. Defaults to true.

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

    OutputUnigramsIfNoShingles

    If output_unigrams is false the output will contain the input tokens (unigrams) if no shingles are available.

    Note if output_unigrams is set to true this setting has no effect. Defaults to false.

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

    TokenSeparator

    The string to use when joining adjacent tokens to form a shingle. Defaults to " ".

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

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • FillerToken
      • MaxShingleSize
      • MinShingleSize
      • OutputUnigrams
      • OutputUnigramsIfNoShingles
      • TokenSeparator
    • Extension Methods
    Back to top Generated by DocFX