elasticsearch 8.15.1__py3-none-any.whl → 8.17.0__py3-none-any.whl
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.
- elasticsearch/_async/client/__init__.py +237 -120
- elasticsearch/_async/client/async_search.py +33 -43
- elasticsearch/_async/client/autoscaling.py +59 -11
- elasticsearch/_async/client/cat.py +75 -66
- elasticsearch/_async/client/ccr.py +85 -35
- elasticsearch/_async/client/cluster.py +165 -70
- elasticsearch/_async/client/connector.py +112 -51
- elasticsearch/_async/client/dangling_indices.py +27 -12
- elasticsearch/_async/client/enrich.py +11 -11
- elasticsearch/_async/client/eql.py +13 -11
- elasticsearch/_async/client/esql.py +44 -5
- elasticsearch/_async/client/features.py +29 -6
- elasticsearch/_async/client/fleet.py +10 -2
- elasticsearch/_async/client/graph.py +9 -3
- elasticsearch/_async/client/ilm.py +74 -35
- elasticsearch/_async/client/indices.py +422 -152
- elasticsearch/_async/client/inference.py +4 -4
- elasticsearch/_async/client/ingest.py +47 -26
- elasticsearch/_async/client/license.py +38 -22
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +346 -291
- elasticsearch/_async/client/monitoring.py +1 -1
- elasticsearch/_async/client/nodes.py +43 -21
- elasticsearch/_async/client/query_rules.py +69 -15
- elasticsearch/_async/client/rollup.py +23 -9
- elasticsearch/_async/client/search_application.py +35 -16
- elasticsearch/_async/client/searchable_snapshots.py +13 -5
- elasticsearch/_async/client/security.py +378 -180
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +97 -12
- elasticsearch/_async/client/sql.py +21 -16
- elasticsearch/_async/client/ssl.py +18 -3
- elasticsearch/_async/client/synonyms.py +17 -14
- elasticsearch/_async/client/tasks.py +19 -9
- elasticsearch/_async/client/text_structure.py +2 -2
- elasticsearch/_async/client/transform.py +78 -72
- elasticsearch/_async/client/utils.py +4 -0
- elasticsearch/_async/client/watcher.py +11 -11
- elasticsearch/_async/client/xpack.py +5 -3
- elasticsearch/_async/helpers.py +19 -10
- elasticsearch/_otel.py +2 -2
- elasticsearch/_sync/client/__init__.py +237 -120
- elasticsearch/_sync/client/async_search.py +33 -43
- elasticsearch/_sync/client/autoscaling.py +59 -11
- elasticsearch/_sync/client/cat.py +75 -66
- elasticsearch/_sync/client/ccr.py +85 -35
- elasticsearch/_sync/client/cluster.py +165 -70
- elasticsearch/_sync/client/connector.py +112 -51
- elasticsearch/_sync/client/dangling_indices.py +27 -12
- elasticsearch/_sync/client/enrich.py +11 -11
- elasticsearch/_sync/client/eql.py +13 -11
- elasticsearch/_sync/client/esql.py +44 -5
- elasticsearch/_sync/client/features.py +29 -6
- elasticsearch/_sync/client/fleet.py +10 -2
- elasticsearch/_sync/client/graph.py +9 -3
- elasticsearch/_sync/client/ilm.py +74 -35
- elasticsearch/_sync/client/indices.py +422 -152
- elasticsearch/_sync/client/inference.py +4 -4
- elasticsearch/_sync/client/ingest.py +47 -26
- elasticsearch/_sync/client/license.py +38 -22
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +346 -291
- elasticsearch/_sync/client/monitoring.py +1 -1
- elasticsearch/_sync/client/nodes.py +43 -21
- elasticsearch/_sync/client/query_rules.py +69 -15
- elasticsearch/_sync/client/rollup.py +23 -9
- elasticsearch/_sync/client/search_application.py +35 -16
- elasticsearch/_sync/client/searchable_snapshots.py +13 -5
- elasticsearch/_sync/client/security.py +378 -180
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +97 -12
- elasticsearch/_sync/client/sql.py +21 -16
- elasticsearch/_sync/client/ssl.py +18 -3
- elasticsearch/_sync/client/synonyms.py +17 -14
- elasticsearch/_sync/client/tasks.py +19 -9
- elasticsearch/_sync/client/text_structure.py +2 -2
- elasticsearch/_sync/client/transform.py +78 -72
- elasticsearch/_sync/client/utils.py +40 -0
- elasticsearch/_sync/client/watcher.py +11 -11
- elasticsearch/_sync/client/xpack.py +5 -3
- elasticsearch/_version.py +1 -1
- elasticsearch/exceptions.py +4 -0
- elasticsearch/helpers/actions.py +19 -10
- elasticsearch/helpers/errors.py +12 -4
- elasticsearch/helpers/vectorstore/_async/strategies.py +30 -9
- elasticsearch/helpers/vectorstore/_sync/strategies.py +30 -9
- {elasticsearch-8.15.1.dist-info → elasticsearch-8.17.0.dist-info}/METADATA +4 -3
- elasticsearch-8.17.0.dist-info/RECORD +117 -0
- {elasticsearch-8.15.1.dist-info → elasticsearch-8.17.0.dist-info}/WHEEL +1 -1
- elasticsearch-8.15.1.dist-info/RECORD +0 -117
- {elasticsearch-8.15.1.dist-info → elasticsearch-8.17.0.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.15.1.dist-info → elasticsearch-8.17.0.dist-info}/licenses/NOTICE +0 -0
|
@@ -36,13 +36,13 @@ class MlClient(NamespacedClient):
|
|
|
36
36
|
pretty: t.Optional[bool] = None,
|
|
37
37
|
) -> ObjectApiResponse[t.Any]:
|
|
38
38
|
"""
|
|
39
|
-
|
|
40
|
-
is assigned. A trained model deployment may have an inference
|
|
41
|
-
As requests are handled by each allocated node, their responses
|
|
42
|
-
on that individual node. Calling this API clears the caches without
|
|
43
|
-
the deployment.
|
|
39
|
+
Clear trained model deployment cache. Cache will be cleared on all nodes where
|
|
40
|
+
the trained model is assigned. A trained model deployment may have an inference
|
|
41
|
+
cache enabled. As requests are handled by each allocated node, their responses
|
|
42
|
+
may be cached on that individual node. Calling this API clears the caches without
|
|
43
|
+
restarting the deployment.
|
|
44
44
|
|
|
45
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
45
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-trained-model-deployment-cache.html>`_
|
|
46
46
|
|
|
47
47
|
:param model_id: The unique identifier of the trained model.
|
|
48
48
|
"""
|
|
@@ -88,7 +88,7 @@ class MlClient(NamespacedClient):
|
|
|
88
88
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
89
89
|
) -> ObjectApiResponse[t.Any]:
|
|
90
90
|
"""
|
|
91
|
-
Close anomaly detection jobs A job can be opened and closed multiple times throughout
|
|
91
|
+
Close anomaly detection jobs. A job can be opened and closed multiple times throughout
|
|
92
92
|
its lifecycle. A closed job cannot receive data or perform analysis operations,
|
|
93
93
|
but you can still explore and navigate results. When you close a job, it runs
|
|
94
94
|
housekeeping tasks such as pruning the model history, flushing buffers, calculating
|
|
@@ -102,7 +102,7 @@ class MlClient(NamespacedClient):
|
|
|
102
102
|
force parameters as the close job request. When a datafeed that has a specified
|
|
103
103
|
end date stops, it automatically closes its associated job.
|
|
104
104
|
|
|
105
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
105
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-close-job.html>`_
|
|
106
106
|
|
|
107
107
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
108
108
|
a group name, or a wildcard expression. You can close multiple anomaly detection
|
|
@@ -161,9 +161,10 @@ class MlClient(NamespacedClient):
|
|
|
161
161
|
pretty: t.Optional[bool] = None,
|
|
162
162
|
) -> ObjectApiResponse[t.Any]:
|
|
163
163
|
"""
|
|
164
|
-
Removes all scheduled events from a calendar, then deletes
|
|
164
|
+
Delete a calendar. Removes all scheduled events from a calendar, then deletes
|
|
165
|
+
it.
|
|
165
166
|
|
|
166
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
167
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar.html>`_
|
|
167
168
|
|
|
168
169
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
169
170
|
"""
|
|
@@ -202,9 +203,9 @@ class MlClient(NamespacedClient):
|
|
|
202
203
|
pretty: t.Optional[bool] = None,
|
|
203
204
|
) -> ObjectApiResponse[t.Any]:
|
|
204
205
|
"""
|
|
205
|
-
|
|
206
|
+
Delete events from a calendar.
|
|
206
207
|
|
|
207
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
208
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar-event.html>`_
|
|
208
209
|
|
|
209
210
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
210
211
|
:param event_id: Identifier for the scheduled event. You can obtain this identifier
|
|
@@ -250,9 +251,9 @@ class MlClient(NamespacedClient):
|
|
|
250
251
|
pretty: t.Optional[bool] = None,
|
|
251
252
|
) -> ObjectApiResponse[t.Any]:
|
|
252
253
|
"""
|
|
253
|
-
|
|
254
|
+
Delete anomaly jobs from a calendar.
|
|
254
255
|
|
|
255
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
256
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar-job.html>`_
|
|
256
257
|
|
|
257
258
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
258
259
|
:param job_id: An identifier for the anomaly detection jobs. It can be a job
|
|
@@ -299,9 +300,9 @@ class MlClient(NamespacedClient):
|
|
|
299
300
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
300
301
|
) -> ObjectApiResponse[t.Any]:
|
|
301
302
|
"""
|
|
302
|
-
|
|
303
|
+
Delete a data frame analytics job.
|
|
303
304
|
|
|
304
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
305
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-dfanalytics.html>`_
|
|
305
306
|
|
|
306
307
|
:param id: Identifier for the data frame analytics job.
|
|
307
308
|
:param force: If `true`, it deletes a job that is not stopped; this method is
|
|
@@ -347,9 +348,9 @@ class MlClient(NamespacedClient):
|
|
|
347
348
|
pretty: t.Optional[bool] = None,
|
|
348
349
|
) -> ObjectApiResponse[t.Any]:
|
|
349
350
|
"""
|
|
350
|
-
|
|
351
|
+
Delete a datafeed.
|
|
351
352
|
|
|
352
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
353
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-datafeed.html>`_
|
|
353
354
|
|
|
354
355
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
355
356
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -399,15 +400,15 @@ class MlClient(NamespacedClient):
|
|
|
399
400
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
400
401
|
) -> ObjectApiResponse[t.Any]:
|
|
401
402
|
"""
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
403
|
+
Delete expired ML data. Deletes all job results, model snapshots and forecast
|
|
404
|
+
data that have exceeded their retention days period. Machine learning state documents
|
|
405
|
+
that are not associated with any job are also deleted. You can limit the request
|
|
406
|
+
to a single or set of anomaly detection jobs by using a job identifier, a group
|
|
407
|
+
name, a comma-separated list of jobs, or a wildcard expression. You can delete
|
|
408
|
+
expired data for all anomaly detection jobs by using _all, by specifying * as
|
|
409
|
+
the <job_id>, or by omitting the <job_id>.
|
|
409
410
|
|
|
410
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
411
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-expired-data.html>`_
|
|
411
412
|
|
|
412
413
|
:param job_id: Identifier for an anomaly detection job. It can be a job identifier,
|
|
413
414
|
a group name, or a wildcard expression.
|
|
@@ -464,11 +465,11 @@ class MlClient(NamespacedClient):
|
|
|
464
465
|
pretty: t.Optional[bool] = None,
|
|
465
466
|
) -> ObjectApiResponse[t.Any]:
|
|
466
467
|
"""
|
|
467
|
-
|
|
468
|
+
Delete a filter. If an anomaly detection job references the filter, you cannot
|
|
468
469
|
delete the filter. You must update or delete the job before you can delete the
|
|
469
470
|
filter.
|
|
470
471
|
|
|
471
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
472
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-filter.html>`_
|
|
472
473
|
|
|
473
474
|
:param filter_id: A string that uniquely identifies a filter.
|
|
474
475
|
"""
|
|
@@ -509,12 +510,12 @@ class MlClient(NamespacedClient):
|
|
|
509
510
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
510
511
|
) -> ObjectApiResponse[t.Any]:
|
|
511
512
|
"""
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
513
|
+
Delete forecasts from a job. By default, forecasts are retained for 14 days.
|
|
514
|
+
You can specify a different retention period with the `expires_in` parameter
|
|
515
|
+
in the forecast jobs API. The delete forecast API enables you to delete one or
|
|
516
|
+
more forecasts before they expire.
|
|
516
517
|
|
|
517
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
518
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-forecast.html>`_
|
|
518
519
|
|
|
519
520
|
:param job_id: Identifier for the anomaly detection job.
|
|
520
521
|
:param forecast_id: A comma-separated list of forecast identifiers. If you do
|
|
@@ -579,14 +580,14 @@ class MlClient(NamespacedClient):
|
|
|
579
580
|
wait_for_completion: t.Optional[bool] = None,
|
|
580
581
|
) -> ObjectApiResponse[t.Any]:
|
|
581
582
|
"""
|
|
582
|
-
|
|
583
|
+
Delete an anomaly detection job. All job configuration, model state and results
|
|
583
584
|
are deleted. It is not currently possible to delete multiple jobs using wildcards
|
|
584
585
|
or a comma separated list. If you delete a job that has a datafeed, the request
|
|
585
586
|
first tries to delete the datafeed. This behavior is equivalent to calling the
|
|
586
587
|
delete datafeed API with the same timeout and force parameters as the delete
|
|
587
588
|
job request.
|
|
588
589
|
|
|
589
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
590
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-job.html>`_
|
|
590
591
|
|
|
591
592
|
:param job_id: Identifier for the anomaly detection job.
|
|
592
593
|
:param delete_user_annotations: Specifies whether annotations that have been
|
|
@@ -638,12 +639,11 @@ class MlClient(NamespacedClient):
|
|
|
638
639
|
pretty: t.Optional[bool] = None,
|
|
639
640
|
) -> ObjectApiResponse[t.Any]:
|
|
640
641
|
"""
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
jobs API.
|
|
642
|
+
Delete a model snapshot. You cannot delete the active model snapshot. To delete
|
|
643
|
+
that snapshot, first revert to a different one. To identify the active model
|
|
644
|
+
snapshot, refer to the `model_snapshot_id` in the results from the get jobs API.
|
|
645
645
|
|
|
646
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
646
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-snapshot.html>`_
|
|
647
647
|
|
|
648
648
|
:param job_id: Identifier for the anomaly detection job.
|
|
649
649
|
:param snapshot_id: Identifier for the model snapshot.
|
|
@@ -688,10 +688,10 @@ class MlClient(NamespacedClient):
|
|
|
688
688
|
pretty: t.Optional[bool] = None,
|
|
689
689
|
) -> ObjectApiResponse[t.Any]:
|
|
690
690
|
"""
|
|
691
|
-
|
|
692
|
-
by an ingest pipeline.
|
|
691
|
+
Delete an unreferenced trained model. The request deletes a trained inference
|
|
692
|
+
model that is not referenced by an ingest pipeline.
|
|
693
693
|
|
|
694
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
694
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-trained-models.html>`_
|
|
695
695
|
|
|
696
696
|
:param model_id: The unique identifier of the trained model.
|
|
697
697
|
:param force: Forcefully deletes a trained model that is referenced by ingest
|
|
@@ -734,11 +734,11 @@ class MlClient(NamespacedClient):
|
|
|
734
734
|
pretty: t.Optional[bool] = None,
|
|
735
735
|
) -> ObjectApiResponse[t.Any]:
|
|
736
736
|
"""
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
737
|
+
Delete a trained model alias. This API deletes an existing model alias that refers
|
|
738
|
+
to a trained model. If the model alias is missing or refers to a model other
|
|
739
|
+
than the one identified by the `model_id`, this API returns an error.
|
|
740
740
|
|
|
741
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
741
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-trained-models-aliases.html>`_
|
|
742
742
|
|
|
743
743
|
:param model_id: The trained model ID to which the model alias refers.
|
|
744
744
|
:param model_alias: The model alias to delete.
|
|
@@ -791,11 +791,11 @@ class MlClient(NamespacedClient):
|
|
|
791
791
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
792
792
|
) -> ObjectApiResponse[t.Any]:
|
|
793
793
|
"""
|
|
794
|
-
Makes an estimation of the memory usage for
|
|
795
|
-
is based on analysis configuration details
|
|
796
|
-
for the fields it references.
|
|
794
|
+
Estimate job model memory usage. Makes an estimation of the memory usage for
|
|
795
|
+
an anomaly detection job model. It is based on analysis configuration details
|
|
796
|
+
for the job and cardinality estimates for the fields it references.
|
|
797
797
|
|
|
798
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
798
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-apis.html>`_
|
|
799
799
|
|
|
800
800
|
:param analysis_config: For a list of the properties that you can specify in
|
|
801
801
|
the `analysis_config` component of the body of this API.
|
|
@@ -858,12 +858,12 @@ class MlClient(NamespacedClient):
|
|
|
858
858
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
859
859
|
) -> ObjectApiResponse[t.Any]:
|
|
860
860
|
"""
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
861
|
+
Evaluate data frame analytics. The API packages together commonly used evaluation
|
|
862
|
+
metrics for various types of machine learning features. This has been designed
|
|
863
|
+
for use on indexes created by data frame analytics. Evaluation requires both
|
|
864
|
+
a ground truth field and an analytics result field to be present.
|
|
865
865
|
|
|
866
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
866
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/evaluate-dfanalytics.html>`_
|
|
867
867
|
|
|
868
868
|
:param evaluation: Defines the type of evaluation you want to perform.
|
|
869
869
|
:param index: Defines the `index` in which the evaluation will be performed.
|
|
@@ -935,15 +935,15 @@ class MlClient(NamespacedClient):
|
|
|
935
935
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
936
936
|
) -> ObjectApiResponse[t.Any]:
|
|
937
937
|
"""
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
938
|
+
Explain data frame analytics config. This API provides explanations for a data
|
|
939
|
+
frame analytics config that either exists already or one that has not been created
|
|
940
|
+
yet. The following explanations are provided: * which fields are included or
|
|
941
|
+
not in the analysis and why, * how much memory is estimated to be required. The
|
|
942
|
+
estimate can be used when deciding the appropriate value for model_memory_limit
|
|
943
943
|
setting later on. If you have object fields or fields that are excluded via source
|
|
944
944
|
filtering, they are not included in the explanation.
|
|
945
945
|
|
|
946
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
946
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/explain-dfanalytics.html>`_
|
|
947
947
|
|
|
948
948
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
949
949
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -1041,16 +1041,16 @@ class MlClient(NamespacedClient):
|
|
|
1041
1041
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1042
1042
|
) -> ObjectApiResponse[t.Any]:
|
|
1043
1043
|
"""
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1044
|
+
Force buffered data to be processed. The flush jobs API is only applicable when
|
|
1045
|
+
sending data for analysis using the post data API. Depending on the content of
|
|
1046
|
+
the buffer, then it might additionally calculate new results. Both flush and
|
|
1047
|
+
close operations are similar, however the flush is more efficient if you are
|
|
1048
|
+
expecting to send more data for analysis. When flushing, the job remains open
|
|
1049
|
+
and is available to continue analyzing data. A close operation additionally prunes
|
|
1050
|
+
and persists the model state to disk and the job must be opened again before
|
|
1051
|
+
analyzing further data.
|
|
1052
1052
|
|
|
1053
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1053
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-flush-job.html>`_
|
|
1054
1054
|
|
|
1055
1055
|
:param job_id: Identifier for the anomaly detection job.
|
|
1056
1056
|
:param advance_time: Refer to the description for the `advance_time` query parameter.
|
|
@@ -1116,12 +1116,12 @@ class MlClient(NamespacedClient):
|
|
|
1116
1116
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1117
1117
|
) -> ObjectApiResponse[t.Any]:
|
|
1118
1118
|
"""
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1119
|
+
Predict future behavior of a time series. Forecasts are not supported for jobs
|
|
1120
|
+
that perform population analysis; an error occurs if you try to create a forecast
|
|
1121
|
+
for a job that has an `over_field_name` in its configuration. Forcasts predict
|
|
1122
|
+
future behavior based on historical data.
|
|
1123
1123
|
|
|
1124
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1124
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-forecast.html>`_
|
|
1125
1125
|
|
|
1126
1126
|
:param job_id: Identifier for the anomaly detection job. The job must be open
|
|
1127
1127
|
when you create a forecast; otherwise, an error occurs.
|
|
@@ -1201,10 +1201,10 @@ class MlClient(NamespacedClient):
|
|
|
1201
1201
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1202
1202
|
) -> ObjectApiResponse[t.Any]:
|
|
1203
1203
|
"""
|
|
1204
|
-
|
|
1205
|
-
|
|
1204
|
+
Get anomaly detection job results for buckets. The API presents a chronological
|
|
1205
|
+
view of the records, grouped by bucket.
|
|
1206
1206
|
|
|
1207
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1207
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-bucket.html>`_
|
|
1208
1208
|
|
|
1209
1209
|
:param job_id: Identifier for the anomaly detection job.
|
|
1210
1210
|
:param timestamp: The timestamp of a single bucket result. If you do not specify
|
|
@@ -1297,9 +1297,9 @@ class MlClient(NamespacedClient):
|
|
|
1297
1297
|
start: t.Optional[t.Union[str, t.Any]] = None,
|
|
1298
1298
|
) -> ObjectApiResponse[t.Any]:
|
|
1299
1299
|
"""
|
|
1300
|
-
|
|
1300
|
+
Get info about events in calendars.
|
|
1301
1301
|
|
|
1302
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1302
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-calendar-event.html>`_
|
|
1303
1303
|
|
|
1304
1304
|
:param calendar_id: A string that uniquely identifies a calendar. You can get
|
|
1305
1305
|
information for multiple calendars by using a comma-separated list of ids
|
|
@@ -1363,9 +1363,9 @@ class MlClient(NamespacedClient):
|
|
|
1363
1363
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1364
1364
|
) -> ObjectApiResponse[t.Any]:
|
|
1365
1365
|
"""
|
|
1366
|
-
|
|
1366
|
+
Get calendar configuration info.
|
|
1367
1367
|
|
|
1368
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1368
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-calendar.html>`_
|
|
1369
1369
|
|
|
1370
1370
|
:param calendar_id: A string that uniquely identifies a calendar. You can get
|
|
1371
1371
|
information for multiple calendars by using a comma-separated list of ids
|
|
@@ -1436,9 +1436,9 @@ class MlClient(NamespacedClient):
|
|
|
1436
1436
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1437
1437
|
) -> ObjectApiResponse[t.Any]:
|
|
1438
1438
|
"""
|
|
1439
|
-
|
|
1439
|
+
Get anomaly detection job results for categories.
|
|
1440
1440
|
|
|
1441
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1441
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-category.html>`_
|
|
1442
1442
|
|
|
1443
1443
|
:param job_id: Identifier for the anomaly detection job.
|
|
1444
1444
|
:param category_id: Identifier for the category, which is unique in the job.
|
|
@@ -1518,11 +1518,11 @@ class MlClient(NamespacedClient):
|
|
|
1518
1518
|
size: t.Optional[int] = None,
|
|
1519
1519
|
) -> ObjectApiResponse[t.Any]:
|
|
1520
1520
|
"""
|
|
1521
|
-
|
|
1522
|
-
|
|
1523
|
-
|
|
1521
|
+
Get data frame analytics job configuration info. You can get information for
|
|
1522
|
+
multiple data frame analytics jobs in a single API request by using a comma-separated
|
|
1523
|
+
list of data frame analytics jobs or a wildcard expression.
|
|
1524
1524
|
|
|
1525
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1525
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-dfanalytics.html>`_
|
|
1526
1526
|
|
|
1527
1527
|
:param id: Identifier for the data frame analytics job. If you do not specify
|
|
1528
1528
|
this option, the API returns information for the first hundred data frame
|
|
@@ -1592,9 +1592,9 @@ class MlClient(NamespacedClient):
|
|
|
1592
1592
|
verbose: t.Optional[bool] = None,
|
|
1593
1593
|
) -> ObjectApiResponse[t.Any]:
|
|
1594
1594
|
"""
|
|
1595
|
-
|
|
1595
|
+
Get data frame analytics jobs usage info.
|
|
1596
1596
|
|
|
1597
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1597
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-dfanalytics-stats.html>`_
|
|
1598
1598
|
|
|
1599
1599
|
:param id: Identifier for the data frame analytics job. If you do not specify
|
|
1600
1600
|
this option, the API returns information for the first hundred data frame
|
|
@@ -1657,14 +1657,14 @@ class MlClient(NamespacedClient):
|
|
|
1657
1657
|
pretty: t.Optional[bool] = None,
|
|
1658
1658
|
) -> ObjectApiResponse[t.Any]:
|
|
1659
1659
|
"""
|
|
1660
|
-
|
|
1661
|
-
|
|
1662
|
-
|
|
1663
|
-
|
|
1664
|
-
|
|
1665
|
-
|
|
1660
|
+
Get datafeeds usage info. You can get statistics for multiple datafeeds in a
|
|
1661
|
+
single API request by using a comma-separated list of datafeeds or a wildcard
|
|
1662
|
+
expression. You can get statistics for all datafeeds by using `_all`, by specifying
|
|
1663
|
+
`*` as the `<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped,
|
|
1664
|
+
the only information you receive is the `datafeed_id` and the `state`. This API
|
|
1665
|
+
returns a maximum of 10,000 datafeeds.
|
|
1666
1666
|
|
|
1667
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1667
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-datafeed-stats.html>`_
|
|
1668
1668
|
|
|
1669
1669
|
:param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier
|
|
1670
1670
|
or a wildcard expression. If you do not specify one of these options, the
|
|
@@ -1718,13 +1718,13 @@ class MlClient(NamespacedClient):
|
|
|
1718
1718
|
pretty: t.Optional[bool] = None,
|
|
1719
1719
|
) -> ObjectApiResponse[t.Any]:
|
|
1720
1720
|
"""
|
|
1721
|
-
|
|
1722
|
-
|
|
1723
|
-
|
|
1724
|
-
|
|
1725
|
-
|
|
1721
|
+
Get datafeeds configuration info. You can get information for multiple datafeeds
|
|
1722
|
+
in a single API request by using a comma-separated list of datafeeds or a wildcard
|
|
1723
|
+
expression. You can get information for all datafeeds by using `_all`, by specifying
|
|
1724
|
+
`*` as the `<feed_id>`, or by omitting the `<feed_id>`. This API returns a maximum
|
|
1725
|
+
of 10,000 datafeeds.
|
|
1726
1726
|
|
|
1727
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1727
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-datafeed.html>`_
|
|
1728
1728
|
|
|
1729
1729
|
:param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier
|
|
1730
1730
|
or a wildcard expression. If you do not specify one of these options, the
|
|
@@ -1785,9 +1785,9 @@ class MlClient(NamespacedClient):
|
|
|
1785
1785
|
size: t.Optional[int] = None,
|
|
1786
1786
|
) -> ObjectApiResponse[t.Any]:
|
|
1787
1787
|
"""
|
|
1788
|
-
|
|
1788
|
+
Get filters. You can get a single filter or all filters.
|
|
1789
1789
|
|
|
1790
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1790
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-filter.html>`_
|
|
1791
1791
|
|
|
1792
1792
|
:param filter_id: A string that uniquely identifies a filter.
|
|
1793
1793
|
:param from_: Skips the specified number of filters.
|
|
@@ -1847,12 +1847,11 @@ class MlClient(NamespacedClient):
|
|
|
1847
1847
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1848
1848
|
) -> ObjectApiResponse[t.Any]:
|
|
1849
1849
|
"""
|
|
1850
|
-
|
|
1851
|
-
|
|
1852
|
-
|
|
1853
|
-
in the job configuration.
|
|
1850
|
+
Get anomaly detection job results for influencers. Influencers are the entities
|
|
1851
|
+
that have contributed to, or are to blame for, the anomalies. Influencer results
|
|
1852
|
+
are available only if an `influencer_field_name` is specified in the job configuration.
|
|
1854
1853
|
|
|
1855
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1854
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-influencer.html>`_
|
|
1856
1855
|
|
|
1857
1856
|
:param job_id: Identifier for the anomaly detection job.
|
|
1858
1857
|
:param desc: If true, the results are sorted in descending order.
|
|
@@ -1931,9 +1930,9 @@ class MlClient(NamespacedClient):
|
|
|
1931
1930
|
pretty: t.Optional[bool] = None,
|
|
1932
1931
|
) -> ObjectApiResponse[t.Any]:
|
|
1933
1932
|
"""
|
|
1934
|
-
|
|
1933
|
+
Get anomaly detection jobs usage info.
|
|
1935
1934
|
|
|
1936
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1935
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-job-stats.html>`_
|
|
1937
1936
|
|
|
1938
1937
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
1939
1938
|
a group name, a comma-separated list of jobs, or a wildcard expression. If
|
|
@@ -1988,13 +1987,13 @@ class MlClient(NamespacedClient):
|
|
|
1988
1987
|
pretty: t.Optional[bool] = None,
|
|
1989
1988
|
) -> ObjectApiResponse[t.Any]:
|
|
1990
1989
|
"""
|
|
1991
|
-
|
|
1992
|
-
|
|
1993
|
-
|
|
1994
|
-
|
|
1995
|
-
|
|
1990
|
+
Get anomaly detection jobs configuration info. You can get information for multiple
|
|
1991
|
+
anomaly detection jobs in a single API request by using a group name, a comma-separated
|
|
1992
|
+
list of jobs, or a wildcard expression. You can get information for all anomaly
|
|
1993
|
+
detection jobs by using `_all`, by specifying `*` as the `<job_id>`, or by omitting
|
|
1994
|
+
the `<job_id>`.
|
|
1996
1995
|
|
|
1997
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1996
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-job.html>`_
|
|
1998
1997
|
|
|
1999
1998
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
2000
1999
|
a group name, or a wildcard expression. If you do not specify one of these
|
|
@@ -2053,11 +2052,11 @@ class MlClient(NamespacedClient):
|
|
|
2053
2052
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2054
2053
|
) -> ObjectApiResponse[t.Any]:
|
|
2055
2054
|
"""
|
|
2056
|
-
Get
|
|
2057
|
-
memory, on each node, both within the JVM heap,
|
|
2058
|
-
JVM.
|
|
2055
|
+
Get machine learning memory usage info. Get information about how machine learning
|
|
2056
|
+
jobs and trained models are using memory, on each node, both within the JVM heap,
|
|
2057
|
+
and natively, outside of the JVM.
|
|
2059
2058
|
|
|
2060
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2059
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-ml-memory.html>`_
|
|
2061
2060
|
|
|
2062
2061
|
:param node_id: The names of particular nodes in the cluster to target. For example,
|
|
2063
2062
|
`nodeId1,nodeId2` or `ml:true`
|
|
@@ -2110,9 +2109,9 @@ class MlClient(NamespacedClient):
|
|
|
2110
2109
|
pretty: t.Optional[bool] = None,
|
|
2111
2110
|
) -> ObjectApiResponse[t.Any]:
|
|
2112
2111
|
"""
|
|
2113
|
-
|
|
2112
|
+
Get anomaly detection job model snapshot upgrade usage info.
|
|
2114
2113
|
|
|
2115
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2114
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-job-model-snapshot-upgrade-stats.html>`_
|
|
2116
2115
|
|
|
2117
2116
|
:param job_id: Identifier for the anomaly detection job.
|
|
2118
2117
|
:param snapshot_id: A numerical character string that uniquely identifies the
|
|
@@ -2181,9 +2180,9 @@ class MlClient(NamespacedClient):
|
|
|
2181
2180
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2182
2181
|
) -> ObjectApiResponse[t.Any]:
|
|
2183
2182
|
"""
|
|
2184
|
-
|
|
2183
|
+
Get model snapshots info.
|
|
2185
2184
|
|
|
2186
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2185
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-snapshot.html>`_
|
|
2187
2186
|
|
|
2188
2187
|
:param job_id: Identifier for the anomaly detection job.
|
|
2189
2188
|
:param snapshot_id: A numerical character string that uniquely identifies the
|
|
@@ -2282,21 +2281,21 @@ class MlClient(NamespacedClient):
|
|
|
2282
2281
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2283
2282
|
) -> ObjectApiResponse[t.Any]:
|
|
2284
2283
|
"""
|
|
2285
|
-
|
|
2286
|
-
anomaly detection jobs. The `overall_score` is calculated
|
|
2287
|
-
of all the buckets within the overall bucket span. First,
|
|
2288
|
-
per anomaly detection job in the overall bucket is
|
|
2289
|
-
of those scores are averaged to result in the `overall_score`.
|
|
2290
|
-
you can fine-tune the `overall_score` so that it is more or less
|
|
2291
|
-
the number of jobs that detect an anomaly at the same time. For
|
|
2292
|
-
set `top_n` to `1`, the `overall_score` is the maximum bucket
|
|
2293
|
-
bucket. Alternatively, if you set `top_n` to the number
|
|
2294
|
-
is high only when all jobs detect anomalies in that
|
|
2295
|
-
the `bucket_span` parameter (to a value greater than
|
|
2296
|
-
is the maximum `overall_score` of the overall
|
|
2297
|
-
to the jobs' largest bucket span.
|
|
2298
|
-
|
|
2299
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2284
|
+
Get overall bucket results. Retrievs overall bucket results that summarize the
|
|
2285
|
+
bucket results of multiple anomaly detection jobs. The `overall_score` is calculated
|
|
2286
|
+
by combining the scores of all the buckets within the overall bucket span. First,
|
|
2287
|
+
the maximum `anomaly_score` per anomaly detection job in the overall bucket is
|
|
2288
|
+
calculated. Then the `top_n` of those scores are averaged to result in the `overall_score`.
|
|
2289
|
+
This means that you can fine-tune the `overall_score` so that it is more or less
|
|
2290
|
+
sensitive to the number of jobs that detect an anomaly at the same time. For
|
|
2291
|
+
example, if you set `top_n` to `1`, the `overall_score` is the maximum bucket
|
|
2292
|
+
score in the overall bucket. Alternatively, if you set `top_n` to the number
|
|
2293
|
+
of jobs, the `overall_score` is high only when all jobs detect anomalies in that
|
|
2294
|
+
overall bucket. If you set the `bucket_span` parameter (to a value greater than
|
|
2295
|
+
its default), the `overall_score` is the maximum `overall_score` of the overall
|
|
2296
|
+
buckets that have a span equal to the jobs' largest bucket span.
|
|
2297
|
+
|
|
2298
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-overall-buckets.html>`_
|
|
2300
2299
|
|
|
2301
2300
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
2302
2301
|
a group name, a comma-separated list of jobs or groups, or a wildcard expression.
|
|
@@ -2391,7 +2390,7 @@ class MlClient(NamespacedClient):
|
|
|
2391
2390
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2392
2391
|
) -> ObjectApiResponse[t.Any]:
|
|
2393
2392
|
"""
|
|
2394
|
-
|
|
2393
|
+
Get anomaly records for an anomaly detection job. Records contain the detailed
|
|
2395
2394
|
analytical results. They describe the anomalous activity that has been identified
|
|
2396
2395
|
in the input data based on the detector configuration. There can be many anomaly
|
|
2397
2396
|
records depending on the characteristics and size of the input data. In practice,
|
|
@@ -2401,7 +2400,7 @@ class MlClient(NamespacedClient):
|
|
|
2401
2400
|
found in each bucket, which relates to the number of time series being modeled
|
|
2402
2401
|
and the number of detectors.
|
|
2403
2402
|
|
|
2404
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2403
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-record.html>`_
|
|
2405
2404
|
|
|
2406
2405
|
:param job_id: Identifier for the anomaly detection job.
|
|
2407
2406
|
:param desc: Refer to the description for the `desc` query parameter.
|
|
@@ -2489,14 +2488,15 @@ class MlClient(NamespacedClient):
|
|
|
2489
2488
|
],
|
|
2490
2489
|
]
|
|
2491
2490
|
] = None,
|
|
2491
|
+
include_model_definition: t.Optional[bool] = None,
|
|
2492
2492
|
pretty: t.Optional[bool] = None,
|
|
2493
2493
|
size: t.Optional[int] = None,
|
|
2494
2494
|
tags: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2495
2495
|
) -> ObjectApiResponse[t.Any]:
|
|
2496
2496
|
"""
|
|
2497
|
-
|
|
2497
|
+
Get trained model configuration info.
|
|
2498
2498
|
|
|
2499
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2499
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-trained-models.html>`_
|
|
2500
2500
|
|
|
2501
2501
|
:param model_id: The unique identifier of the trained model or a model alias.
|
|
2502
2502
|
You can get information for multiple trained models in a single API request
|
|
@@ -2515,6 +2515,8 @@ class MlClient(NamespacedClient):
|
|
|
2515
2515
|
:param from_: Skips the specified number of models.
|
|
2516
2516
|
:param include: A comma delimited string of optional fields to include in the
|
|
2517
2517
|
response body.
|
|
2518
|
+
:param include_model_definition: parameter is deprecated! Use [include=definition]
|
|
2519
|
+
instead
|
|
2518
2520
|
:param size: Specifies the maximum number of models to obtain.
|
|
2519
2521
|
:param tags: A comma delimited string of tags. A trained model can have many
|
|
2520
2522
|
tags, or none. When supplied, only trained models that contain all the supplied
|
|
@@ -2544,6 +2546,8 @@ class MlClient(NamespacedClient):
|
|
|
2544
2546
|
__query["human"] = human
|
|
2545
2547
|
if include is not None:
|
|
2546
2548
|
__query["include"] = include
|
|
2549
|
+
if include_model_definition is not None:
|
|
2550
|
+
__query["include_model_definition"] = include_model_definition
|
|
2547
2551
|
if pretty is not None:
|
|
2548
2552
|
__query["pretty"] = pretty
|
|
2549
2553
|
if size is not None:
|
|
@@ -2576,11 +2580,11 @@ class MlClient(NamespacedClient):
|
|
|
2576
2580
|
size: t.Optional[int] = None,
|
|
2577
2581
|
) -> ObjectApiResponse[t.Any]:
|
|
2578
2582
|
"""
|
|
2579
|
-
|
|
2580
|
-
|
|
2581
|
-
|
|
2583
|
+
Get trained models usage info. You can get usage information for multiple trained
|
|
2584
|
+
models in a single API request by using a comma-separated list of model IDs or
|
|
2585
|
+
a wildcard expression.
|
|
2582
2586
|
|
|
2583
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2587
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-trained-models-stats.html>`_
|
|
2584
2588
|
|
|
2585
2589
|
:param model_id: The unique identifier of the trained model or a model alias.
|
|
2586
2590
|
It can be a comma-separated list or a wildcard expression.
|
|
@@ -2641,9 +2645,9 @@ class MlClient(NamespacedClient):
|
|
|
2641
2645
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2642
2646
|
) -> ObjectApiResponse[t.Any]:
|
|
2643
2647
|
"""
|
|
2644
|
-
|
|
2648
|
+
Evaluate a trained model.
|
|
2645
2649
|
|
|
2646
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2650
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/infer-trained-model.html>`_
|
|
2647
2651
|
|
|
2648
2652
|
:param model_id: The unique identifier of the trained model.
|
|
2649
2653
|
:param docs: An array of objects to pass to the model for inference. The objects
|
|
@@ -2698,14 +2702,14 @@ class MlClient(NamespacedClient):
|
|
|
2698
2702
|
pretty: t.Optional[bool] = None,
|
|
2699
2703
|
) -> ObjectApiResponse[t.Any]:
|
|
2700
2704
|
"""
|
|
2701
|
-
Returns defaults and limits used by machine learning.
|
|
2702
|
-
to be used by a user interface that needs to fully
|
|
2703
|
-
configurations where some options are not specified,
|
|
2704
|
-
should be used. This endpoint may be used to find out
|
|
2705
|
-
It also provides information about the maximum size
|
|
2706
|
-
that could run in the current cluster configuration.
|
|
2705
|
+
Return ML defaults and limits. Returns defaults and limits used by machine learning.
|
|
2706
|
+
This endpoint is designed to be used by a user interface that needs to fully
|
|
2707
|
+
understand machine learning configurations where some options are not specified,
|
|
2708
|
+
meaning that the defaults should be used. This endpoint may be used to find out
|
|
2709
|
+
what those defaults are. It also provides information about the maximum size
|
|
2710
|
+
of machine learning jobs that could run in the current cluster configuration.
|
|
2707
2711
|
|
|
2708
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2712
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-ml-info.html>`_
|
|
2709
2713
|
"""
|
|
2710
2714
|
__path_parts: t.Dict[str, str] = {}
|
|
2711
2715
|
__path = "/_ml/info"
|
|
@@ -2743,14 +2747,14 @@ class MlClient(NamespacedClient):
|
|
|
2743
2747
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2744
2748
|
) -> ObjectApiResponse[t.Any]:
|
|
2745
2749
|
"""
|
|
2746
|
-
|
|
2747
|
-
|
|
2748
|
-
|
|
2749
|
-
|
|
2750
|
-
|
|
2751
|
-
|
|
2750
|
+
Open anomaly detection jobs. An anomaly detection job must be opened to be ready
|
|
2751
|
+
to receive and analyze data. It can be opened and closed multiple times throughout
|
|
2752
|
+
its lifecycle. When you open a new job, it starts with an empty model. When you
|
|
2753
|
+
open an existing job, the most recent model state is automatically loaded. The
|
|
2754
|
+
job is ready to resume its analysis from where it left off, once new data is
|
|
2755
|
+
received.
|
|
2752
2756
|
|
|
2753
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2757
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-open-job.html>`_
|
|
2754
2758
|
|
|
2755
2759
|
:param job_id: Identifier for the anomaly detection job.
|
|
2756
2760
|
:param timeout: Refer to the description for the `timeout` query parameter.
|
|
@@ -2802,9 +2806,9 @@ class MlClient(NamespacedClient):
|
|
|
2802
2806
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2803
2807
|
) -> ObjectApiResponse[t.Any]:
|
|
2804
2808
|
"""
|
|
2805
|
-
|
|
2809
|
+
Add scheduled events to the calendar.
|
|
2806
2810
|
|
|
2807
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2811
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-post-calendar-event.html>`_
|
|
2808
2812
|
|
|
2809
2813
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
2810
2814
|
:param events: A list of one of more scheduled events. The event’s start and
|
|
@@ -2858,11 +2862,11 @@ class MlClient(NamespacedClient):
|
|
|
2858
2862
|
reset_start: t.Optional[t.Union[str, t.Any]] = None,
|
|
2859
2863
|
) -> ObjectApiResponse[t.Any]:
|
|
2860
2864
|
"""
|
|
2861
|
-
|
|
2865
|
+
Send data to an anomaly detection job for analysis. IMPORTANT: For each job,
|
|
2862
2866
|
data can be accepted from only a single connection at a time. It is not currently
|
|
2863
2867
|
possible to post data to multiple jobs using wildcards or a comma-separated list.
|
|
2864
2868
|
|
|
2865
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2869
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-post-data.html>`_
|
|
2866
2870
|
|
|
2867
2871
|
:param job_id: Identifier for the anomaly detection job. The job must have a
|
|
2868
2872
|
state of open to receive and process the data.
|
|
@@ -2923,9 +2927,10 @@ class MlClient(NamespacedClient):
|
|
|
2923
2927
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2924
2928
|
) -> ObjectApiResponse[t.Any]:
|
|
2925
2929
|
"""
|
|
2926
|
-
|
|
2930
|
+
Preview features used by data frame analytics. Previews the extracted features
|
|
2931
|
+
used by a data frame analytics config.
|
|
2927
2932
|
|
|
2928
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2933
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/preview-dfanalytics.html>`_
|
|
2929
2934
|
|
|
2930
2935
|
:param id: Identifier for the data frame analytics job.
|
|
2931
2936
|
:param config: A data frame analytics config as described in create data frame
|
|
@@ -2985,7 +2990,7 @@ class MlClient(NamespacedClient):
|
|
|
2985
2990
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2986
2991
|
) -> ObjectApiResponse[t.Any]:
|
|
2987
2992
|
"""
|
|
2988
|
-
|
|
2993
|
+
Preview a datafeed. This API returns the first "page" of search results from
|
|
2989
2994
|
a datafeed. You can preview an existing datafeed or provide configuration details
|
|
2990
2995
|
for a datafeed and anomaly detection job in the API. The preview shows the structure
|
|
2991
2996
|
of the data that will be passed to the anomaly detection engine. IMPORTANT: When
|
|
@@ -2995,7 +3000,7 @@ class MlClient(NamespacedClient):
|
|
|
2995
3000
|
that accurately reflects the behavior of the datafeed, use the appropriate credentials.
|
|
2996
3001
|
You can also use secondary authorization headers to supply the credentials.
|
|
2997
3002
|
|
|
2998
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3003
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-preview-datafeed.html>`_
|
|
2999
3004
|
|
|
3000
3005
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
3001
3006
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -3069,9 +3074,9 @@ class MlClient(NamespacedClient):
|
|
|
3069
3074
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3070
3075
|
) -> ObjectApiResponse[t.Any]:
|
|
3071
3076
|
"""
|
|
3072
|
-
|
|
3077
|
+
Create a calendar.
|
|
3073
3078
|
|
|
3074
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3079
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-put-calendar.html>`_
|
|
3075
3080
|
|
|
3076
3081
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
3077
3082
|
:param description: A description of the calendar.
|
|
@@ -3123,9 +3128,9 @@ class MlClient(NamespacedClient):
|
|
|
3123
3128
|
pretty: t.Optional[bool] = None,
|
|
3124
3129
|
) -> ObjectApiResponse[t.Any]:
|
|
3125
3130
|
"""
|
|
3126
|
-
|
|
3131
|
+
Add anomaly detection job to calendar.
|
|
3127
3132
|
|
|
3128
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3133
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-put-calendar-job.html>`_
|
|
3129
3134
|
|
|
3130
3135
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
3131
3136
|
:param job_id: An identifier for the anomaly detection jobs. It can be a job
|
|
@@ -3169,9 +3174,11 @@ class MlClient(NamespacedClient):
|
|
|
3169
3174
|
"description",
|
|
3170
3175
|
"headers",
|
|
3171
3176
|
"max_num_threads",
|
|
3177
|
+
"meta",
|
|
3172
3178
|
"model_memory_limit",
|
|
3173
3179
|
"version",
|
|
3174
3180
|
),
|
|
3181
|
+
parameter_aliases={"_meta": "meta"},
|
|
3175
3182
|
ignore_deprecated_options={"headers"},
|
|
3176
3183
|
)
|
|
3177
3184
|
async def put_data_frame_analytics(
|
|
@@ -3189,17 +3196,18 @@ class MlClient(NamespacedClient):
|
|
|
3189
3196
|
headers: t.Optional[t.Mapping[str, t.Union[str, t.Sequence[str]]]] = None,
|
|
3190
3197
|
human: t.Optional[bool] = None,
|
|
3191
3198
|
max_num_threads: t.Optional[int] = None,
|
|
3199
|
+
meta: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3192
3200
|
model_memory_limit: t.Optional[str] = None,
|
|
3193
3201
|
pretty: t.Optional[bool] = None,
|
|
3194
3202
|
version: t.Optional[str] = None,
|
|
3195
3203
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3196
3204
|
) -> ObjectApiResponse[t.Any]:
|
|
3197
3205
|
"""
|
|
3198
|
-
|
|
3199
|
-
|
|
3200
|
-
|
|
3206
|
+
Create a data frame analytics job. This API creates a data frame analytics job
|
|
3207
|
+
that performs an analysis on the source indices and stores the outcome in a destination
|
|
3208
|
+
index.
|
|
3201
3209
|
|
|
3202
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3210
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-dfanalytics.html>`_
|
|
3203
3211
|
|
|
3204
3212
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
3205
3213
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -3249,6 +3257,7 @@ class MlClient(NamespacedClient):
|
|
|
3249
3257
|
Using more threads may decrease the time necessary to complete the analysis
|
|
3250
3258
|
at the cost of using more CPU. Note that the process may use additional threads
|
|
3251
3259
|
for operational functionality other than the analysis itself.
|
|
3260
|
+
:param meta:
|
|
3252
3261
|
:param model_memory_limit: The approximate maximum amount of memory resources
|
|
3253
3262
|
that are permitted for analytical processing. If your `elasticsearch.yml`
|
|
3254
3263
|
file contains an `xpack.ml.max_model_memory_limit` setting, an error occurs
|
|
@@ -3293,6 +3302,8 @@ class MlClient(NamespacedClient):
|
|
|
3293
3302
|
__body["headers"] = headers
|
|
3294
3303
|
if max_num_threads is not None:
|
|
3295
3304
|
__body["max_num_threads"] = max_num_threads
|
|
3305
|
+
if meta is not None:
|
|
3306
|
+
__body["_meta"] = meta
|
|
3296
3307
|
if model_memory_limit is not None:
|
|
3297
3308
|
__body["model_memory_limit"] = model_memory_limit
|
|
3298
3309
|
if version is not None:
|
|
@@ -3311,6 +3322,7 @@ class MlClient(NamespacedClient):
|
|
|
3311
3322
|
@_rewrite_parameters(
|
|
3312
3323
|
body_fields=(
|
|
3313
3324
|
"aggregations",
|
|
3325
|
+
"aggs",
|
|
3314
3326
|
"chunking_config",
|
|
3315
3327
|
"delayed_data_check_config",
|
|
3316
3328
|
"frequency",
|
|
@@ -3333,6 +3345,7 @@ class MlClient(NamespacedClient):
|
|
|
3333
3345
|
*,
|
|
3334
3346
|
datafeed_id: str,
|
|
3335
3347
|
aggregations: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
|
|
3348
|
+
aggs: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
|
|
3336
3349
|
allow_no_indices: t.Optional[bool] = None,
|
|
3337
3350
|
chunking_config: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3338
3351
|
delayed_data_check_config: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
@@ -3365,8 +3378,8 @@ class MlClient(NamespacedClient):
|
|
|
3365
3378
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3366
3379
|
) -> ObjectApiResponse[t.Any]:
|
|
3367
3380
|
"""
|
|
3368
|
-
|
|
3369
|
-
|
|
3381
|
+
Create a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by
|
|
3382
|
+
an anomaly detection job. You can associate only one datafeed with each anomaly
|
|
3370
3383
|
detection job. The datafeed contains a query that runs at a defined interval
|
|
3371
3384
|
(`frequency`). If you are concerned about delayed data, you can add a delay (`query_delay')
|
|
3372
3385
|
at each interval. When Elasticsearch security features are enabled, your datafeed
|
|
@@ -3377,7 +3390,7 @@ class MlClient(NamespacedClient):
|
|
|
3377
3390
|
directly to the `.ml-config` index. Do not give users `write` privileges on the
|
|
3378
3391
|
`.ml-config` index.
|
|
3379
3392
|
|
|
3380
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3393
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-put-datafeed.html>`_
|
|
3381
3394
|
|
|
3382
3395
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
3383
3396
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -3386,6 +3399,8 @@ class MlClient(NamespacedClient):
|
|
|
3386
3399
|
:param aggregations: If set, the datafeed performs aggregation searches. Support
|
|
3387
3400
|
for aggregations is limited and should be used only with low cardinality
|
|
3388
3401
|
data.
|
|
3402
|
+
:param aggs: If set, the datafeed performs aggregation searches. Support for
|
|
3403
|
+
aggregations is limited and should be used only with low cardinality data.
|
|
3389
3404
|
:param allow_no_indices: If true, wildcard indices expressions that resolve into
|
|
3390
3405
|
no concrete indices are ignored. This includes the `_all` string or when
|
|
3391
3406
|
no indices are specified.
|
|
@@ -3473,6 +3488,8 @@ class MlClient(NamespacedClient):
|
|
|
3473
3488
|
if not __body:
|
|
3474
3489
|
if aggregations is not None:
|
|
3475
3490
|
__body["aggregations"] = aggregations
|
|
3491
|
+
if aggs is not None:
|
|
3492
|
+
__body["aggs"] = aggs
|
|
3476
3493
|
if chunking_config is not None:
|
|
3477
3494
|
__body["chunking_config"] = chunking_config
|
|
3478
3495
|
if delayed_data_check_config is not None:
|
|
@@ -3528,11 +3545,11 @@ class MlClient(NamespacedClient):
|
|
|
3528
3545
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3529
3546
|
) -> ObjectApiResponse[t.Any]:
|
|
3530
3547
|
"""
|
|
3531
|
-
|
|
3532
|
-
|
|
3533
|
-
|
|
3548
|
+
Create a filter. A filter contains a list of strings. It can be used by one or
|
|
3549
|
+
more anomaly detection jobs. Specifically, filters are referenced in the `custom_rules`
|
|
3550
|
+
property of detector configuration objects.
|
|
3534
3551
|
|
|
3535
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3552
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-put-filter.html>`_
|
|
3536
3553
|
|
|
3537
3554
|
:param filter_id: A string that uniquely identifies a filter.
|
|
3538
3555
|
:param description: A description of the filter.
|
|
@@ -3595,6 +3612,7 @@ class MlClient(NamespacedClient):
|
|
|
3595
3612
|
analysis_config: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3596
3613
|
data_description: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3597
3614
|
allow_lazy_open: t.Optional[bool] = None,
|
|
3615
|
+
allow_no_indices: t.Optional[bool] = None,
|
|
3598
3616
|
analysis_limits: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3599
3617
|
background_persist_interval: t.Optional[
|
|
3600
3618
|
t.Union[str, t.Literal[-1], t.Literal[0]]
|
|
@@ -3604,9 +3622,19 @@ class MlClient(NamespacedClient):
|
|
|
3604
3622
|
datafeed_config: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3605
3623
|
description: t.Optional[str] = None,
|
|
3606
3624
|
error_trace: t.Optional[bool] = None,
|
|
3625
|
+
expand_wildcards: t.Optional[
|
|
3626
|
+
t.Union[
|
|
3627
|
+
t.Sequence[
|
|
3628
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
3629
|
+
],
|
|
3630
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
3631
|
+
]
|
|
3632
|
+
] = None,
|
|
3607
3633
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3608
3634
|
groups: t.Optional[t.Sequence[str]] = None,
|
|
3609
3635
|
human: t.Optional[bool] = None,
|
|
3636
|
+
ignore_throttled: t.Optional[bool] = None,
|
|
3637
|
+
ignore_unavailable: t.Optional[bool] = None,
|
|
3610
3638
|
model_plot_config: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3611
3639
|
model_snapshot_retention_days: t.Optional[int] = None,
|
|
3612
3640
|
pretty: t.Optional[bool] = None,
|
|
@@ -3616,10 +3644,10 @@ class MlClient(NamespacedClient):
|
|
|
3616
3644
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3617
3645
|
) -> ObjectApiResponse[t.Any]:
|
|
3618
3646
|
"""
|
|
3619
|
-
|
|
3620
|
-
|
|
3647
|
+
Create an anomaly detection job. If you include a `datafeed_config`, you must
|
|
3648
|
+
have read index privileges on the source index.
|
|
3621
3649
|
|
|
3622
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3650
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-put-job.html>`_
|
|
3623
3651
|
|
|
3624
3652
|
:param job_id: The identifier for the anomaly detection job. This identifier
|
|
3625
3653
|
can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
|
|
@@ -3641,6 +3669,9 @@ class MlClient(NamespacedClient):
|
|
|
3641
3669
|
to true, the open anomaly detection jobs API does not return an error and
|
|
3642
3670
|
the job waits in the opening state until sufficient machine learning node
|
|
3643
3671
|
capacity is available.
|
|
3672
|
+
:param allow_no_indices: If `true`, wildcard indices expressions that resolve
|
|
3673
|
+
into no concrete indices are ignored. This includes the `_all` string or
|
|
3674
|
+
when no indices are specified.
|
|
3644
3675
|
:param analysis_limits: Limits can be applied for the resources required to hold
|
|
3645
3676
|
the mathematical models in memory. These limits are approximate and can be
|
|
3646
3677
|
set per job. They do not control the memory used by other processes, for
|
|
@@ -3664,7 +3695,20 @@ class MlClient(NamespacedClient):
|
|
|
3664
3695
|
using those same roles. If you provide secondary authorization headers, those
|
|
3665
3696
|
credentials are used instead.
|
|
3666
3697
|
:param description: A description of the job.
|
|
3698
|
+
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
3699
|
+
request can target data streams, this argument determines whether wildcard
|
|
3700
|
+
expressions match hidden data streams. Supports comma-separated values. Valid
|
|
3701
|
+
values are: * `all`: Match any data stream or index, including hidden ones.
|
|
3702
|
+
* `closed`: Match closed, non-hidden indices. Also matches any non-hidden
|
|
3703
|
+
data stream. Data streams cannot be closed. * `hidden`: Match hidden data
|
|
3704
|
+
streams and hidden indices. Must be combined with `open`, `closed`, or both.
|
|
3705
|
+
* `none`: Wildcard patterns are not accepted. * `open`: Match open, non-hidden
|
|
3706
|
+
indices. Also matches any non-hidden data stream.
|
|
3667
3707
|
:param groups: A list of job groups. A job can belong to no groups or many.
|
|
3708
|
+
:param ignore_throttled: If `true`, concrete, expanded or aliased indices are
|
|
3709
|
+
ignored when frozen.
|
|
3710
|
+
:param ignore_unavailable: If `true`, unavailable indices (missing or closed)
|
|
3711
|
+
are ignored.
|
|
3668
3712
|
:param model_plot_config: This advanced configuration option stores model information
|
|
3669
3713
|
along with the results. It provides a more detailed view into anomaly detection.
|
|
3670
3714
|
If you enable model plot it can add considerable overhead to the performance
|
|
@@ -3704,12 +3748,20 @@ class MlClient(NamespacedClient):
|
|
|
3704
3748
|
__path = f'/_ml/anomaly_detectors/{__path_parts["job_id"]}'
|
|
3705
3749
|
__query: t.Dict[str, t.Any] = {}
|
|
3706
3750
|
__body: t.Dict[str, t.Any] = body if body is not None else {}
|
|
3751
|
+
if allow_no_indices is not None:
|
|
3752
|
+
__query["allow_no_indices"] = allow_no_indices
|
|
3707
3753
|
if error_trace is not None:
|
|
3708
3754
|
__query["error_trace"] = error_trace
|
|
3755
|
+
if expand_wildcards is not None:
|
|
3756
|
+
__query["expand_wildcards"] = expand_wildcards
|
|
3709
3757
|
if filter_path is not None:
|
|
3710
3758
|
__query["filter_path"] = filter_path
|
|
3711
3759
|
if human is not None:
|
|
3712
3760
|
__query["human"] = human
|
|
3761
|
+
if ignore_throttled is not None:
|
|
3762
|
+
__query["ignore_throttled"] = ignore_throttled
|
|
3763
|
+
if ignore_unavailable is not None:
|
|
3764
|
+
__query["ignore_unavailable"] = ignore_unavailable
|
|
3713
3765
|
if pretty is not None:
|
|
3714
3766
|
__query["pretty"] = pretty
|
|
3715
3767
|
if not __body:
|
|
@@ -3797,9 +3849,10 @@ class MlClient(NamespacedClient):
|
|
|
3797
3849
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3798
3850
|
) -> ObjectApiResponse[t.Any]:
|
|
3799
3851
|
"""
|
|
3800
|
-
|
|
3852
|
+
Create a trained model. Enable you to supply a trained model that is not created
|
|
3853
|
+
by data frame analytics.
|
|
3801
3854
|
|
|
3802
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3855
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-trained-models.html>`_
|
|
3803
3856
|
|
|
3804
3857
|
:param model_id: The unique identifier of the trained model.
|
|
3805
3858
|
:param compressed_definition: The compressed (GZipped and Base64 encoded) inference
|
|
@@ -3899,21 +3952,21 @@ class MlClient(NamespacedClient):
|
|
|
3899
3952
|
reassign: t.Optional[bool] = None,
|
|
3900
3953
|
) -> ObjectApiResponse[t.Any]:
|
|
3901
3954
|
"""
|
|
3902
|
-
|
|
3903
|
-
|
|
3904
|
-
|
|
3905
|
-
|
|
3906
|
-
|
|
3907
|
-
|
|
3908
|
-
|
|
3909
|
-
|
|
3910
|
-
|
|
3955
|
+
Create or update a trained model alias. A trained model alias is a logical name
|
|
3956
|
+
used to reference a single trained model. You can use aliases instead of trained
|
|
3957
|
+
model identifiers to make it easier to reference your models. For example, you
|
|
3958
|
+
can use aliases in inference aggregations and processors. An alias must be unique
|
|
3959
|
+
and refer to only a single trained model. However, you can have multiple aliases
|
|
3960
|
+
for each trained model. If you use this API to update an alias such that it references
|
|
3961
|
+
a different trained model ID and the model uses a different type of data frame
|
|
3962
|
+
analytics, an error occurs. For example, this situation occurs if you have a
|
|
3963
|
+
trained model for regression analysis and a trained model for classification
|
|
3911
3964
|
analysis; you cannot reassign an alias from one type of trained model to another.
|
|
3912
3965
|
If you use this API to update an alias and there are very few input fields in
|
|
3913
3966
|
common between the old and new trained models for the model alias, the API returns
|
|
3914
3967
|
a warning.
|
|
3915
3968
|
|
|
3916
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3969
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-trained-models-aliases.html>`_
|
|
3917
3970
|
|
|
3918
3971
|
:param model_id: The identifier for the trained model that the alias refers to.
|
|
3919
3972
|
:param model_alias: The alias to create or update. This value cannot end in numbers.
|
|
@@ -3969,9 +4022,9 @@ class MlClient(NamespacedClient):
|
|
|
3969
4022
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3970
4023
|
) -> ObjectApiResponse[t.Any]:
|
|
3971
4024
|
"""
|
|
3972
|
-
|
|
4025
|
+
Create part of a trained model definition.
|
|
3973
4026
|
|
|
3974
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4027
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-trained-model-definition-part.html>`_
|
|
3975
4028
|
|
|
3976
4029
|
:param model_id: The unique identifier of the trained model.
|
|
3977
4030
|
:param part: The definition part number. When the definition is loaded for inference
|
|
@@ -4046,11 +4099,11 @@ class MlClient(NamespacedClient):
|
|
|
4046
4099
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4047
4100
|
) -> ObjectApiResponse[t.Any]:
|
|
4048
4101
|
"""
|
|
4049
|
-
|
|
4102
|
+
Create a trained model vocabulary. This API is supported only for natural language
|
|
4050
4103
|
processing (NLP) models. The vocabulary is stored in the index as described in
|
|
4051
4104
|
`inference_config.*.vocabulary` of the trained model definition.
|
|
4052
4105
|
|
|
4053
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4106
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-trained-model-vocabulary.html>`_
|
|
4054
4107
|
|
|
4055
4108
|
:param model_id: The unique identifier of the trained model.
|
|
4056
4109
|
:param vocabulary: The model vocabulary, which must not be empty.
|
|
@@ -4104,11 +4157,11 @@ class MlClient(NamespacedClient):
|
|
|
4104
4157
|
wait_for_completion: t.Optional[bool] = None,
|
|
4105
4158
|
) -> ObjectApiResponse[t.Any]:
|
|
4106
4159
|
"""
|
|
4107
|
-
|
|
4160
|
+
Reset an anomaly detection job. All model state and results are deleted. The
|
|
4108
4161
|
job is ready to start over as if it had just been created. It is not currently
|
|
4109
4162
|
possible to reset multiple jobs using wildcards or a comma separated list.
|
|
4110
4163
|
|
|
4111
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4164
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-reset-job.html>`_
|
|
4112
4165
|
|
|
4113
4166
|
:param job_id: The ID of the job to reset.
|
|
4114
4167
|
:param delete_user_annotations: Specifies whether annotations that have been
|
|
@@ -4160,15 +4213,15 @@ class MlClient(NamespacedClient):
|
|
|
4160
4213
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4161
4214
|
) -> ObjectApiResponse[t.Any]:
|
|
4162
4215
|
"""
|
|
4163
|
-
|
|
4164
|
-
|
|
4165
|
-
|
|
4166
|
-
|
|
4167
|
-
|
|
4168
|
-
|
|
4169
|
-
|
|
4216
|
+
Revert to a snapshot. The machine learning features react quickly to anomalous
|
|
4217
|
+
input, learning new behaviors in data. Highly anomalous input increases the variance
|
|
4218
|
+
in the models whilst the system learns whether this is a new step-change in behavior
|
|
4219
|
+
or a one-off event. In the case where this anomalous input is known to be a one-off,
|
|
4220
|
+
then it might be appropriate to reset the model state to a time before this event.
|
|
4221
|
+
For example, you might consider reverting to a saved snapshot after Black Friday
|
|
4222
|
+
or a critical system failure.
|
|
4170
4223
|
|
|
4171
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4224
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-revert-snapshot.html>`_
|
|
4172
4225
|
|
|
4173
4226
|
:param job_id: Identifier for the anomaly detection job.
|
|
4174
4227
|
:param snapshot_id: You can specify `empty` as the <snapshot_id>. Reverting to
|
|
@@ -4226,18 +4279,19 @@ class MlClient(NamespacedClient):
|
|
|
4226
4279
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4227
4280
|
) -> ObjectApiResponse[t.Any]:
|
|
4228
4281
|
"""
|
|
4229
|
-
Sets a cluster wide upgrade_mode setting that
|
|
4230
|
-
for an upgrade. When upgrading your cluster,
|
|
4231
|
-
your nodes and reindex your machine learning
|
|
4232
|
-
there must be no machine learning jobs running.
|
|
4233
|
-
jobs, do the upgrade, then open all the jobs
|
|
4234
|
-
this API to temporarily halt tasks associated
|
|
4235
|
-
prevent new jobs from opening. You can also use
|
|
4236
|
-
do not require you to reindex your machine learning
|
|
4237
|
-
jobs is not a requirement in that case. You can see
|
|
4238
|
-
upgrade_mode setting by using the get machine learning
|
|
4282
|
+
Set upgrade_mode for ML indices. Sets a cluster wide upgrade_mode setting that
|
|
4283
|
+
prepares machine learning indices for an upgrade. When upgrading your cluster,
|
|
4284
|
+
in some circumstances you must restart your nodes and reindex your machine learning
|
|
4285
|
+
indices. In those circumstances, there must be no machine learning jobs running.
|
|
4286
|
+
You can close the machine learning jobs, do the upgrade, then open all the jobs
|
|
4287
|
+
again. Alternatively, you can use this API to temporarily halt tasks associated
|
|
4288
|
+
with the jobs and datafeeds and prevent new jobs from opening. You can also use
|
|
4289
|
+
this API during upgrades that do not require you to reindex your machine learning
|
|
4290
|
+
indices, though stopping jobs is not a requirement in that case. You can see
|
|
4291
|
+
the current value for the upgrade_mode setting by using the get machine learning
|
|
4292
|
+
info API.
|
|
4239
4293
|
|
|
4240
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4294
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-set-upgrade-mode.html>`_
|
|
4241
4295
|
|
|
4242
4296
|
:param enabled: When `true`, it enables `upgrade_mode` which temporarily halts
|
|
4243
4297
|
all job and datafeed tasks and prohibits new job and datafeed tasks from
|
|
@@ -4281,18 +4335,18 @@ class MlClient(NamespacedClient):
|
|
|
4281
4335
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4282
4336
|
) -> ObjectApiResponse[t.Any]:
|
|
4283
4337
|
"""
|
|
4284
|
-
|
|
4285
|
-
|
|
4286
|
-
|
|
4287
|
-
|
|
4288
|
-
|
|
4289
|
-
|
|
4290
|
-
|
|
4291
|
-
|
|
4292
|
-
|
|
4293
|
-
|
|
4338
|
+
Start a data frame analytics job. A data frame analytics job can be started and
|
|
4339
|
+
stopped multiple times throughout its lifecycle. If the destination index does
|
|
4340
|
+
not exist, it is created automatically the first time you start the data frame
|
|
4341
|
+
analytics job. The `index.number_of_shards` and `index.number_of_replicas` settings
|
|
4342
|
+
for the destination index are copied from the source index. If there are multiple
|
|
4343
|
+
source indices, the destination index copies the highest setting values. The
|
|
4344
|
+
mappings for the destination index are also copied from the source indices. If
|
|
4345
|
+
there are any mapping conflicts, the job fails to start. If the destination index
|
|
4346
|
+
exists, it is used as is. You can therefore set up the destination index in advance
|
|
4347
|
+
with custom settings and mappings.
|
|
4294
4348
|
|
|
4295
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4349
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-dfanalytics.html>`_
|
|
4296
4350
|
|
|
4297
4351
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
4298
4352
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -4342,19 +4396,19 @@ class MlClient(NamespacedClient):
|
|
|
4342
4396
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4343
4397
|
) -> ObjectApiResponse[t.Any]:
|
|
4344
4398
|
"""
|
|
4345
|
-
|
|
4346
|
-
|
|
4347
|
-
|
|
4348
|
-
|
|
4349
|
-
|
|
4350
|
-
|
|
4351
|
-
|
|
4352
|
-
|
|
4353
|
-
|
|
4354
|
-
|
|
4355
|
-
|
|
4399
|
+
Start datafeeds. A datafeed must be started in order to retrieve data from Elasticsearch.
|
|
4400
|
+
A datafeed can be started and stopped multiple times throughout its lifecycle.
|
|
4401
|
+
Before you can start a datafeed, the anomaly detection job must be open. Otherwise,
|
|
4402
|
+
an error occurs. If you restart a stopped datafeed, it continues processing input
|
|
4403
|
+
data from the next millisecond after it was stopped. If new data was indexed
|
|
4404
|
+
for that exact millisecond between stopping and starting, it will be ignored.
|
|
4405
|
+
When Elasticsearch security features are enabled, your datafeed remembers which
|
|
4406
|
+
roles the last user to create or update it had at the time of creation or update
|
|
4407
|
+
and runs the query using those same roles. If you provided secondary authorization
|
|
4408
|
+
headers when you created or updated the datafeed, those credentials are used
|
|
4409
|
+
instead.
|
|
4356
4410
|
|
|
4357
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4411
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-start-datafeed.html>`_
|
|
4358
4412
|
|
|
4359
4413
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
4360
4414
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -4421,10 +4475,10 @@ class MlClient(NamespacedClient):
|
|
|
4421
4475
|
] = None,
|
|
4422
4476
|
) -> ObjectApiResponse[t.Any]:
|
|
4423
4477
|
"""
|
|
4424
|
-
|
|
4425
|
-
|
|
4478
|
+
Start a trained model deployment. It allocates the model to every machine learning
|
|
4479
|
+
node.
|
|
4426
4480
|
|
|
4427
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4481
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-trained-model-deployment.html>`_
|
|
4428
4482
|
|
|
4429
4483
|
:param model_id: The unique identifier of the trained model. Currently, only
|
|
4430
4484
|
PyTorch models are supported.
|
|
@@ -4505,10 +4559,10 @@ class MlClient(NamespacedClient):
|
|
|
4505
4559
|
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4506
4560
|
) -> ObjectApiResponse[t.Any]:
|
|
4507
4561
|
"""
|
|
4508
|
-
|
|
4509
|
-
|
|
4562
|
+
Stop data frame analytics jobs. A data frame analytics job can be started and
|
|
4563
|
+
stopped multiple times throughout its lifecycle.
|
|
4510
4564
|
|
|
4511
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4565
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/stop-dfanalytics.html>`_
|
|
4512
4566
|
|
|
4513
4567
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
4514
4568
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -4571,11 +4625,10 @@ class MlClient(NamespacedClient):
|
|
|
4571
4625
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4572
4626
|
) -> ObjectApiResponse[t.Any]:
|
|
4573
4627
|
"""
|
|
4574
|
-
|
|
4575
|
-
|
|
4576
|
-
its lifecycle.
|
|
4628
|
+
Stop datafeeds. A datafeed that is stopped ceases to retrieve data from Elasticsearch.
|
|
4629
|
+
A datafeed can be started and stopped multiple times throughout its lifecycle.
|
|
4577
4630
|
|
|
4578
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4631
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-stop-datafeed.html>`_
|
|
4579
4632
|
|
|
4580
4633
|
:param datafeed_id: Identifier for the datafeed. You can stop multiple datafeeds
|
|
4581
4634
|
in a single API request by using a comma-separated list of datafeeds or a
|
|
@@ -4635,9 +4688,9 @@ class MlClient(NamespacedClient):
|
|
|
4635
4688
|
pretty: t.Optional[bool] = None,
|
|
4636
4689
|
) -> ObjectApiResponse[t.Any]:
|
|
4637
4690
|
"""
|
|
4638
|
-
|
|
4691
|
+
Stop a trained model deployment.
|
|
4639
4692
|
|
|
4640
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4693
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/stop-trained-model-deployment.html>`_
|
|
4641
4694
|
|
|
4642
4695
|
:param model_id: The unique identifier of the trained model.
|
|
4643
4696
|
:param allow_no_match: Specifies what to do when the request: contains wildcard
|
|
@@ -4700,9 +4753,9 @@ class MlClient(NamespacedClient):
|
|
|
4700
4753
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4701
4754
|
) -> ObjectApiResponse[t.Any]:
|
|
4702
4755
|
"""
|
|
4703
|
-
|
|
4756
|
+
Update a data frame analytics job.
|
|
4704
4757
|
|
|
4705
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4758
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-dfanalytics.html>`_
|
|
4706
4759
|
|
|
4707
4760
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
4708
4761
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -4808,13 +4861,13 @@ class MlClient(NamespacedClient):
|
|
|
4808
4861
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4809
4862
|
) -> ObjectApiResponse[t.Any]:
|
|
4810
4863
|
"""
|
|
4811
|
-
|
|
4812
|
-
|
|
4813
|
-
|
|
4814
|
-
|
|
4815
|
-
|
|
4864
|
+
Update a datafeed. You must stop and start the datafeed for the changes to be
|
|
4865
|
+
applied. When Elasticsearch security features are enabled, your datafeed remembers
|
|
4866
|
+
which roles the user who updated it had at the time of the update and runs the
|
|
4867
|
+
query using those same roles. If you provide secondary authorization headers,
|
|
4868
|
+
those credentials are used instead.
|
|
4816
4869
|
|
|
4817
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4870
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-update-datafeed.html>`_
|
|
4818
4871
|
|
|
4819
4872
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
4820
4873
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -4975,9 +5028,10 @@ class MlClient(NamespacedClient):
|
|
|
4975
5028
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4976
5029
|
) -> ObjectApiResponse[t.Any]:
|
|
4977
5030
|
"""
|
|
4978
|
-
Updates the description of a filter, adds items, or removes
|
|
5031
|
+
Update a filter. Updates the description of a filter, adds items, or removes
|
|
5032
|
+
items from the list.
|
|
4979
5033
|
|
|
4980
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5034
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-update-filter.html>`_
|
|
4981
5035
|
|
|
4982
5036
|
:param filter_id: A string that uniquely identifies a filter.
|
|
4983
5037
|
:param add_items: The items to add to the filter.
|
|
@@ -5065,9 +5119,10 @@ class MlClient(NamespacedClient):
|
|
|
5065
5119
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
5066
5120
|
) -> ObjectApiResponse[t.Any]:
|
|
5067
5121
|
"""
|
|
5068
|
-
Updates certain properties of an anomaly detection
|
|
5122
|
+
Update an anomaly detection job. Updates certain properties of an anomaly detection
|
|
5123
|
+
job.
|
|
5069
5124
|
|
|
5070
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5125
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-update-job.html>`_
|
|
5071
5126
|
|
|
5072
5127
|
:param job_id: Identifier for the job.
|
|
5073
5128
|
:param allow_lazy_open: Advanced configuration option. Specifies whether this
|
|
@@ -5193,9 +5248,9 @@ class MlClient(NamespacedClient):
|
|
|
5193
5248
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
5194
5249
|
) -> ObjectApiResponse[t.Any]:
|
|
5195
5250
|
"""
|
|
5196
|
-
Updates certain properties of a snapshot.
|
|
5251
|
+
Update a snapshot. Updates certain properties of a snapshot.
|
|
5197
5252
|
|
|
5198
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5253
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-update-snapshot.html>`_
|
|
5199
5254
|
|
|
5200
5255
|
:param job_id: Identifier for the anomaly detection job.
|
|
5201
5256
|
:param snapshot_id: Identifier for the model snapshot.
|
|
@@ -5254,10 +5309,9 @@ class MlClient(NamespacedClient):
|
|
|
5254
5309
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
5255
5310
|
) -> ObjectApiResponse[t.Any]:
|
|
5256
5311
|
"""
|
|
5257
|
-
|
|
5258
|
-
learning node.
|
|
5312
|
+
Update a trained model deployment.
|
|
5259
5313
|
|
|
5260
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5314
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-trained-model-deployment.html>`_
|
|
5261
5315
|
|
|
5262
5316
|
:param model_id: The unique identifier of the trained model. Currently, only
|
|
5263
5317
|
PyTorch models are supported.
|
|
@@ -5314,15 +5368,16 @@ class MlClient(NamespacedClient):
|
|
|
5314
5368
|
wait_for_completion: t.Optional[bool] = None,
|
|
5315
5369
|
) -> ObjectApiResponse[t.Any]:
|
|
5316
5370
|
"""
|
|
5317
|
-
Upgrades an anomaly detection model snapshot to the latest
|
|
5318
|
-
time, older snapshot formats are deprecated and removed.
|
|
5319
|
-
support only snapshots that are from the current or previous
|
|
5320
|
-
API provides a means to upgrade a snapshot to the current
|
|
5321
|
-
aids in preparing the cluster for an upgrade to the next
|
|
5322
|
-
one snapshot per anomaly detection job can be upgraded at
|
|
5323
|
-
snapshot cannot be the current snapshot of the anomaly
|
|
5371
|
+
Upgrade a snapshot. Upgrades an anomaly detection model snapshot to the latest
|
|
5372
|
+
major version. Over time, older snapshot formats are deprecated and removed.
|
|
5373
|
+
Anomaly detection jobs support only snapshots that are from the current or previous
|
|
5374
|
+
major version. This API provides a means to upgrade a snapshot to the current
|
|
5375
|
+
major version. This aids in preparing the cluster for an upgrade to the next
|
|
5376
|
+
major version. Only one snapshot per anomaly detection job can be upgraded at
|
|
5377
|
+
a time and the upgraded snapshot cannot be the current snapshot of the anomaly
|
|
5378
|
+
detection job.
|
|
5324
5379
|
|
|
5325
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5380
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-upgrade-job-model-snapshot.html>`_
|
|
5326
5381
|
|
|
5327
5382
|
:param job_id: Identifier for the anomaly detection job.
|
|
5328
5383
|
:param snapshot_id: A numerical character string that uniquely identifies the
|
|
@@ -5398,7 +5453,7 @@ class MlClient(NamespacedClient):
|
|
|
5398
5453
|
"""
|
|
5399
5454
|
Validates an anomaly detection job.
|
|
5400
5455
|
|
|
5401
|
-
`<https://www.elastic.co/guide/en/machine-learning/8.
|
|
5456
|
+
`<https://www.elastic.co/guide/en/machine-learning/8.17/ml-jobs.html>`_
|
|
5402
5457
|
|
|
5403
5458
|
:param analysis_config:
|
|
5404
5459
|
:param analysis_limits:
|
|
@@ -5468,7 +5523,7 @@ class MlClient(NamespacedClient):
|
|
|
5468
5523
|
"""
|
|
5469
5524
|
Validates an anomaly detection detector.
|
|
5470
5525
|
|
|
5471
|
-
`<https://www.elastic.co/guide/en/machine-learning/8.
|
|
5526
|
+
`<https://www.elastic.co/guide/en/machine-learning/8.17/ml-jobs.html>`_
|
|
5472
5527
|
|
|
5473
5528
|
:param detector:
|
|
5474
5529
|
"""
|