Test run of new docs

2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
--- a/docs/reference-ml-put_job.asciidoc
+++ b/docs/reference-ml-put_job.asciidoc
@ -0,0 +1,96 @@
+[[reference-ml-put_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.putJob
+
+Create an anomaly detection job. If you include a `datafeed_config`, you must have read index privileges on the source index.
+
+{ref}/ml-put-job.html[{es} documentation]
+
+[discrete]
+==== Function signature
+
+[source,ts]
+----
+(MlPutJobRequest, options?): Promise<MlPutJobResponse>
+----
+
+[discrete]
+===== `MlPutJobRequest`
+
+[source,ts]
+----
+interface MlPutJobRequest extends <<shared-type-request-base, RequestBase>> {
+  job_id: <<shared-type-id, Id>>
+  allow_lazy_open?: boolean
+  analysis_config: MlAnalysisConfig
+  analysis_limits?: MlAnalysisLimits
+  background_persist_interval?: <<shared-type-duration, Duration>>
+  custom_settings?: MlCustomSettings
+  daily_model_snapshot_retention_after_days?: <<shared-type-long, long>>
+  data_description: MlDataDescription
+  datafeed_config?: MlDatafeedConfig
+  description?: string
+  groups?: string[]
+  model_plot_config?: MlModelPlotConfig
+  model_snapshot_retention_days?: <<shared-type-long, long>>
+  renormalization_window_days?: <<shared-type-long, long>>
+  results_index_name?: <<shared-type-index-name, IndexName>>
+  results_retention_days?: <<shared-type-long, long>>
+}
+----
+
+[discrete]
+===== `MlPutJobResponse`
+
+[source,ts]
+----
+interface MlPutJobResponse {
+  allow_lazy_open: boolean
+  analysis_config: MlAnalysisConfigRead
+  analysis_limits: MlAnalysisLimits
+  background_persist_interval?: <<shared-type-duration, Duration>>
+  create_time: <<shared-type-date-time, DateTime>>
+  custom_settings?: MlCustomSettings
+  daily_model_snapshot_retention_after_days: <<shared-type-long, long>>
+  data_description: MlDataDescription
+  datafeed_config?: MlDatafeed
+  description?: string
+  groups?: string[]
+  job_id: <<shared-type-id, Id>>
+  job_type: string
+  job_version: string
+  model_plot_config?: MlModelPlotConfig
+  model_snapshot_id?: <<shared-type-id, Id>>
+  model_snapshot_retention_days: <<shared-type-long, long>>
+  renormalization_window_days?: <<shared-type-long, long>>
+  results_index_name: string
+  results_retention_days?: <<shared-type-long, long>>
+}
+----
+