Files
elasticsearch-js/docs/reference/api/MlPutDataFrameAnalyticsRequest.md
2025-05-28 10:02:30 -05:00

5.0 KiB

MlPutDataFrameAnalyticsRequest [interface-MlPutDataFrameAnalyticsRequest]

Name Type Description
_meta Metadata  
allow_lazy_start boolean Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node. If set to false and a machine learning node with capacity to run the job cannot be immediately found, the API returns an error. If set to true, the API does not return an error; the job waits in the starting state until sufficient machine learning node capacity is available. This behavior is also affected by the cluster-wide xpack.ml.max_lazy_ml_nodes setting.
analysis MlDataframeAnalysisContainer The analysis configuration, which contains the information necessary to perform one of the following types of analysis: classification, outlier detection, or regression.
analyzed_fields MlDataframeAnalysisAnalyzedFields string[]
body string ({ [key: string]: any; } & { id?: never; allow_lazy_start?: never; analysis?: never; analyzed_fields?: never; description?: never; dest?: never; max_num_threads?: never; _meta?: never; model_memory_limit?: never; source?: never; headers?: never; version?: never; })
description string A description of the job.
dest MlDataframeAnalyticsDestination The destination configuration.
headers HttpHeaders  
id Id Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.
max_num_threads integer The maximum number of threads to be used by the analysis. Using more threads may decrease the time necessary to complete the analysis at the cost of using more CPU. Note that the process may use additional threads for operational functionality other than the analysis itself.
model_memory_limit string The approximate maximum amount of memory resources that are permitted for analytical processing. If your elasticsearch.yml file contains an xpack.ml.max_model_memory_limit setting, an error occurs when you try to create data frame analytics jobs that have model_memory_limit values greater than that setting.
querystring { [key: string]: any; } & { id?: never; allow_lazy_start?: never; analysis?: never; analyzed_fields?: never; description?: never; dest?: never; max_num_threads?: never; _meta?: never; model_memory_limit?: never; source?: never; headers?: never; version?: never; } All values in querystring will be added to the request querystring.
source MlDataframeAnalyticsSource The configuration of how to source the analysis data.
version VersionString