stack es indices analyze cli command

elastic stack es indices analyze [options]

Get tokens from text analysis.

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--index string

Index used to derive the analyzer. If specified, the analyzer or field parameter overrides this value. If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.

--analyzer string

The name of the analyzer that should be applied to the provided text. This could be a built-in analyzer, or an analyzer that’s been configured in the index.

--attributes string[]

Array of token attributes used to filter the output of the explain parameter.

Repeatable: pass --attributes multiple times to supply more than one value

--char-filter string[]

Array of character filters used to preprocess characters before the tokenizer.

Repeatable: pass --char-filter multiple times to supply more than one value

--explain

If true, the response includes token attributes and additional details.

--field string

Field used to derive the analyzer. To use this parameter, you must specify an index. If specified, the analyzer parameter overrides this value.

--filter string[]

Array of token filters used to apply after the tokenizer.

Repeatable: pass --filter multiple times to supply more than one value

--normalizer string

Normalizer to use to convert text into a single token.

--text string

Text to analyze. If an array of strings is provided, it is analyzed as a multi-value field.

Repeatable: pass --text multiple times to supply more than one value

--tokenizer string

Tokenizer to use to convert text into tokens.

--error-trace

When set to true Elasticsearch will include the full stack trace of errors when they occur.

--filter-path string

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.

Repeatable: pass --filter-path multiple times to supply more than one value

--human

When set to true will return statistics in a format suitable for humans. For example "exists_time": "1h" for humans and "exists_time_in_millis": 3600000 for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.

--pretty

If set to true the returned JSON will be "pretty-formatted". Only use this option for debugging only.

--input-file string

path to a JSON file to use as command input

--dry-run

validate all inputs and exit without performing any action (preview changes without applying them)

--no-validate

skip input validation and send the request as-is

--output-fields string

comma-separated list of fields to include in output (dot-notation supported)

--output-template string

Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")

--json

output as JSON