@elastic/elasticsearch 8.14.1 → 8.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/catalog-info.yaml +9 -9
- package/lib/api/api/async_search.d.ts +8 -8
- package/lib/api/api/autoscaling.d.ts +4 -4
- package/lib/api/api/bulk.d.ts +2 -2
- package/lib/api/api/capabilities.d.ts +14 -0
- package/lib/api/api/capabilities.js +42 -0
- package/lib/api/api/capabilities.js.map +1 -0
- package/lib/api/api/cat.d.ts +51 -51
- package/lib/api/api/ccr.d.ts +13 -13
- package/lib/api/api/clear_scroll.d.ts +2 -2
- package/lib/api/api/close_point_in_time.d.ts +2 -2
- package/lib/api/api/cluster.d.ts +24 -24
- package/lib/api/api/connector.d.ts +67 -53
- package/lib/api/api/connector.js +59 -3
- package/lib/api/api/connector.js.map +1 -1
- package/lib/api/api/count.d.ts +1 -1
- package/lib/api/api/create.d.ts +2 -2
- package/lib/api/api/dangling_indices.d.ts +3 -3
- package/lib/api/api/delete.d.ts +2 -2
- package/lib/api/api/delete_by_query.d.ts +2 -2
- package/lib/api/api/delete_by_query_rethrottle.d.ts +1 -1
- package/lib/api/api/delete_script.d.ts +2 -2
- package/lib/api/api/enrich.d.ts +8 -8
- package/lib/api/api/eql.d.ts +7 -7
- package/lib/api/api/esql.d.ts +4 -4
- package/lib/api/api/exists.d.ts +2 -2
- package/lib/api/api/exists_source.d.ts +2 -2
- package/lib/api/api/explain.d.ts +2 -2
- package/lib/api/api/features.d.ts +2 -2
- package/lib/api/api/field_caps.d.ts +2 -2
- package/lib/api/api/fleet.d.ts +3 -3
- package/lib/api/api/get.d.ts +1 -1
- package/lib/api/api/get_script.d.ts +2 -2
- package/lib/api/api/get_script_context.d.ts +1 -1
- package/lib/api/api/get_script_languages.d.ts +1 -1
- package/lib/api/api/get_source.d.ts +1 -1
- package/lib/api/api/graph.d.ts +2 -2
- package/lib/api/api/health_report.d.ts +1 -1
- package/lib/api/api/ilm.d.ts +16 -16
- package/lib/api/api/index.d.ts +2 -2
- package/lib/api/api/indices.d.ts +111 -111
- package/lib/api/api/inference.d.ts +17 -17
- package/lib/api/api/inference.js +8 -7
- package/lib/api/api/inference.js.map +1 -1
- package/lib/api/api/info.d.ts +1 -1
- package/lib/api/api/ingest.d.ts +33 -12
- package/lib/api/api/ingest.js +77 -0
- package/lib/api/api/ingest.js.map +1 -1
- package/lib/api/api/knn_search.d.ts +1 -1
- package/lib/api/api/license.d.ts +10 -10
- package/lib/api/api/logstash.d.ts +6 -6
- package/lib/api/api/mget.d.ts +1 -1
- package/lib/api/api/migration.d.ts +3 -3
- package/lib/api/api/ml.d.ts +131 -131
- package/lib/api/api/monitoring.d.ts +1 -1
- package/lib/api/api/msearch.d.ts +1 -1
- package/lib/api/api/msearch_template.d.ts +2 -2
- package/lib/api/api/mtermvectors.d.ts +1 -1
- package/lib/api/api/nodes.d.ts +14 -14
- package/lib/api/api/open_point_in_time.d.ts +2 -2
- package/lib/api/api/ping.d.ts +1 -1
- package/lib/api/api/profiling.d.ts +4 -4
- package/lib/api/api/put_script.d.ts +2 -2
- package/lib/api/api/query_rules.d.ts +60 -0
- package/lib/api/api/{query_ruleset.js → query_rules.js} +97 -11
- package/lib/api/api/query_rules.js.map +1 -0
- package/lib/api/api/rank_eval.d.ts +2 -2
- package/lib/api/api/reindex.d.ts +1 -1
- package/lib/api/api/reindex_rethrottle.d.ts +2 -2
- package/lib/api/api/render_search_template.d.ts +2 -2
- package/lib/api/api/rollup.d.ts +10 -10
- package/lib/api/api/scripts_painless_execute.d.ts +2 -2
- package/lib/api/api/scroll.d.ts +1 -1
- package/lib/api/api/search.d.ts +2 -2
- package/lib/api/api/search_application.d.ts +11 -11
- package/lib/api/api/search_mvt.d.ts +1 -1
- package/lib/api/api/search_shards.d.ts +1 -1
- package/lib/api/api/search_template.d.ts +2 -2
- package/lib/api/api/searchable_snapshots.d.ts +4 -4
- package/lib/api/api/security.d.ts +108 -87
- package/lib/api/api/security.js +121 -3
- package/lib/api/api/security.js.map +1 -1
- package/lib/api/api/simulate.d.ts +1 -1
- package/lib/api/api/slm.d.ts +9 -9
- package/lib/api/api/snapshot.d.ts +13 -13
- package/lib/api/api/sql.d.ts +6 -6
- package/lib/api/api/ssl.d.ts +1 -1
- package/lib/api/api/synonyms.d.ts +8 -8
- package/lib/api/api/tasks.d.ts +4 -4
- package/lib/api/api/terms_enum.d.ts +1 -1
- package/lib/api/api/termvectors.d.ts +1 -1
- package/lib/api/api/text_structure.d.ts +4 -4
- package/lib/api/api/transform.d.ts +26 -19
- package/lib/api/api/transform.js +20 -0
- package/lib/api/api/transform.js.map +1 -1
- package/lib/api/api/update.d.ts +1 -1
- package/lib/api/api/update_by_query.d.ts +2 -2
- package/lib/api/api/update_by_query_rethrottle.d.ts +1 -1
- package/lib/api/api/watcher.d.ts +14 -14
- package/lib/api/api/xpack.d.ts +4 -4
- package/lib/api/index.d.ts +6 -4
- package/lib/api/index.js +8 -6
- package/lib/api/index.js.map +1 -1
- package/lib/api/types.d.ts +418 -215
- package/lib/api/typesWithBodyKey.d.ts +434 -216
- package/package.json +3 -3
- package/lib/api/api/query_ruleset.d.ts +0 -39
- package/lib/api/api/query_ruleset.js.map +0 -1
package/lib/api/api/ml.d.ts
CHANGED
|
@@ -8,512 +8,512 @@ export default class Ml {
|
|
|
8
8
|
transport: Transport;
|
|
9
9
|
constructor(transport: Transport);
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
12
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
11
|
+
* Clears a trained model deployment cache on all nodes where the trained model is assigned. A trained model deployment may have an inference cache enabled. As requests are handled by each allocated node, their responses may be cached on that individual node. Calling this API clears the caches without restarting the deployment.
|
|
12
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/clear-trained-model-deployment-cache.html | Elasticsearch API documentation}
|
|
13
13
|
*/
|
|
14
14
|
clearTrainedModelDeploymentCache(this: That, params: T.MlClearTrainedModelDeploymentCacheRequest | TB.MlClearTrainedModelDeploymentCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlClearTrainedModelDeploymentCacheResponse>;
|
|
15
15
|
clearTrainedModelDeploymentCache(this: That, params: T.MlClearTrainedModelDeploymentCacheRequest | TB.MlClearTrainedModelDeploymentCacheRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlClearTrainedModelDeploymentCacheResponse, unknown>>;
|
|
16
16
|
clearTrainedModelDeploymentCache(this: That, params: T.MlClearTrainedModelDeploymentCacheRequest | TB.MlClearTrainedModelDeploymentCacheRequest, options?: TransportRequestOptions): Promise<T.MlClearTrainedModelDeploymentCacheResponse>;
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
19
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
18
|
+
* Close anomaly detection jobs A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. When a datafeed that has a specified end date stops, it automatically closes its associated job.
|
|
19
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-close-job.html | Elasticsearch API documentation}
|
|
20
20
|
*/
|
|
21
21
|
closeJob(this: That, params: T.MlCloseJobRequest | TB.MlCloseJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlCloseJobResponse>;
|
|
22
22
|
closeJob(this: That, params: T.MlCloseJobRequest | TB.MlCloseJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlCloseJobResponse, unknown>>;
|
|
23
23
|
closeJob(this: That, params: T.MlCloseJobRequest | TB.MlCloseJobRequest, options?: TransportRequestOptions): Promise<T.MlCloseJobResponse>;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
26
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
25
|
+
* Removes all scheduled events from a calendar, then deletes it.
|
|
26
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-calendar.html | Elasticsearch API documentation}
|
|
27
27
|
*/
|
|
28
28
|
deleteCalendar(this: That, params: T.MlDeleteCalendarRequest | TB.MlDeleteCalendarRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlDeleteCalendarResponse>;
|
|
29
29
|
deleteCalendar(this: That, params: T.MlDeleteCalendarRequest | TB.MlDeleteCalendarRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlDeleteCalendarResponse, unknown>>;
|
|
30
30
|
deleteCalendar(this: That, params: T.MlDeleteCalendarRequest | TB.MlDeleteCalendarRequest, options?: TransportRequestOptions): Promise<T.MlDeleteCalendarResponse>;
|
|
31
31
|
/**
|
|
32
32
|
* Deletes scheduled events from a calendar.
|
|
33
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
33
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-calendar-event.html | Elasticsearch API documentation}
|
|
34
34
|
*/
|
|
35
35
|
deleteCalendarEvent(this: That, params: T.MlDeleteCalendarEventRequest | TB.MlDeleteCalendarEventRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlDeleteCalendarEventResponse>;
|
|
36
36
|
deleteCalendarEvent(this: That, params: T.MlDeleteCalendarEventRequest | TB.MlDeleteCalendarEventRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlDeleteCalendarEventResponse, unknown>>;
|
|
37
37
|
deleteCalendarEvent(this: That, params: T.MlDeleteCalendarEventRequest | TB.MlDeleteCalendarEventRequest, options?: TransportRequestOptions): Promise<T.MlDeleteCalendarEventResponse>;
|
|
38
38
|
/**
|
|
39
39
|
* Deletes anomaly detection jobs from a calendar.
|
|
40
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
40
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-calendar-job.html | Elasticsearch API documentation}
|
|
41
41
|
*/
|
|
42
42
|
deleteCalendarJob(this: That, params: T.MlDeleteCalendarJobRequest | TB.MlDeleteCalendarJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlDeleteCalendarJobResponse>;
|
|
43
43
|
deleteCalendarJob(this: That, params: T.MlDeleteCalendarJobRequest | TB.MlDeleteCalendarJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlDeleteCalendarJobResponse, unknown>>;
|
|
44
44
|
deleteCalendarJob(this: That, params: T.MlDeleteCalendarJobRequest | TB.MlDeleteCalendarJobRequest, options?: TransportRequestOptions): Promise<T.MlDeleteCalendarJobResponse>;
|
|
45
45
|
/**
|
|
46
|
-
* Deletes
|
|
47
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
46
|
+
* Deletes a data frame analytics job.
|
|
47
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-dfanalytics.html | Elasticsearch API documentation}
|
|
48
48
|
*/
|
|
49
49
|
deleteDataFrameAnalytics(this: That, params: T.MlDeleteDataFrameAnalyticsRequest | TB.MlDeleteDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlDeleteDataFrameAnalyticsResponse>;
|
|
50
50
|
deleteDataFrameAnalytics(this: That, params: T.MlDeleteDataFrameAnalyticsRequest | TB.MlDeleteDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlDeleteDataFrameAnalyticsResponse, unknown>>;
|
|
51
51
|
deleteDataFrameAnalytics(this: That, params: T.MlDeleteDataFrameAnalyticsRequest | TB.MlDeleteDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise<T.MlDeleteDataFrameAnalyticsResponse>;
|
|
52
52
|
/**
|
|
53
53
|
* Deletes an existing datafeed.
|
|
54
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
54
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-datafeed.html | Elasticsearch API documentation}
|
|
55
55
|
*/
|
|
56
56
|
deleteDatafeed(this: That, params: T.MlDeleteDatafeedRequest | TB.MlDeleteDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlDeleteDatafeedResponse>;
|
|
57
57
|
deleteDatafeed(this: That, params: T.MlDeleteDatafeedRequest | TB.MlDeleteDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlDeleteDatafeedResponse, unknown>>;
|
|
58
58
|
deleteDatafeed(this: That, params: T.MlDeleteDatafeedRequest | TB.MlDeleteDatafeedRequest, options?: TransportRequestOptions): Promise<T.MlDeleteDatafeedResponse>;
|
|
59
59
|
/**
|
|
60
|
-
* Deletes expired and unused machine learning data.
|
|
61
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
60
|
+
* Deletes expired and unused machine learning data. Deletes all job results, model snapshots and forecast data that have exceeded their retention days period. Machine learning state documents that are not associated with any job are also deleted. You can limit the request to a single or set of anomaly detection jobs by using a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. You can delete expired data for all anomaly detection jobs by using _all, by specifying * as the <job_id>, or by omitting the <job_id>.
|
|
61
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-expired-data.html | Elasticsearch API documentation}
|
|
62
62
|
*/
|
|
63
63
|
deleteExpiredData(this: That, params?: T.MlDeleteExpiredDataRequest | TB.MlDeleteExpiredDataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlDeleteExpiredDataResponse>;
|
|
64
64
|
deleteExpiredData(this: That, params?: T.MlDeleteExpiredDataRequest | TB.MlDeleteExpiredDataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlDeleteExpiredDataResponse, unknown>>;
|
|
65
65
|
deleteExpiredData(this: That, params?: T.MlDeleteExpiredDataRequest | TB.MlDeleteExpiredDataRequest, options?: TransportRequestOptions): Promise<T.MlDeleteExpiredDataResponse>;
|
|
66
66
|
/**
|
|
67
|
-
* Deletes a filter.
|
|
68
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
67
|
+
* Deletes a filter. If an anomaly detection job references the filter, you cannot delete the filter. You must update or delete the job before you can delete the filter.
|
|
68
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-filter.html | Elasticsearch API documentation}
|
|
69
69
|
*/
|
|
70
70
|
deleteFilter(this: That, params: T.MlDeleteFilterRequest | TB.MlDeleteFilterRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlDeleteFilterResponse>;
|
|
71
71
|
deleteFilter(this: That, params: T.MlDeleteFilterRequest | TB.MlDeleteFilterRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlDeleteFilterResponse, unknown>>;
|
|
72
72
|
deleteFilter(this: That, params: T.MlDeleteFilterRequest | TB.MlDeleteFilterRequest, options?: TransportRequestOptions): Promise<T.MlDeleteFilterResponse>;
|
|
73
73
|
/**
|
|
74
|
-
* Deletes forecasts from a machine learning job.
|
|
75
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
74
|
+
* Deletes forecasts from a machine learning 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.
|
|
75
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-forecast.html | Elasticsearch API documentation}
|
|
76
76
|
*/
|
|
77
77
|
deleteForecast(this: That, params: T.MlDeleteForecastRequest | TB.MlDeleteForecastRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlDeleteForecastResponse>;
|
|
78
78
|
deleteForecast(this: That, params: T.MlDeleteForecastRequest | TB.MlDeleteForecastRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlDeleteForecastResponse, unknown>>;
|
|
79
79
|
deleteForecast(this: That, params: T.MlDeleteForecastRequest | TB.MlDeleteForecastRequest, options?: TransportRequestOptions): Promise<T.MlDeleteForecastResponse>;
|
|
80
80
|
/**
|
|
81
|
-
* Deletes an
|
|
82
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
81
|
+
* Deletes an anomaly detection job. All job configuration, model state and results are deleted. It is not currently possible to delete multiple jobs using wildcards or a comma separated list. If you delete a job that has a datafeed, the request first tries to delete the datafeed. This behavior is equivalent to calling the delete datafeed API with the same timeout and force parameters as the delete job request.
|
|
82
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-job.html | Elasticsearch API documentation}
|
|
83
83
|
*/
|
|
84
84
|
deleteJob(this: That, params: T.MlDeleteJobRequest | TB.MlDeleteJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlDeleteJobResponse>;
|
|
85
85
|
deleteJob(this: That, params: T.MlDeleteJobRequest | TB.MlDeleteJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlDeleteJobResponse, unknown>>;
|
|
86
86
|
deleteJob(this: That, params: T.MlDeleteJobRequest | TB.MlDeleteJobRequest, options?: TransportRequestOptions): Promise<T.MlDeleteJobResponse>;
|
|
87
87
|
/**
|
|
88
|
-
* Deletes an existing model snapshot.
|
|
89
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
88
|
+
* Deletes an existing model snapshot. You cannot delete the active model snapshot. To delete that snapshot, first revert to a different one. To identify the active model snapshot, refer to the `model_snapshot_id` in the results from the get jobs API.
|
|
89
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-snapshot.html | Elasticsearch API documentation}
|
|
90
90
|
*/
|
|
91
91
|
deleteModelSnapshot(this: That, params: T.MlDeleteModelSnapshotRequest | TB.MlDeleteModelSnapshotRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlDeleteModelSnapshotResponse>;
|
|
92
92
|
deleteModelSnapshot(this: That, params: T.MlDeleteModelSnapshotRequest | TB.MlDeleteModelSnapshotRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlDeleteModelSnapshotResponse, unknown>>;
|
|
93
93
|
deleteModelSnapshot(this: That, params: T.MlDeleteModelSnapshotRequest | TB.MlDeleteModelSnapshotRequest, options?: TransportRequestOptions): Promise<T.MlDeleteModelSnapshotResponse>;
|
|
94
94
|
/**
|
|
95
95
|
* Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.
|
|
96
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
96
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-trained-models.html | Elasticsearch API documentation}
|
|
97
97
|
*/
|
|
98
98
|
deleteTrainedModel(this: That, params: T.MlDeleteTrainedModelRequest | TB.MlDeleteTrainedModelRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlDeleteTrainedModelResponse>;
|
|
99
99
|
deleteTrainedModel(this: That, params: T.MlDeleteTrainedModelRequest | TB.MlDeleteTrainedModelRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlDeleteTrainedModelResponse, unknown>>;
|
|
100
100
|
deleteTrainedModel(this: That, params: T.MlDeleteTrainedModelRequest | TB.MlDeleteTrainedModelRequest, options?: TransportRequestOptions): Promise<T.MlDeleteTrainedModelResponse>;
|
|
101
101
|
/**
|
|
102
|
-
* Deletes a model alias that refers to
|
|
103
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
102
|
+
* Deletes a trained model alias. This API deletes an existing model alias that refers to a trained model. If the model alias is missing or refers to a model other than the one identified by the `model_id`, this API returns an error.
|
|
103
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-trained-models-aliases.html | Elasticsearch API documentation}
|
|
104
104
|
*/
|
|
105
105
|
deleteTrainedModelAlias(this: That, params: T.MlDeleteTrainedModelAliasRequest | TB.MlDeleteTrainedModelAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlDeleteTrainedModelAliasResponse>;
|
|
106
106
|
deleteTrainedModelAlias(this: That, params: T.MlDeleteTrainedModelAliasRequest | TB.MlDeleteTrainedModelAliasRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlDeleteTrainedModelAliasResponse, unknown>>;
|
|
107
107
|
deleteTrainedModelAlias(this: That, params: T.MlDeleteTrainedModelAliasRequest | TB.MlDeleteTrainedModelAliasRequest, options?: TransportRequestOptions): Promise<T.MlDeleteTrainedModelAliasResponse>;
|
|
108
108
|
/**
|
|
109
|
-
*
|
|
110
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
109
|
+
* Makes an estimation of the memory usage for an anomaly detection job model. It is based on analysis configuration details for the job and cardinality estimates for the fields it references.
|
|
110
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-apis.html | Elasticsearch API documentation}
|
|
111
111
|
*/
|
|
112
112
|
estimateModelMemory(this: That, params?: T.MlEstimateModelMemoryRequest | TB.MlEstimateModelMemoryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlEstimateModelMemoryResponse>;
|
|
113
113
|
estimateModelMemory(this: That, params?: T.MlEstimateModelMemoryRequest | TB.MlEstimateModelMemoryRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlEstimateModelMemoryResponse, unknown>>;
|
|
114
114
|
estimateModelMemory(this: That, params?: T.MlEstimateModelMemoryRequest | TB.MlEstimateModelMemoryRequest, options?: TransportRequestOptions): Promise<T.MlEstimateModelMemoryResponse>;
|
|
115
115
|
/**
|
|
116
|
-
* Evaluates the data frame analytics for an annotated index.
|
|
117
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
116
|
+
* Evaluates the data frame analytics for an annotated index. The API packages together commonly used evaluation metrics for various types of machine learning features. This has been designed for use on indexes created by data frame analytics. Evaluation requires both a ground truth field and an analytics result field to be present.
|
|
117
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/evaluate-dfanalytics.html | Elasticsearch API documentation}
|
|
118
118
|
*/
|
|
119
119
|
evaluateDataFrame(this: That, params: T.MlEvaluateDataFrameRequest | TB.MlEvaluateDataFrameRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlEvaluateDataFrameResponse>;
|
|
120
120
|
evaluateDataFrame(this: That, params: T.MlEvaluateDataFrameRequest | TB.MlEvaluateDataFrameRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlEvaluateDataFrameResponse, unknown>>;
|
|
121
121
|
evaluateDataFrame(this: That, params: T.MlEvaluateDataFrameRequest | TB.MlEvaluateDataFrameRequest, options?: TransportRequestOptions): Promise<T.MlEvaluateDataFrameResponse>;
|
|
122
122
|
/**
|
|
123
|
-
* Explains a data frame analytics config.
|
|
124
|
-
* @see {@link http://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
123
|
+
* Explains a data frame analytics config. This API provides explanations for a data frame analytics config that either exists already or one that has not been created yet. The following explanations are provided: * which fields are included or not in the analysis and why, * how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. If you have object fields or fields that are excluded via source filtering, they are not included in the explanation.
|
|
124
|
+
* @see {@link http://www.elastic.co/guide/en/elasticsearch/reference/8.15/explain-dfanalytics.html | Elasticsearch API documentation}
|
|
125
125
|
*/
|
|
126
126
|
explainDataFrameAnalytics(this: That, params?: T.MlExplainDataFrameAnalyticsRequest | TB.MlExplainDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlExplainDataFrameAnalyticsResponse>;
|
|
127
127
|
explainDataFrameAnalytics(this: That, params?: T.MlExplainDataFrameAnalyticsRequest | TB.MlExplainDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlExplainDataFrameAnalyticsResponse, unknown>>;
|
|
128
128
|
explainDataFrameAnalytics(this: That, params?: T.MlExplainDataFrameAnalyticsRequest | TB.MlExplainDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise<T.MlExplainDataFrameAnalyticsResponse>;
|
|
129
129
|
/**
|
|
130
|
-
* Forces any buffered data to be processed by the job.
|
|
131
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
130
|
+
* Forces any buffered data to be processed by the job. The flush jobs API is only applicable when sending data for analysis using the post data API. Depending on the content of the buffer, then it might additionally calculate new results. Both flush and close operations are similar, however the flush is more efficient if you are expecting to send more data for analysis. When flushing, the job remains open and is available to continue analyzing data. A close operation additionally prunes and persists the model state to disk and the job must be opened again before analyzing further data.
|
|
131
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-flush-job.html | Elasticsearch API documentation}
|
|
132
132
|
*/
|
|
133
133
|
flushJob(this: That, params: T.MlFlushJobRequest | TB.MlFlushJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlFlushJobResponse>;
|
|
134
134
|
flushJob(this: That, params: T.MlFlushJobRequest | TB.MlFlushJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlFlushJobResponse, unknown>>;
|
|
135
135
|
flushJob(this: That, params: T.MlFlushJobRequest | TB.MlFlushJobRequest, options?: TransportRequestOptions): Promise<T.MlFlushJobResponse>;
|
|
136
136
|
/**
|
|
137
|
-
* Predicts the future behavior of a time series by using its historical behavior.
|
|
138
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
137
|
+
* Predicts the future behavior of a time series by using its historical behavior. 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.
|
|
138
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-forecast.html | Elasticsearch API documentation}
|
|
139
139
|
*/
|
|
140
140
|
forecast(this: That, params: T.MlForecastRequest | TB.MlForecastRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlForecastResponse>;
|
|
141
141
|
forecast(this: That, params: T.MlForecastRequest | TB.MlForecastRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlForecastResponse, unknown>>;
|
|
142
142
|
forecast(this: That, params: T.MlForecastRequest | TB.MlForecastRequest, options?: TransportRequestOptions): Promise<T.MlForecastResponse>;
|
|
143
143
|
/**
|
|
144
|
-
* Retrieves anomaly detection job results for one or more buckets.
|
|
145
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
144
|
+
* Retrieves anomaly detection job results for one or more buckets. The API presents a chronological view of the records, grouped by bucket.
|
|
145
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-bucket.html | Elasticsearch API documentation}
|
|
146
146
|
*/
|
|
147
147
|
getBuckets(this: That, params: T.MlGetBucketsRequest | TB.MlGetBucketsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetBucketsResponse>;
|
|
148
148
|
getBuckets(this: That, params: T.MlGetBucketsRequest | TB.MlGetBucketsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetBucketsResponse, unknown>>;
|
|
149
149
|
getBuckets(this: That, params: T.MlGetBucketsRequest | TB.MlGetBucketsRequest, options?: TransportRequestOptions): Promise<T.MlGetBucketsResponse>;
|
|
150
150
|
/**
|
|
151
151
|
* Retrieves information about the scheduled events in calendars.
|
|
152
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
152
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-calendar-event.html | Elasticsearch API documentation}
|
|
153
153
|
*/
|
|
154
154
|
getCalendarEvents(this: That, params: T.MlGetCalendarEventsRequest | TB.MlGetCalendarEventsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetCalendarEventsResponse>;
|
|
155
155
|
getCalendarEvents(this: That, params: T.MlGetCalendarEventsRequest | TB.MlGetCalendarEventsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetCalendarEventsResponse, unknown>>;
|
|
156
156
|
getCalendarEvents(this: That, params: T.MlGetCalendarEventsRequest | TB.MlGetCalendarEventsRequest, options?: TransportRequestOptions): Promise<T.MlGetCalendarEventsResponse>;
|
|
157
157
|
/**
|
|
158
158
|
* Retrieves configuration information for calendars.
|
|
159
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
159
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-calendar.html | Elasticsearch API documentation}
|
|
160
160
|
*/
|
|
161
161
|
getCalendars(this: That, params?: T.MlGetCalendarsRequest | TB.MlGetCalendarsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetCalendarsResponse>;
|
|
162
162
|
getCalendars(this: That, params?: T.MlGetCalendarsRequest | TB.MlGetCalendarsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetCalendarsResponse, unknown>>;
|
|
163
163
|
getCalendars(this: That, params?: T.MlGetCalendarsRequest | TB.MlGetCalendarsRequest, options?: TransportRequestOptions): Promise<T.MlGetCalendarsResponse>;
|
|
164
164
|
/**
|
|
165
165
|
* Retrieves anomaly detection job results for one or more categories.
|
|
166
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
166
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-category.html | Elasticsearch API documentation}
|
|
167
167
|
*/
|
|
168
168
|
getCategories(this: That, params: T.MlGetCategoriesRequest | TB.MlGetCategoriesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetCategoriesResponse>;
|
|
169
169
|
getCategories(this: That, params: T.MlGetCategoriesRequest | TB.MlGetCategoriesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetCategoriesResponse, unknown>>;
|
|
170
170
|
getCategories(this: That, params: T.MlGetCategoriesRequest | TB.MlGetCategoriesRequest, options?: TransportRequestOptions): Promise<T.MlGetCategoriesResponse>;
|
|
171
171
|
/**
|
|
172
|
-
* Retrieves configuration information for data frame analytics jobs.
|
|
173
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
172
|
+
* Retrieves configuration information for data frame analytics jobs. You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression.
|
|
173
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-dfanalytics.html | Elasticsearch API documentation}
|
|
174
174
|
*/
|
|
175
175
|
getDataFrameAnalytics(this: That, params?: T.MlGetDataFrameAnalyticsRequest | TB.MlGetDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetDataFrameAnalyticsResponse>;
|
|
176
176
|
getDataFrameAnalytics(this: That, params?: T.MlGetDataFrameAnalyticsRequest | TB.MlGetDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetDataFrameAnalyticsResponse, unknown>>;
|
|
177
177
|
getDataFrameAnalytics(this: That, params?: T.MlGetDataFrameAnalyticsRequest | TB.MlGetDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise<T.MlGetDataFrameAnalyticsResponse>;
|
|
178
178
|
/**
|
|
179
179
|
* Retrieves usage information for data frame analytics jobs.
|
|
180
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
180
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-dfanalytics-stats.html | Elasticsearch API documentation}
|
|
181
181
|
*/
|
|
182
182
|
getDataFrameAnalyticsStats(this: That, params?: T.MlGetDataFrameAnalyticsStatsRequest | TB.MlGetDataFrameAnalyticsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetDataFrameAnalyticsStatsResponse>;
|
|
183
183
|
getDataFrameAnalyticsStats(this: That, params?: T.MlGetDataFrameAnalyticsStatsRequest | TB.MlGetDataFrameAnalyticsStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetDataFrameAnalyticsStatsResponse, unknown>>;
|
|
184
184
|
getDataFrameAnalyticsStats(this: That, params?: T.MlGetDataFrameAnalyticsStatsRequest | TB.MlGetDataFrameAnalyticsStatsRequest, options?: TransportRequestOptions): Promise<T.MlGetDataFrameAnalyticsStatsResponse>;
|
|
185
185
|
/**
|
|
186
|
-
* Retrieves usage information for datafeeds.
|
|
187
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
186
|
+
* Retrieves usage information for datafeeds. You can get statistics for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get statistics for all datafeeds by using `_all`, by specifying `*` as the `<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped, the only information you receive is the `datafeed_id` and the `state`. This API returns a maximum of 10,000 datafeeds.
|
|
187
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-datafeed-stats.html | Elasticsearch API documentation}
|
|
188
188
|
*/
|
|
189
189
|
getDatafeedStats(this: That, params?: T.MlGetDatafeedStatsRequest | TB.MlGetDatafeedStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetDatafeedStatsResponse>;
|
|
190
190
|
getDatafeedStats(this: That, params?: T.MlGetDatafeedStatsRequest | TB.MlGetDatafeedStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetDatafeedStatsResponse, unknown>>;
|
|
191
191
|
getDatafeedStats(this: That, params?: T.MlGetDatafeedStatsRequest | TB.MlGetDatafeedStatsRequest, options?: TransportRequestOptions): Promise<T.MlGetDatafeedStatsResponse>;
|
|
192
192
|
/**
|
|
193
|
-
* Retrieves configuration information for datafeeds.
|
|
194
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
193
|
+
* Retrieves configuration information for datafeeds. You can get information for multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can get information for all datafeeds by using `_all`, by specifying `*` as the `<feed_id>`, or by omitting the `<feed_id>`. This API returns a maximum of 10,000 datafeeds.
|
|
194
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-datafeed.html | Elasticsearch API documentation}
|
|
195
195
|
*/
|
|
196
196
|
getDatafeeds(this: That, params?: T.MlGetDatafeedsRequest | TB.MlGetDatafeedsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetDatafeedsResponse>;
|
|
197
197
|
getDatafeeds(this: That, params?: T.MlGetDatafeedsRequest | TB.MlGetDatafeedsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetDatafeedsResponse, unknown>>;
|
|
198
198
|
getDatafeeds(this: That, params?: T.MlGetDatafeedsRequest | TB.MlGetDatafeedsRequest, options?: TransportRequestOptions): Promise<T.MlGetDatafeedsResponse>;
|
|
199
199
|
/**
|
|
200
|
-
* Retrieves filters.
|
|
201
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
200
|
+
* Retrieves filters. You can get a single filter or all filters.
|
|
201
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-filter.html | Elasticsearch API documentation}
|
|
202
202
|
*/
|
|
203
203
|
getFilters(this: That, params?: T.MlGetFiltersRequest | TB.MlGetFiltersRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetFiltersResponse>;
|
|
204
204
|
getFilters(this: That, params?: T.MlGetFiltersRequest | TB.MlGetFiltersRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetFiltersResponse, unknown>>;
|
|
205
205
|
getFilters(this: That, params?: T.MlGetFiltersRequest | TB.MlGetFiltersRequest, options?: TransportRequestOptions): Promise<T.MlGetFiltersResponse>;
|
|
206
206
|
/**
|
|
207
|
-
* Retrieves anomaly detection job results for one or more influencers.
|
|
208
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
207
|
+
* Retrieves anomaly detection job results for one or more influencers. Influencers are the entities that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an `influencer_field_name` is specified in the job configuration.
|
|
208
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-influencer.html | Elasticsearch API documentation}
|
|
209
209
|
*/
|
|
210
210
|
getInfluencers(this: That, params: T.MlGetInfluencersRequest | TB.MlGetInfluencersRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetInfluencersResponse>;
|
|
211
211
|
getInfluencers(this: That, params: T.MlGetInfluencersRequest | TB.MlGetInfluencersRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetInfluencersResponse, unknown>>;
|
|
212
212
|
getInfluencers(this: That, params: T.MlGetInfluencersRequest | TB.MlGetInfluencersRequest, options?: TransportRequestOptions): Promise<T.MlGetInfluencersResponse>;
|
|
213
213
|
/**
|
|
214
214
|
* Retrieves usage information for anomaly detection jobs.
|
|
215
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
215
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-job-stats.html | Elasticsearch API documentation}
|
|
216
216
|
*/
|
|
217
217
|
getJobStats(this: That, params?: T.MlGetJobStatsRequest | TB.MlGetJobStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetJobStatsResponse>;
|
|
218
218
|
getJobStats(this: That, params?: T.MlGetJobStatsRequest | TB.MlGetJobStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetJobStatsResponse, unknown>>;
|
|
219
219
|
getJobStats(this: That, params?: T.MlGetJobStatsRequest | TB.MlGetJobStatsRequest, options?: TransportRequestOptions): Promise<T.MlGetJobStatsResponse>;
|
|
220
220
|
/**
|
|
221
|
-
* Retrieves configuration information for anomaly detection jobs.
|
|
222
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
221
|
+
* Retrieves configuration information for anomaly detection jobs. You can get information for multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can get information for all anomaly detection jobs by using `_all`, by specifying `*` as the `<job_id>`, or by omitting the `<job_id>`.
|
|
222
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-job.html | Elasticsearch API documentation}
|
|
223
223
|
*/
|
|
224
224
|
getJobs(this: That, params?: T.MlGetJobsRequest | TB.MlGetJobsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetJobsResponse>;
|
|
225
225
|
getJobs(this: That, params?: T.MlGetJobsRequest | TB.MlGetJobsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetJobsResponse, unknown>>;
|
|
226
226
|
getJobs(this: That, params?: T.MlGetJobsRequest | TB.MlGetJobsRequest, options?: TransportRequestOptions): Promise<T.MlGetJobsResponse>;
|
|
227
227
|
/**
|
|
228
|
-
*
|
|
229
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
228
|
+
* Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM.
|
|
229
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-ml-memory.html | Elasticsearch API documentation}
|
|
230
230
|
*/
|
|
231
231
|
getMemoryStats(this: That, params?: T.MlGetMemoryStatsRequest | TB.MlGetMemoryStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetMemoryStatsResponse>;
|
|
232
232
|
getMemoryStats(this: That, params?: T.MlGetMemoryStatsRequest | TB.MlGetMemoryStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetMemoryStatsResponse, unknown>>;
|
|
233
233
|
getMemoryStats(this: That, params?: T.MlGetMemoryStatsRequest | TB.MlGetMemoryStatsRequest, options?: TransportRequestOptions): Promise<T.MlGetMemoryStatsResponse>;
|
|
234
234
|
/**
|
|
235
|
-
*
|
|
236
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
235
|
+
* Retrieves usage information for anomaly detection job model snapshot upgrades.
|
|
236
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-job-model-snapshot-upgrade-stats.html | Elasticsearch API documentation}
|
|
237
237
|
*/
|
|
238
238
|
getModelSnapshotUpgradeStats(this: That, params: T.MlGetModelSnapshotUpgradeStatsRequest | TB.MlGetModelSnapshotUpgradeStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetModelSnapshotUpgradeStatsResponse>;
|
|
239
239
|
getModelSnapshotUpgradeStats(this: That, params: T.MlGetModelSnapshotUpgradeStatsRequest | TB.MlGetModelSnapshotUpgradeStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetModelSnapshotUpgradeStatsResponse, unknown>>;
|
|
240
240
|
getModelSnapshotUpgradeStats(this: That, params: T.MlGetModelSnapshotUpgradeStatsRequest | TB.MlGetModelSnapshotUpgradeStatsRequest, options?: TransportRequestOptions): Promise<T.MlGetModelSnapshotUpgradeStatsResponse>;
|
|
241
241
|
/**
|
|
242
242
|
* Retrieves information about model snapshots.
|
|
243
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
243
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-snapshot.html | Elasticsearch API documentation}
|
|
244
244
|
*/
|
|
245
245
|
getModelSnapshots(this: That, params: T.MlGetModelSnapshotsRequest | TB.MlGetModelSnapshotsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetModelSnapshotsResponse>;
|
|
246
246
|
getModelSnapshots(this: That, params: T.MlGetModelSnapshotsRequest | TB.MlGetModelSnapshotsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetModelSnapshotsResponse, unknown>>;
|
|
247
247
|
getModelSnapshots(this: That, params: T.MlGetModelSnapshotsRequest | TB.MlGetModelSnapshotsRequest, options?: TransportRequestOptions): Promise<T.MlGetModelSnapshotsResponse>;
|
|
248
248
|
/**
|
|
249
|
-
* Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.
|
|
250
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
249
|
+
* Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs. The `overall_score` is calculated by combining the scores of all the buckets within the overall bucket span. First, the maximum `anomaly_score` per anomaly detection job in the overall bucket is calculated. Then the `top_n` of those scores are averaged to result in the `overall_score`. This means that you can fine-tune the `overall_score` so that it is more or less sensitive to the number of jobs that detect an anomaly at the same time. For example, if you set `top_n` to `1`, the `overall_score` is the maximum bucket score in the overall bucket. Alternatively, if you set `top_n` to the number of jobs, the `overall_score` is high only when all jobs detect anomalies in that overall bucket. If you set the `bucket_span` parameter (to a value greater than its default), the `overall_score` is the maximum `overall_score` of the overall buckets that have a span equal to the jobs' largest bucket span.
|
|
250
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-overall-buckets.html | Elasticsearch API documentation}
|
|
251
251
|
*/
|
|
252
252
|
getOverallBuckets(this: That, params: T.MlGetOverallBucketsRequest | TB.MlGetOverallBucketsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetOverallBucketsResponse>;
|
|
253
253
|
getOverallBuckets(this: That, params: T.MlGetOverallBucketsRequest | TB.MlGetOverallBucketsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetOverallBucketsResponse, unknown>>;
|
|
254
254
|
getOverallBuckets(this: That, params: T.MlGetOverallBucketsRequest | TB.MlGetOverallBucketsRequest, options?: TransportRequestOptions): Promise<T.MlGetOverallBucketsResponse>;
|
|
255
255
|
/**
|
|
256
|
-
* Retrieves anomaly records for an anomaly detection job.
|
|
257
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
256
|
+
* Retrieves anomaly records for an anomaly detection job. Records contain the detailed analytical results. They describe the anomalous activity that has been identified in the input data based on the detector configuration. There can be many anomaly records depending on the characteristics and size of the input data. In practice, there are often too many to be able to manually process them. The machine learning features therefore perform a sophisticated aggregation of the anomaly records into buckets. The number of record results depends on the number of anomalies found in each bucket, which relates to the number of time series being modeled and the number of detectors.
|
|
257
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-record.html | Elasticsearch API documentation}
|
|
258
258
|
*/
|
|
259
259
|
getRecords(this: That, params: T.MlGetRecordsRequest | TB.MlGetRecordsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetRecordsResponse>;
|
|
260
260
|
getRecords(this: That, params: T.MlGetRecordsRequest | TB.MlGetRecordsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetRecordsResponse, unknown>>;
|
|
261
261
|
getRecords(this: That, params: T.MlGetRecordsRequest | TB.MlGetRecordsRequest, options?: TransportRequestOptions): Promise<T.MlGetRecordsResponse>;
|
|
262
262
|
/**
|
|
263
|
-
* Retrieves configuration information for a trained
|
|
264
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
263
|
+
* Retrieves configuration information for a trained model.
|
|
264
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-trained-models.html | Elasticsearch API documentation}
|
|
265
265
|
*/
|
|
266
266
|
getTrainedModels(this: That, params?: T.MlGetTrainedModelsRequest | TB.MlGetTrainedModelsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetTrainedModelsResponse>;
|
|
267
267
|
getTrainedModels(this: That, params?: T.MlGetTrainedModelsRequest | TB.MlGetTrainedModelsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetTrainedModelsResponse, unknown>>;
|
|
268
268
|
getTrainedModels(this: That, params?: T.MlGetTrainedModelsRequest | TB.MlGetTrainedModelsRequest, options?: TransportRequestOptions): Promise<T.MlGetTrainedModelsResponse>;
|
|
269
269
|
/**
|
|
270
|
-
* Retrieves usage information for trained
|
|
271
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
270
|
+
* Retrieves usage information for trained models. You can get usage information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.
|
|
271
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-trained-models-stats.html | Elasticsearch API documentation}
|
|
272
272
|
*/
|
|
273
273
|
getTrainedModelsStats(this: That, params?: T.MlGetTrainedModelsStatsRequest | TB.MlGetTrainedModelsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlGetTrainedModelsStatsResponse>;
|
|
274
274
|
getTrainedModelsStats(this: That, params?: T.MlGetTrainedModelsStatsRequest | TB.MlGetTrainedModelsStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlGetTrainedModelsStatsResponse, unknown>>;
|
|
275
275
|
getTrainedModelsStats(this: That, params?: T.MlGetTrainedModelsStatsRequest | TB.MlGetTrainedModelsStatsRequest, options?: TransportRequestOptions): Promise<T.MlGetTrainedModelsStatsResponse>;
|
|
276
276
|
/**
|
|
277
|
-
*
|
|
278
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
277
|
+
* Evaluates a trained model.
|
|
278
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/infer-trained-model.html | Elasticsearch API documentation}
|
|
279
279
|
*/
|
|
280
280
|
inferTrainedModel(this: That, params: T.MlInferTrainedModelRequest | TB.MlInferTrainedModelRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlInferTrainedModelResponse>;
|
|
281
281
|
inferTrainedModel(this: That, params: T.MlInferTrainedModelRequest | TB.MlInferTrainedModelRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlInferTrainedModelResponse, unknown>>;
|
|
282
282
|
inferTrainedModel(this: That, params: T.MlInferTrainedModelRequest | TB.MlInferTrainedModelRequest, options?: TransportRequestOptions): Promise<T.MlInferTrainedModelResponse>;
|
|
283
283
|
/**
|
|
284
|
-
* Returns defaults and limits used by machine learning.
|
|
285
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
284
|
+
* Returns defaults and limits used by machine learning. This endpoint is designed to be used by a user interface that needs to fully understand machine learning configurations where some options are not specified, meaning that the defaults should be used. This endpoint may be used to find out what those defaults are. It also provides information about the maximum size of machine learning jobs that could run in the current cluster configuration.
|
|
285
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-ml-info.html | Elasticsearch API documentation}
|
|
286
286
|
*/
|
|
287
287
|
info(this: That, params?: T.MlInfoRequest | TB.MlInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlInfoResponse>;
|
|
288
288
|
info(this: That, params?: T.MlInfoRequest | TB.MlInfoRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlInfoResponse, unknown>>;
|
|
289
289
|
info(this: That, params?: T.MlInfoRequest | TB.MlInfoRequest, options?: TransportRequestOptions): Promise<T.MlInfoResponse>;
|
|
290
290
|
/**
|
|
291
|
-
* Opens one or more anomaly detection jobs.
|
|
292
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
291
|
+
* Opens one or more anomaly detection jobs. An anomaly detection job must be opened in order for it to be ready to receive and analyze data. It can be opened and closed multiple times throughout its lifecycle. When you open a new job, it starts with an empty model. When you open an existing job, the most recent model state is automatically loaded. The job is ready to resume its analysis from where it left off, once new data is received.
|
|
292
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-open-job.html | Elasticsearch API documentation}
|
|
293
293
|
*/
|
|
294
294
|
openJob(this: That, params: T.MlOpenJobRequest | TB.MlOpenJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlOpenJobResponse>;
|
|
295
295
|
openJob(this: That, params: T.MlOpenJobRequest | TB.MlOpenJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlOpenJobResponse, unknown>>;
|
|
296
296
|
openJob(this: That, params: T.MlOpenJobRequest | TB.MlOpenJobRequest, options?: TransportRequestOptions): Promise<T.MlOpenJobResponse>;
|
|
297
297
|
/**
|
|
298
|
-
*
|
|
299
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
298
|
+
* Adds scheduled events to a calendar.
|
|
299
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-post-calendar-event.html | Elasticsearch API documentation}
|
|
300
300
|
*/
|
|
301
301
|
postCalendarEvents(this: That, params: T.MlPostCalendarEventsRequest | TB.MlPostCalendarEventsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPostCalendarEventsResponse>;
|
|
302
302
|
postCalendarEvents(this: That, params: T.MlPostCalendarEventsRequest | TB.MlPostCalendarEventsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlPostCalendarEventsResponse, unknown>>;
|
|
303
303
|
postCalendarEvents(this: That, params: T.MlPostCalendarEventsRequest | TB.MlPostCalendarEventsRequest, options?: TransportRequestOptions): Promise<T.MlPostCalendarEventsResponse>;
|
|
304
304
|
/**
|
|
305
|
-
* Sends data to an anomaly detection job for analysis.
|
|
306
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
305
|
+
* Sends data to an anomaly detection job for analysis. IMPORTANT: For each job, data can be accepted from only a single connection at a time. It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.
|
|
306
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-post-data.html | Elasticsearch API documentation}
|
|
307
307
|
*/
|
|
308
308
|
postData<TData = unknown>(this: That, params: T.MlPostDataRequest<TData> | TB.MlPostDataRequest<TData>, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPostDataResponse>;
|
|
309
309
|
postData<TData = unknown>(this: That, params: T.MlPostDataRequest<TData> | TB.MlPostDataRequest<TData>, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlPostDataResponse, unknown>>;
|
|
310
310
|
postData<TData = unknown>(this: That, params: T.MlPostDataRequest<TData> | TB.MlPostDataRequest<TData>, options?: TransportRequestOptions): Promise<T.MlPostDataResponse>;
|
|
311
311
|
/**
|
|
312
|
-
* Previews
|
|
313
|
-
* @see {@link http://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
312
|
+
* Previews the extracted features used by a data frame analytics config.
|
|
313
|
+
* @see {@link http://www.elastic.co/guide/en/elasticsearch/reference/8.15/preview-dfanalytics.html | Elasticsearch API documentation}
|
|
314
314
|
*/
|
|
315
315
|
previewDataFrameAnalytics(this: That, params?: T.MlPreviewDataFrameAnalyticsRequest | TB.MlPreviewDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPreviewDataFrameAnalyticsResponse>;
|
|
316
316
|
previewDataFrameAnalytics(this: That, params?: T.MlPreviewDataFrameAnalyticsRequest | TB.MlPreviewDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlPreviewDataFrameAnalyticsResponse, unknown>>;
|
|
317
317
|
previewDataFrameAnalytics(this: That, params?: T.MlPreviewDataFrameAnalyticsRequest | TB.MlPreviewDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise<T.MlPreviewDataFrameAnalyticsResponse>;
|
|
318
318
|
/**
|
|
319
|
-
* Previews a datafeed.
|
|
320
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
319
|
+
* Previews a datafeed. This API returns the first "page" of search results from a datafeed. You can preview an existing datafeed or provide configuration details for a datafeed and anomaly detection job in the API. The preview shows the structure of the data that will be passed to the anomaly detection engine. IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. You can also use secondary authorization headers to supply the credentials.
|
|
320
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-preview-datafeed.html | Elasticsearch API documentation}
|
|
321
321
|
*/
|
|
322
322
|
previewDatafeed<TDocument = unknown>(this: That, params?: T.MlPreviewDatafeedRequest | TB.MlPreviewDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPreviewDatafeedResponse<TDocument>>;
|
|
323
323
|
previewDatafeed<TDocument = unknown>(this: That, params?: T.MlPreviewDatafeedRequest | TB.MlPreviewDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlPreviewDatafeedResponse<TDocument>, unknown>>;
|
|
324
324
|
previewDatafeed<TDocument = unknown>(this: That, params?: T.MlPreviewDatafeedRequest | TB.MlPreviewDatafeedRequest, options?: TransportRequestOptions): Promise<T.MlPreviewDatafeedResponse<TDocument>>;
|
|
325
325
|
/**
|
|
326
|
-
*
|
|
327
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
326
|
+
* Creates a calendar.
|
|
327
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-put-calendar.html | Elasticsearch API documentation}
|
|
328
328
|
*/
|
|
329
329
|
putCalendar(this: That, params: T.MlPutCalendarRequest | TB.MlPutCalendarRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPutCalendarResponse>;
|
|
330
330
|
putCalendar(this: That, params: T.MlPutCalendarRequest | TB.MlPutCalendarRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlPutCalendarResponse, unknown>>;
|
|
331
331
|
putCalendar(this: That, params: T.MlPutCalendarRequest | TB.MlPutCalendarRequest, options?: TransportRequestOptions): Promise<T.MlPutCalendarResponse>;
|
|
332
332
|
/**
|
|
333
333
|
* Adds an anomaly detection job to a calendar.
|
|
334
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
334
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-put-calendar-job.html | Elasticsearch API documentation}
|
|
335
335
|
*/
|
|
336
336
|
putCalendarJob(this: That, params: T.MlPutCalendarJobRequest | TB.MlPutCalendarJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPutCalendarJobResponse>;
|
|
337
337
|
putCalendarJob(this: That, params: T.MlPutCalendarJobRequest | TB.MlPutCalendarJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlPutCalendarJobResponse, unknown>>;
|
|
338
338
|
putCalendarJob(this: That, params: T.MlPutCalendarJobRequest | TB.MlPutCalendarJobRequest, options?: TransportRequestOptions): Promise<T.MlPutCalendarJobResponse>;
|
|
339
339
|
/**
|
|
340
|
-
* Instantiates a data frame analytics job.
|
|
341
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
340
|
+
* Instantiates a data frame analytics job. This API creates a data frame analytics job that performs an analysis on the source indices and stores the outcome in a destination index.
|
|
341
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-dfanalytics.html | Elasticsearch API documentation}
|
|
342
342
|
*/
|
|
343
343
|
putDataFrameAnalytics(this: That, params: T.MlPutDataFrameAnalyticsRequest | TB.MlPutDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPutDataFrameAnalyticsResponse>;
|
|
344
344
|
putDataFrameAnalytics(this: That, params: T.MlPutDataFrameAnalyticsRequest | TB.MlPutDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlPutDataFrameAnalyticsResponse, unknown>>;
|
|
345
345
|
putDataFrameAnalytics(this: That, params: T.MlPutDataFrameAnalyticsRequest | TB.MlPutDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise<T.MlPutDataFrameAnalyticsResponse>;
|
|
346
346
|
/**
|
|
347
|
-
* Instantiates a datafeed.
|
|
348
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
347
|
+
* Instantiates a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval (`frequency`). If you are concerned about delayed data, you can add a delay (`query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.
|
|
348
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-put-datafeed.html | Elasticsearch API documentation}
|
|
349
349
|
*/
|
|
350
350
|
putDatafeed(this: That, params: T.MlPutDatafeedRequest | TB.MlPutDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPutDatafeedResponse>;
|
|
351
351
|
putDatafeed(this: That, params: T.MlPutDatafeedRequest | TB.MlPutDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlPutDatafeedResponse, unknown>>;
|
|
352
352
|
putDatafeed(this: That, params: T.MlPutDatafeedRequest | TB.MlPutDatafeedRequest, options?: TransportRequestOptions): Promise<T.MlPutDatafeedResponse>;
|
|
353
353
|
/**
|
|
354
|
-
* Instantiates a filter.
|
|
355
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
354
|
+
* Instantiates a filter. A filter contains a list of strings. It can be used by one or more anomaly detection jobs. Specifically, filters are referenced in the `custom_rules` property of detector configuration objects.
|
|
355
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-put-filter.html | Elasticsearch API documentation}
|
|
356
356
|
*/
|
|
357
357
|
putFilter(this: That, params: T.MlPutFilterRequest | TB.MlPutFilterRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPutFilterResponse>;
|
|
358
358
|
putFilter(this: That, params: T.MlPutFilterRequest | TB.MlPutFilterRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlPutFilterResponse, unknown>>;
|
|
359
359
|
putFilter(this: That, params: T.MlPutFilterRequest | TB.MlPutFilterRequest, options?: TransportRequestOptions): Promise<T.MlPutFilterResponse>;
|
|
360
360
|
/**
|
|
361
|
-
* Instantiates an anomaly detection job.
|
|
362
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
361
|
+
* Instantiates an anomaly detection job. If you include a `datafeed_config`, you must have read index privileges on the source index.
|
|
362
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-put-job.html | Elasticsearch API documentation}
|
|
363
363
|
*/
|
|
364
364
|
putJob(this: That, params: T.MlPutJobRequest | TB.MlPutJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPutJobResponse>;
|
|
365
365
|
putJob(this: That, params: T.MlPutJobRequest | TB.MlPutJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlPutJobResponse, unknown>>;
|
|
366
366
|
putJob(this: That, params: T.MlPutJobRequest | TB.MlPutJobRequest, options?: TransportRequestOptions): Promise<T.MlPutJobResponse>;
|
|
367
367
|
/**
|
|
368
|
-
*
|
|
369
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
368
|
+
* Enables you to supply a trained model that is not created by data frame analytics.
|
|
369
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-trained-models.html | Elasticsearch API documentation}
|
|
370
370
|
*/
|
|
371
371
|
putTrainedModel(this: That, params: T.MlPutTrainedModelRequest | TB.MlPutTrainedModelRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPutTrainedModelResponse>;
|
|
372
372
|
putTrainedModel(this: That, params: T.MlPutTrainedModelRequest | TB.MlPutTrainedModelRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlPutTrainedModelResponse, unknown>>;
|
|
373
373
|
putTrainedModel(this: That, params: T.MlPutTrainedModelRequest | TB.MlPutTrainedModelRequest, options?: TransportRequestOptions): Promise<T.MlPutTrainedModelResponse>;
|
|
374
374
|
/**
|
|
375
|
-
* Creates a
|
|
376
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
375
|
+
* Creates or updates a trained model alias. A trained model alias is a logical name used to reference a single trained model. You can use aliases instead of trained model identifiers to make it easier to reference your models. For example, you can use aliases in inference aggregations and processors. An alias must be unique and refer to only a single trained model. However, you can have multiple aliases for each trained model. If you use this API to update an alias such that it references a different trained model ID and the model uses a different type of data frame analytics, an error occurs. For example, this situation occurs if you have a trained model for regression analysis and a trained model for classification analysis; you cannot reassign an alias from one type of trained model to another. If you use this API to update an alias and there are very few input fields in common between the old and new trained models for the model alias, the API returns a warning.
|
|
376
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-trained-models-aliases.html | Elasticsearch API documentation}
|
|
377
377
|
*/
|
|
378
378
|
putTrainedModelAlias(this: That, params: T.MlPutTrainedModelAliasRequest | TB.MlPutTrainedModelAliasRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPutTrainedModelAliasResponse>;
|
|
379
379
|
putTrainedModelAlias(this: That, params: T.MlPutTrainedModelAliasRequest | TB.MlPutTrainedModelAliasRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlPutTrainedModelAliasResponse, unknown>>;
|
|
380
380
|
putTrainedModelAlias(this: That, params: T.MlPutTrainedModelAliasRequest | TB.MlPutTrainedModelAliasRequest, options?: TransportRequestOptions): Promise<T.MlPutTrainedModelAliasResponse>;
|
|
381
381
|
/**
|
|
382
|
-
* Creates part of a trained model definition
|
|
383
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
382
|
+
* Creates part of a trained model definition.
|
|
383
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-trained-model-definition-part.html | Elasticsearch API documentation}
|
|
384
384
|
*/
|
|
385
385
|
putTrainedModelDefinitionPart(this: That, params: T.MlPutTrainedModelDefinitionPartRequest | TB.MlPutTrainedModelDefinitionPartRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPutTrainedModelDefinitionPartResponse>;
|
|
386
386
|
putTrainedModelDefinitionPart(this: That, params: T.MlPutTrainedModelDefinitionPartRequest | TB.MlPutTrainedModelDefinitionPartRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlPutTrainedModelDefinitionPartResponse, unknown>>;
|
|
387
387
|
putTrainedModelDefinitionPart(this: That, params: T.MlPutTrainedModelDefinitionPartRequest | TB.MlPutTrainedModelDefinitionPartRequest, options?: TransportRequestOptions): Promise<T.MlPutTrainedModelDefinitionPartResponse>;
|
|
388
388
|
/**
|
|
389
|
-
* Creates a trained model vocabulary
|
|
390
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
389
|
+
* Creates a trained model vocabulary. This API is supported only for natural language processing (NLP) models. The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.
|
|
390
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-trained-model-vocabulary.html | Elasticsearch API documentation}
|
|
391
391
|
*/
|
|
392
392
|
putTrainedModelVocabulary(this: That, params: T.MlPutTrainedModelVocabularyRequest | TB.MlPutTrainedModelVocabularyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPutTrainedModelVocabularyResponse>;
|
|
393
393
|
putTrainedModelVocabulary(this: That, params: T.MlPutTrainedModelVocabularyRequest | TB.MlPutTrainedModelVocabularyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlPutTrainedModelVocabularyResponse, unknown>>;
|
|
394
394
|
putTrainedModelVocabulary(this: That, params: T.MlPutTrainedModelVocabularyRequest | TB.MlPutTrainedModelVocabularyRequest, options?: TransportRequestOptions): Promise<T.MlPutTrainedModelVocabularyResponse>;
|
|
395
395
|
/**
|
|
396
|
-
* Resets an
|
|
397
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
396
|
+
* Resets 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.
|
|
397
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-reset-job.html | Elasticsearch API documentation}
|
|
398
398
|
*/
|
|
399
399
|
resetJob(this: That, params: T.MlResetJobRequest | TB.MlResetJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlResetJobResponse>;
|
|
400
400
|
resetJob(this: That, params: T.MlResetJobRequest | TB.MlResetJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlResetJobResponse, unknown>>;
|
|
401
401
|
resetJob(this: That, params: T.MlResetJobRequest | TB.MlResetJobRequest, options?: TransportRequestOptions): Promise<T.MlResetJobResponse>;
|
|
402
402
|
/**
|
|
403
|
-
* Reverts to a specific snapshot.
|
|
404
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
403
|
+
* Reverts to a specific snapshot. The machine learning features react quickly to anomalous input, learning new behaviors in data. Highly anomalous input increases the variance in the models whilst the system learns whether this is a new step-change in behavior or a one-off event. In the case where this anomalous input is known to be a one-off, then it might be appropriate to reset the model state to a time before this event. For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure.
|
|
404
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-revert-snapshot.html | Elasticsearch API documentation}
|
|
405
405
|
*/
|
|
406
406
|
revertModelSnapshot(this: That, params: T.MlRevertModelSnapshotRequest | TB.MlRevertModelSnapshotRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlRevertModelSnapshotResponse>;
|
|
407
407
|
revertModelSnapshot(this: That, params: T.MlRevertModelSnapshotRequest | TB.MlRevertModelSnapshotRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlRevertModelSnapshotResponse, unknown>>;
|
|
408
408
|
revertModelSnapshot(this: That, params: T.MlRevertModelSnapshotRequest | TB.MlRevertModelSnapshotRequest, options?: TransportRequestOptions): Promise<T.MlRevertModelSnapshotResponse>;
|
|
409
409
|
/**
|
|
410
|
-
* Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.
|
|
411
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
410
|
+
* Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. When upgrading your cluster, in some circumstances you must restart your nodes and reindex your machine learning indices. In those circumstances, there must be no machine learning jobs running. You can close the machine learning jobs, do the upgrade, then open all the jobs again. Alternatively, you can use this API to temporarily halt tasks associated with the jobs and datafeeds and prevent new jobs from opening. You can also use this API during upgrades that do not require you to reindex your machine learning indices, though stopping jobs is not a requirement in that case. You can see the current value for the upgrade_mode setting by using the get machine learning info API.
|
|
411
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-set-upgrade-mode.html | Elasticsearch API documentation}
|
|
412
412
|
*/
|
|
413
413
|
setUpgradeMode(this: That, params?: T.MlSetUpgradeModeRequest | TB.MlSetUpgradeModeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlSetUpgradeModeResponse>;
|
|
414
414
|
setUpgradeMode(this: That, params?: T.MlSetUpgradeModeRequest | TB.MlSetUpgradeModeRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlSetUpgradeModeResponse, unknown>>;
|
|
415
415
|
setUpgradeMode(this: That, params?: T.MlSetUpgradeModeRequest | TB.MlSetUpgradeModeRequest, options?: TransportRequestOptions): Promise<T.MlSetUpgradeModeResponse>;
|
|
416
416
|
/**
|
|
417
|
-
* Starts a data frame analytics job.
|
|
418
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
417
|
+
* Starts a data frame analytics job. A data frame analytics job can be started and stopped multiple times throughout its lifecycle. If the destination index does not exist, it is created automatically the first time you start the data frame analytics job. The `index.number_of_shards` and `index.number_of_replicas` settings for the destination index are copied from the source index. If there are multiple source indices, the destination index copies the highest setting values. The mappings for the destination index are also copied from the source indices. If there are any mapping conflicts, the job fails to start. If the destination index exists, it is used as is. You can therefore set up the destination index in advance with custom settings and mappings.
|
|
418
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/start-dfanalytics.html | Elasticsearch API documentation}
|
|
419
419
|
*/
|
|
420
420
|
startDataFrameAnalytics(this: That, params: T.MlStartDataFrameAnalyticsRequest | TB.MlStartDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlStartDataFrameAnalyticsResponse>;
|
|
421
421
|
startDataFrameAnalytics(this: That, params: T.MlStartDataFrameAnalyticsRequest | TB.MlStartDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlStartDataFrameAnalyticsResponse, unknown>>;
|
|
422
422
|
startDataFrameAnalytics(this: That, params: T.MlStartDataFrameAnalyticsRequest | TB.MlStartDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise<T.MlStartDataFrameAnalyticsResponse>;
|
|
423
423
|
/**
|
|
424
|
-
* Starts one or more datafeeds.
|
|
425
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
424
|
+
* Starts one or more datafeeds. A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle. Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or update it had at the time of creation or update and runs the query using those same roles. If you provided secondary authorization headers when you created or updated the datafeed, those credentials are used instead.
|
|
425
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-start-datafeed.html | Elasticsearch API documentation}
|
|
426
426
|
*/
|
|
427
427
|
startDatafeed(this: That, params: T.MlStartDatafeedRequest | TB.MlStartDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlStartDatafeedResponse>;
|
|
428
428
|
startDatafeed(this: That, params: T.MlStartDatafeedRequest | TB.MlStartDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlStartDatafeedResponse, unknown>>;
|
|
429
429
|
startDatafeed(this: That, params: T.MlStartDatafeedRequest | TB.MlStartDatafeedRequest, options?: TransportRequestOptions): Promise<T.MlStartDatafeedResponse>;
|
|
430
430
|
/**
|
|
431
|
-
*
|
|
432
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
431
|
+
* Starts a trained model deployment, which allocates the model to every machine learning node.
|
|
432
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/start-trained-model-deployment.html | Elasticsearch API documentation}
|
|
433
433
|
*/
|
|
434
434
|
startTrainedModelDeployment(this: That, params: T.MlStartTrainedModelDeploymentRequest | TB.MlStartTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlStartTrainedModelDeploymentResponse>;
|
|
435
435
|
startTrainedModelDeployment(this: That, params: T.MlStartTrainedModelDeploymentRequest | TB.MlStartTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlStartTrainedModelDeploymentResponse, unknown>>;
|
|
436
436
|
startTrainedModelDeployment(this: That, params: T.MlStartTrainedModelDeploymentRequest | TB.MlStartTrainedModelDeploymentRequest, options?: TransportRequestOptions): Promise<T.MlStartTrainedModelDeploymentResponse>;
|
|
437
437
|
/**
|
|
438
|
-
* Stops one or more data frame analytics jobs.
|
|
439
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
438
|
+
* Stops one or more data frame analytics jobs. A data frame analytics job can be started and stopped multiple times throughout its lifecycle.
|
|
439
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/stop-dfanalytics.html | Elasticsearch API documentation}
|
|
440
440
|
*/
|
|
441
441
|
stopDataFrameAnalytics(this: That, params: T.MlStopDataFrameAnalyticsRequest | TB.MlStopDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlStopDataFrameAnalyticsResponse>;
|
|
442
442
|
stopDataFrameAnalytics(this: That, params: T.MlStopDataFrameAnalyticsRequest | TB.MlStopDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlStopDataFrameAnalyticsResponse, unknown>>;
|
|
443
443
|
stopDataFrameAnalytics(this: That, params: T.MlStopDataFrameAnalyticsRequest | TB.MlStopDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise<T.MlStopDataFrameAnalyticsResponse>;
|
|
444
444
|
/**
|
|
445
|
-
* Stops one or more datafeeds.
|
|
446
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
445
|
+
* Stops one or more datafeeds. A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.
|
|
446
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-stop-datafeed.html | Elasticsearch API documentation}
|
|
447
447
|
*/
|
|
448
448
|
stopDatafeed(this: That, params: T.MlStopDatafeedRequest | TB.MlStopDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlStopDatafeedResponse>;
|
|
449
449
|
stopDatafeed(this: That, params: T.MlStopDatafeedRequest | TB.MlStopDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlStopDatafeedResponse, unknown>>;
|
|
450
450
|
stopDatafeed(this: That, params: T.MlStopDatafeedRequest | TB.MlStopDatafeedRequest, options?: TransportRequestOptions): Promise<T.MlStopDatafeedResponse>;
|
|
451
451
|
/**
|
|
452
|
-
*
|
|
453
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
452
|
+
* Stops a trained model deployment.
|
|
453
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/stop-trained-model-deployment.html | Elasticsearch API documentation}
|
|
454
454
|
*/
|
|
455
455
|
stopTrainedModelDeployment(this: That, params: T.MlStopTrainedModelDeploymentRequest | TB.MlStopTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlStopTrainedModelDeploymentResponse>;
|
|
456
456
|
stopTrainedModelDeployment(this: That, params: T.MlStopTrainedModelDeploymentRequest | TB.MlStopTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlStopTrainedModelDeploymentResponse, unknown>>;
|
|
457
457
|
stopTrainedModelDeployment(this: That, params: T.MlStopTrainedModelDeploymentRequest | TB.MlStopTrainedModelDeploymentRequest, options?: TransportRequestOptions): Promise<T.MlStopTrainedModelDeploymentResponse>;
|
|
458
458
|
/**
|
|
459
|
-
* Updates
|
|
460
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
459
|
+
* Updates an existing data frame analytics job.
|
|
460
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/update-dfanalytics.html | Elasticsearch API documentation}
|
|
461
461
|
*/
|
|
462
462
|
updateDataFrameAnalytics(this: That, params: T.MlUpdateDataFrameAnalyticsRequest | TB.MlUpdateDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlUpdateDataFrameAnalyticsResponse>;
|
|
463
463
|
updateDataFrameAnalytics(this: That, params: T.MlUpdateDataFrameAnalyticsRequest | TB.MlUpdateDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlUpdateDataFrameAnalyticsResponse, unknown>>;
|
|
464
464
|
updateDataFrameAnalytics(this: That, params: T.MlUpdateDataFrameAnalyticsRequest | TB.MlUpdateDataFrameAnalyticsRequest, options?: TransportRequestOptions): Promise<T.MlUpdateDataFrameAnalyticsResponse>;
|
|
465
465
|
/**
|
|
466
|
-
* Updates
|
|
467
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
466
|
+
* Updates the properties of a datafeed. You must stop and start the datafeed for the changes to be applied. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at the time of the update and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead.
|
|
467
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-update-datafeed.html | Elasticsearch API documentation}
|
|
468
468
|
*/
|
|
469
469
|
updateDatafeed(this: That, params: T.MlUpdateDatafeedRequest | TB.MlUpdateDatafeedRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlUpdateDatafeedResponse>;
|
|
470
470
|
updateDatafeed(this: That, params: T.MlUpdateDatafeedRequest | TB.MlUpdateDatafeedRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlUpdateDatafeedResponse, unknown>>;
|
|
471
471
|
updateDatafeed(this: That, params: T.MlUpdateDatafeedRequest | TB.MlUpdateDatafeedRequest, options?: TransportRequestOptions): Promise<T.MlUpdateDatafeedResponse>;
|
|
472
472
|
/**
|
|
473
|
-
* Updates the description of a filter, adds items, or removes items.
|
|
474
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
473
|
+
* Updates the description of a filter, adds items, or removes items from the list.
|
|
474
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-update-filter.html | Elasticsearch API documentation}
|
|
475
475
|
*/
|
|
476
476
|
updateFilter(this: That, params: T.MlUpdateFilterRequest | TB.MlUpdateFilterRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlUpdateFilterResponse>;
|
|
477
477
|
updateFilter(this: That, params: T.MlUpdateFilterRequest | TB.MlUpdateFilterRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlUpdateFilterResponse, unknown>>;
|
|
478
478
|
updateFilter(this: That, params: T.MlUpdateFilterRequest | TB.MlUpdateFilterRequest, options?: TransportRequestOptions): Promise<T.MlUpdateFilterResponse>;
|
|
479
479
|
/**
|
|
480
480
|
* Updates certain properties of an anomaly detection job.
|
|
481
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
481
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-update-job.html | Elasticsearch API documentation}
|
|
482
482
|
*/
|
|
483
483
|
updateJob(this: That, params: T.MlUpdateJobRequest | TB.MlUpdateJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlUpdateJobResponse>;
|
|
484
484
|
updateJob(this: That, params: T.MlUpdateJobRequest | TB.MlUpdateJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlUpdateJobResponse, unknown>>;
|
|
485
485
|
updateJob(this: That, params: T.MlUpdateJobRequest | TB.MlUpdateJobRequest, options?: TransportRequestOptions): Promise<T.MlUpdateJobResponse>;
|
|
486
486
|
/**
|
|
487
487
|
* Updates certain properties of a snapshot.
|
|
488
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
488
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-update-snapshot.html | Elasticsearch API documentation}
|
|
489
489
|
*/
|
|
490
490
|
updateModelSnapshot(this: That, params: T.MlUpdateModelSnapshotRequest | TB.MlUpdateModelSnapshotRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlUpdateModelSnapshotResponse>;
|
|
491
491
|
updateModelSnapshot(this: That, params: T.MlUpdateModelSnapshotRequest | TB.MlUpdateModelSnapshotRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlUpdateModelSnapshotResponse, unknown>>;
|
|
492
492
|
updateModelSnapshot(this: That, params: T.MlUpdateModelSnapshotRequest | TB.MlUpdateModelSnapshotRequest, options?: TransportRequestOptions): Promise<T.MlUpdateModelSnapshotResponse>;
|
|
493
493
|
/**
|
|
494
|
-
*
|
|
495
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
494
|
+
* Starts a trained model deployment, which allocates the model to every machine learning node.
|
|
495
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/update-trained-model-deployment.html | Elasticsearch API documentation}
|
|
496
496
|
*/
|
|
497
497
|
updateTrainedModelDeployment(this: That, params: T.MlUpdateTrainedModelDeploymentRequest | TB.MlUpdateTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlUpdateTrainedModelDeploymentResponse>;
|
|
498
498
|
updateTrainedModelDeployment(this: That, params: T.MlUpdateTrainedModelDeploymentRequest | TB.MlUpdateTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlUpdateTrainedModelDeploymentResponse, unknown>>;
|
|
499
499
|
updateTrainedModelDeployment(this: That, params: T.MlUpdateTrainedModelDeploymentRequest | TB.MlUpdateTrainedModelDeploymentRequest, options?: TransportRequestOptions): Promise<T.MlUpdateTrainedModelDeploymentResponse>;
|
|
500
500
|
/**
|
|
501
|
-
* Upgrades a
|
|
502
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
501
|
+
* Upgrades an anomaly detection model snapshot to the latest major version. Over time, older snapshot formats are deprecated and removed. Anomaly detection jobs support only snapshots that are from the current or previous major version. This API provides a means to upgrade a snapshot to the current major version. This aids in preparing the cluster for an upgrade to the next major version. Only one snapshot per anomaly detection job can be upgraded at a time and the upgraded snapshot cannot be the current snapshot of the anomaly detection job.
|
|
502
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-upgrade-job-model-snapshot.html | Elasticsearch API documentation}
|
|
503
503
|
*/
|
|
504
504
|
upgradeJobSnapshot(this: That, params: T.MlUpgradeJobSnapshotRequest | TB.MlUpgradeJobSnapshotRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlUpgradeJobSnapshotResponse>;
|
|
505
505
|
upgradeJobSnapshot(this: That, params: T.MlUpgradeJobSnapshotRequest | TB.MlUpgradeJobSnapshotRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlUpgradeJobSnapshotResponse, unknown>>;
|
|
506
506
|
upgradeJobSnapshot(this: That, params: T.MlUpgradeJobSnapshotRequest | TB.MlUpgradeJobSnapshotRequest, options?: TransportRequestOptions): Promise<T.MlUpgradeJobSnapshotResponse>;
|
|
507
507
|
/**
|
|
508
508
|
* Validates an anomaly detection job.
|
|
509
|
-
* @see {@link https://www.elastic.co/guide/en/machine-learning/8.
|
|
509
|
+
* @see {@link https://www.elastic.co/guide/en/machine-learning/8.15/ml-jobs.html | Elasticsearch API documentation}
|
|
510
510
|
*/
|
|
511
511
|
validate(this: That, params?: T.MlValidateRequest | TB.MlValidateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlValidateResponse>;
|
|
512
512
|
validate(this: That, params?: T.MlValidateRequest | TB.MlValidateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlValidateResponse, unknown>>;
|
|
513
513
|
validate(this: That, params?: T.MlValidateRequest | TB.MlValidateRequest, options?: TransportRequestOptions): Promise<T.MlValidateResponse>;
|
|
514
514
|
/**
|
|
515
515
|
* Validates an anomaly detection detector.
|
|
516
|
-
* @see {@link https://www.elastic.co/guide/en/machine-learning/8.
|
|
516
|
+
* @see {@link https://www.elastic.co/guide/en/machine-learning/8.15/ml-jobs.html | Elasticsearch API documentation}
|
|
517
517
|
*/
|
|
518
518
|
validateDetector(this: That, params: T.MlValidateDetectorRequest | TB.MlValidateDetectorRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlValidateDetectorResponse>;
|
|
519
519
|
validateDetector(this: That, params: T.MlValidateDetectorRequest | TB.MlValidateDetectorRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlValidateDetectorResponse, unknown>>;
|