elasticsearch 8.14.0__py3-none-any.whl → 8.15.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 +196 -168
- elasticsearch/_async/client/async_search.py +35 -20
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +785 -180
- elasticsearch/_async/client/ccr.py +20 -32
- elasticsearch/_async/client/cluster.py +87 -79
- elasticsearch/_async/client/connector.py +1470 -0
- elasticsearch/_async/client/dangling_indices.py +7 -11
- elasticsearch/_async/client/enrich.py +8 -8
- elasticsearch/_async/client/eql.py +17 -16
- elasticsearch/_async/client/esql.py +2 -2
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +18 -17
- elasticsearch/_async/client/graph.py +4 -4
- elasticsearch/_async/client/ilm.py +36 -44
- elasticsearch/_async/client/indices.py +282 -317
- elasticsearch/_async/client/inference.py +42 -33
- elasticsearch/_async/client/ingest.py +22 -23
- elasticsearch/_async/client/license.py +18 -10
- elasticsearch/_async/client/logstash.py +6 -6
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +383 -176
- elasticsearch/_async/client/monitoring.py +2 -2
- elasticsearch/_async/client/nodes.py +32 -32
- elasticsearch/_async/client/query_rules.py +384 -0
- elasticsearch/_async/client/rollup.py +13 -13
- elasticsearch/_async/client/search_application.py +10 -10
- elasticsearch/_async/client/searchable_snapshots.py +9 -13
- elasticsearch/_async/client/security.py +577 -104
- elasticsearch/_async/client/shutdown.py +7 -7
- elasticsearch/_async/client/slm.py +11 -13
- elasticsearch/_async/client/snapshot.py +39 -52
- elasticsearch/_async/client/sql.py +12 -14
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +8 -8
- elasticsearch/_async/client/tasks.py +9 -10
- elasticsearch/_async/client/text_structure.py +3 -3
- elasticsearch/_async/client/transform.py +89 -34
- elasticsearch/_async/client/watcher.py +30 -15
- elasticsearch/_async/client/xpack.py +6 -7
- elasticsearch/_otel.py +2 -6
- elasticsearch/_sync/client/__init__.py +196 -168
- elasticsearch/_sync/client/async_search.py +35 -20
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +785 -180
- elasticsearch/_sync/client/ccr.py +20 -32
- elasticsearch/_sync/client/cluster.py +87 -79
- elasticsearch/_sync/client/connector.py +1470 -0
- elasticsearch/_sync/client/dangling_indices.py +7 -11
- elasticsearch/_sync/client/enrich.py +8 -8
- elasticsearch/_sync/client/eql.py +17 -16
- elasticsearch/_sync/client/esql.py +2 -2
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +18 -17
- elasticsearch/_sync/client/graph.py +4 -4
- elasticsearch/_sync/client/ilm.py +36 -44
- elasticsearch/_sync/client/indices.py +282 -317
- elasticsearch/_sync/client/inference.py +42 -33
- elasticsearch/_sync/client/ingest.py +22 -23
- elasticsearch/_sync/client/license.py +18 -10
- elasticsearch/_sync/client/logstash.py +6 -6
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +383 -176
- elasticsearch/_sync/client/monitoring.py +2 -2
- elasticsearch/_sync/client/nodes.py +32 -32
- elasticsearch/_sync/client/query_rules.py +384 -0
- elasticsearch/_sync/client/rollup.py +13 -13
- elasticsearch/_sync/client/search_application.py +10 -10
- elasticsearch/_sync/client/searchable_snapshots.py +9 -13
- elasticsearch/_sync/client/security.py +577 -104
- elasticsearch/_sync/client/shutdown.py +7 -7
- elasticsearch/_sync/client/slm.py +11 -13
- elasticsearch/_sync/client/snapshot.py +39 -52
- elasticsearch/_sync/client/sql.py +12 -14
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +8 -8
- elasticsearch/_sync/client/tasks.py +9 -10
- elasticsearch/_sync/client/text_structure.py +3 -3
- elasticsearch/_sync/client/transform.py +89 -34
- elasticsearch/_sync/client/watcher.py +30 -15
- elasticsearch/_sync/client/xpack.py +6 -7
- elasticsearch/_version.py +1 -1
- elasticsearch/client.py +3 -3
- elasticsearch/helpers/vectorstore/_async/vectorstore.py +36 -6
- elasticsearch/helpers/vectorstore/_sync/vectorstore.py +36 -6
- elasticsearch/serializer.py +34 -0
- elasticsearch-8.15.0.dist-info/METADATA +177 -0
- elasticsearch-8.15.0.dist-info/RECORD +117 -0
- {elasticsearch-8.14.0.dist-info → elasticsearch-8.15.0.dist-info}/WHEEL +1 -2
- elasticsearch/_async/client/query_ruleset.py +0 -205
- elasticsearch/_sync/client/query_ruleset.py +0 -205
- elasticsearch-8.14.0.dist-info/METADATA +0 -161
- elasticsearch-8.14.0.dist-info/RECORD +0 -116
- elasticsearch-8.14.0.dist-info/top_level.txt +0 -1
- {elasticsearch-8.14.0.dist-info → elasticsearch-8.15.0.dist-info/licenses}/LICENSE +0 -0
- {elasticsearch-8.14.0.dist-info → elasticsearch-8.15.0.dist-info/licenses}/NOTICE +0 -0
elasticsearch/_sync/client/ml.py
CHANGED
|
@@ -36,9 +36,13 @@ class MlClient(NamespacedClient):
|
|
|
36
36
|
pretty: t.Optional[bool] = None,
|
|
37
37
|
) -> ObjectApiResponse[t.Any]:
|
|
38
38
|
"""
|
|
39
|
-
|
|
39
|
+
Clears a trained model deployment cache on all nodes where the trained model
|
|
40
|
+
is assigned. A trained model deployment may have an inference cache enabled.
|
|
41
|
+
As requests are handled by each allocated node, their responses may be cached
|
|
42
|
+
on that individual node. Calling this API clears the caches without restarting
|
|
43
|
+
the deployment.
|
|
40
44
|
|
|
41
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
45
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/clear-trained-model-deployment-cache.html>`_
|
|
42
46
|
|
|
43
47
|
:param model_id: The unique identifier of the trained model.
|
|
44
48
|
"""
|
|
@@ -80,14 +84,25 @@ class MlClient(NamespacedClient):
|
|
|
80
84
|
force: t.Optional[bool] = None,
|
|
81
85
|
human: t.Optional[bool] = None,
|
|
82
86
|
pretty: t.Optional[bool] = None,
|
|
83
|
-
timeout: t.Optional[t.Union[
|
|
87
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
84
88
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
85
89
|
) -> ObjectApiResponse[t.Any]:
|
|
86
90
|
"""
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
+
Close anomaly detection jobs A job can be opened and closed multiple times throughout
|
|
92
|
+
its lifecycle. A closed job cannot receive data or perform analysis operations,
|
|
93
|
+
but you can still explore and navigate results. When you close a job, it runs
|
|
94
|
+
housekeeping tasks such as pruning the model history, flushing buffers, calculating
|
|
95
|
+
final results and persisting the model snapshots. Depending upon the size of
|
|
96
|
+
the job, it could take several minutes to close and the equivalent time to re-open.
|
|
97
|
+
After it is closed, the job has a minimal overhead on the cluster except for
|
|
98
|
+
maintaining its meta data. Therefore it is a best practice to close jobs that
|
|
99
|
+
are no longer required to process data. If you close an anomaly detection job
|
|
100
|
+
whose datafeed is running, the request first tries to stop the datafeed. This
|
|
101
|
+
behavior is equivalent to calling stop datafeed API with the same timeout and
|
|
102
|
+
force parameters as the close job request. When a datafeed that has a specified
|
|
103
|
+
end date stops, it automatically closes its associated job.
|
|
104
|
+
|
|
105
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-close-job.html>`_
|
|
91
106
|
|
|
92
107
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
93
108
|
a group name, or a wildcard expression. You can close multiple anomaly detection
|
|
@@ -146,9 +161,9 @@ class MlClient(NamespacedClient):
|
|
|
146
161
|
pretty: t.Optional[bool] = None,
|
|
147
162
|
) -> ObjectApiResponse[t.Any]:
|
|
148
163
|
"""
|
|
149
|
-
|
|
164
|
+
Removes all scheduled events from a calendar, then deletes it.
|
|
150
165
|
|
|
151
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
166
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-calendar.html>`_
|
|
152
167
|
|
|
153
168
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
154
169
|
"""
|
|
@@ -189,7 +204,7 @@ class MlClient(NamespacedClient):
|
|
|
189
204
|
"""
|
|
190
205
|
Deletes scheduled events from a calendar.
|
|
191
206
|
|
|
192
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
207
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-calendar-event.html>`_
|
|
193
208
|
|
|
194
209
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
195
210
|
:param event_id: Identifier for the scheduled event. You can obtain this identifier
|
|
@@ -237,7 +252,7 @@ class MlClient(NamespacedClient):
|
|
|
237
252
|
"""
|
|
238
253
|
Deletes anomaly detection jobs from a calendar.
|
|
239
254
|
|
|
240
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
255
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-calendar-job.html>`_
|
|
241
256
|
|
|
242
257
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
243
258
|
:param job_id: An identifier for the anomaly detection jobs. It can be a job
|
|
@@ -281,12 +296,12 @@ class MlClient(NamespacedClient):
|
|
|
281
296
|
force: t.Optional[bool] = None,
|
|
282
297
|
human: t.Optional[bool] = None,
|
|
283
298
|
pretty: t.Optional[bool] = None,
|
|
284
|
-
timeout: t.Optional[t.Union[
|
|
299
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
285
300
|
) -> ObjectApiResponse[t.Any]:
|
|
286
301
|
"""
|
|
287
|
-
Deletes
|
|
302
|
+
Deletes a data frame analytics job.
|
|
288
303
|
|
|
289
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
304
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-dfanalytics.html>`_
|
|
290
305
|
|
|
291
306
|
:param id: Identifier for the data frame analytics job.
|
|
292
307
|
:param force: If `true`, it deletes a job that is not stopped; this method is
|
|
@@ -334,7 +349,7 @@ class MlClient(NamespacedClient):
|
|
|
334
349
|
"""
|
|
335
350
|
Deletes an existing datafeed.
|
|
336
351
|
|
|
337
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
352
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-datafeed.html>`_
|
|
338
353
|
|
|
339
354
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
340
355
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -380,13 +395,19 @@ class MlClient(NamespacedClient):
|
|
|
380
395
|
human: t.Optional[bool] = None,
|
|
381
396
|
pretty: t.Optional[bool] = None,
|
|
382
397
|
requests_per_second: t.Optional[float] = None,
|
|
383
|
-
timeout: t.Optional[t.Union[
|
|
398
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
384
399
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
385
400
|
) -> ObjectApiResponse[t.Any]:
|
|
386
401
|
"""
|
|
387
|
-
Deletes expired and unused machine learning data.
|
|
402
|
+
Deletes expired and unused machine learning data. Deletes all job results, model
|
|
403
|
+
snapshots and forecast data that have exceeded their retention days period. Machine
|
|
404
|
+
learning state documents that are not associated with any job are also deleted.
|
|
405
|
+
You can limit the request to a single or set of anomaly detection jobs by using
|
|
406
|
+
a job identifier, a group name, a comma-separated list of jobs, or a wildcard
|
|
407
|
+
expression. You can delete expired data for all anomaly detection jobs by using
|
|
408
|
+
_all, by specifying * as the <job_id>, or by omitting the <job_id>.
|
|
388
409
|
|
|
389
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
410
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-expired-data.html>`_
|
|
390
411
|
|
|
391
412
|
:param job_id: Identifier for an anomaly detection job. It can be a job identifier,
|
|
392
413
|
a group name, or a wildcard expression.
|
|
@@ -443,9 +464,11 @@ class MlClient(NamespacedClient):
|
|
|
443
464
|
pretty: t.Optional[bool] = None,
|
|
444
465
|
) -> ObjectApiResponse[t.Any]:
|
|
445
466
|
"""
|
|
446
|
-
Deletes a filter.
|
|
467
|
+
Deletes a filter. If an anomaly detection job references the filter, you cannot
|
|
468
|
+
delete the filter. You must update or delete the job before you can delete the
|
|
469
|
+
filter.
|
|
447
470
|
|
|
448
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
471
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-filter.html>`_
|
|
449
472
|
|
|
450
473
|
:param filter_id: A string that uniquely identifies a filter.
|
|
451
474
|
"""
|
|
@@ -483,12 +506,15 @@ class MlClient(NamespacedClient):
|
|
|
483
506
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
484
507
|
human: t.Optional[bool] = None,
|
|
485
508
|
pretty: t.Optional[bool] = None,
|
|
486
|
-
timeout: t.Optional[t.Union[
|
|
509
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
487
510
|
) -> ObjectApiResponse[t.Any]:
|
|
488
511
|
"""
|
|
489
|
-
Deletes forecasts from a machine learning job.
|
|
512
|
+
Deletes forecasts from a machine learning job. By default, forecasts are retained
|
|
513
|
+
for 14 days. You can specify a different retention period with the `expires_in`
|
|
514
|
+
parameter in the forecast jobs API. The delete forecast API enables you to delete
|
|
515
|
+
one or more forecasts before they expire.
|
|
490
516
|
|
|
491
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
517
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-forecast.html>`_
|
|
492
518
|
|
|
493
519
|
:param job_id: Identifier for the anomaly detection job.
|
|
494
520
|
:param forecast_id: A comma-separated list of forecast identifiers. If you do
|
|
@@ -553,9 +579,14 @@ class MlClient(NamespacedClient):
|
|
|
553
579
|
wait_for_completion: t.Optional[bool] = None,
|
|
554
580
|
) -> ObjectApiResponse[t.Any]:
|
|
555
581
|
"""
|
|
556
|
-
Deletes an
|
|
582
|
+
Deletes an anomaly detection job. All job configuration, model state and results
|
|
583
|
+
are deleted. It is not currently possible to delete multiple jobs using wildcards
|
|
584
|
+
or a comma separated list. If you delete a job that has a datafeed, the request
|
|
585
|
+
first tries to delete the datafeed. This behavior is equivalent to calling the
|
|
586
|
+
delete datafeed API with the same timeout and force parameters as the delete
|
|
587
|
+
job request.
|
|
557
588
|
|
|
558
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
589
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-job.html>`_
|
|
559
590
|
|
|
560
591
|
:param job_id: Identifier for the anomaly detection job.
|
|
561
592
|
:param delete_user_annotations: Specifies whether annotations that have been
|
|
@@ -607,9 +638,12 @@ class MlClient(NamespacedClient):
|
|
|
607
638
|
pretty: t.Optional[bool] = None,
|
|
608
639
|
) -> ObjectApiResponse[t.Any]:
|
|
609
640
|
"""
|
|
610
|
-
Deletes an existing model snapshot.
|
|
641
|
+
Deletes an existing model snapshot. You cannot delete the active model snapshot.
|
|
642
|
+
To delete that snapshot, first revert to a different one. To identify the active
|
|
643
|
+
model snapshot, refer to the `model_snapshot_id` in the results from the get
|
|
644
|
+
jobs API.
|
|
611
645
|
|
|
612
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
646
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-delete-snapshot.html>`_
|
|
613
647
|
|
|
614
648
|
:param job_id: Identifier for the anomaly detection job.
|
|
615
649
|
:param snapshot_id: Identifier for the model snapshot.
|
|
@@ -657,7 +691,7 @@ class MlClient(NamespacedClient):
|
|
|
657
691
|
Deletes an existing trained inference model that is currently not referenced
|
|
658
692
|
by an ingest pipeline.
|
|
659
693
|
|
|
660
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
694
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-trained-models.html>`_
|
|
661
695
|
|
|
662
696
|
:param model_id: The unique identifier of the trained model.
|
|
663
697
|
:param force: Forcefully deletes a trained model that is referenced by ingest
|
|
@@ -700,9 +734,11 @@ class MlClient(NamespacedClient):
|
|
|
700
734
|
pretty: t.Optional[bool] = None,
|
|
701
735
|
) -> ObjectApiResponse[t.Any]:
|
|
702
736
|
"""
|
|
703
|
-
Deletes a model alias
|
|
737
|
+
Deletes a trained model alias. This API deletes an existing model alias that
|
|
738
|
+
refers to a trained model. If the model alias is missing or refers to a model
|
|
739
|
+
other than the one identified by the `model_id`, this API returns an error.
|
|
704
740
|
|
|
705
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
741
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-trained-models-aliases.html>`_
|
|
706
742
|
|
|
707
743
|
:param model_id: The trained model ID to which the model alias refers.
|
|
708
744
|
:param model_alias: The model alias to delete.
|
|
@@ -755,9 +791,11 @@ class MlClient(NamespacedClient):
|
|
|
755
791
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
756
792
|
) -> ObjectApiResponse[t.Any]:
|
|
757
793
|
"""
|
|
758
|
-
|
|
794
|
+
Makes an estimation of the memory usage for an anomaly detection job model. It
|
|
795
|
+
is based on analysis configuration details for the job and cardinality estimates
|
|
796
|
+
for the fields it references.
|
|
759
797
|
|
|
760
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
798
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-apis.html>`_
|
|
761
799
|
|
|
762
800
|
:param analysis_config: For a list of the properties that you can specify in
|
|
763
801
|
the `analysis_config` component of the body of this API.
|
|
@@ -820,9 +858,12 @@ class MlClient(NamespacedClient):
|
|
|
820
858
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
821
859
|
) -> ObjectApiResponse[t.Any]:
|
|
822
860
|
"""
|
|
823
|
-
Evaluates the data frame analytics for an annotated index.
|
|
861
|
+
Evaluates the data frame analytics for an annotated index. The API packages together
|
|
862
|
+
commonly used evaluation metrics for various types of machine learning features.
|
|
863
|
+
This has been designed for use on indexes created by data frame analytics. Evaluation
|
|
864
|
+
requires both a ground truth field and an analytics result field to be present.
|
|
824
865
|
|
|
825
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
866
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/evaluate-dfanalytics.html>`_
|
|
826
867
|
|
|
827
868
|
:param evaluation: Defines the type of evaluation you want to perform.
|
|
828
869
|
:param index: Defines the `index` in which the evaluation will be performed.
|
|
@@ -894,9 +935,15 @@ class MlClient(NamespacedClient):
|
|
|
894
935
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
895
936
|
) -> ObjectApiResponse[t.Any]:
|
|
896
937
|
"""
|
|
897
|
-
Explains a data frame analytics config.
|
|
938
|
+
Explains a data frame analytics config. This API provides explanations for a
|
|
939
|
+
data frame analytics config that either exists already or one that has not been
|
|
940
|
+
created yet. The following explanations are provided: * which fields are included
|
|
941
|
+
or not in the analysis and why, * how much memory is estimated to be required.
|
|
942
|
+
The estimate can be used when deciding the appropriate value for model_memory_limit
|
|
943
|
+
setting later on. If you have object fields or fields that are excluded via source
|
|
944
|
+
filtering, they are not included in the explanation.
|
|
898
945
|
|
|
899
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
946
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/explain-dfanalytics.html>`_
|
|
900
947
|
|
|
901
948
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
902
949
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -994,9 +1041,16 @@ class MlClient(NamespacedClient):
|
|
|
994
1041
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
995
1042
|
) -> ObjectApiResponse[t.Any]:
|
|
996
1043
|
"""
|
|
997
|
-
Forces any buffered data to be processed by the job.
|
|
1044
|
+
Forces any buffered data to be processed by the job. The flush jobs API is only
|
|
1045
|
+
applicable when sending data for analysis using the post data API. Depending
|
|
1046
|
+
on the content of the buffer, then it might additionally calculate new results.
|
|
1047
|
+
Both flush and close operations are similar, however the flush is more efficient
|
|
1048
|
+
if you are expecting to send more data for analysis. When flushing, the job remains
|
|
1049
|
+
open and is available to continue analyzing data. A close operation additionally
|
|
1050
|
+
prunes and persists the model state to disk and the job must be opened again
|
|
1051
|
+
before analyzing further data.
|
|
998
1052
|
|
|
999
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1053
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-flush-job.html>`_
|
|
1000
1054
|
|
|
1001
1055
|
:param job_id: Identifier for the anomaly detection job.
|
|
1002
1056
|
:param advance_time: Refer to the description for the `advance_time` query parameter.
|
|
@@ -1052,9 +1106,9 @@ class MlClient(NamespacedClient):
|
|
|
1052
1106
|
self,
|
|
1053
1107
|
*,
|
|
1054
1108
|
job_id: str,
|
|
1055
|
-
duration: t.Optional[t.Union[
|
|
1109
|
+
duration: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1056
1110
|
error_trace: t.Optional[bool] = None,
|
|
1057
|
-
expires_in: t.Optional[t.Union[
|
|
1111
|
+
expires_in: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1058
1112
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1059
1113
|
human: t.Optional[bool] = None,
|
|
1060
1114
|
max_model_memory: t.Optional[str] = None,
|
|
@@ -1063,8 +1117,11 @@ class MlClient(NamespacedClient):
|
|
|
1063
1117
|
) -> ObjectApiResponse[t.Any]:
|
|
1064
1118
|
"""
|
|
1065
1119
|
Predicts the future behavior of a time series by using its historical behavior.
|
|
1120
|
+
Forecasts are not supported for jobs that perform population analysis; an error
|
|
1121
|
+
occurs if you try to create a forecast for a job that has an `over_field_name`
|
|
1122
|
+
in its configuration.
|
|
1066
1123
|
|
|
1067
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1124
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-forecast.html>`_
|
|
1068
1125
|
|
|
1069
1126
|
:param job_id: Identifier for the anomaly detection job. The job must be open
|
|
1070
1127
|
when you create a forecast; otherwise, an error occurs.
|
|
@@ -1144,9 +1201,10 @@ class MlClient(NamespacedClient):
|
|
|
1144
1201
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1145
1202
|
) -> ObjectApiResponse[t.Any]:
|
|
1146
1203
|
"""
|
|
1147
|
-
Retrieves anomaly detection job results for one or more buckets.
|
|
1204
|
+
Retrieves anomaly detection job results for one or more buckets. The API presents
|
|
1205
|
+
a chronological view of the records, grouped by bucket.
|
|
1148
1206
|
|
|
1149
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1207
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-bucket.html>`_
|
|
1150
1208
|
|
|
1151
1209
|
:param job_id: Identifier for the anomaly detection job.
|
|
1152
1210
|
:param timestamp: The timestamp of a single bucket result. If you do not specify
|
|
@@ -1241,7 +1299,7 @@ class MlClient(NamespacedClient):
|
|
|
1241
1299
|
"""
|
|
1242
1300
|
Retrieves information about the scheduled events in calendars.
|
|
1243
1301
|
|
|
1244
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1302
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-calendar-event.html>`_
|
|
1245
1303
|
|
|
1246
1304
|
:param calendar_id: A string that uniquely identifies a calendar. You can get
|
|
1247
1305
|
information for multiple calendars by using a comma-separated list of ids
|
|
@@ -1307,7 +1365,7 @@ class MlClient(NamespacedClient):
|
|
|
1307
1365
|
"""
|
|
1308
1366
|
Retrieves configuration information for calendars.
|
|
1309
1367
|
|
|
1310
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1368
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-calendar.html>`_
|
|
1311
1369
|
|
|
1312
1370
|
:param calendar_id: A string that uniquely identifies a calendar. You can get
|
|
1313
1371
|
information for multiple calendars by using a comma-separated list of ids
|
|
@@ -1380,7 +1438,7 @@ class MlClient(NamespacedClient):
|
|
|
1380
1438
|
"""
|
|
1381
1439
|
Retrieves anomaly detection job results for one or more categories.
|
|
1382
1440
|
|
|
1383
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1441
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-category.html>`_
|
|
1384
1442
|
|
|
1385
1443
|
:param job_id: Identifier for the anomaly detection job.
|
|
1386
1444
|
:param category_id: Identifier for the category, which is unique in the job.
|
|
@@ -1460,9 +1518,11 @@ class MlClient(NamespacedClient):
|
|
|
1460
1518
|
size: t.Optional[int] = None,
|
|
1461
1519
|
) -> ObjectApiResponse[t.Any]:
|
|
1462
1520
|
"""
|
|
1463
|
-
Retrieves configuration information for data frame analytics jobs.
|
|
1521
|
+
Retrieves configuration information for data frame analytics jobs. You can get
|
|
1522
|
+
information for multiple data frame analytics jobs in a single API request by
|
|
1523
|
+
using a comma-separated list of data frame analytics jobs or a wildcard expression.
|
|
1464
1524
|
|
|
1465
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1525
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-dfanalytics.html>`_
|
|
1466
1526
|
|
|
1467
1527
|
:param id: Identifier for the data frame analytics job. If you do not specify
|
|
1468
1528
|
this option, the API returns information for the first hundred data frame
|
|
@@ -1534,7 +1594,7 @@ class MlClient(NamespacedClient):
|
|
|
1534
1594
|
"""
|
|
1535
1595
|
Retrieves usage information for data frame analytics jobs.
|
|
1536
1596
|
|
|
1537
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1597
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-dfanalytics-stats.html>`_
|
|
1538
1598
|
|
|
1539
1599
|
:param id: Identifier for the data frame analytics job. If you do not specify
|
|
1540
1600
|
this option, the API returns information for the first hundred data frame
|
|
@@ -1597,9 +1657,14 @@ class MlClient(NamespacedClient):
|
|
|
1597
1657
|
pretty: t.Optional[bool] = None,
|
|
1598
1658
|
) -> ObjectApiResponse[t.Any]:
|
|
1599
1659
|
"""
|
|
1600
|
-
Retrieves usage information for datafeeds.
|
|
1660
|
+
Retrieves usage information for datafeeds. You can get statistics for multiple
|
|
1661
|
+
datafeeds in a single API request by using a comma-separated list of datafeeds
|
|
1662
|
+
or a wildcard expression. You can get statistics for all datafeeds by using `_all`,
|
|
1663
|
+
by specifying `*` as the `<feed_id>`, or by omitting the `<feed_id>`. If the
|
|
1664
|
+
datafeed is stopped, the only information you receive is the `datafeed_id` and
|
|
1665
|
+
the `state`. This API returns a maximum of 10,000 datafeeds.
|
|
1601
1666
|
|
|
1602
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1667
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-datafeed-stats.html>`_
|
|
1603
1668
|
|
|
1604
1669
|
:param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier
|
|
1605
1670
|
or a wildcard expression. If you do not specify one of these options, the
|
|
@@ -1653,9 +1718,13 @@ class MlClient(NamespacedClient):
|
|
|
1653
1718
|
pretty: t.Optional[bool] = None,
|
|
1654
1719
|
) -> ObjectApiResponse[t.Any]:
|
|
1655
1720
|
"""
|
|
1656
|
-
Retrieves configuration information for datafeeds.
|
|
1721
|
+
Retrieves configuration information for datafeeds. You can get information for
|
|
1722
|
+
multiple datafeeds in a single API request by using a comma-separated list of
|
|
1723
|
+
datafeeds or a wildcard expression. You can get information for all datafeeds
|
|
1724
|
+
by using `_all`, by specifying `*` as the `<feed_id>`, or by omitting the `<feed_id>`.
|
|
1725
|
+
This API returns a maximum of 10,000 datafeeds.
|
|
1657
1726
|
|
|
1658
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1727
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-datafeed.html>`_
|
|
1659
1728
|
|
|
1660
1729
|
:param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier
|
|
1661
1730
|
or a wildcard expression. If you do not specify one of these options, the
|
|
@@ -1716,9 +1785,9 @@ class MlClient(NamespacedClient):
|
|
|
1716
1785
|
size: t.Optional[int] = None,
|
|
1717
1786
|
) -> ObjectApiResponse[t.Any]:
|
|
1718
1787
|
"""
|
|
1719
|
-
Retrieves filters.
|
|
1788
|
+
Retrieves filters. You can get a single filter or all filters.
|
|
1720
1789
|
|
|
1721
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1790
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-filter.html>`_
|
|
1722
1791
|
|
|
1723
1792
|
:param filter_id: A string that uniquely identifies a filter.
|
|
1724
1793
|
:param from_: Skips the specified number of filters.
|
|
@@ -1778,9 +1847,12 @@ class MlClient(NamespacedClient):
|
|
|
1778
1847
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
1779
1848
|
) -> ObjectApiResponse[t.Any]:
|
|
1780
1849
|
"""
|
|
1781
|
-
Retrieves anomaly detection job results for one or more influencers.
|
|
1850
|
+
Retrieves anomaly detection job results for one or more influencers. Influencers
|
|
1851
|
+
are the entities that have contributed to, or are to blame for, the anomalies.
|
|
1852
|
+
Influencer results are available only if an `influencer_field_name` is specified
|
|
1853
|
+
in the job configuration.
|
|
1782
1854
|
|
|
1783
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1855
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-influencer.html>`_
|
|
1784
1856
|
|
|
1785
1857
|
:param job_id: Identifier for the anomaly detection job.
|
|
1786
1858
|
:param desc: If true, the results are sorted in descending order.
|
|
@@ -1861,7 +1933,7 @@ class MlClient(NamespacedClient):
|
|
|
1861
1933
|
"""
|
|
1862
1934
|
Retrieves usage information for anomaly detection jobs.
|
|
1863
1935
|
|
|
1864
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1936
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-job-stats.html>`_
|
|
1865
1937
|
|
|
1866
1938
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
1867
1939
|
a group name, a comma-separated list of jobs, or a wildcard expression. If
|
|
@@ -1916,9 +1988,13 @@ class MlClient(NamespacedClient):
|
|
|
1916
1988
|
pretty: t.Optional[bool] = None,
|
|
1917
1989
|
) -> ObjectApiResponse[t.Any]:
|
|
1918
1990
|
"""
|
|
1919
|
-
Retrieves configuration information for anomaly detection jobs.
|
|
1991
|
+
Retrieves configuration information for anomaly detection jobs. You can get information
|
|
1992
|
+
for multiple anomaly detection jobs in a single API request by using a group
|
|
1993
|
+
name, a comma-separated list of jobs, or a wildcard expression. You can get information
|
|
1994
|
+
for all anomaly detection jobs by using `_all`, by specifying `*` as the `<job_id>`,
|
|
1995
|
+
or by omitting the `<job_id>`.
|
|
1920
1996
|
|
|
1921
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1997
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-job.html>`_
|
|
1922
1998
|
|
|
1923
1999
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
1924
2000
|
a group name, or a wildcard expression. If you do not specify one of these
|
|
@@ -1972,16 +2048,16 @@ class MlClient(NamespacedClient):
|
|
|
1972
2048
|
error_trace: t.Optional[bool] = None,
|
|
1973
2049
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
1974
2050
|
human: t.Optional[bool] = None,
|
|
1975
|
-
master_timeout: t.Optional[
|
|
1976
|
-
t.Union["t.Literal[-1]", "t.Literal[0]", str]
|
|
1977
|
-
] = None,
|
|
2051
|
+
master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1978
2052
|
pretty: t.Optional[bool] = None,
|
|
1979
|
-
timeout: t.Optional[t.Union[
|
|
2053
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
1980
2054
|
) -> ObjectApiResponse[t.Any]:
|
|
1981
2055
|
"""
|
|
1982
|
-
|
|
2056
|
+
Get information about how machine learning jobs and trained models are using
|
|
2057
|
+
memory, on each node, both within the JVM heap, and natively, outside of the
|
|
2058
|
+
JVM.
|
|
1983
2059
|
|
|
1984
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2060
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-ml-memory.html>`_
|
|
1985
2061
|
|
|
1986
2062
|
:param node_id: The names of particular nodes in the cluster to target. For example,
|
|
1987
2063
|
`nodeId1,nodeId2` or `ml:true`
|
|
@@ -2034,9 +2110,9 @@ class MlClient(NamespacedClient):
|
|
|
2034
2110
|
pretty: t.Optional[bool] = None,
|
|
2035
2111
|
) -> ObjectApiResponse[t.Any]:
|
|
2036
2112
|
"""
|
|
2037
|
-
|
|
2113
|
+
Retrieves usage information for anomaly detection job model snapshot upgrades.
|
|
2038
2114
|
|
|
2039
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2115
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-job-model-snapshot-upgrade-stats.html>`_
|
|
2040
2116
|
|
|
2041
2117
|
:param job_id: Identifier for the anomaly detection job.
|
|
2042
2118
|
:param snapshot_id: A numerical character string that uniquely identifies the
|
|
@@ -2107,7 +2183,7 @@ class MlClient(NamespacedClient):
|
|
|
2107
2183
|
"""
|
|
2108
2184
|
Retrieves information about model snapshots.
|
|
2109
2185
|
|
|
2110
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2186
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-snapshot.html>`_
|
|
2111
2187
|
|
|
2112
2188
|
:param job_id: Identifier for the anomaly detection job.
|
|
2113
2189
|
:param snapshot_id: A numerical character string that uniquely identifies the
|
|
@@ -2193,7 +2269,7 @@ class MlClient(NamespacedClient):
|
|
|
2193
2269
|
*,
|
|
2194
2270
|
job_id: str,
|
|
2195
2271
|
allow_no_match: t.Optional[bool] = None,
|
|
2196
|
-
bucket_span: t.Optional[t.Union[
|
|
2272
|
+
bucket_span: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2197
2273
|
end: t.Optional[t.Union[str, t.Any]] = None,
|
|
2198
2274
|
error_trace: t.Optional[bool] = None,
|
|
2199
2275
|
exclude_interim: t.Optional[bool] = None,
|
|
@@ -2207,9 +2283,20 @@ class MlClient(NamespacedClient):
|
|
|
2207
2283
|
) -> ObjectApiResponse[t.Any]:
|
|
2208
2284
|
"""
|
|
2209
2285
|
Retrieves overall bucket results that summarize the bucket results of multiple
|
|
2210
|
-
anomaly detection jobs.
|
|
2211
|
-
|
|
2212
|
-
|
|
2286
|
+
anomaly detection jobs. The `overall_score` is calculated by combining the scores
|
|
2287
|
+
of all the buckets within the overall bucket span. First, the maximum `anomaly_score`
|
|
2288
|
+
per anomaly detection job in the overall bucket is calculated. Then the `top_n`
|
|
2289
|
+
of those scores are averaged to result in the `overall_score`. This means that
|
|
2290
|
+
you can fine-tune the `overall_score` so that it is more or less sensitive to
|
|
2291
|
+
the number of jobs that detect an anomaly at the same time. For example, if you
|
|
2292
|
+
set `top_n` to `1`, the `overall_score` is the maximum bucket score in the overall
|
|
2293
|
+
bucket. Alternatively, if you set `top_n` to the number of jobs, the `overall_score`
|
|
2294
|
+
is high only when all jobs detect anomalies in that overall bucket. If you set
|
|
2295
|
+
the `bucket_span` parameter (to a value greater than its default), the `overall_score`
|
|
2296
|
+
is the maximum `overall_score` of the overall buckets that have a span equal
|
|
2297
|
+
to the jobs' largest bucket span.
|
|
2298
|
+
|
|
2299
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-overall-buckets.html>`_
|
|
2213
2300
|
|
|
2214
2301
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
2215
2302
|
a group name, a comma-separated list of jobs or groups, or a wildcard expression.
|
|
@@ -2304,9 +2391,17 @@ class MlClient(NamespacedClient):
|
|
|
2304
2391
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2305
2392
|
) -> ObjectApiResponse[t.Any]:
|
|
2306
2393
|
"""
|
|
2307
|
-
Retrieves anomaly records for an anomaly detection job.
|
|
2394
|
+
Retrieves anomaly records for an anomaly detection job. Records contain the detailed
|
|
2395
|
+
analytical results. They describe the anomalous activity that has been identified
|
|
2396
|
+
in the input data based on the detector configuration. There can be many anomaly
|
|
2397
|
+
records depending on the characteristics and size of the input data. In practice,
|
|
2398
|
+
there are often too many to be able to manually process them. The machine learning
|
|
2399
|
+
features therefore perform a sophisticated aggregation of the anomaly records
|
|
2400
|
+
into buckets. The number of record results depends on the number of anomalies
|
|
2401
|
+
found in each bucket, which relates to the number of time series being modeled
|
|
2402
|
+
and the number of detectors.
|
|
2308
2403
|
|
|
2309
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2404
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-get-record.html>`_
|
|
2310
2405
|
|
|
2311
2406
|
:param job_id: Identifier for the anomaly detection job.
|
|
2312
2407
|
:param desc: Refer to the description for the `desc` query parameter.
|
|
@@ -2374,7 +2469,7 @@ class MlClient(NamespacedClient):
|
|
|
2374
2469
|
def get_trained_models(
|
|
2375
2470
|
self,
|
|
2376
2471
|
*,
|
|
2377
|
-
model_id: t.Optional[str] = None,
|
|
2472
|
+
model_id: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2378
2473
|
allow_no_match: t.Optional[bool] = None,
|
|
2379
2474
|
decompress_definition: t.Optional[bool] = None,
|
|
2380
2475
|
error_trace: t.Optional[bool] = None,
|
|
@@ -2384,20 +2479,28 @@ class MlClient(NamespacedClient):
|
|
|
2384
2479
|
human: t.Optional[bool] = None,
|
|
2385
2480
|
include: t.Optional[
|
|
2386
2481
|
t.Union[
|
|
2387
|
-
"t.Literal['definition', 'definition_status', 'feature_importance_baseline', 'hyperparameters', 'total_feature_importance']",
|
|
2388
2482
|
str,
|
|
2483
|
+
t.Literal[
|
|
2484
|
+
"definition",
|
|
2485
|
+
"definition_status",
|
|
2486
|
+
"feature_importance_baseline",
|
|
2487
|
+
"hyperparameters",
|
|
2488
|
+
"total_feature_importance",
|
|
2489
|
+
],
|
|
2389
2490
|
]
|
|
2390
2491
|
] = None,
|
|
2391
2492
|
pretty: t.Optional[bool] = None,
|
|
2392
2493
|
size: t.Optional[int] = None,
|
|
2393
|
-
tags: t.Optional[str] = None,
|
|
2494
|
+
tags: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2394
2495
|
) -> ObjectApiResponse[t.Any]:
|
|
2395
2496
|
"""
|
|
2396
|
-
Retrieves configuration information for a trained
|
|
2497
|
+
Retrieves configuration information for a trained model.
|
|
2397
2498
|
|
|
2398
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2499
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-trained-models.html>`_
|
|
2399
2500
|
|
|
2400
|
-
:param model_id: The unique identifier of the trained model.
|
|
2501
|
+
:param model_id: The unique identifier of the trained model or a model alias.
|
|
2502
|
+
You can get information for multiple trained models in a single API request
|
|
2503
|
+
by using a comma-separated list of model IDs or a wildcard expression.
|
|
2401
2504
|
:param allow_no_match: Specifies what to do when the request: - Contains wildcard
|
|
2402
2505
|
expressions and there are no models that match. - Contains the _all string
|
|
2403
2506
|
or no identifiers and there are no matches. - Contains wildcard expressions
|
|
@@ -2473,9 +2576,11 @@ class MlClient(NamespacedClient):
|
|
|
2473
2576
|
size: t.Optional[int] = None,
|
|
2474
2577
|
) -> ObjectApiResponse[t.Any]:
|
|
2475
2578
|
"""
|
|
2476
|
-
Retrieves usage information for trained
|
|
2579
|
+
Retrieves usage information for trained models. You can get usage information
|
|
2580
|
+
for multiple trained models in a single API request by using a comma-separated
|
|
2581
|
+
list of model IDs or a wildcard expression.
|
|
2477
2582
|
|
|
2478
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2583
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-trained-models-stats.html>`_
|
|
2479
2584
|
|
|
2480
2585
|
:param model_id: The unique identifier of the trained model or a model alias.
|
|
2481
2586
|
It can be a comma-separated list or a wildcard expression.
|
|
@@ -2532,13 +2637,13 @@ class MlClient(NamespacedClient):
|
|
|
2532
2637
|
human: t.Optional[bool] = None,
|
|
2533
2638
|
inference_config: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
2534
2639
|
pretty: t.Optional[bool] = None,
|
|
2535
|
-
timeout: t.Optional[t.Union[
|
|
2640
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2536
2641
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2537
2642
|
) -> ObjectApiResponse[t.Any]:
|
|
2538
2643
|
"""
|
|
2539
|
-
|
|
2644
|
+
Evaluates a trained model.
|
|
2540
2645
|
|
|
2541
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2646
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/infer-trained-model.html>`_
|
|
2542
2647
|
|
|
2543
2648
|
:param model_id: The unique identifier of the trained model.
|
|
2544
2649
|
:param docs: An array of objects to pass to the model for inference. The objects
|
|
@@ -2593,9 +2698,14 @@ class MlClient(NamespacedClient):
|
|
|
2593
2698
|
pretty: t.Optional[bool] = None,
|
|
2594
2699
|
) -> ObjectApiResponse[t.Any]:
|
|
2595
2700
|
"""
|
|
2596
|
-
Returns defaults and limits used by machine learning.
|
|
2701
|
+
Returns defaults and limits used by machine learning. This endpoint is designed
|
|
2702
|
+
to be used by a user interface that needs to fully understand machine learning
|
|
2703
|
+
configurations where some options are not specified, meaning that the defaults
|
|
2704
|
+
should be used. This endpoint may be used to find out what those defaults are.
|
|
2705
|
+
It also provides information about the maximum size of machine learning jobs
|
|
2706
|
+
that could run in the current cluster configuration.
|
|
2597
2707
|
|
|
2598
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2708
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-ml-info.html>`_
|
|
2599
2709
|
"""
|
|
2600
2710
|
__path_parts: t.Dict[str, str] = {}
|
|
2601
2711
|
__path = "/_ml/info"
|
|
@@ -2629,13 +2739,18 @@ class MlClient(NamespacedClient):
|
|
|
2629
2739
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2630
2740
|
human: t.Optional[bool] = None,
|
|
2631
2741
|
pretty: t.Optional[bool] = None,
|
|
2632
|
-
timeout: t.Optional[t.Union[
|
|
2742
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
2633
2743
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2634
2744
|
) -> ObjectApiResponse[t.Any]:
|
|
2635
2745
|
"""
|
|
2636
|
-
Opens one or more anomaly detection jobs.
|
|
2746
|
+
Opens one or more anomaly detection jobs. An anomaly detection job must be opened
|
|
2747
|
+
in order for it to be ready to receive and analyze data. It can be opened and
|
|
2748
|
+
closed multiple times throughout its lifecycle. When you open a new job, it starts
|
|
2749
|
+
with an empty model. When you open an existing job, the most recent model state
|
|
2750
|
+
is automatically loaded. The job is ready to resume its analysis from where it
|
|
2751
|
+
left off, once new data is received.
|
|
2637
2752
|
|
|
2638
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2753
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-open-job.html>`_
|
|
2639
2754
|
|
|
2640
2755
|
:param job_id: Identifier for the anomaly detection job.
|
|
2641
2756
|
:param timeout: Refer to the description for the `timeout` query parameter.
|
|
@@ -2687,9 +2802,9 @@ class MlClient(NamespacedClient):
|
|
|
2687
2802
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2688
2803
|
) -> ObjectApiResponse[t.Any]:
|
|
2689
2804
|
"""
|
|
2690
|
-
|
|
2805
|
+
Adds scheduled events to a calendar.
|
|
2691
2806
|
|
|
2692
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2807
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-post-calendar-event.html>`_
|
|
2693
2808
|
|
|
2694
2809
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
2695
2810
|
:param events: A list of one of more scheduled events. The event’s start and
|
|
@@ -2743,9 +2858,11 @@ class MlClient(NamespacedClient):
|
|
|
2743
2858
|
reset_start: t.Optional[t.Union[str, t.Any]] = None,
|
|
2744
2859
|
) -> ObjectApiResponse[t.Any]:
|
|
2745
2860
|
"""
|
|
2746
|
-
Sends data to an anomaly detection job for analysis.
|
|
2861
|
+
Sends data to an anomaly detection job for analysis. IMPORTANT: For each job,
|
|
2862
|
+
data can be accepted from only a single connection at a time. It is not currently
|
|
2863
|
+
possible to post data to multiple jobs using wildcards or a comma-separated list.
|
|
2747
2864
|
|
|
2748
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2865
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-post-data.html>`_
|
|
2749
2866
|
|
|
2750
2867
|
:param job_id: Identifier for the anomaly detection job. The job must have a
|
|
2751
2868
|
state of open to receive and process the data.
|
|
@@ -2806,9 +2923,9 @@ class MlClient(NamespacedClient):
|
|
|
2806
2923
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2807
2924
|
) -> ObjectApiResponse[t.Any]:
|
|
2808
2925
|
"""
|
|
2809
|
-
Previews
|
|
2926
|
+
Previews the extracted features used by a data frame analytics config.
|
|
2810
2927
|
|
|
2811
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2928
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/preview-dfanalytics.html>`_
|
|
2812
2929
|
|
|
2813
2930
|
:param id: Identifier for the data frame analytics job.
|
|
2814
2931
|
:param config: A data frame analytics config as described in create data frame
|
|
@@ -2868,9 +2985,17 @@ class MlClient(NamespacedClient):
|
|
|
2868
2985
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2869
2986
|
) -> ObjectApiResponse[t.Any]:
|
|
2870
2987
|
"""
|
|
2871
|
-
Previews a datafeed.
|
|
2988
|
+
Previews a datafeed. This API returns the first "page" of search results from
|
|
2989
|
+
a datafeed. You can preview an existing datafeed or provide configuration details
|
|
2990
|
+
for a datafeed and anomaly detection job in the API. The preview shows the structure
|
|
2991
|
+
of the data that will be passed to the anomaly detection engine. IMPORTANT: When
|
|
2992
|
+
Elasticsearch security features are enabled, the preview uses the credentials
|
|
2993
|
+
of the user that called the API. However, when the datafeed starts it uses the
|
|
2994
|
+
roles of the last user that created or updated the datafeed. To get a preview
|
|
2995
|
+
that accurately reflects the behavior of the datafeed, use the appropriate credentials.
|
|
2996
|
+
You can also use secondary authorization headers to supply the credentials.
|
|
2872
2997
|
|
|
2873
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2998
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-preview-datafeed.html>`_
|
|
2874
2999
|
|
|
2875
3000
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
2876
3001
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -2944,9 +3069,9 @@ class MlClient(NamespacedClient):
|
|
|
2944
3069
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
2945
3070
|
) -> ObjectApiResponse[t.Any]:
|
|
2946
3071
|
"""
|
|
2947
|
-
|
|
3072
|
+
Creates a calendar.
|
|
2948
3073
|
|
|
2949
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3074
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-put-calendar.html>`_
|
|
2950
3075
|
|
|
2951
3076
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
2952
3077
|
:param description: A description of the calendar.
|
|
@@ -2991,7 +3116,7 @@ class MlClient(NamespacedClient):
|
|
|
2991
3116
|
self,
|
|
2992
3117
|
*,
|
|
2993
3118
|
calendar_id: str,
|
|
2994
|
-
job_id: str,
|
|
3119
|
+
job_id: t.Union[str, t.Sequence[str]],
|
|
2995
3120
|
error_trace: t.Optional[bool] = None,
|
|
2996
3121
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2997
3122
|
human: t.Optional[bool] = None,
|
|
@@ -3000,7 +3125,7 @@ class MlClient(NamespacedClient):
|
|
|
3000
3125
|
"""
|
|
3001
3126
|
Adds an anomaly detection job to a calendar.
|
|
3002
3127
|
|
|
3003
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3128
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-put-calendar-job.html>`_
|
|
3004
3129
|
|
|
3005
3130
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
3006
3131
|
:param job_id: An identifier for the anomaly detection jobs. It can be a job
|
|
@@ -3070,9 +3195,11 @@ class MlClient(NamespacedClient):
|
|
|
3070
3195
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3071
3196
|
) -> ObjectApiResponse[t.Any]:
|
|
3072
3197
|
"""
|
|
3073
|
-
Instantiates a data frame analytics job.
|
|
3198
|
+
Instantiates a data frame analytics job. This API creates a data frame analytics
|
|
3199
|
+
job that performs an analysis on the source indices and stores the outcome in
|
|
3200
|
+
a destination index.
|
|
3074
3201
|
|
|
3075
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3202
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-dfanalytics.html>`_
|
|
3076
3203
|
|
|
3077
3204
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
3078
3205
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -3213,13 +3340,13 @@ class MlClient(NamespacedClient):
|
|
|
3213
3340
|
expand_wildcards: t.Optional[
|
|
3214
3341
|
t.Union[
|
|
3215
3342
|
t.Sequence[
|
|
3216
|
-
t.Union[
|
|
3343
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
3217
3344
|
],
|
|
3218
|
-
t.Union[
|
|
3345
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
3219
3346
|
]
|
|
3220
3347
|
] = None,
|
|
3221
3348
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
3222
|
-
frequency: t.Optional[t.Union[
|
|
3349
|
+
frequency: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3223
3350
|
headers: t.Optional[t.Mapping[str, t.Union[str, t.Sequence[str]]]] = None,
|
|
3224
3351
|
human: t.Optional[bool] = None,
|
|
3225
3352
|
ignore_throttled: t.Optional[bool] = None,
|
|
@@ -3231,16 +3358,26 @@ class MlClient(NamespacedClient):
|
|
|
3231
3358
|
max_empty_searches: t.Optional[int] = None,
|
|
3232
3359
|
pretty: t.Optional[bool] = None,
|
|
3233
3360
|
query: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3234
|
-
query_delay: t.Optional[t.Union[
|
|
3361
|
+
query_delay: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
3235
3362
|
runtime_mappings: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
|
|
3236
3363
|
script_fields: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
|
|
3237
3364
|
scroll_size: t.Optional[int] = None,
|
|
3238
3365
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3239
3366
|
) -> ObjectApiResponse[t.Any]:
|
|
3240
3367
|
"""
|
|
3241
|
-
Instantiates a datafeed.
|
|
3368
|
+
Instantiates a datafeed. Datafeeds retrieve data from Elasticsearch for analysis
|
|
3369
|
+
by an anomaly detection job. You can associate only one datafeed with each anomaly
|
|
3370
|
+
detection job. The datafeed contains a query that runs at a defined interval
|
|
3371
|
+
(`frequency`). If you are concerned about delayed data, you can add a delay (`query_delay')
|
|
3372
|
+
at each interval. When Elasticsearch security features are enabled, your datafeed
|
|
3373
|
+
remembers which roles the user who created it had at the time of creation and
|
|
3374
|
+
runs the query using those same roles. If you provide secondary authorization
|
|
3375
|
+
headers, those credentials are used instead. You must use Kibana, this API, or
|
|
3376
|
+
the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
|
|
3377
|
+
directly to the `.ml-config` index. Do not give users `write` privileges on the
|
|
3378
|
+
`.ml-config` index.
|
|
3242
3379
|
|
|
3243
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3380
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-put-datafeed.html>`_
|
|
3244
3381
|
|
|
3245
3382
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
3246
3383
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -3391,9 +3528,11 @@ class MlClient(NamespacedClient):
|
|
|
3391
3528
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3392
3529
|
) -> ObjectApiResponse[t.Any]:
|
|
3393
3530
|
"""
|
|
3394
|
-
Instantiates a filter.
|
|
3531
|
+
Instantiates a filter. A filter contains a list of strings. It can be used by
|
|
3532
|
+
one or more anomaly detection jobs. Specifically, filters are referenced in the
|
|
3533
|
+
`custom_rules` property of detector configuration objects.
|
|
3395
3534
|
|
|
3396
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3535
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-put-filter.html>`_
|
|
3397
3536
|
|
|
3398
3537
|
:param filter_id: A string that uniquely identifies a filter.
|
|
3399
3538
|
:param description: A description of the filter.
|
|
@@ -3458,7 +3597,7 @@ class MlClient(NamespacedClient):
|
|
|
3458
3597
|
allow_lazy_open: t.Optional[bool] = None,
|
|
3459
3598
|
analysis_limits: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3460
3599
|
background_persist_interval: t.Optional[
|
|
3461
|
-
t.Union[
|
|
3600
|
+
t.Union[str, t.Literal[-1], t.Literal[0]]
|
|
3462
3601
|
] = None,
|
|
3463
3602
|
custom_settings: t.Optional[t.Any] = None,
|
|
3464
3603
|
daily_model_snapshot_retention_after_days: t.Optional[int] = None,
|
|
@@ -3477,9 +3616,10 @@ class MlClient(NamespacedClient):
|
|
|
3477
3616
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3478
3617
|
) -> ObjectApiResponse[t.Any]:
|
|
3479
3618
|
"""
|
|
3480
|
-
Instantiates an anomaly detection job.
|
|
3619
|
+
Instantiates an anomaly detection job. If you include a `datafeed_config`, you
|
|
3620
|
+
must have read index privileges on the source index.
|
|
3481
3621
|
|
|
3482
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3622
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-put-job.html>`_
|
|
3483
3623
|
|
|
3484
3624
|
:param job_id: The identifier for the anomaly detection job. This identifier
|
|
3485
3625
|
can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
|
|
@@ -3647,7 +3787,7 @@ class MlClient(NamespacedClient):
|
|
|
3647
3787
|
metadata: t.Optional[t.Any] = None,
|
|
3648
3788
|
model_size_bytes: t.Optional[int] = None,
|
|
3649
3789
|
model_type: t.Optional[
|
|
3650
|
-
t.Union[
|
|
3790
|
+
t.Union[str, t.Literal["lang_ident", "pytorch", "tree_ensemble"]]
|
|
3651
3791
|
] = None,
|
|
3652
3792
|
platform_architecture: t.Optional[str] = None,
|
|
3653
3793
|
prefix_strings: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
@@ -3657,9 +3797,9 @@ class MlClient(NamespacedClient):
|
|
|
3657
3797
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3658
3798
|
) -> ObjectApiResponse[t.Any]:
|
|
3659
3799
|
"""
|
|
3660
|
-
|
|
3800
|
+
Enables you to supply a trained model that is not created by data frame analytics.
|
|
3661
3801
|
|
|
3662
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3802
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-trained-models.html>`_
|
|
3663
3803
|
|
|
3664
3804
|
:param model_id: The unique identifier of the trained model.
|
|
3665
3805
|
:param compressed_definition: The compressed (GZipped and Base64 encoded) inference
|
|
@@ -3759,10 +3899,21 @@ class MlClient(NamespacedClient):
|
|
|
3759
3899
|
reassign: t.Optional[bool] = None,
|
|
3760
3900
|
) -> ObjectApiResponse[t.Any]:
|
|
3761
3901
|
"""
|
|
3762
|
-
Creates a
|
|
3763
|
-
model
|
|
3764
|
-
|
|
3765
|
-
|
|
3902
|
+
Creates or updates a trained model alias. A trained model alias is a logical
|
|
3903
|
+
name used to reference a single trained model. You can use aliases instead of
|
|
3904
|
+
trained model identifiers to make it easier to reference your models. For example,
|
|
3905
|
+
you can use aliases in inference aggregations and processors. An alias must be
|
|
3906
|
+
unique and refer to only a single trained model. However, you can have multiple
|
|
3907
|
+
aliases for each trained model. If you use this API to update an alias such that
|
|
3908
|
+
it references a different trained model ID and the model uses a different type
|
|
3909
|
+
of data frame analytics, an error occurs. For example, this situation occurs
|
|
3910
|
+
if you have a trained model for regression analysis and a trained model for classification
|
|
3911
|
+
analysis; you cannot reassign an alias from one type of trained model to another.
|
|
3912
|
+
If you use this API to update an alias and there are very few input fields in
|
|
3913
|
+
common between the old and new trained models for the model alias, the API returns
|
|
3914
|
+
a warning.
|
|
3915
|
+
|
|
3916
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-trained-models-aliases.html>`_
|
|
3766
3917
|
|
|
3767
3918
|
:param model_id: The identifier for the trained model that the alias refers to.
|
|
3768
3919
|
:param model_alias: The alias to create or update. This value cannot end in numbers.
|
|
@@ -3818,9 +3969,9 @@ class MlClient(NamespacedClient):
|
|
|
3818
3969
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3819
3970
|
) -> ObjectApiResponse[t.Any]:
|
|
3820
3971
|
"""
|
|
3821
|
-
Creates part of a trained model definition
|
|
3972
|
+
Creates part of a trained model definition.
|
|
3822
3973
|
|
|
3823
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3974
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-trained-model-definition-part.html>`_
|
|
3824
3975
|
|
|
3825
3976
|
:param model_id: The unique identifier of the trained model.
|
|
3826
3977
|
:param part: The definition part number. When the definition is loaded for inference
|
|
@@ -3895,9 +4046,11 @@ class MlClient(NamespacedClient):
|
|
|
3895
4046
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
3896
4047
|
) -> ObjectApiResponse[t.Any]:
|
|
3897
4048
|
"""
|
|
3898
|
-
Creates a trained model vocabulary
|
|
4049
|
+
Creates a trained model vocabulary. This API is supported only for natural language
|
|
4050
|
+
processing (NLP) models. The vocabulary is stored in the index as described in
|
|
4051
|
+
`inference_config.*.vocabulary` of the trained model definition.
|
|
3899
4052
|
|
|
3900
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4053
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-trained-model-vocabulary.html>`_
|
|
3901
4054
|
|
|
3902
4055
|
:param model_id: The unique identifier of the trained model.
|
|
3903
4056
|
:param vocabulary: The model vocabulary, which must not be empty.
|
|
@@ -3951,9 +4104,11 @@ class MlClient(NamespacedClient):
|
|
|
3951
4104
|
wait_for_completion: t.Optional[bool] = None,
|
|
3952
4105
|
) -> ObjectApiResponse[t.Any]:
|
|
3953
4106
|
"""
|
|
3954
|
-
Resets an
|
|
4107
|
+
Resets an anomaly detection job. All model state and results are deleted. The
|
|
4108
|
+
job is ready to start over as if it had just been created. It is not currently
|
|
4109
|
+
possible to reset multiple jobs using wildcards or a comma separated list.
|
|
3955
4110
|
|
|
3956
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4111
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-reset-job.html>`_
|
|
3957
4112
|
|
|
3958
4113
|
:param job_id: The ID of the job to reset.
|
|
3959
4114
|
:param delete_user_annotations: Specifies whether annotations that have been
|
|
@@ -4005,9 +4160,15 @@ class MlClient(NamespacedClient):
|
|
|
4005
4160
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4006
4161
|
) -> ObjectApiResponse[t.Any]:
|
|
4007
4162
|
"""
|
|
4008
|
-
Reverts to a specific snapshot.
|
|
4163
|
+
Reverts to a specific snapshot. The machine learning features react quickly to
|
|
4164
|
+
anomalous input, learning new behaviors in data. Highly anomalous input increases
|
|
4165
|
+
the variance in the models whilst the system learns whether this is a new step-change
|
|
4166
|
+
in behavior or a one-off event. In the case where this anomalous input is known
|
|
4167
|
+
to be a one-off, then it might be appropriate to reset the model state to a time
|
|
4168
|
+
before this event. For example, you might consider reverting to a saved snapshot
|
|
4169
|
+
after Black Friday or a critical system failure.
|
|
4009
4170
|
|
|
4010
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4171
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-revert-snapshot.html>`_
|
|
4011
4172
|
|
|
4012
4173
|
:param job_id: Identifier for the anomaly detection job.
|
|
4013
4174
|
:param snapshot_id: You can specify `empty` as the <snapshot_id>. Reverting to
|
|
@@ -4062,13 +4223,21 @@ class MlClient(NamespacedClient):
|
|
|
4062
4223
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4063
4224
|
human: t.Optional[bool] = None,
|
|
4064
4225
|
pretty: t.Optional[bool] = None,
|
|
4065
|
-
timeout: t.Optional[t.Union[
|
|
4226
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4066
4227
|
) -> ObjectApiResponse[t.Any]:
|
|
4067
4228
|
"""
|
|
4068
4229
|
Sets a cluster wide upgrade_mode setting that prepares machine learning indices
|
|
4069
|
-
for an upgrade.
|
|
4070
|
-
|
|
4071
|
-
|
|
4230
|
+
for an upgrade. When upgrading your cluster, in some circumstances you must restart
|
|
4231
|
+
your nodes and reindex your machine learning indices. In those circumstances,
|
|
4232
|
+
there must be no machine learning jobs running. You can close the machine learning
|
|
4233
|
+
jobs, do the upgrade, then open all the jobs again. Alternatively, you can use
|
|
4234
|
+
this API to temporarily halt tasks associated with the jobs and datafeeds and
|
|
4235
|
+
prevent new jobs from opening. You can also use this API during upgrades that
|
|
4236
|
+
do not require you to reindex your machine learning indices, though stopping
|
|
4237
|
+
jobs is not a requirement in that case. You can see the current value for the
|
|
4238
|
+
upgrade_mode setting by using the get machine learning info API.
|
|
4239
|
+
|
|
4240
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-set-upgrade-mode.html>`_
|
|
4072
4241
|
|
|
4073
4242
|
:param enabled: When `true`, it enables `upgrade_mode` which temporarily halts
|
|
4074
4243
|
all job and datafeed tasks and prohibits new job and datafeed tasks from
|
|
@@ -4109,12 +4278,21 @@ class MlClient(NamespacedClient):
|
|
|
4109
4278
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4110
4279
|
human: t.Optional[bool] = None,
|
|
4111
4280
|
pretty: t.Optional[bool] = None,
|
|
4112
|
-
timeout: t.Optional[t.Union[
|
|
4281
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4113
4282
|
) -> ObjectApiResponse[t.Any]:
|
|
4114
4283
|
"""
|
|
4115
|
-
Starts a data frame analytics job.
|
|
4284
|
+
Starts a data frame analytics job. A data frame analytics job can be started
|
|
4285
|
+
and stopped multiple times throughout its lifecycle. If the destination index
|
|
4286
|
+
does not exist, it is created automatically the first time you start the data
|
|
4287
|
+
frame analytics job. The `index.number_of_shards` and `index.number_of_replicas`
|
|
4288
|
+
settings for the destination index are copied from the source index. If there
|
|
4289
|
+
are multiple source indices, the destination index copies the highest setting
|
|
4290
|
+
values. The mappings for the destination index are also copied from the source
|
|
4291
|
+
indices. If there are any mapping conflicts, the job fails to start. If the destination
|
|
4292
|
+
index exists, it is used as is. You can therefore set up the destination index
|
|
4293
|
+
in advance with custom settings and mappings.
|
|
4116
4294
|
|
|
4117
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4295
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/start-dfanalytics.html>`_
|
|
4118
4296
|
|
|
4119
4297
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
4120
4298
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -4160,13 +4338,23 @@ class MlClient(NamespacedClient):
|
|
|
4160
4338
|
human: t.Optional[bool] = None,
|
|
4161
4339
|
pretty: t.Optional[bool] = None,
|
|
4162
4340
|
start: t.Optional[t.Union[str, t.Any]] = None,
|
|
4163
|
-
timeout: t.Optional[t.Union[
|
|
4341
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4164
4342
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4165
4343
|
) -> ObjectApiResponse[t.Any]:
|
|
4166
4344
|
"""
|
|
4167
|
-
Starts one or more datafeeds.
|
|
4345
|
+
Starts one or more datafeeds. A datafeed must be started in order to retrieve
|
|
4346
|
+
data from Elasticsearch. A datafeed can be started and stopped multiple times
|
|
4347
|
+
throughout its lifecycle. Before you can start a datafeed, the anomaly detection
|
|
4348
|
+
job must be open. Otherwise, an error occurs. If you restart a stopped datafeed,
|
|
4349
|
+
it continues processing input data from the next millisecond after it was stopped.
|
|
4350
|
+
If new data was indexed for that exact millisecond between stopping and starting,
|
|
4351
|
+
it will be ignored. When Elasticsearch security features are enabled, your datafeed
|
|
4352
|
+
remembers which roles the last user to create or update it had at the time of
|
|
4353
|
+
creation or update and runs the query using those same roles. If you provided
|
|
4354
|
+
secondary authorization headers when you created or updated the datafeed, those
|
|
4355
|
+
credentials are used instead.
|
|
4168
4356
|
|
|
4169
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4357
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-start-datafeed.html>`_
|
|
4170
4358
|
|
|
4171
4359
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
4172
4360
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -4224,18 +4412,19 @@ class MlClient(NamespacedClient):
|
|
|
4224
4412
|
human: t.Optional[bool] = None,
|
|
4225
4413
|
number_of_allocations: t.Optional[int] = None,
|
|
4226
4414
|
pretty: t.Optional[bool] = None,
|
|
4227
|
-
priority: t.Optional[t.Union[
|
|
4415
|
+
priority: t.Optional[t.Union[str, t.Literal["low", "normal"]]] = None,
|
|
4228
4416
|
queue_capacity: t.Optional[int] = None,
|
|
4229
4417
|
threads_per_allocation: t.Optional[int] = None,
|
|
4230
|
-
timeout: t.Optional[t.Union[
|
|
4418
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4231
4419
|
wait_for: t.Optional[
|
|
4232
|
-
t.Union[
|
|
4420
|
+
t.Union[str, t.Literal["fully_allocated", "started", "starting"]]
|
|
4233
4421
|
] = None,
|
|
4234
4422
|
) -> ObjectApiResponse[t.Any]:
|
|
4235
4423
|
"""
|
|
4236
|
-
|
|
4424
|
+
Starts a trained model deployment, which allocates the model to every machine
|
|
4425
|
+
learning node.
|
|
4237
4426
|
|
|
4238
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4427
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/start-trained-model-deployment.html>`_
|
|
4239
4428
|
|
|
4240
4429
|
:param model_id: The unique identifier of the trained model. Currently, only
|
|
4241
4430
|
PyTorch models are supported.
|
|
@@ -4313,12 +4502,13 @@ class MlClient(NamespacedClient):
|
|
|
4313
4502
|
force: t.Optional[bool] = None,
|
|
4314
4503
|
human: t.Optional[bool] = None,
|
|
4315
4504
|
pretty: t.Optional[bool] = None,
|
|
4316
|
-
timeout: t.Optional[t.Union[
|
|
4505
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4317
4506
|
) -> ObjectApiResponse[t.Any]:
|
|
4318
4507
|
"""
|
|
4319
|
-
Stops one or more data frame analytics jobs.
|
|
4508
|
+
Stops one or more data frame analytics jobs. A data frame analytics job can be
|
|
4509
|
+
started and stopped multiple times throughout its lifecycle.
|
|
4320
4510
|
|
|
4321
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4511
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/stop-dfanalytics.html>`_
|
|
4322
4512
|
|
|
4323
4513
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
4324
4514
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -4377,13 +4567,15 @@ class MlClient(NamespacedClient):
|
|
|
4377
4567
|
force: t.Optional[bool] = None,
|
|
4378
4568
|
human: t.Optional[bool] = None,
|
|
4379
4569
|
pretty: t.Optional[bool] = None,
|
|
4380
|
-
timeout: t.Optional[t.Union[
|
|
4570
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4381
4571
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4382
4572
|
) -> ObjectApiResponse[t.Any]:
|
|
4383
4573
|
"""
|
|
4384
|
-
Stops one or more datafeeds.
|
|
4574
|
+
Stops one or more datafeeds. A datafeed that is stopped ceases to retrieve data
|
|
4575
|
+
from Elasticsearch. A datafeed can be started and stopped multiple times throughout
|
|
4576
|
+
its lifecycle.
|
|
4385
4577
|
|
|
4386
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4578
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-stop-datafeed.html>`_
|
|
4387
4579
|
|
|
4388
4580
|
:param datafeed_id: Identifier for the datafeed. You can stop multiple datafeeds
|
|
4389
4581
|
in a single API request by using a comma-separated list of datafeeds or a
|
|
@@ -4443,9 +4635,9 @@ class MlClient(NamespacedClient):
|
|
|
4443
4635
|
pretty: t.Optional[bool] = None,
|
|
4444
4636
|
) -> ObjectApiResponse[t.Any]:
|
|
4445
4637
|
"""
|
|
4446
|
-
|
|
4638
|
+
Stops a trained model deployment.
|
|
4447
4639
|
|
|
4448
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4640
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/stop-trained-model-deployment.html>`_
|
|
4449
4641
|
|
|
4450
4642
|
:param model_id: The unique identifier of the trained model.
|
|
4451
4643
|
:param allow_no_match: Specifies what to do when the request: contains wildcard
|
|
@@ -4508,9 +4700,9 @@ class MlClient(NamespacedClient):
|
|
|
4508
4700
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4509
4701
|
) -> ObjectApiResponse[t.Any]:
|
|
4510
4702
|
"""
|
|
4511
|
-
Updates
|
|
4703
|
+
Updates an existing data frame analytics job.
|
|
4512
4704
|
|
|
4513
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4705
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/update-dfanalytics.html>`_
|
|
4514
4706
|
|
|
4515
4707
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
4516
4708
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -4592,13 +4784,13 @@ class MlClient(NamespacedClient):
|
|
|
4592
4784
|
expand_wildcards: t.Optional[
|
|
4593
4785
|
t.Union[
|
|
4594
4786
|
t.Sequence[
|
|
4595
|
-
t.Union[
|
|
4787
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
|
|
4596
4788
|
],
|
|
4597
|
-
t.Union[
|
|
4789
|
+
t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
|
|
4598
4790
|
]
|
|
4599
4791
|
] = None,
|
|
4600
4792
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
4601
|
-
frequency: t.Optional[t.Union[
|
|
4793
|
+
frequency: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4602
4794
|
human: t.Optional[bool] = None,
|
|
4603
4795
|
ignore_throttled: t.Optional[bool] = None,
|
|
4604
4796
|
ignore_unavailable: t.Optional[bool] = None,
|
|
@@ -4609,16 +4801,20 @@ class MlClient(NamespacedClient):
|
|
|
4609
4801
|
max_empty_searches: t.Optional[int] = None,
|
|
4610
4802
|
pretty: t.Optional[bool] = None,
|
|
4611
4803
|
query: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
4612
|
-
query_delay: t.Optional[t.Union[
|
|
4804
|
+
query_delay: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
4613
4805
|
runtime_mappings: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
|
|
4614
4806
|
script_fields: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
|
|
4615
4807
|
scroll_size: t.Optional[int] = None,
|
|
4616
4808
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4617
4809
|
) -> ObjectApiResponse[t.Any]:
|
|
4618
4810
|
"""
|
|
4619
|
-
Updates
|
|
4811
|
+
Updates the properties of a datafeed. You must stop and start the datafeed for
|
|
4812
|
+
the changes to be applied. When Elasticsearch security features are enabled,
|
|
4813
|
+
your datafeed remembers which roles the user who updated it had at the time of
|
|
4814
|
+
the update and runs the query using those same roles. If you provide secondary
|
|
4815
|
+
authorization headers, those credentials are used instead.
|
|
4620
4816
|
|
|
4621
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4817
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-update-datafeed.html>`_
|
|
4622
4818
|
|
|
4623
4819
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
4624
4820
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -4779,9 +4975,9 @@ class MlClient(NamespacedClient):
|
|
|
4779
4975
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
4780
4976
|
) -> ObjectApiResponse[t.Any]:
|
|
4781
4977
|
"""
|
|
4782
|
-
Updates the description of a filter, adds items, or removes items.
|
|
4978
|
+
Updates the description of a filter, adds items, or removes items from the list.
|
|
4783
4979
|
|
|
4784
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4980
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-update-filter.html>`_
|
|
4785
4981
|
|
|
4786
4982
|
:param filter_id: A string that uniquely identifies a filter.
|
|
4787
4983
|
:param add_items: The items to add to the filter.
|
|
@@ -4846,7 +5042,7 @@ class MlClient(NamespacedClient):
|
|
|
4846
5042
|
allow_lazy_open: t.Optional[bool] = None,
|
|
4847
5043
|
analysis_limits: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
4848
5044
|
background_persist_interval: t.Optional[
|
|
4849
|
-
t.Union[
|
|
5045
|
+
t.Union[str, t.Literal[-1], t.Literal[0]]
|
|
4850
5046
|
] = None,
|
|
4851
5047
|
categorization_filters: t.Optional[t.Sequence[str]] = None,
|
|
4852
5048
|
custom_settings: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
@@ -4859,7 +5055,7 @@ class MlClient(NamespacedClient):
|
|
|
4859
5055
|
human: t.Optional[bool] = None,
|
|
4860
5056
|
model_plot_config: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
4861
5057
|
model_prune_window: t.Optional[
|
|
4862
|
-
t.Union[
|
|
5058
|
+
t.Union[str, t.Literal[-1], t.Literal[0]]
|
|
4863
5059
|
] = None,
|
|
4864
5060
|
model_snapshot_retention_days: t.Optional[int] = None,
|
|
4865
5061
|
per_partition_categorization: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
@@ -4871,7 +5067,7 @@ class MlClient(NamespacedClient):
|
|
|
4871
5067
|
"""
|
|
4872
5068
|
Updates certain properties of an anomaly detection job.
|
|
4873
5069
|
|
|
4874
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5070
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-update-job.html>`_
|
|
4875
5071
|
|
|
4876
5072
|
:param job_id: Identifier for the job.
|
|
4877
5073
|
:param allow_lazy_open: Advanced configuration option. Specifies whether this
|
|
@@ -4999,7 +5195,7 @@ class MlClient(NamespacedClient):
|
|
|
4999
5195
|
"""
|
|
5000
5196
|
Updates certain properties of a snapshot.
|
|
5001
5197
|
|
|
5002
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5198
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-update-snapshot.html>`_
|
|
5003
5199
|
|
|
5004
5200
|
:param job_id: Identifier for the anomaly detection job.
|
|
5005
5201
|
:param snapshot_id: Identifier for the model snapshot.
|
|
@@ -5058,9 +5254,10 @@ class MlClient(NamespacedClient):
|
|
|
5058
5254
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
5059
5255
|
) -> ObjectApiResponse[t.Any]:
|
|
5060
5256
|
"""
|
|
5061
|
-
|
|
5257
|
+
Starts a trained model deployment, which allocates the model to every machine
|
|
5258
|
+
learning node.
|
|
5062
5259
|
|
|
5063
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5260
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/update-trained-model-deployment.html>`_
|
|
5064
5261
|
|
|
5065
5262
|
:param model_id: The unique identifier of the trained model. Currently, only
|
|
5066
5263
|
PyTorch models are supported.
|
|
@@ -5088,7 +5285,11 @@ class MlClient(NamespacedClient):
|
|
|
5088
5285
|
if not __body:
|
|
5089
5286
|
if number_of_allocations is not None:
|
|
5090
5287
|
__body["number_of_allocations"] = number_of_allocations
|
|
5091
|
-
|
|
5288
|
+
if not __body:
|
|
5289
|
+
__body = None # type: ignore[assignment]
|
|
5290
|
+
__headers = {"accept": "application/json"}
|
|
5291
|
+
if __body is not None:
|
|
5292
|
+
__headers["content-type"] = "application/json"
|
|
5092
5293
|
return self.perform_request( # type: ignore[return-value]
|
|
5093
5294
|
"POST",
|
|
5094
5295
|
__path,
|
|
@@ -5109,13 +5310,19 @@ class MlClient(NamespacedClient):
|
|
|
5109
5310
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
5110
5311
|
human: t.Optional[bool] = None,
|
|
5111
5312
|
pretty: t.Optional[bool] = None,
|
|
5112
|
-
timeout: t.Optional[t.Union[
|
|
5313
|
+
timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
|
|
5113
5314
|
wait_for_completion: t.Optional[bool] = None,
|
|
5114
5315
|
) -> ObjectApiResponse[t.Any]:
|
|
5115
5316
|
"""
|
|
5116
|
-
Upgrades
|
|
5317
|
+
Upgrades an anomaly detection model snapshot to the latest major version. Over
|
|
5318
|
+
time, older snapshot formats are deprecated and removed. Anomaly detection jobs
|
|
5319
|
+
support only snapshots that are from the current or previous major version. This
|
|
5320
|
+
API provides a means to upgrade a snapshot to the current major version. This
|
|
5321
|
+
aids in preparing the cluster for an upgrade to the next major version. Only
|
|
5322
|
+
one snapshot per anomaly detection job can be upgraded at a time and the upgraded
|
|
5323
|
+
snapshot cannot be the current snapshot of the anomaly detection job.
|
|
5117
5324
|
|
|
5118
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5325
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ml-upgrade-job-model-snapshot.html>`_
|
|
5119
5326
|
|
|
5120
5327
|
:param job_id: Identifier for the anomaly detection job.
|
|
5121
5328
|
:param snapshot_id: A numerical character string that uniquely identifies the
|
|
@@ -5191,7 +5398,7 @@ class MlClient(NamespacedClient):
|
|
|
5191
5398
|
"""
|
|
5192
5399
|
Validates an anomaly detection job.
|
|
5193
5400
|
|
|
5194
|
-
`<https://www.elastic.co/guide/en/machine-learning/8.
|
|
5401
|
+
`<https://www.elastic.co/guide/en/machine-learning/8.15/ml-jobs.html>`_
|
|
5195
5402
|
|
|
5196
5403
|
:param analysis_config:
|
|
5197
5404
|
:param analysis_limits:
|
|
@@ -5261,7 +5468,7 @@ class MlClient(NamespacedClient):
|
|
|
5261
5468
|
"""
|
|
5262
5469
|
Validates an anomaly detection detector.
|
|
5263
5470
|
|
|
5264
|
-
`<https://www.elastic.co/guide/en/machine-learning/8.
|
|
5471
|
+
`<https://www.elastic.co/guide/en/machine-learning/8.15/ml-jobs.html>`_
|
|
5265
5472
|
|
|
5266
5473
|
:param detector:
|
|
5267
5474
|
"""
|