Get data stream settings

Array of character scripts for which to disable bigrams.

A list of tokens. The filter generates bigrams for these tokens. Either this or the common_words_path parameter is required.

Path to a file containing a list of tokens. The filter generates bigrams for these tokens. This path must be absolute or relative to the config location. The file must be UTF-8 encoded. Each token in the file must be separated by a line break. Either this or the common_words parameter is required.

If true, matches for common words matching are case-insensitive. Defaults to false.

Array of token filters. If a token matches the predicate script in the script parameter, these filters are applied to the token in the order provided.

Character used to separate tokens from payloads. Defaults to |.

Maximum character length of a gram. For custom token filters, defaults to 2. For the built-in edge_ngram filter, defaults to 1.

Minimum character length of a gram. Defaults to 1.

Indicates whether to truncate tokens from the front or back. Defaults to front.

List of elisions to remove. To be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed. For custom elision filters, either this parameter or articles_path must be specified.

Path to a file that contains a list of elisions to remove. This path must be absolute or relative to the config location, and the file must be UTF-8 encoded. Each elision in the file must be separated by a line break. To be removed, the elision must be at the beginning of a token and be immediately followed by an apostrophe. Both the elision and apostrophe are removed. For custom elision filters, either this parameter or articles must be specified.

Maximum character length, including whitespace, of the output token. Defaults to 255. Concatenated tokens longer than this will result in no token output.

If true, duplicate tokens are removed from the filter’s output. Defaults to true.

One or more .dic files (e.g, en_US.dic, my_custom.dic) to use for the Hunspell dictionary. By default, the hunspell filter uses all .dic files in the <$ES_PATH_CONF>/hunspell/<locale> directory specified using the lang, language, or locale parameter.

Locale directory used to specify the .aff and .dic files for a Hunspell dictionary.

Maximum subword character length. Longer subword tokens are excluded from the output. Defaults to 15.

Minimum subword character length. Shorter subword tokens are excluded from the output. Defaults to 2.

Minimum word character length. Shorter word tokens are excluded from the output. Defaults to 5.

If true, only include the longest matching subword. Defaults to false.

A list of subwords to look for in the token stream. If found, the subword is included in the token output. Either this parameter or word_list_path must be specified.

Path to a file that contains a list of subwords to find in the token stream. If found, the subword is included in the token output. This path must be absolute or relative to the config location, and the file must be UTF-8 encoded. Each token in the file must be separated by a line break. Either this parameter or word_list must be specified.

Path to an Apache FOP (Formatting Objects Processor) XML hyphenation pattern file. This path must be absolute or relative to the config location. Only FOP v1.2 compatible files are supported.

If true, do not match sub tokens in tokens that are in the word list. Defaults to false.

Indicates whether to keep or remove the specified token types.

List of words to keep. Only tokens that match words in this list are included in the output. Either this parameter or keep_words_path must be specified.

If true, lowercase all keep words. Defaults to false.

If true, matching for the keywords and keywords_path parameters ignores letter case. Defaults to false.

Array of keywords. Tokens that match these keywords are not stemmed. This parameter, keywords_path, or keywords_pattern must be specified. You cannot specify this parameter and keywords_pattern.

Path to a file that contains a list of keywords. Tokens that match these keywords are not stemmed. This path must be absolute or relative to the config location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break. This parameter, keywords, or keywords_pattern must be specified. You cannot specify this parameter and keywords_pattern.

Maximum character length of a token. Longer tokens are excluded from the output. Defaults to Integer.MAX_VALUE, which is 2^31-1 or 2147483647.

If true, the limit filter exhausts the token stream, even if the max_token_count has already been reached. Defaults to false.

Number of buckets to which hashes are assigned. Defaults to 512.

Number of ways to hash each token in the stream. Defaults to 1.

Number of hashes to keep from each bucket. Defaults to 1. Hashes are retained by ascending size, starting with the bucket’s smallest hash first.