stack es ml put-trained-model cli command
Auth required
Idempotent
Scope: global
elastic stack es ml put-trained-model --model-id <model-id> [options]
Create a trained model.
Behaviour flags:
--dry-run — validate all inputs and exit without performing any action
--model-idstringrequired- The unique identifier of the trained model.
--[no-]defer-definition-decompression- If set to
trueand acompressed_definitionis provided, the request defers definition decompression and skips relevant validations. --[no-]wait-for-completion- Whether to wait for all child operations (e.g. model download) to complete.
--compressed-definitionstring- The compressed (GZipped and Base64 encoded) inference definition of the model. If compressed_definition is specified, then definition cannot be specified.
--definitionstring- The inference definition for the model. If definition is specified, then compressed_definition cannot be specified.
--descriptionstring- A human-readable description of the inference trained model.
--inference-configstring- The default configuration for inference. This can be either a regression or classification configuration. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required.
--inputstring- The input field names for the model definition.
--metadatastring- An object map that contains metadata about the model.
--model-typestring- The model type.
--model-size-bytesnumber- The estimated memory usage in bytes to keep the trained model in memory. This property is supported only if defer_definition_decompression is true or the model definition is not supplied.
--platform-architecturestring- The platform architecture (if applicable) of the trained mode. If the model only works on one platform, because it is heavily optimized for a particular processor architecture and OS combination, then this field specifies which. The format of the string must match the platform identifiers used by Elasticsearch, so one of,
linux-x86_64,linux-aarch64,darwin-x86_64,darwin-aarch64, orwindows-x86_64. For portable models (those that work independent of processor architecture or OS features), leave this field unset. - An array of tags to organize the model.
--prefix-stringsstring- Optional prefix strings applied at inference
--input-filestring- path to a JSON file to use as command input
--[no-]dry-run- validate all inputs and exit without performing any action (preview changes without applying them)
--[no-]json-
output as JSON