83 lines
4.8 KiB
Plaintext
83 lines
4.8 KiB
Plaintext
[[reference-ml-explain_data_frame_analytics]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
|
|| You should update the script that does the generation, which can be found in: ||
|
|
|| https://github.com/elastic/elastic-client-generator-js ||
|
|
|| ||
|
|
|| You can run the script with the following command: ||
|
|
|| npm run elasticsearch -- --version <version> ||
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
===========================================================================================================================
|
|
////////
|
|
|
|
[discrete]
|
|
[[client.ml.explainDataFrameAnalytics]]
|
|
=== client.ml.explainDataFrameAnalytics
|
|
|
|
Explain data frame analytics config. This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: * which fields are included or not in the analysis and why, * how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation.
|
|
|
|
{ref}/explain-dfanalytics.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(MlExplainDataFrameAnalyticsRequest, options?): Promise<MlExplainDataFrameAnalyticsResponse>
|
|
----
|
|
|
|
[discrete]
|
|
==== Request
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface MlExplainDataFrameAnalyticsRequest extends <<RequestBase>> {
|
|
id?: <<Id>>
|
|
source?: <<MlDataframeAnalyticsSource>>
|
|
dest?: <<MlDataframeAnalyticsDestination>>
|
|
analysis?: <<MlDataframeAnalysisContainer>>
|
|
description?: string
|
|
model_memory_limit?: string
|
|
max_num_threads?: <<integer>>
|
|
analyzed_fields?: <<MlDataframeAnalysisAnalyzedFields>> | string[]
|
|
allow_lazy_start?: boolean
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
[discrete]
|
|
==== Response
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface MlExplainDataFrameAnalyticsResponse {
|
|
field_selection: <<MlDataframeAnalyticsFieldSelection>>[]
|
|
memory_estimation: <<MlDataframeAnalyticsMemoryEstimation>>
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|