[[reference-ml-estimate_model_memory]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    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.estimateModelMemory

Estimate job model memory usage. Makes an estimation of the memory usage for an anomaly detection job model. It is based on analysis configuration details for the job and cardinality estimates for the fields it references.

{ref}/ml-apis.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(MlEstimateModelMemoryRequest, options?): Promise<MlEstimateModelMemoryResponse>
----

[discrete]
===== `MlEstimateModelMemoryRequest`

[source,ts]
----
interface MlEstimateModelMemoryRequest extends <<shared-type-request-base, RequestBase>> {
  analysis_config?: MlAnalysisConfig
  max_bucket_cardinality?: Record<<<shared-type-field, Field>>, <<shared-type-long, long>>>
  overall_cardinality?: Record<<<shared-type-field, Field>>, <<shared-type-long, long>>>
}
----

[discrete]
===== `MlEstimateModelMemoryResponse`

[source,ts]
----
interface MlEstimateModelMemoryResponse {
  model_memory_estimate: string
}
----