67 lines
4.2 KiB
Plaintext
67 lines
4.2 KiB
Plaintext
[[reference-ml-forecast]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.forecast
|
|
|
|
Predict future behavior of a time series. Forecasts are not supported for jobs that perform population analysis; an error occurs if you try to create a forecast for a job that has an `over_field_name` in its configuration. Forcasts predict future behavior based on historical data.
|
|
|
|
{ref}/ml-forecast.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(MlForecastRequest, options?): Promise<MlForecastResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `MlForecastRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface MlForecastRequest extends <<shared-type-request-base, RequestBase>> {
|
|
job_id: <<shared-type-id, Id>>
|
|
duration?: <<shared-type-duration, Duration>>
|
|
expires_in?: <<shared-type-duration, Duration>>
|
|
max_model_memory?: string
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `MlForecastResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
interface MlForecastResponse {
|
|
acknowledged: boolean
|
|
forecast_id: <<shared-type-id, Id>>
|
|
}
|
|
----
|
|
|