64 lines
4.2 KiB
Plaintext
64 lines
4.2 KiB
Plaintext
[[reference-ml-delete_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.deleteForecast
|
|
|
|
Delete forecasts from a job. By default, forecasts are retained for 14 days. You can specify a different retention period with the `expires_in` parameter in the forecast jobs API. The delete forecast API enables you to delete one or more forecasts before they expire.
|
|
|
|
{ref}/ml-delete-forecast.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(MlDeleteForecastRequest, options?): Promise<MlDeleteForecastResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `MlDeleteForecastRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface MlDeleteForecastRequest extends <<shared-type-request-base, RequestBase>> {
|
|
job_id: <<shared-type-id, Id>>
|
|
forecast_id?: <<shared-type-id, Id>>
|
|
allow_no_forecasts?: boolean
|
|
timeout?: <<shared-type-duration, Duration>>
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `MlDeleteForecastResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
type MlDeleteForecastResponse = <<shared-type-acknowledged-response-base, AcknowledgedResponseBase>>
|
|
----
|
|
|