stack es ml get-trained-models cli command

elastic stack es ml get-trained-models [options]

Get trained model configuration info.

Behaviour flags:

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

--allow-no-match

Specifies what to do when the request: - Contains wildcard expressions and there are no models that match.

• Contains the _all string or no identifiers and there are no matches.
• Contains wildcard expressions and there are only partial matches. If true, it returns an empty array when there are no matches and the subset of results when there are partial matches.

--decompress-definition

Specifies whether the included model definition should be returned as a JSON map (true) or in a custom compressed format (false).

--exclude-generated

Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.

--from number

Skips the specified number of models.

--include enum

A comma delimited string of optional fields to include in the response body.

Values: definition, feature_importance_baseline, hyperparameters, total_feature_importance, definition_status

--size number

Specifies the maximum number of models to obtain.

--tags string

A comma delimited string of tags. A trained model can have many tags, or none. When supplied, only trained models that contain all the supplied tags are returned.

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

--model-id string

The unique identifier of the trained model or a model alias. You can get information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.

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

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