parent
9df7c943cb
commit
a2b18e9ab9
|
@ -180,7 +180,7 @@ Guidelines
|
||||||
////
|
////
|
||||||
|
|
||||||
`foo`::
|
`foo`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, do a cool thing.
|
If `true`, do a cool thing.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
||||||
|
|
|
@ -100,7 +100,7 @@ PUT /asciifold_example
|
||||||
==== Configurable parameters
|
==== Configurable parameters
|
||||||
|
|
||||||
`preserve_original`::
|
`preserve_original`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, emit both original tokens and folded tokens.
|
If `true`, emit both original tokens and folded tokens.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
||||||
|
|
|
@ -159,7 +159,7 @@ All non-CJK input is passed through unmodified.
|
||||||
--
|
--
|
||||||
|
|
||||||
`output_unigrams`
|
`output_unigrams`
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, emit tokens in both bigram and
|
If `true`, emit tokens in both bigram and
|
||||||
{wikipedia}/N-gram[unigram] form. If `false`, a CJK character
|
{wikipedia}/N-gram[unigram] form. If `false`, a CJK character
|
||||||
is output in unigram form when it has no adjacent characters. Defaults to
|
is output in unigram form when it has no adjacent characters. Defaults to
|
||||||
|
|
|
@ -171,14 +171,14 @@ Either this or the `common_words` parameter is required.
|
||||||
--
|
--
|
||||||
|
|
||||||
`ignore_case`::
|
`ignore_case`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, matches for common words matching are case-insensitive.
|
If `true`, matches for common words matching are case-insensitive.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
||||||
`query_mode`::
|
`query_mode`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter excludes the following tokens from the output:
|
If `true`, the filter excludes the following tokens from the output:
|
||||||
|
|
||||||
* Unigrams for common words
|
* Unigrams for common words
|
||||||
|
|
|
@ -130,7 +130,7 @@ Minimum word character length. Shorter word tokens are excluded from the
|
||||||
output. Defaults to `5`.
|
output. Defaults to `5`.
|
||||||
|
|
||||||
`only_longest_match`::
|
`only_longest_match`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, only include the longest matching subword. Defaults to `false`.
|
If `true`, only include the longest matching subword. Defaults to `false`.
|
||||||
|
|
||||||
[[analysis-dict-decomp-tokenfilter-customize]]
|
[[analysis-dict-decomp-tokenfilter-customize]]
|
||||||
|
|
|
@ -174,7 +174,7 @@ See <<analysis-edgengram-tokenfilter-max-gram-limits>>.
|
||||||
Minimum character length of a gram. Defaults to `1`.
|
Minimum character length of a gram. Defaults to `1`.
|
||||||
|
|
||||||
`preserve_original`::
|
`preserve_original`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
Emits original token when set to `true`. Defaults to `false`.
|
Emits original token when set to `true`. Defaults to `false`.
|
||||||
|
|
||||||
`side`::
|
`side`::
|
||||||
|
|
|
@ -146,7 +146,7 @@ specified.
|
||||||
--
|
--
|
||||||
|
|
||||||
`articles_case`::
|
`articles_case`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter treats any provided elisions as case sensitive.
|
If `true`, the filter treats any provided elisions as case sensitive.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
||||||
|
|
|
@ -45,7 +45,7 @@ Each dictionary can be configured with one setting:
|
||||||
|
|
||||||
[[analysis-hunspell-ignore-case-settings]]
|
[[analysis-hunspell-ignore-case-settings]]
|
||||||
`ignore_case`::
|
`ignore_case`::
|
||||||
(Static, boolean)
|
(Static, Boolean)
|
||||||
If true, dictionary matching will be case insensitive. Defaults to `false`.
|
If true, dictionary matching will be case insensitive. Defaults to `false`.
|
||||||
|
|
||||||
This setting can be configured globally in `elasticsearch.yml` using
|
This setting can be configured globally in `elasticsearch.yml` using
|
||||||
|
@ -147,7 +147,7 @@ directory's path must be registered using the
|
||||||
`indices.analysis.hunspell.dictionary.location`>> setting.
|
`indices.analysis.hunspell.dictionary.location`>> setting.
|
||||||
|
|
||||||
`dedup`::
|
`dedup`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, duplicate tokens are removed from the filter's output. Defaults to
|
If `true`, duplicate tokens are removed from the filter's output. Defaults to
|
||||||
`true`.
|
`true`.
|
||||||
|
|
||||||
|
@ -177,7 +177,7 @@ If this parameter is not specified, the `lang` or `language` parameter is
|
||||||
required.
|
required.
|
||||||
|
|
||||||
`longest_only`::
|
`longest_only`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, only the longest stemmed version of each token is
|
If `true`, only the longest stemmed version of each token is
|
||||||
included in the output. If `false`, all stemmed versions of the token are
|
included in the output. If `false`, all stemmed versions of the token are
|
||||||
included. Defaults to `false`.
|
included. Defaults to `false`.
|
||||||
|
@ -231,7 +231,7 @@ settings>>, you can configure the following global settings for the `hunspell`
|
||||||
filter using `elasticsearch.yml`:
|
filter using `elasticsearch.yml`:
|
||||||
|
|
||||||
`indices.analysis.hunspell.dictionary.lazy`::
|
`indices.analysis.hunspell.dictionary.lazy`::
|
||||||
(Static, boolean)
|
(Static, Boolean)
|
||||||
If `true`, the loading of Hunspell dictionaries is deferred until a dictionary
|
If `true`, the loading of Hunspell dictionaries is deferred until a dictionary
|
||||||
is used. If `false`, the dictionary directory is checked for dictionaries when
|
is used. If `false`, the dictionary directory is checked for dictionaries when
|
||||||
the node starts, and any dictionaries are automatically loaded. Defaults to
|
the node starts, and any dictionaries are automatically loaded. Defaults to
|
||||||
|
|
|
@ -108,7 +108,7 @@ Minimum word character length. Shorter word tokens are excluded from the
|
||||||
output. Defaults to `5`.
|
output. Defaults to `5`.
|
||||||
|
|
||||||
`only_longest_match`::
|
`only_longest_match`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, only include the longest matching subword. Defaults to `false`.
|
If `true`, only include the longest matching subword. Defaults to `false`.
|
||||||
|
|
||||||
[[analysis-hyp-decomp-tokenfilter-customize]]
|
[[analysis-hyp-decomp-tokenfilter-customize]]
|
||||||
|
|
|
@ -95,7 +95,7 @@ Either this parameter or `keep_words` must be specified.
|
||||||
--
|
--
|
||||||
|
|
||||||
`keep_words_case`::
|
`keep_words_case`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, lowercase all keep words. Defaults to `false`.
|
If `true`, lowercase all keep words. Defaults to `false`.
|
||||||
|
|
||||||
[[analysis-keep-words-tokenfilter-customize]]
|
[[analysis-keep-words-tokenfilter-customize]]
|
||||||
|
|
|
@ -303,7 +303,7 @@ The API returns the following response. Note the `jumping` token has a
|
||||||
==== Configurable parameters
|
==== Configurable parameters
|
||||||
|
|
||||||
`ignore_case`::
|
`ignore_case`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, matching for the `keywords` and `keywords_path` parameters ignores
|
If `true`, matching for the `keywords` and `keywords_path` parameters ignores
|
||||||
letter case. Defaults to `false`.
|
letter case. Defaults to `false`.
|
||||||
|
|
||||||
|
|
|
@ -29,7 +29,7 @@ Maximum number of tokens to keep. Once this limit is reached, any remaining
|
||||||
tokens are excluded from the output. Defaults to `1`.
|
tokens are excluded from the output. Defaults to `1`.
|
||||||
|
|
||||||
`consume_all_tokens`::
|
`consume_all_tokens`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the `limit` filter exhausts the token stream, even if the
|
If `true`, the `limit` filter exhausts the token stream, even if the
|
||||||
`max_token_count` has already been reached. Defaults to `false`.
|
`max_token_count` has already been reached. Defaults to `false`.
|
||||||
|
|
||||||
|
|
|
@ -38,7 +38,7 @@ Hashes are retained by ascending size, starting with the bucket's smallest hash
|
||||||
first.
|
first.
|
||||||
|
|
||||||
`with_rotation`::
|
`with_rotation`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter fills empty buckets with the value of the first non-empty
|
If `true`, the filter fills empty buckets with the value of the first non-empty
|
||||||
bucket to its circular right if the `hash_set_size` is `1`. If the
|
bucket to its circular right if the `hash_set_size` is `1`. If the
|
||||||
`bucket_count` argument is greater than `1`, this parameter defaults to `true`.
|
`bucket_count` argument is greater than `1`, this parameter defaults to `true`.
|
||||||
|
|
|
@ -186,7 +186,7 @@ Maximum length of characters in a gram. Defaults to `2`.
|
||||||
Minimum length of characters in a gram. Defaults to `1`.
|
Minimum length of characters in a gram. Defaults to `1`.
|
||||||
|
|
||||||
`preserve_original`::
|
`preserve_original`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
Emits original token when set to `true`. Defaults to `false`.
|
Emits original token when set to `true`. Defaults to `false`.
|
||||||
|
|
||||||
You can use the <<index-max-ngram-diff,`index.max_ngram_diff`>> index-level
|
You can use the <<index-max-ngram-diff,`index.max_ngram_diff`>> index-level
|
||||||
|
|
|
@ -99,7 +99,7 @@ The filter produces the following tokens.
|
||||||
==== Configurable parameters
|
==== Configurable parameters
|
||||||
|
|
||||||
`all`::
|
`all`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, all substrings matching the `pattern` parameter's regular expression
|
If `true`, all substrings matching the `pattern` parameter's regular expression
|
||||||
are replaced. If `false`, the filter replaces only the first matching substring
|
are replaced. If `false`, the filter replaces only the first matching substring
|
||||||
in each token. Defaults to `true`.
|
in each token. Defaults to `true`.
|
||||||
|
|
|
@ -333,7 +333,7 @@ cannot exceed the <<index-max-shingle-diff,`index.max_shingle_diff`>>
|
||||||
index-level setting, which defaults to `3`.
|
index-level setting, which defaults to `3`.
|
||||||
|
|
||||||
`output_unigrams`::
|
`output_unigrams`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the output includes the original input tokens. If `false`, the output
|
If `true`, the output includes the original input tokens. If `false`, the output
|
||||||
only includes shingles; the original input tokens are removed. Defaults to
|
only includes shingles; the original input tokens are removed. Defaults to
|
||||||
`true`.
|
`true`.
|
||||||
|
|
|
@ -150,7 +150,7 @@ break.
|
||||||
--
|
--
|
||||||
|
|
||||||
`ignore_case`::
|
`ignore_case`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, stop word matching is case insensitive. For example, if `true`, a
|
If `true`, stop word matching is case insensitive. For example, if `true`, a
|
||||||
stop word of `the` matches and removes `The`, `THE`, or `the`. Defaults to
|
stop word of `the` matches and removes `The`, `THE`, or `the`. Defaults to
|
||||||
`false`.
|
`false`.
|
||||||
|
@ -158,7 +158,7 @@ stop word of `the` matches and removes `The`, `THE`, or `the`. Defaults to
|
||||||
`remove_trailing`::
|
`remove_trailing`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the last token of a stream is removed if it's a stop word. Defaults
|
If `true`, the last token of a stream is removed if it's a stop word. Defaults
|
||||||
to `true`.
|
to `true`.
|
||||||
|
|
||||||
|
|
|
@ -112,7 +112,7 @@ PUT custom_unique_example
|
||||||
==== Configurable parameters
|
==== Configurable parameters
|
||||||
|
|
||||||
`only_on_same_position`::
|
`only_on_same_position`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, only remove duplicate tokens in the same position.
|
If `true`, only remove duplicate tokens in the same position.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
||||||
|
|
|
@ -169,7 +169,7 @@ recommend using the <<analysis-keyword-tokenizer,`keyword`>> or
|
||||||
`adjust_offsets`::
|
`adjust_offsets`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter adjusts the offsets of split or catenated tokens to better
|
If `true`, the filter adjusts the offsets of split or catenated tokens to better
|
||||||
reflect their actual position in the token stream. Defaults to `true`.
|
reflect their actual position in the token stream. Defaults to `true`.
|
||||||
|
|
||||||
|
@ -186,7 +186,7 @@ could produce tokens with illegal offsets.
|
||||||
`catenate_all`::
|
`catenate_all`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter produces catenated tokens for chains of alphanumeric
|
If `true`, the filter produces catenated tokens for chains of alphanumeric
|
||||||
characters separated by non-alphabetic delimiters. For example:
|
characters separated by non-alphabetic delimiters. For example:
|
||||||
`super-duper-xl-500` -> [ **`superduperxl500`**, `super`, `duper`, `xl`, `500` ].
|
`super-duper-xl-500` -> [ **`superduperxl500`**, `super`, `duper`, `xl`, `500` ].
|
||||||
|
@ -212,7 +212,7 @@ you plan to use these queries.
|
||||||
`catenate_numbers`::
|
`catenate_numbers`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter produces catenated tokens for chains of numeric characters
|
If `true`, the filter produces catenated tokens for chains of numeric characters
|
||||||
separated by non-alphabetic delimiters. For example: `01-02-03` ->
|
separated by non-alphabetic delimiters. For example: `01-02-03` ->
|
||||||
[ **`010203`**, `01`, `02`, `03` ]. Defaults to `false`.
|
[ **`010203`**, `01`, `02`, `03` ]. Defaults to `false`.
|
||||||
|
@ -237,7 +237,7 @@ you plan to use these queries.
|
||||||
`catenate_words`::
|
`catenate_words`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter produces catenated tokens for chains of alphabetical
|
If `true`, the filter produces catenated tokens for chains of alphabetical
|
||||||
characters separated by non-alphabetic delimiters. For example: `super-duper-xl`
|
characters separated by non-alphabetic delimiters. For example: `super-duper-xl`
|
||||||
-> [ **`superduperxl`**, `super`, `duper`, `xl` ]. Defaults to `false`.
|
-> [ **`superduperxl`**, `super`, `duper`, `xl` ]. Defaults to `false`.
|
||||||
|
@ -259,19 +259,19 @@ you plan to use these queries.
|
||||||
--
|
--
|
||||||
|
|
||||||
`generate_number_parts`::
|
`generate_number_parts`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter includes tokens consisting of only numeric characters in
|
If `true`, the filter includes tokens consisting of only numeric characters in
|
||||||
the output. If `false`, the filter excludes these tokens from the output.
|
the output. If `false`, the filter excludes these tokens from the output.
|
||||||
Defaults to `true`.
|
Defaults to `true`.
|
||||||
|
|
||||||
`generate_word_parts`::
|
`generate_word_parts`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter includes tokens consisting of only alphabetical characters
|
If `true`, the filter includes tokens consisting of only alphabetical characters
|
||||||
in the output. If `false`, the filter excludes these tokens from the output.
|
in the output. If `false`, the filter excludes these tokens from the output.
|
||||||
Defaults to `true`.
|
Defaults to `true`.
|
||||||
|
|
||||||
`ignore_keywords`::
|
`ignore_keywords`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter skips tokens with
|
If `true`, the filter skips tokens with
|
||||||
a `keyword` attribute of `true`.
|
a `keyword` attribute of `true`.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
@ -280,7 +280,7 @@ Defaults to `false`.
|
||||||
`preserve_original`::
|
`preserve_original`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter includes the original version of any split tokens in the
|
If `true`, the filter includes the original version of any split tokens in the
|
||||||
output. This original version includes non-alphanumeric delimiters. For example:
|
output. This original version includes non-alphanumeric delimiters. For example:
|
||||||
`super-duper-xl-500` -> [ **`super-duper-xl-500`**, `super`, `duper`, `xl`,
|
`super-duper-xl-500` -> [ **`super-duper-xl-500`**, `super`, `duper`, `xl`,
|
||||||
|
@ -313,17 +313,17 @@ break.
|
||||||
--
|
--
|
||||||
|
|
||||||
`split_on_case_change`::
|
`split_on_case_change`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter splits tokens at letter case transitions. For example:
|
If `true`, the filter splits tokens at letter case transitions. For example:
|
||||||
`camelCase` -> [ `camel`, `Case` ]. Defaults to `true`.
|
`camelCase` -> [ `camel`, `Case` ]. Defaults to `true`.
|
||||||
|
|
||||||
`split_on_numerics`::
|
`split_on_numerics`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter splits tokens at letter-number transitions. For example:
|
If `true`, the filter splits tokens at letter-number transitions. For example:
|
||||||
`j2se` -> [ `j`, `2`, `se` ]. Defaults to `true`.
|
`j2se` -> [ `j`, `2`, `se` ]. Defaults to `true`.
|
||||||
|
|
||||||
`stem_english_possessive`::
|
`stem_english_possessive`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter removes the English possessive (`'s`) from the end of each
|
If `true`, the filter removes the English possessive (`'s`) from the end of each
|
||||||
token. For example: `O'Neil's` -> [ `O`, `Neil` ]. Defaults to `true`.
|
token. For example: `O'Neil's` -> [ `O`, `Neil` ]. Defaults to `true`.
|
||||||
|
|
||||||
|
|
|
@ -178,7 +178,7 @@ interfere with the filter's configurable parameters, such as `catenate_all` or
|
||||||
`catenate_all`::
|
`catenate_all`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter produces catenated tokens for chains of alphanumeric
|
If `true`, the filter produces catenated tokens for chains of alphanumeric
|
||||||
characters separated by non-alphabetic delimiters. For example:
|
characters separated by non-alphabetic delimiters. For example:
|
||||||
`super-duper-xl-500` -> [ `super`, **`superduperxl500`**, `duper`, `xl`, `500`
|
`super-duper-xl-500` -> [ `super`, **`superduperxl500`**, `duper`, `xl`, `500`
|
||||||
|
@ -196,7 +196,7 @@ you plan to use these queries.
|
||||||
`catenate_numbers`::
|
`catenate_numbers`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter produces catenated tokens for chains of numeric characters
|
If `true`, the filter produces catenated tokens for chains of numeric characters
|
||||||
separated by non-alphabetic delimiters. For example: `01-02-03` ->
|
separated by non-alphabetic delimiters. For example: `01-02-03` ->
|
||||||
[ `01`, **`010203`**, `02`, `03` ]. Defaults to `false`.
|
[ `01`, **`010203`**, `02`, `03` ]. Defaults to `false`.
|
||||||
|
@ -213,7 +213,7 @@ you plan to use these queries.
|
||||||
`catenate_words`::
|
`catenate_words`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter produces catenated tokens for chains of alphabetical
|
If `true`, the filter produces catenated tokens for chains of alphabetical
|
||||||
characters separated by non-alphabetic delimiters. For example: `super-duper-xl`
|
characters separated by non-alphabetic delimiters. For example: `super-duper-xl`
|
||||||
-> [ `super`, **`superduperxl`**, `duper`, `xl` ]. Defaults to `false`.
|
-> [ `super`, **`superduperxl`**, `duper`, `xl` ]. Defaults to `false`.
|
||||||
|
@ -228,19 +228,19 @@ you plan to use these queries.
|
||||||
--
|
--
|
||||||
|
|
||||||
`generate_number_parts`::
|
`generate_number_parts`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter includes tokens consisting of only numeric characters in
|
If `true`, the filter includes tokens consisting of only numeric characters in
|
||||||
the output. If `false`, the filter excludes these tokens from the output.
|
the output. If `false`, the filter excludes these tokens from the output.
|
||||||
Defaults to `true`.
|
Defaults to `true`.
|
||||||
|
|
||||||
`generate_word_parts`::
|
`generate_word_parts`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter includes tokens consisting of only alphabetical characters
|
If `true`, the filter includes tokens consisting of only alphabetical characters
|
||||||
in the output. If `false`, the filter excludes these tokens from the output.
|
in the output. If `false`, the filter excludes these tokens from the output.
|
||||||
Defaults to `true`.
|
Defaults to `true`.
|
||||||
|
|
||||||
`preserve_original`::
|
`preserve_original`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter includes the original version of any split tokens in the
|
If `true`, the filter includes the original version of any split tokens in the
|
||||||
output. This original version includes non-alphanumeric delimiters. For example:
|
output. This original version includes non-alphanumeric delimiters. For example:
|
||||||
`super-duper-xl-500` -> [ **`super-duper-xl-500`**, `super`, `duper`, `xl`,
|
`super-duper-xl-500` -> [ **`super-duper-xl-500`**, `super`, `duper`, `xl`,
|
||||||
|
@ -262,17 +262,17 @@ break.
|
||||||
--
|
--
|
||||||
|
|
||||||
`split_on_case_change`::
|
`split_on_case_change`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter splits tokens at letter case transitions. For example:
|
If `true`, the filter splits tokens at letter case transitions. For example:
|
||||||
`camelCase` -> [ `camel`, `Case` ]. Defaults to `true`.
|
`camelCase` -> [ `camel`, `Case` ]. Defaults to `true`.
|
||||||
|
|
||||||
`split_on_numerics`::
|
`split_on_numerics`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter splits tokens at letter-number transitions. For example:
|
If `true`, the filter splits tokens at letter-number transitions. For example:
|
||||||
`j2se` -> [ `j`, `2`, `se` ]. Defaults to `true`.
|
`j2se` -> [ `j`, `2`, `se` ]. Defaults to `true`.
|
||||||
|
|
||||||
`stem_english_possessive`::
|
`stem_english_possessive`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the filter removes the English possessive (`'s`) from the end of each
|
If `true`, the filter removes the English possessive (`'s`) from the end of each
|
||||||
token. For example: `O'Neil's` -> [ `O`, `Neil` ]. Defaults to `true`.
|
token. For example: `O'Neil's` -> [ `O`, `Neil` ]. Defaults to `true`.
|
||||||
|
|
||||||
|
|
|
@ -41,7 +41,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`allow_no_match`::
|
`allow_no_match`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]
|
||||||
|
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes]
|
||||||
|
|
|
@ -42,7 +42,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id]
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`allow_no_match`::
|
`allow_no_match`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]
|
||||||
|
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
|
||||||
|
|
|
@ -50,7 +50,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=time]
|
||||||
|
|
||||||
`ts` (timestamps)::
|
`ts` (timestamps)::
|
||||||
(Optional, boolean) If `true`, returns `HH:MM:SS` and
|
(Optional, Boolean) If `true`, returns `HH:MM:SS` and
|
||||||
{wikipedia}/Unix_time[Unix `epoch`] timestamps. Defaults to
|
{wikipedia}/Unix_time[Unix `epoch`] timestamps. Defaults to
|
||||||
`true`.
|
`true`.
|
||||||
|
|
||||||
|
|
|
@ -80,7 +80,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
|
||||||
|
|
||||||
[[pri-flag]]
|
[[pri-flag]]
|
||||||
`pri` (primary shards)::
|
`pri` (primary shards)::
|
||||||
(Optional, boolean) If `true`, the response only includes information from
|
(Optional, Boolean) If `true`, the response only includes information from
|
||||||
primary shards. Defaults to `false`.
|
primary shards. Defaults to `false`.
|
||||||
|
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
|
||||||
|
|
|
@ -19,7 +19,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=bytes]
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
|
||||||
|
|
||||||
`full_id`::
|
`full_id`::
|
||||||
(Optional, boolean) If `true`, return the full node ID. If `false`, return the
|
(Optional, Boolean) If `true`, return the full node ID. If `false`, return the
|
||||||
shortened node ID. Defaults to `false`.
|
shortened node ID. Defaults to `false`.
|
||||||
|
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
|
||||||
|
|
|
@ -93,7 +93,7 @@ Reason for any snapshot failures.
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
|
||||||
|
|
||||||
`ignore_unavailable`::
|
`ignore_unavailable`::
|
||||||
(Optional, boolean) If `true`, the response does not include information from
|
(Optional, Boolean) If `true`, the response does not include information from
|
||||||
unavailable snapshots. Defaults to `false`.
|
unavailable snapshots. Defaults to `false`.
|
||||||
|
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
|
||||||
|
|
|
@ -39,7 +39,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id-wildcard]
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`allow_no_match`::
|
`allow_no_match`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-match-transforms1]
|
||||||
|
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
|
||||||
|
|
|
@ -30,11 +30,11 @@ you might expect otherwise.
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`include_disk_info`::
|
`include_disk_info`::
|
||||||
(Optional, boolean) If `true`, returns information about disk usage and
|
(Optional, Boolean) If `true`, returns information about disk usage and
|
||||||
shard sizes. Defaults to `false`.
|
shard sizes. Defaults to `false`.
|
||||||
|
|
||||||
`include_yes_decisions`::
|
`include_yes_decisions`::
|
||||||
(Optional, boolean) If `true`, returns 'YES' decisions in explanation.
|
(Optional, Boolean) If `true`, returns 'YES' decisions in explanation.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
||||||
|
|
||||||
|
@ -50,7 +50,7 @@ you might expect otherwise.
|
||||||
explanation for.
|
explanation for.
|
||||||
|
|
||||||
`primary`::
|
`primary`::
|
||||||
(Optional, boolean) If `true`, returns explanation for the primary shard
|
(Optional, Boolean) If `true`, returns explanation for the primary shard
|
||||||
for the given shard ID.
|
for the given shard ID.
|
||||||
|
|
||||||
`shard`::
|
`shard`::
|
||||||
|
|
|
@ -23,7 +23,7 @@ defined, but can also include the default settings by calling the
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
|
||||||
|
|
||||||
`include_defaults`::
|
`include_defaults`::
|
||||||
(Optional, boolean) If `true`, returns all default cluster settings.
|
(Optional, Boolean) If `true`, returns all default cluster settings.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
|
@ -70,12 +70,12 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
||||||
priority are processed.
|
priority are processed.
|
||||||
|
|
||||||
`wait_for_no_initializing_shards`::
|
`wait_for_no_initializing_shards`::
|
||||||
(Optional, boolean) A boolean value which controls whether to wait (until
|
(Optional, Boolean) A boolean value which controls whether to wait (until
|
||||||
the timeout provided) for the cluster to have no shard initializations.
|
the timeout provided) for the cluster to have no shard initializations.
|
||||||
Defaults to false, which means it will not wait for initializing shards.
|
Defaults to false, which means it will not wait for initializing shards.
|
||||||
|
|
||||||
`wait_for_no_relocating_shards`::
|
`wait_for_no_relocating_shards`::
|
||||||
(Optional, boolean) A boolean value which controls whether to wait (until
|
(Optional, Boolean) A boolean value which controls whether to wait (until
|
||||||
the timeout provided) for the cluster to have no shard relocations. Defaults
|
the timeout provided) for the cluster to have no shard relocations. Defaults
|
||||||
to false, which means it will not wait for relocating shards.
|
to false, which means it will not wait for relocating shards.
|
||||||
|
|
||||||
|
@ -101,7 +101,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cluster-health-status]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cluster-health-status]
|
||||||
|
|
||||||
`timed_out`::
|
`timed_out`::
|
||||||
(boolean) If `false` the response returned within the period of
|
(Boolean) If `false` the response returned within the period of
|
||||||
time that is specified by the `timeout` parameter (`30s` by default).
|
time that is specified by the `timeout` parameter (`30s` by default).
|
||||||
|
|
||||||
`number_of_nodes`::
|
`number_of_nodes`::
|
||||||
|
|
|
@ -34,7 +34,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id]
|
||||||
|
|
||||||
|
|
||||||
`ignore_idle_threads`::
|
`ignore_idle_threads`::
|
||||||
(Optional, boolean) If true, known idle threads (e.g. waiting in a socket
|
(Optional, Boolean) If true, known idle threads (e.g. waiting in a socket
|
||||||
select, or to get a task from an empty queue) are filtered out. Defaults to
|
select, or to get a task from an empty queue) are filtered out. Defaults to
|
||||||
true.
|
true.
|
||||||
|
|
||||||
|
|
|
@ -312,7 +312,7 @@ Number of deletion operations currently running.
|
||||||
Total number of noop operations.
|
Total number of noop operations.
|
||||||
|
|
||||||
`is_throttled`::
|
`is_throttled`::
|
||||||
(boolean)
|
(Boolean)
|
||||||
Number of times
|
Number of times
|
||||||
operations were throttled.
|
operations were throttled.
|
||||||
|
|
||||||
|
|
|
@ -58,11 +58,11 @@ query parameter, which will attempt a single retry round for these shards.
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`dry_run`::
|
`dry_run`::
|
||||||
(Optional, boolean) If `true`, then the request simulates the operation only
|
(Optional, Boolean) If `true`, then the request simulates the operation only
|
||||||
and returns the resulting state.
|
and returns the resulting state.
|
||||||
|
|
||||||
`explain`::
|
`explain`::
|
||||||
(Optional, boolean) If `true`, then the response contains an explanation of
|
(Optional, Boolean) If `true`, then the response contains an explanation of
|
||||||
why the commands can or cannot be executed.
|
why the commands can or cannot be executed.
|
||||||
|
|
||||||
`metric`::
|
`metric`::
|
||||||
|
@ -99,7 +99,7 @@ query parameter, which will attempt a single retry round for these shards.
|
||||||
|
|
||||||
|
|
||||||
`retry_failed`::
|
`retry_failed`::
|
||||||
(Optional, boolean) If `true`, then retries allocation of shards that are
|
(Optional, Boolean) If `true`, then retries allocation of shards that are
|
||||||
blocked due to too many subsequent allocation failures.
|
blocked due to too many subsequent allocation failures.
|
||||||
|
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
||||||
|
|
|
@ -99,7 +99,7 @@ To target all data streams and indices in a cluster, omit this parameter or use
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`allow_no_indices`::
|
`allow_no_indices`::
|
||||||
(Optional, boolean) If `true`, the wildcard indices expression that resolves
|
(Optional, Boolean) If `true`, the wildcard indices expression that resolves
|
||||||
into no concrete indices will be ignored. (This includes `_all` string or
|
into no concrete indices will be ignored. (This includes `_all` string or
|
||||||
when no indices have been specified).
|
when no indices have been specified).
|
||||||
+
|
+
|
||||||
|
@ -113,7 +113,7 @@ Defaults to `true`.
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
|
||||||
|
|
||||||
`ignore_unavailable`::
|
`ignore_unavailable`::
|
||||||
(Optional, boolean) If `true`, unavailable indices (missing or closed) will
|
(Optional, Boolean) If `true`, unavailable indices (missing or closed) will
|
||||||
be ignored.
|
be ignored.
|
||||||
|
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
|
||||||
|
|
|
@ -885,11 +885,11 @@ The full version number includes a plus sign (`+`) followed by the build number.
|
||||||
Vendor of the JVM.
|
Vendor of the JVM.
|
||||||
|
|
||||||
`bundled_jdk`::
|
`bundled_jdk`::
|
||||||
(boolean)
|
(Boolean)
|
||||||
If `true`, the JVM includes a bundled Java Development Kit (JDK).
|
If `true`, the JVM includes a bundled Java Development Kit (JDK).
|
||||||
|
|
||||||
`using_bundled_jdk`::
|
`using_bundled_jdk`::
|
||||||
(boolean)
|
(Boolean)
|
||||||
If `true`, a bundled JDK is in use by JVM.
|
If `true`, a bundled JDK is in use by JVM.
|
||||||
|
|
||||||
`count`::
|
`count`::
|
||||||
|
@ -1019,7 +1019,7 @@ Provider Interface (SPI).
|
||||||
If this plugin extends no other plugins, this array is empty.
|
If this plugin extends no other plugins, this array is empty.
|
||||||
|
|
||||||
`has_native_controller`:::
|
`has_native_controller`:::
|
||||||
(boolean)
|
(Boolean)
|
||||||
If `true`, the plugin has a native controller process.
|
If `true`, the plugin has a native controller process.
|
||||||
======
|
======
|
||||||
=====
|
=====
|
||||||
|
|
|
@ -233,7 +233,7 @@ example, the following command will cancel all reindex tasks running on the
|
||||||
nodes `nodeId1` and `nodeId2`.
|
nodes `nodeId1` and `nodeId2`.
|
||||||
|
|
||||||
`wait_for_completion`::
|
`wait_for_completion`::
|
||||||
(Optional, boolean) If `true`, the request blocks until the cancellation of the
|
(Optional, Boolean) If `true`, the request blocks until the cancellation of the
|
||||||
task and its descendant tasks is completed. Otherwise, the request can return soon
|
task and its descendant tasks is completed. Otherwise, the request can return soon
|
||||||
after the cancellation is started. Defaults to `false`.
|
after the cancellation is started. Defaults to `false`.
|
||||||
|
|
||||||
|
|
|
@ -47,7 +47,7 @@ difficult to notice these discrepancies.
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
|
||||||
|
|
||||||
`include_defaults`::
|
`include_defaults`::
|
||||||
(Optional, boolean) If `true`, returns all default cluster settings.
|
(Optional, Boolean) If `true`, returns all default cluster settings.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
||||||
|
|
|
@ -64,7 +64,7 @@ condition is satisfied, the request fails and returns an error. Defaults to
|
||||||
`30s`.
|
`30s`.
|
||||||
|
|
||||||
`wait_for_removal`::
|
`wait_for_removal`::
|
||||||
(Optional, boolean) Specifies whether to wait for all excluded nodes to be
|
(Optional, Boolean) Specifies whether to wait for all excluded nodes to be
|
||||||
removed from the cluster before clearing the voting configuration exclusions
|
removed from the cluster before clearing the voting configuration exclusions
|
||||||
list. Defaults to `true`, meaning that all excluded nodes must be removed from
|
list. Defaults to `true`, meaning that all excluded nodes must be removed from
|
||||||
the cluster before this API takes any action. If set to `false` then the voting
|
the cluster before this API takes any action. If set to `false` then the voting
|
||||||
|
|
|
@ -305,7 +305,7 @@ information.
|
||||||
How long, in milliseconds, it took to process the bulk request.
|
How long, in milliseconds, it took to process the bulk request.
|
||||||
|
|
||||||
`errors`::
|
`errors`::
|
||||||
(boolean)
|
(Boolean)
|
||||||
If `true`, one or more of the operations in the bulk request did not complete
|
If `true`, one or more of the operations in the bulk request did not complete
|
||||||
successfully.
|
successfully.
|
||||||
|
|
||||||
|
|
|
@ -161,7 +161,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=preference]
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=realtime]
|
||||||
|
|
||||||
`refresh`::
|
`refresh`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, {es} refreshes the affected shards to make this operation visible to
|
If `true`, {es} refreshes the affected shards to make this operation visible to
|
||||||
search. If `false`, do nothing with refreshes. Defaults to `false`.
|
search. If `false`, do nothing with refreshes. Defaults to `false`.
|
||||||
|
|
||||||
|
|
|
@ -97,7 +97,7 @@ Required if no index is specified in the request URI.
|
||||||
Required if routing is used during indexing.
|
Required if routing is used during indexing.
|
||||||
|
|
||||||
`_source`::
|
`_source`::
|
||||||
(Optional, boolean) If `false`, excludes all `_source` fields. Defaults to `true`.
|
(Optional, Boolean) If `false`, excludes all `_source` fields. Defaults to `true`.
|
||||||
`source_include`:::
|
`source_include`:::
|
||||||
(Optional, array) The fields to extract and return from the `_source` field.
|
(Optional, array) The fields to extract and return from the `_source` field.
|
||||||
`source_exclude`:::
|
`source_exclude`:::
|
||||||
|
|
|
@ -550,7 +550,7 @@ For more information, see <<modules-scripting>>.
|
||||||
|
|
||||||
`timed_out`::
|
`timed_out`::
|
||||||
|
|
||||||
{boolean) This flag is set to `true` if any of the requests executed during the
|
{Boolean) This flag is set to `true` if any of the requests executed during the
|
||||||
reindex timed out.
|
reindex timed out.
|
||||||
|
|
||||||
`total`::
|
`total`::
|
||||||
|
|
|
@ -57,7 +57,7 @@ To search all data streams and indices in a cluster, use
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`allow_no_indices`::
|
`allow_no_indices`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
+
|
+
|
||||||
NOTE: This parameter's behavior differs from the `allow_no_indices` parameter
|
NOTE: This parameter's behavior differs from the `allow_no_indices` parameter
|
||||||
used in other <<multi-index,multi-target APIs>>.
|
used in other <<multi-index,multi-target APIs>>.
|
||||||
|
@ -81,7 +81,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
|
||||||
Defaults to `open`.
|
Defaults to `open`.
|
||||||
|
|
||||||
`ignore_unavailable`::
|
`ignore_unavailable`::
|
||||||
(Optional, boolean) If `true`, missing or closed indices are not included in the
|
(Optional, Boolean) If `true`, missing or closed indices are not included in the
|
||||||
response. Defaults to `true`.
|
response. Defaults to `true`.
|
||||||
|
|
||||||
`keep_alive`::
|
`keep_alive`::
|
||||||
|
@ -110,7 +110,7 @@ If both parameters are specified, only the query parameter is used.
|
||||||
`keep_on_completion`::
|
`keep_on_completion`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the search and its results are stored on the cluster.
|
If `true`, the search and its results are stored on the cluster.
|
||||||
|
|
||||||
If `false`, the search and its results are stored on the cluster only if the
|
If `false`, the search and its results are stored on the cluster only if the
|
||||||
|
@ -209,7 +209,7 @@ If both parameters are specified, only the query parameter is used.
|
||||||
`keep_on_completion`::
|
`keep_on_completion`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the search and its results are stored on the cluster.
|
If `true`, the search and its results are stored on the cluster.
|
||||||
|
|
||||||
If `false`, the search and its results are stored on the cluster only if the
|
If `false`, the search and its results are stored on the cluster only if the
|
||||||
|
@ -320,13 +320,13 @@ API>> to get the current status and available results for the search.
|
||||||
--
|
--
|
||||||
|
|
||||||
`is_partial`::
|
`is_partial`::
|
||||||
(boolean)
|
(Boolean)
|
||||||
If `true`, the response does not contain complete search results.
|
If `true`, the response does not contain complete search results.
|
||||||
|
|
||||||
`is_running`::
|
`is_running`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(boolean)
|
(Boolean)
|
||||||
If `true`, the search request is still executing.
|
If `true`, the search request is still executing.
|
||||||
|
|
||||||
[IMPORTANT]
|
[IMPORTANT]
|
||||||
|
@ -366,7 +366,7 @@ Took time does *not* include:
|
||||||
--
|
--
|
||||||
|
|
||||||
`timed_out`::
|
`timed_out`::
|
||||||
(boolean)
|
(Boolean)
|
||||||
If `true`, the request timed out before completion.
|
If `true`, the request timed out before completion.
|
||||||
|
|
||||||
`hits`::
|
`hits`::
|
||||||
|
|
|
@ -137,7 +137,7 @@ field data types:
|
||||||
--
|
--
|
||||||
|
|
||||||
`<greedy_matching>`::
|
`<greedy_matching>`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, match the longest possible substring, similar to `.*` in regular
|
If `true`, match the longest possible substring, similar to `.*` in regular
|
||||||
expressions. If `false`, match the shortest possible substring, similar to `.*?`
|
expressions. If `false`, match the shortest possible substring, similar to `.*?`
|
||||||
in regular expressions. Defaults to `false`.
|
in regular expressions. Defaults to `false`.
|
||||||
|
|
|
@ -11,7 +11,7 @@ Permanently removes the index.
|
||||||
|
|
||||||
`delete_searchable_snapshot`::
|
`delete_searchable_snapshot`::
|
||||||
beta:[]
|
beta:[]
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
Deletes the searchable snapshot created in the cold phase.
|
Deletes the searchable snapshot created in the cold phase.
|
||||||
Defaults to `true`.
|
Defaults to `true`.
|
||||||
This option is applicable when the <<ilm-searchable-snapshot-action,searchable
|
This option is applicable when the <<ilm-searchable-snapshot-action,searchable
|
||||||
|
|
|
@ -33,7 +33,7 @@ and can be configured manually or via <<indices-templates, index templates>>.
|
||||||
==== Options
|
==== Options
|
||||||
|
|
||||||
`enabled`::
|
`enabled`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
Controls whether {ilm-init} automatically migrates the index during this phase.
|
Controls whether {ilm-init} automatically migrates the index during this phase.
|
||||||
Defaults to `true`.
|
Defaults to `true`.
|
||||||
|
|
||||||
|
|
|
@ -33,7 +33,7 @@ Specifies where to store the snapshot.
|
||||||
See <<snapshots-register-repository>> for more information.
|
See <<snapshots-register-repository>> for more information.
|
||||||
|
|
||||||
`force_merge_index`::
|
`force_merge_index`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
Force merges the managed index to one segment.
|
Force merges the managed index to one segment.
|
||||||
Defaults to `true`.
|
Defaults to `true`.
|
||||||
If the managed index was already force merged using the
|
If the managed index was already force merged using the
|
||||||
|
|
|
@ -44,11 +44,11 @@ To target all data streams and indices in a cluster, use `_all` or `*`.
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`only_managed`::
|
`only_managed`::
|
||||||
(Optional, boolean) Filters the returned indices to only indices that are managed by
|
(Optional, Boolean) Filters the returned indices to only indices that are managed by
|
||||||
{ilm-init}.
|
{ilm-init}.
|
||||||
|
|
||||||
`only_errors`::
|
`only_errors`::
|
||||||
(Optional, boolean) Filters the returned indices to only indices that are managed by
|
(Optional, Boolean) Filters the returned indices to only indices that are managed by
|
||||||
{ilm-init} and are in an error state, either due to an encountering an error while
|
{ilm-init} and are in an error state, either due to an encountering an error while
|
||||||
executing the policy, or attempting to use a policy that does not exist.
|
executing the policy, or attempting to use a policy that does not exist.
|
||||||
|
|
||||||
|
|
|
@ -111,18 +111,18 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-alias-filter]
|
||||||
See <<filtered>> for an example.
|
See <<filtered>> for an example.
|
||||||
|
|
||||||
`is_hidden`::
|
`is_hidden`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the alias will be excluded from wildcard expressions by default,
|
If `true`, the alias will be excluded from wildcard expressions by default,
|
||||||
unless overriden in the request using the `expand_wildcards` parameter,
|
unless overriden in the request using the `expand_wildcards` parameter,
|
||||||
similar to <<index-hidden,hidden indices>>. This property must be set to the
|
similar to <<index-hidden,hidden indices>>. This property must be set to the
|
||||||
same value on all indices that share an alias. Defaults to `false`.
|
same value on all indices that share an alias. Defaults to `false`.
|
||||||
|
|
||||||
`must_exist`::
|
`must_exist`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the alias to remove must exist. Defaults to `false`.
|
If `true`, the alias to remove must exist. Defaults to `false`.
|
||||||
|
|
||||||
`is_write_index`::
|
`is_write_index`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, assigns the index as an alias's write index.
|
If `true`, assigns the index as an alias's write index.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
+
|
+
|
||||||
|
|
|
@ -81,7 +81,7 @@ Array of character filters used to preprocess characters before the tokenizer.
|
||||||
See <<analysis-charfilters>> for a list of character filters.
|
See <<analysis-charfilters>> for a list of character filters.
|
||||||
|
|
||||||
`explain`::
|
`explain`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the response includes token attributes and additional details.
|
If `true`, the response includes token attributes and additional details.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
experimental:[The format of the additional detail information is labelled as experimental in Lucene and it may change in the future.]
|
experimental:[The format of the additional detail information is labelled as experimental in Lucene and it may change in the future.]
|
||||||
|
|
|
@ -48,7 +48,7 @@ Defaults to `open`.
|
||||||
`fielddata`::
|
`fielddata`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`,
|
If `true`,
|
||||||
clears the fields cache.
|
clears the fields cache.
|
||||||
|
|
||||||
|
@ -78,12 +78,12 @@ used to limit the request.
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
|
||||||
|
|
||||||
`query`::
|
`query`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`,
|
If `true`,
|
||||||
clears the query cache.
|
clears the query cache.
|
||||||
|
|
||||||
`request`::
|
`request`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`,
|
If `true`,
|
||||||
clears the request cache.
|
clears the request cache.
|
||||||
|
|
||||||
|
|
|
@ -88,7 +88,7 @@ Name of the component template to create.
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`create`::
|
`create`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, this request cannot replace or update existing component templates.
|
If `true`, this request cannot replace or update existing component templates.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
||||||
|
|
|
@ -37,7 +37,7 @@ UUID of the index to delete. You can find this using the
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`accept_data_loss`::
|
`accept_data_loss`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
This field must be set to `true` in order to carry out the import, since it will
|
This field must be set to `true` in order to carry out the import, since it will
|
||||||
no longer be possible to recover the data from the dangling index.
|
no longer be possible to recover the data from the dangling index.
|
||||||
|
|
||||||
|
|
|
@ -36,7 +36,7 @@ UUID of the index to import, which you can find using the
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`accept_data_loss`::
|
`accept_data_loss`::
|
||||||
(Required, boolean)
|
(Required, Boolean)
|
||||||
This field must be set to `true` to import a dangling index. Because {es}
|
This field must be set to `true` to import a dangling index. Because {es}
|
||||||
cannot know where the dangling index data came from or determine which shard
|
cannot know where the dangling index data came from or determine which shard
|
||||||
copies are fresh and which are stale, it cannot guarantee that the imported data
|
copies are fresh and which are stale, it cannot guarantee that the imported data
|
||||||
|
|
|
@ -73,7 +73,7 @@ To target all data streams in a cluster, omit this parameter or use `*`.
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`human`::
|
`human`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the response includes statistics in human-readable <<byte-units,byte
|
If `true`, the response includes statistics in human-readable <<byte-units,byte
|
||||||
values>>. Defaults to `false`.
|
values>>. Defaults to `false`.
|
||||||
|
|
||||||
|
|
|
@ -76,7 +76,7 @@ Defaults to `open`.
|
||||||
`force`::
|
`force`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`,
|
If `true`,
|
||||||
the request forces a flush
|
the request forces a flush
|
||||||
even if there are no changes to commit to the index.
|
even if there are no changes to commit to the index.
|
||||||
|
@ -94,7 +94,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailab
|
||||||
`wait_if_ongoing`::
|
`wait_if_ongoing`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`,
|
If `true`,
|
||||||
the flush operation blocks until execution
|
the flush operation blocks until execution
|
||||||
when another flush operation is running.
|
when another flush operation is running.
|
||||||
|
|
|
@ -90,7 +90,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
|
||||||
Defaults to `open`.
|
Defaults to `open`.
|
||||||
|
|
||||||
`flush`::
|
`flush`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`,
|
If `true`,
|
||||||
{es} performs a <<indices-flush,flush>> on the indices
|
{es} performs a <<indices-flush,flush>> on the indices
|
||||||
after the force merge.
|
after the force merge.
|
||||||
|
@ -113,7 +113,7 @@ If so, executes it.
|
||||||
`only_expunge_deletes`::
|
`only_expunge_deletes`::
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`,
|
If `true`,
|
||||||
only expunge segments containing document deletions.
|
only expunge segments containing document deletions.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
|
@ -51,7 +51,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
|
||||||
Defaults to `all`.
|
Defaults to `all`.
|
||||||
|
|
||||||
`ignore_unavailable`::
|
`ignore_unavailable`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `false`, requests that include a missing index in the `<index>` argument
|
If `false`, requests that include a missing index in the `<index>` argument
|
||||||
return an error. Defaults to `false`.
|
return an error. Defaults to `false`.
|
||||||
|
|
||||||
|
|
|
@ -54,7 +54,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-type-name]
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
|
||||||
|
|
||||||
`include_defaults`::
|
`include_defaults`::
|
||||||
(Optional, boolean) If `true`, the response includes default mapping values.
|
(Optional, Boolean) If `true`, the response includes default mapping values.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
||||||
`local`::
|
`local`::
|
||||||
|
|
|
@ -54,7 +54,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-defaults]
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-type-name]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-type-name]
|
||||||
|
|
||||||
`ignore_unavailable`::
|
`ignore_unavailable`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `false`, requests that target a missing index return an error. Defaults to
|
If `false`, requests that target a missing index return an error. Defaults to
|
||||||
`false`.
|
`false`.
|
||||||
|
|
||||||
|
|
|
@ -85,7 +85,7 @@ Name of the component template to create.
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`create`::
|
`create`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, this request cannot replace or update existing component templates.
|
If `true`, this request cannot replace or update existing component templates.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
||||||
|
|
|
@ -95,7 +95,7 @@ Name of the index template to create.
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`create`::
|
`create`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, this request cannot replace or update existing index templates.
|
If `true`, this request cannot replace or update existing index templates.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
||||||
|
|
|
@ -70,7 +70,7 @@ Name of the index template to create.
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`create`::
|
`create`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, this request cannot replace or update existing index templates. Defaults to `false`.
|
If `true`, this request cannot replace or update existing index templates. Defaults to `false`.
|
||||||
|
|
||||||
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
|
||||||
|
|
|
@ -66,7 +66,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailab
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
||||||
|
|
||||||
`write_index_only`::
|
`write_index_only`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`,
|
If `true`,
|
||||||
the mappings are applied only to the current write index for the target.
|
the mappings are applied only to the current write index for the target.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
|
@ -115,7 +115,7 @@ is required.
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`dry_run`::
|
`dry_run`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`,
|
If `true`,
|
||||||
the request checks whether the index matches provided conditions
|
the request checks whether the index matches provided conditions
|
||||||
but does not perform a rollover.
|
but does not perform a rollover.
|
||||||
|
|
|
@ -50,7 +50,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailab
|
||||||
|
|
||||||
`verbose`::
|
`verbose`::
|
||||||
experimental:[]
|
experimental:[]
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, the response includes detailed information
|
If `true`, the response includes detailed information
|
||||||
about Lucene's memory usage.
|
about Lucene's memory usage.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
|
@ -82,7 +82,7 @@ omit this parameter and specify the template configuration in the request body.
|
||||||
////
|
////
|
||||||
|
|
||||||
`create`::
|
`create`::
|
||||||
(Optional, boolean) If `true`, the template passed in the body is
|
(Optional, Boolean) If `true`, the template passed in the body is
|
||||||
only used if no existing templates match the same index patterns.
|
only used if no existing templates match the same index patterns.
|
||||||
If `false`, the simulation uses the template with the highest priority.
|
If `false`, the simulation uses the template with the highest priority.
|
||||||
Note that the template is not permanently added or updated in either case;
|
Note that the template is not permanently added or updated in either case;
|
||||||
|
|
|
@ -78,7 +78,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=completion-fields]
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fielddata-fields]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fielddata-fields]
|
||||||
|
|
||||||
`forbid_closed_indices`::
|
`forbid_closed_indices`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, statistics are *not* collected from closed indices.
|
If `true`, statistics are *not* collected from closed indices.
|
||||||
Defaults to `true`.
|
Defaults to `true`.
|
||||||
|
|
||||||
|
|
|
@ -55,7 +55,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
|
||||||
|
|
||||||
`preserve_existing`::
|
`preserve_existing`::
|
||||||
(Optional, boolean) If `true`, existing index settings remain unchanged.
|
(Optional, Boolean) If `true`, existing index settings remain unchanged.
|
||||||
Defaults to `false`.
|
Defaults to `false`.
|
||||||
|
|
||||||
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
||||||
|
|
|
@ -106,6 +106,6 @@ Enrich policy to execute.
|
||||||
==== {api-request-body-title}
|
==== {api-request-body-title}
|
||||||
|
|
||||||
`wait_for_completion`::
|
`wait_for_completion`::
|
||||||
(Required, boolean)
|
(Required, Boolean)
|
||||||
If `true`, the request blocks other enrich policy execution requests until
|
If `true`, the request blocks other enrich policy execution requests until
|
||||||
complete. Defaults to `true`.
|
complete. Defaults to `true`.
|
||||||
|
|
|
@ -86,7 +86,7 @@ Pipeline ID used to simulate an ingest.
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`verbose`::
|
`verbose`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`,
|
If `true`,
|
||||||
the response includes output data
|
the response includes output data
|
||||||
for each processor in the executed pipeline.
|
for each processor in the executed pipeline.
|
||||||
|
|
|
@ -27,7 +27,7 @@ https://www.elastic.co/subscriptions.
|
||||||
==== Query Parameters
|
==== Query Parameters
|
||||||
|
|
||||||
`local`::
|
`local`::
|
||||||
(boolean) Specifies whether to retrieve local information. The default value
|
(Boolean) Specifies whether to retrieve local information. The default value
|
||||||
is `false`, which means the information is retrieved from the master node.
|
is `false`, which means the information is retrieved from the master node.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -41,7 +41,7 @@ https://www.elastic.co/subscriptions.
|
||||||
==== {api-query-parms-title}
|
==== {api-query-parms-title}
|
||||||
|
|
||||||
`acknowledge`::
|
`acknowledge`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
Specifies whether you acknowledge the license changes. The default
|
Specifies whether you acknowledge the license changes. The default
|
||||||
value is `false`.
|
value is `false`.
|
||||||
|
|
||||||
|
|
|
@ -203,13 +203,13 @@ may be added to an existing nested object.
|
||||||
|
|
||||||
[[nested-include-in-parent-parm]]
|
[[nested-include-in-parent-parm]]
|
||||||
`include_in_parent`::
|
`include_in_parent`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, all fields in the nested object are also added to the parent document
|
If `true`, all fields in the nested object are also added to the parent document
|
||||||
as standard (flat) fields. Defaults to `false`.
|
as standard (flat) fields. Defaults to `false`.
|
||||||
|
|
||||||
[[nested-include-in-root-parm]]
|
[[nested-include-in-root-parm]]
|
||||||
`include_in_root`::
|
`include_in_root`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
If `true`, all fields in the nested object are also added to the root
|
If `true`, all fields in the nested object are also added to the root
|
||||||
document as standard (flat) fields. Defaults to `false`.
|
document as standard (flat) fields. Defaults to `false`.
|
||||||
|
|
||||||
|
|
|
@ -67,11 +67,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-wildca
|
||||||
== {api-query-parms-title}
|
== {api-query-parms-title}
|
||||||
|
|
||||||
`allow_no_match`::
|
`allow_no_match`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]
|
||||||
|
|
||||||
`force`::
|
`force`::
|
||||||
(Optional, boolean) Use to close a failed job, or to forcefully close a job
|
(Optional, Boolean) Use to close a failed job, or to forcefully close a job
|
||||||
which has not responded to its initial close request.
|
which has not responded to its initial close request.
|
||||||
|
|
||||||
`timeout`::
|
`timeout`::
|
||||||
|
|
|
@ -35,7 +35,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id]
|
||||||
== {api-query-parms-title}
|
== {api-query-parms-title}
|
||||||
|
|
||||||
`force`::
|
`force`::
|
||||||
(Optional, boolean) Use to forcefully delete a started {dfeed}; this method is
|
(Optional, Boolean) Use to forcefully delete a started {dfeed}; this method is
|
||||||
quicker than stopping and deleting the {dfeed}.
|
quicker than stopping and deleting the {dfeed}.
|
||||||
|
|
||||||
[[ml-delete-datafeed-example]]
|
[[ml-delete-datafeed-example]]
|
||||||
|
|
|
@ -54,7 +54,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
|
||||||
== {api-query-parms-title}
|
== {api-query-parms-title}
|
||||||
|
|
||||||
`allow_no_forecasts`::
|
`allow_no_forecasts`::
|
||||||
(Optional, boolean) Specifies whether an error occurs when there are no
|
(Optional, Boolean) Specifies whether an error occurs when there are no
|
||||||
forecasts. In particular, if this parameter is set to `false` and there are no
|
forecasts. In particular, if this parameter is set to `false` and there are no
|
||||||
forecasts associated with the job, attempts to delete all forecasts return an
|
forecasts associated with the job, attempts to delete all forecasts return an
|
||||||
error. The default value is `true`.
|
error. The default value is `true`.
|
||||||
|
|
|
@ -47,7 +47,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
|
||||||
== {api-query-parms-title}
|
== {api-query-parms-title}
|
||||||
|
|
||||||
`force`::
|
`force`::
|
||||||
(Optional, boolean) Use to forcefully delete an opened job; this method is
|
(Optional, Boolean) Use to forcefully delete an opened job; this method is
|
||||||
quicker than closing and deleting the job.
|
quicker than closing and deleting the job.
|
||||||
|
|
||||||
`wait_for_completion`::
|
`wait_for_completion`::
|
||||||
|
|
|
@ -86,7 +86,7 @@ chosen.
|
||||||
of the rows can have a different number of columns than the first row.
|
of the rows can have a different number of columns than the first row.
|
||||||
|
|
||||||
`explain`::
|
`explain`::
|
||||||
(Optional, boolean) If this parameter is set to `true`, the response includes
|
(Optional, Boolean) If this parameter is set to `true`, the response includes
|
||||||
a field named `explanation`, which is an array of strings that indicate how
|
a field named `explanation`, which is an array of strings that indicate how
|
||||||
the structure finder produced its result. The default value is `false`.
|
the structure finder produced its result. The default value is `false`.
|
||||||
|
|
||||||
|
@ -109,7 +109,7 @@ columns than the first row.
|
||||||
a Grok pattern.
|
a Grok pattern.
|
||||||
|
|
||||||
`has_header_row`::
|
`has_header_row`::
|
||||||
(Optional, boolean) If you have set `format` to `delimited`, you can use this
|
(Optional, Boolean) If you have set `format` to `delimited`, you can use this
|
||||||
parameter to indicate whether the column names are in the first row of the
|
parameter to indicate whether the column names are in the first row of the
|
||||||
file. If this parameter is not specified, the structure finder guesses based
|
file. If this parameter is not specified, the structure finder guesses based
|
||||||
on the similarity of the first row of the file to other rows.
|
on the similarity of the first row of the file to other rows.
|
||||||
|
@ -146,7 +146,7 @@ to request analysis of 100000 lines to achieve some variety.
|
||||||
argument to a character that does not appear anywhere in the sample.
|
argument to a character that does not appear anywhere in the sample.
|
||||||
|
|
||||||
`should_trim_fields`::
|
`should_trim_fields`::
|
||||||
(Optional, boolean) If you have set `format` to `delimited`, you can specify
|
(Optional, Boolean) If you have set `format` to `delimited`, you can specify
|
||||||
whether values between delimiters should have whitespace trimmed from them. If
|
whether values between delimiters should have whitespace trimmed from them. If
|
||||||
this parameter is not specified and the delimiter is pipe (`|`), the default
|
this parameter is not specified and the delimiter is pipe (`|`), the default
|
||||||
value is `true`. Otherwise, the default value is `false`.
|
value is `true`. Otherwise, the default value is `false`.
|
||||||
|
|
|
@ -48,7 +48,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
|
||||||
generated and the model is updated for data from the specified time interval.
|
generated and the model is updated for data from the specified time interval.
|
||||||
|
|
||||||
`calc_interim`::
|
`calc_interim`::
|
||||||
(boolean) Optional. If true, calculates the interim results for the most
|
(Boolean) Optional. If true, calculates the interim results for the most
|
||||||
recent bucket or all buckets within the latency period.
|
recent bucket or all buckets within the latency period.
|
||||||
|
|
||||||
`end`::
|
`end`::
|
||||||
|
|
|
@ -50,18 +50,18 @@ specify this parameter, the API returns information about all buckets.
|
||||||
this value.
|
this value.
|
||||||
|
|
||||||
`desc`::
|
`desc`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=desc-results]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=desc-results]
|
||||||
|
|
||||||
`end`::
|
`end`::
|
||||||
(Optional, string) Returns buckets with timestamps earlier than this time.
|
(Optional, string) Returns buckets with timestamps earlier than this time.
|
||||||
|
|
||||||
`exclude_interim`::
|
`exclude_interim`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results]
|
||||||
|
|
||||||
`expand`::
|
`expand`::
|
||||||
(Optional, boolean) If true, the output includes anomaly records.
|
(Optional, Boolean) If true, the output includes anomaly records.
|
||||||
|
|
||||||
`page`.`from`::
|
`page`.`from`::
|
||||||
(Optional, integer) Skips the specified number of buckets.
|
(Optional, integer) Skips the specified number of buckets.
|
||||||
|
@ -113,7 +113,7 @@ initial value that was calculated at the time the bucket was processed.
|
||||||
(string) The field value of the influencer.
|
(string) The field value of the influencer.
|
||||||
|
|
||||||
`is_interim`:::
|
`is_interim`:::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim]
|
||||||
|
|
||||||
`job_id`:::
|
`job_id`:::
|
||||||
|
@ -148,7 +148,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=bucket-span-results]
|
||||||
the initial value that was calculated at the time the bucket was processed.
|
the initial value that was calculated at the time the bucket was processed.
|
||||||
|
|
||||||
`is_interim`::
|
`is_interim`::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim]
|
||||||
|
|
||||||
`job_id`::
|
`job_id`::
|
||||||
|
|
|
@ -57,7 +57,7 @@ all {dfeeds}.
|
||||||
== {api-query-parms-title}
|
== {api-query-parms-title}
|
||||||
|
|
||||||
`allow_no_match`::
|
`allow_no_match`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]
|
||||||
|
|
||||||
[role="child_attributes"]
|
[role="child_attributes"]
|
||||||
|
|
|
@ -54,7 +54,7 @@ all {dfeeds}.
|
||||||
== {api-query-parms-title}
|
== {api-query-parms-title}
|
||||||
|
|
||||||
`allow_no_match`::
|
`allow_no_match`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]
|
||||||
|
|
||||||
[[ml-get-datafeed-results]]
|
[[ml-get-datafeed-results]]
|
||||||
|
|
|
@ -41,14 +41,14 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
|
||||||
== {api-request-body-title}
|
== {api-request-body-title}
|
||||||
|
|
||||||
`desc`::
|
`desc`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=desc-results]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=desc-results]
|
||||||
|
|
||||||
`end`::
|
`end`::
|
||||||
(Optional, string) Returns influencers with timestamps earlier than this time.
|
(Optional, string) Returns influencers with timestamps earlier than this time.
|
||||||
|
|
||||||
`exclude_interim`::
|
`exclude_interim`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results]
|
||||||
|
|
||||||
`influencer_score`::
|
`influencer_score`::
|
||||||
|
@ -97,7 +97,7 @@ the influencer aggregated across detectors. This is the initial value that was
|
||||||
calculated at the time the bucket was processed.
|
calculated at the time the bucket was processed.
|
||||||
|
|
||||||
`is_interim`::
|
`is_interim`::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim]
|
||||||
|
|
||||||
`job_id`::
|
`job_id`::
|
||||||
|
|
|
@ -47,7 +47,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-defaul
|
||||||
== {api-query-parms-title}
|
== {api-query-parms-title}
|
||||||
|
|
||||||
`allow_no_match`::
|
`allow_no_match`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]
|
||||||
|
|
||||||
[role="child_attributes"]
|
[role="child_attributes"]
|
||||||
|
@ -143,7 +143,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=sparse-bucket-count]
|
||||||
//End data_counts
|
//End data_counts
|
||||||
|
|
||||||
`deleting`::
|
`deleting`::
|
||||||
(boolean)
|
(Boolean)
|
||||||
Indicates that the process of deleting the job is in progress but not yet
|
Indicates that the process of deleting the job is in progress but not yet
|
||||||
completed. It is only reported when `true`.
|
completed. It is only reported when `true`.
|
||||||
|
|
||||||
|
|
|
@ -47,7 +47,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-defaul
|
||||||
== {api-query-parms-title}
|
== {api-query-parms-title}
|
||||||
|
|
||||||
`allow_no_match`::
|
`allow_no_match`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]
|
||||||
|
|
||||||
[[ml-get-job-results]]
|
[[ml-get-job-results]]
|
||||||
|
|
|
@ -63,7 +63,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-wildca
|
||||||
== {api-request-body-title}
|
== {api-request-body-title}
|
||||||
|
|
||||||
`allow_no_match`::
|
`allow_no_match`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-jobs]
|
||||||
|
|
||||||
`bucket_span`::
|
`bucket_span`::
|
||||||
|
@ -76,7 +76,7 @@ value.
|
||||||
time.
|
time.
|
||||||
|
|
||||||
`exclude_interim`::
|
`exclude_interim`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results]
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
|
@ -105,7 +105,7 @@ properties:
|
||||||
(number) The length of the bucket in seconds. Matches the job with the longest `bucket_span` value.
|
(number) The length of the bucket in seconds. Matches the job with the longest `bucket_span` value.
|
||||||
|
|
||||||
`is_interim`::
|
`is_interim`::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim]
|
||||||
|
|
||||||
`jobs`::
|
`jobs`::
|
||||||
|
|
|
@ -50,14 +50,14 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
|
||||||
== {api-request-body-title}
|
== {api-request-body-title}
|
||||||
|
|
||||||
`desc`::
|
`desc`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=desc-results]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=desc-results]
|
||||||
|
|
||||||
`end`::
|
`end`::
|
||||||
(Optional, string) Returns records with timestamps earlier than this time.
|
(Optional, string) Returns records with timestamps earlier than this time.
|
||||||
|
|
||||||
`exclude_interim`::
|
`exclude_interim`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=exclude-interim-results]
|
||||||
|
|
||||||
`page`.`from`::
|
`page`.`from`::
|
||||||
|
@ -145,7 +145,7 @@ the anomalousness of this record. This is the initial value that was calculated
|
||||||
at the time the bucket was processed.
|
at the time the bucket was processed.
|
||||||
|
|
||||||
`is_interim`::
|
`is_interim`::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=is-interim]
|
||||||
|
|
||||||
`job_id`::
|
`job_id`::
|
||||||
|
|
|
@ -44,7 +44,7 @@ by specifying `*` as the `<snapshot_id>`, or by omitting the `<snapshot_id>`.
|
||||||
== {api-request-body-title}
|
== {api-request-body-title}
|
||||||
|
|
||||||
`desc`::
|
`desc`::
|
||||||
(Optional, boolean) If true, the results are sorted in descending order.
|
(Optional, Boolean) If true, the results are sorted in descending order.
|
||||||
|
|
||||||
`end`::
|
`end`::
|
||||||
(Optional, date) Returns snapshots with timestamps earlier than this time.
|
(Optional, date) Returns snapshots with timestamps earlier than this time.
|
||||||
|
@ -186,7 +186,7 @@ separately for each detector and partition.
|
||||||
//End model_size_stats
|
//End model_size_stats
|
||||||
|
|
||||||
`retain`::
|
`retain`::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=retain]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=retain]
|
||||||
|
|
||||||
`snapshot_id`::
|
`snapshot_id`::
|
||||||
|
|
|
@ -55,7 +55,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
|
||||||
open lazily and has not yet been assigned to a node, this value is an empty string.
|
open lazily and has not yet been assigned to a node, this value is an empty string.
|
||||||
|
|
||||||
`opened`::
|
`opened`::
|
||||||
(boolean) For a successful response, this value is always `true`. On failure, an
|
(Boolean) For a successful response, this value is always `true`. On failure, an
|
||||||
exception is returned instead.
|
exception is returned instead.
|
||||||
|
|
||||||
[[ml-open-job-example]]
|
[[ml-open-job-example]]
|
||||||
|
|
|
@ -40,7 +40,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-define
|
||||||
== {api-request-body-title}
|
== {api-request-body-title}
|
||||||
|
|
||||||
`allow_lazy_open`::
|
`allow_lazy_open`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-lazy-open]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-lazy-open]
|
||||||
|
|
||||||
//Begin analysis_config
|
//Begin analysis_config
|
||||||
|
@ -169,7 +169,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=over-field-name]
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=partition-field-name]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=partition-field-name]
|
||||||
|
|
||||||
`use_null`::::
|
`use_null`::::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=use-null]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=use-null]
|
||||||
=====
|
=====
|
||||||
//End analysis_config.detectors
|
//End analysis_config.detectors
|
||||||
|
@ -183,7 +183,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=influencers]
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latency]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=latency]
|
||||||
|
|
||||||
`multivariate_by_fields`:::
|
`multivariate_by_fields`:::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=multivariate-by-fields]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=multivariate-by-fields]
|
||||||
|
|
||||||
//Begin analysis_config.per_partition_categorization
|
//Begin analysis_config.per_partition_categorization
|
||||||
|
@ -195,11 +195,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization]
|
||||||
[%collapsible%open]
|
[%collapsible%open]
|
||||||
=====
|
=====
|
||||||
`enabled`::::
|
`enabled`::::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-enabled]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-enabled]
|
||||||
|
|
||||||
`stop_on_warn`::::
|
`stop_on_warn`::::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-stop-on-warn]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-stop-on-warn]
|
||||||
=====
|
=====
|
||||||
//End analysis_config.per_partition_categorization
|
//End analysis_config.per_partition_categorization
|
||||||
|
@ -262,11 +262,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config]
|
||||||
[%collapsible%open]
|
[%collapsible%open]
|
||||||
====
|
====
|
||||||
`annotations_enabled`:::
|
`annotations_enabled`:::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-annotations-enabled]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-annotations-enabled]
|
||||||
|
|
||||||
`enabled`:::
|
`enabled`:::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-enabled]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-enabled]
|
||||||
|
|
||||||
`terms`:::
|
`terms`:::
|
||||||
|
|
|
@ -47,7 +47,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id]
|
||||||
== {api-request-body-title}
|
== {api-request-body-title}
|
||||||
|
|
||||||
`delete_intervening_results`::
|
`delete_intervening_results`::
|
||||||
(Optional, boolean) If true, deletes the results in the time period between
|
(Optional, Boolean) If true, deletes the results in the time period between
|
||||||
the latest results and the time of the reverted snapshot. It also resets the
|
the latest results and the time of the reverted snapshot. It also resets the
|
||||||
model to accept records for this time period. The default value is false.
|
model to accept records for this time period. The default value is false.
|
||||||
|
|
||||||
|
|
|
@ -60,7 +60,7 @@ IMPORTANT: No new {ml} jobs can be opened while the `upgrade_mode` setting is
|
||||||
== {api-query-parms-title}
|
== {api-query-parms-title}
|
||||||
|
|
||||||
`enabled`::
|
`enabled`::
|
||||||
(Optional, boolean) When `true`, this enables `upgrade_mode`. Defaults to
|
(Optional, Boolean) When `true`, this enables `upgrade_mode`. Defaults to
|
||||||
`false`.
|
`false`.
|
||||||
|
|
||||||
`timeout`::
|
`timeout`::
|
||||||
|
|
|
@ -103,7 +103,7 @@ If the {dfeed} is allowed to open lazily and has not yet been
|
||||||
assigned to a node, this value is an empty string.
|
assigned to a node, this value is an empty string.
|
||||||
|
|
||||||
`started`::
|
`started`::
|
||||||
(boolean) For a successful response, this value is always `true`. On failure, an
|
(Boolean) For a successful response, this value is always `true`. On failure, an
|
||||||
exception is returned instead.
|
exception is returned instead.
|
||||||
|
|
||||||
[[ml-start-datafeed-example]]
|
[[ml-start-datafeed-example]]
|
||||||
|
|
|
@ -47,14 +47,14 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=datafeed-id-wildcard]
|
||||||
== {api-query-parms-title}
|
== {api-query-parms-title}
|
||||||
|
|
||||||
`allow_no_match`::
|
`allow_no_match`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]
|
||||||
|
|
||||||
[[ml-stop-datafeed-request-body]]
|
[[ml-stop-datafeed-request-body]]
|
||||||
== {api-request-body-title}
|
== {api-request-body-title}
|
||||||
|
|
||||||
`force`::
|
`force`::
|
||||||
(Optional, boolean) If true, the {dfeed} is stopped forcefully.
|
(Optional, Boolean) If true, the {dfeed} is stopped forcefully.
|
||||||
|
|
||||||
`timeout`::
|
`timeout`::
|
||||||
(Optional, time) Controls the amount of time to wait until a {dfeed} stops.
|
(Optional, time) Controls the amount of time to wait until a {dfeed} stops.
|
||||||
|
|
|
@ -35,7 +35,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
|
||||||
The following properties can be updated after the job is created:
|
The following properties can be updated after the job is created:
|
||||||
|
|
||||||
`allow_lazy_open`::
|
`allow_lazy_open`::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-lazy-open]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=allow-lazy-open]
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
|
@ -181,11 +181,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config]
|
||||||
[%collapsible%open]
|
[%collapsible%open]
|
||||||
====
|
====
|
||||||
`annotations_enabled`:::
|
`annotations_enabled`:::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-annotations-enabled]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-annotations-enabled]
|
||||||
|
|
||||||
`enabled`:::
|
`enabled`:::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-enabled]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=model-plot-config-enabled]
|
||||||
|
|
||||||
`terms`:::
|
`terms`:::
|
||||||
|
@ -207,11 +207,11 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization]
|
||||||
[%collapsible%open]
|
[%collapsible%open]
|
||||||
====
|
====
|
||||||
`enabled`:::
|
`enabled`:::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-enabled]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-enabled]
|
||||||
|
|
||||||
`stop_on_warn`:::
|
`stop_on_warn`:::
|
||||||
(boolean)
|
(Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-stop-on-warn]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=per-partition-categorization-stop-on-warn]
|
||||||
====
|
====
|
||||||
//End per_partition_categorization
|
//End per_partition_categorization
|
||||||
|
|
|
@ -41,7 +41,7 @@ The following properties can be updated after the model snapshot is created:
|
||||||
(Optional, string) A description of the model snapshot.
|
(Optional, string) A description of the model snapshot.
|
||||||
|
|
||||||
`retain`::
|
`retain`::
|
||||||
(Optional, boolean)
|
(Optional, Boolean)
|
||||||
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=retain]
|
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=retain]
|
||||||
|
|
||||||
[[ml-update-snapshot-example]]
|
[[ml-update-snapshot-example]]
|
||||||
|
|
|
@ -39,7 +39,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-data-frame-analytics]
|
||||||
== {api-query-parms-title}
|
== {api-query-parms-title}
|
||||||
|
|
||||||
`force`::
|
`force`::
|
||||||
(Optional, boolean) If `true`, it deletes a job that is not stopped; this method is
|
(Optional, Boolean) If `true`, it deletes a job that is not stopped; this method is
|
||||||
quicker than stopping and deleting the job.
|
quicker than stopping and deleting the job.
|
||||||
|
|
||||||
`timeout`::
|
`timeout`::
|
||||||
|
|
|
@ -197,7 +197,7 @@ belongs.
|
||||||
`class_name` in the list of their top classes.
|
`class_name` in the list of their top classes.
|
||||||
|
|
||||||
`include_curve`::::
|
`include_curve`::::
|
||||||
(Optional, boolean) Whether or not the curve should be returned in
|
(Optional, Boolean) Whether or not the curve should be returned in
|
||||||
addition to the score. Default value is false.
|
addition to the score. Default value is false.
|
||||||
|
|
||||||
`multiclass_confusion_matrix`:::
|
`multiclass_confusion_matrix`:::
|
||||||
|
|
|
@ -78,10 +78,10 @@ the field names.
|
||||||
[%collapsible%open]
|
[%collapsible%open]
|
||||||
====
|
====
|
||||||
`is_included`:::
|
`is_included`:::
|
||||||
(boolean) Whether the field is selected to be included in the analysis.
|
(Boolean) Whether the field is selected to be included in the analysis.
|
||||||
|
|
||||||
`is_required`:::
|
`is_required`:::
|
||||||
(boolean) Whether the field is required.
|
(Boolean) Whether the field is required.
|
||||||
|
|
||||||
`feature_type`:::
|
`feature_type`:::
|
||||||
(string) The feature type of this field for the analysis. May be `categorical`
|
(string) The feature type of this field for the analysis. May be `categorical`
|
||||||
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue