Files
elasticsearch-js/docs/reference-ml-reset_job.asciidoc
2024-12-05 14:46:52 -06:00

74 lines
4.0 KiB
Plaintext

[[reference-ml-reset_job]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.resetJob]]
=== client.ml.resetJob
Reset an anomaly detection job. All model state and results are deleted. The job is ready to start over as if it had just been created. It is not currently possible to reset multiple jobs using wildcards or a comma separated list.
{ref}/ml-reset-job.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(MlResetJobRequest, options?): Promise<MlResetJobResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface MlResetJobRequest extends <<RequestBase>> {
job_id: <<Id>>
wait_for_completion?: boolean
delete_user_annotations?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
type MlResetJobResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++