[[reference-ml-preview_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.previewDataFrameAnalytics]]
=== client.ml.previewDataFrameAnalytics

Preview features used by data frame analytics. Previews the extracted features used by a data frame analytics config.

{ref}/preview-dfanalytics.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(MlPreviewDataFrameAnalyticsRequest, options?): Promise<MlPreviewDataFrameAnalyticsResponse>
----

[discrete]
==== MlPreviewDataFrameAnalyticsRequest

[pass]
++++
<pre>
++++
interface MlPreviewDataFrameAnalyticsRequest extends <<RequestBase>> {
  id?: <<Id>>
  config?: MlPreviewDataFrameAnalyticsDataframePreviewConfig
}

[pass]
++++
</pre>
++++
[discrete]
==== MlPreviewDataFrameAnalyticsResponse

[pass]
++++
<pre>
++++
interface MlPreviewDataFrameAnalyticsResponse {
  feature_values: Record<<<Field>>, string>[]
}

[pass]
++++
</pre>
++++