habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
docs/reference-ml-delete_forecast.asciidoc Normal file
View File

@ -0,0 +1,63 @@
[[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>>
----