elasticsearch 8.13.1__py3-none-any.whl → 8.14.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 +51 -44
- elasticsearch/_async/client/async_search.py +4 -4
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +26 -26
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +23 -25
- elasticsearch/_async/client/dangling_indices.py +3 -3
- elasticsearch/_async/client/enrich.py +5 -5
- elasticsearch/_async/client/eql.py +4 -4
- elasticsearch/_async/client/esql.py +1 -1
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +1 -1
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +11 -11
- elasticsearch/_async/client/indices.py +182 -157
- elasticsearch/_async/client/inference.py +34 -17
- elasticsearch/_async/client/ingest.py +6 -6
- elasticsearch/_async/client/license.py +7 -7
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +128 -72
- elasticsearch/_async/client/monitoring.py +1 -1
- elasticsearch/_async/client/nodes.py +7 -7
- elasticsearch/_async/client/query_ruleset.py +4 -4
- elasticsearch/_async/client/rollup.py +8 -8
- elasticsearch/_async/client/search_application.py +13 -8
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +63 -53
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +11 -11
- elasticsearch/_async/client/sql.py +6 -6
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +7 -7
- elasticsearch/_async/client/tasks.py +3 -3
- elasticsearch/_async/client/text_structure.py +2 -2
- elasticsearch/_async/client/transform.py +11 -11
- elasticsearch/_async/client/watcher.py +11 -11
- elasticsearch/_async/client/xpack.py +2 -2
- elasticsearch/_sync/client/__init__.py +51 -44
- elasticsearch/_sync/client/async_search.py +4 -4
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +26 -26
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +23 -25
- elasticsearch/_sync/client/dangling_indices.py +3 -3
- elasticsearch/_sync/client/enrich.py +5 -5
- elasticsearch/_sync/client/eql.py +4 -4
- elasticsearch/_sync/client/esql.py +1 -1
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +1 -1
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +11 -11
- elasticsearch/_sync/client/indices.py +182 -157
- elasticsearch/_sync/client/inference.py +34 -17
- elasticsearch/_sync/client/ingest.py +6 -6
- elasticsearch/_sync/client/license.py +7 -7
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +128 -72
- elasticsearch/_sync/client/monitoring.py +1 -1
- elasticsearch/_sync/client/nodes.py +7 -7
- elasticsearch/_sync/client/query_ruleset.py +4 -4
- elasticsearch/_sync/client/rollup.py +8 -8
- elasticsearch/_sync/client/search_application.py +13 -8
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +63 -53
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +11 -11
- elasticsearch/_sync/client/sql.py +6 -6
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +7 -7
- elasticsearch/_sync/client/tasks.py +3 -3
- elasticsearch/_sync/client/text_structure.py +2 -2
- elasticsearch/_sync/client/transform.py +11 -11
- elasticsearch/_sync/client/watcher.py +11 -11
- elasticsearch/_sync/client/xpack.py +2 -2
- elasticsearch/_version.py +1 -1
- elasticsearch/serializer.py +0 -1
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/METADATA +16 -2
- elasticsearch-8.14.0.dist-info/RECORD +116 -0
- elasticsearch-8.13.1.dist-info/RECORD +0 -116
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/LICENSE +0 -0
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/NOTICE +0 -0
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/WHEEL +0 -0
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/top_level.txt +0 -0
|
@@ -38,7 +38,7 @@ class MlClient(NamespacedClient):
|
|
|
38
38
|
"""
|
|
39
39
|
Clear the cached results from a trained model deployment
|
|
40
40
|
|
|
41
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
41
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/clear-trained-model-deployment-cache.html>`_
|
|
42
42
|
|
|
43
43
|
:param model_id: The unique identifier of the trained model.
|
|
44
44
|
"""
|
|
@@ -87,7 +87,7 @@ class MlClient(NamespacedClient):
|
|
|
87
87
|
Closes one or more anomaly detection jobs. A job can be opened and closed multiple
|
|
88
88
|
times throughout its lifecycle.
|
|
89
89
|
|
|
90
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
90
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-close-job.html>`_
|
|
91
91
|
|
|
92
92
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
93
93
|
a group name, or a wildcard expression. You can close multiple anomaly detection
|
|
@@ -148,7 +148,7 @@ class MlClient(NamespacedClient):
|
|
|
148
148
|
"""
|
|
149
149
|
Deletes a calendar.
|
|
150
150
|
|
|
151
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
151
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-delete-calendar.html>`_
|
|
152
152
|
|
|
153
153
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
154
154
|
"""
|
|
@@ -189,7 +189,7 @@ class MlClient(NamespacedClient):
|
|
|
189
189
|
"""
|
|
190
190
|
Deletes scheduled events from a calendar.
|
|
191
191
|
|
|
192
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
192
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-delete-calendar-event.html>`_
|
|
193
193
|
|
|
194
194
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
195
195
|
:param event_id: Identifier for the scheduled event. You can obtain this identifier
|
|
@@ -237,7 +237,7 @@ class MlClient(NamespacedClient):
|
|
|
237
237
|
"""
|
|
238
238
|
Deletes anomaly detection jobs from a calendar.
|
|
239
239
|
|
|
240
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
240
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-delete-calendar-job.html>`_
|
|
241
241
|
|
|
242
242
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
243
243
|
:param job_id: An identifier for the anomaly detection jobs. It can be a job
|
|
@@ -286,7 +286,7 @@ class MlClient(NamespacedClient):
|
|
|
286
286
|
"""
|
|
287
287
|
Deletes an existing data frame analytics job.
|
|
288
288
|
|
|
289
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
289
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/delete-dfanalytics.html>`_
|
|
290
290
|
|
|
291
291
|
:param id: Identifier for the data frame analytics job.
|
|
292
292
|
:param force: If `true`, it deletes a job that is not stopped; this method is
|
|
@@ -334,7 +334,7 @@ class MlClient(NamespacedClient):
|
|
|
334
334
|
"""
|
|
335
335
|
Deletes an existing datafeed.
|
|
336
336
|
|
|
337
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
337
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-delete-datafeed.html>`_
|
|
338
338
|
|
|
339
339
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
340
340
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -386,7 +386,7 @@ class MlClient(NamespacedClient):
|
|
|
386
386
|
"""
|
|
387
387
|
Deletes expired and unused machine learning data.
|
|
388
388
|
|
|
389
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
389
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-delete-expired-data.html>`_
|
|
390
390
|
|
|
391
391
|
:param job_id: Identifier for an anomaly detection job. It can be a job identifier,
|
|
392
392
|
a group name, or a wildcard expression.
|
|
@@ -445,7 +445,7 @@ class MlClient(NamespacedClient):
|
|
|
445
445
|
"""
|
|
446
446
|
Deletes a filter.
|
|
447
447
|
|
|
448
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
448
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-delete-filter.html>`_
|
|
449
449
|
|
|
450
450
|
:param filter_id: A string that uniquely identifies a filter.
|
|
451
451
|
"""
|
|
@@ -488,7 +488,7 @@ class MlClient(NamespacedClient):
|
|
|
488
488
|
"""
|
|
489
489
|
Deletes forecasts from a machine learning job.
|
|
490
490
|
|
|
491
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
491
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-delete-forecast.html>`_
|
|
492
492
|
|
|
493
493
|
:param job_id: Identifier for the anomaly detection job.
|
|
494
494
|
:param forecast_id: A comma-separated list of forecast identifiers. If you do
|
|
@@ -555,7 +555,7 @@ class MlClient(NamespacedClient):
|
|
|
555
555
|
"""
|
|
556
556
|
Deletes an existing anomaly detection job.
|
|
557
557
|
|
|
558
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
558
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-delete-job.html>`_
|
|
559
559
|
|
|
560
560
|
:param job_id: Identifier for the anomaly detection job.
|
|
561
561
|
:param delete_user_annotations: Specifies whether annotations that have been
|
|
@@ -609,7 +609,7 @@ class MlClient(NamespacedClient):
|
|
|
609
609
|
"""
|
|
610
610
|
Deletes an existing model snapshot.
|
|
611
611
|
|
|
612
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
612
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-delete-snapshot.html>`_
|
|
613
613
|
|
|
614
614
|
:param job_id: Identifier for the anomaly detection job.
|
|
615
615
|
:param snapshot_id: Identifier for the model snapshot.
|
|
@@ -657,7 +657,7 @@ class MlClient(NamespacedClient):
|
|
|
657
657
|
Deletes an existing trained inference model that is currently not referenced
|
|
658
658
|
by an ingest pipeline.
|
|
659
659
|
|
|
660
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
660
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/delete-trained-models.html>`_
|
|
661
661
|
|
|
662
662
|
:param model_id: The unique identifier of the trained model.
|
|
663
663
|
:param force: Forcefully deletes a trained model that is referenced by ingest
|
|
@@ -702,7 +702,7 @@ class MlClient(NamespacedClient):
|
|
|
702
702
|
"""
|
|
703
703
|
Deletes a model alias that refers to the trained model
|
|
704
704
|
|
|
705
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
705
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/delete-trained-models-aliases.html>`_
|
|
706
706
|
|
|
707
707
|
:param model_id: The trained model ID to which the model alias refers.
|
|
708
708
|
:param model_alias: The model alias to delete.
|
|
@@ -757,7 +757,7 @@ class MlClient(NamespacedClient):
|
|
|
757
757
|
"""
|
|
758
758
|
Estimates the model memory
|
|
759
759
|
|
|
760
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
760
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-apis.html>`_
|
|
761
761
|
|
|
762
762
|
:param analysis_config: For a list of the properties that you can specify in
|
|
763
763
|
the `analysis_config` component of the body of this API.
|
|
@@ -822,7 +822,7 @@ class MlClient(NamespacedClient):
|
|
|
822
822
|
"""
|
|
823
823
|
Evaluates the data frame analytics for an annotated index.
|
|
824
824
|
|
|
825
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
825
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/evaluate-dfanalytics.html>`_
|
|
826
826
|
|
|
827
827
|
:param evaluation: Defines the type of evaluation you want to perform.
|
|
828
828
|
:param index: Defines the `index` in which the evaluation will be performed.
|
|
@@ -896,7 +896,7 @@ class MlClient(NamespacedClient):
|
|
|
896
896
|
"""
|
|
897
897
|
Explains a data frame analytics config.
|
|
898
898
|
|
|
899
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
899
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/explain-dfanalytics.html>`_
|
|
900
900
|
|
|
901
901
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
902
902
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -996,7 +996,7 @@ class MlClient(NamespacedClient):
|
|
|
996
996
|
"""
|
|
997
997
|
Forces any buffered data to be processed by the job.
|
|
998
998
|
|
|
999
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
999
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-flush-job.html>`_
|
|
1000
1000
|
|
|
1001
1001
|
:param job_id: Identifier for the anomaly detection job.
|
|
1002
1002
|
:param advance_time: Refer to the description for the `advance_time` query parameter.
|
|
@@ -1064,7 +1064,7 @@ class MlClient(NamespacedClient):
|
|
|
1064
1064
|
"""
|
|
1065
1065
|
Predicts the future behavior of a time series by using its historical behavior.
|
|
1066
1066
|
|
|
1067
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1067
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-forecast.html>`_
|
|
1068
1068
|
|
|
1069
1069
|
:param job_id: Identifier for the anomaly detection job. The job must be open
|
|
1070
1070
|
when you create a forecast; otherwise, an error occurs.
|
|
@@ -1146,7 +1146,7 @@ class MlClient(NamespacedClient):
|
|
|
1146
1146
|
"""
|
|
1147
1147
|
Retrieves anomaly detection job results for one or more buckets.
|
|
1148
1148
|
|
|
1149
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1149
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-get-bucket.html>`_
|
|
1150
1150
|
|
|
1151
1151
|
:param job_id: Identifier for the anomaly detection job.
|
|
1152
1152
|
:param timestamp: The timestamp of a single bucket result. If you do not specify
|
|
@@ -1241,7 +1241,7 @@ class MlClient(NamespacedClient):
|
|
|
1241
1241
|
"""
|
|
1242
1242
|
Retrieves information about the scheduled events in calendars.
|
|
1243
1243
|
|
|
1244
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1244
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-get-calendar-event.html>`_
|
|
1245
1245
|
|
|
1246
1246
|
:param calendar_id: A string that uniquely identifies a calendar. You can get
|
|
1247
1247
|
information for multiple calendars by using a comma-separated list of ids
|
|
@@ -1307,7 +1307,7 @@ class MlClient(NamespacedClient):
|
|
|
1307
1307
|
"""
|
|
1308
1308
|
Retrieves configuration information for calendars.
|
|
1309
1309
|
|
|
1310
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1310
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-get-calendar.html>`_
|
|
1311
1311
|
|
|
1312
1312
|
:param calendar_id: A string that uniquely identifies a calendar. You can get
|
|
1313
1313
|
information for multiple calendars by using a comma-separated list of ids
|
|
@@ -1380,7 +1380,7 @@ class MlClient(NamespacedClient):
|
|
|
1380
1380
|
"""
|
|
1381
1381
|
Retrieves anomaly detection job results for one or more categories.
|
|
1382
1382
|
|
|
1383
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1383
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-get-category.html>`_
|
|
1384
1384
|
|
|
1385
1385
|
:param job_id: Identifier for the anomaly detection job.
|
|
1386
1386
|
:param category_id: Identifier for the category, which is unique in the job.
|
|
@@ -1462,7 +1462,7 @@ class MlClient(NamespacedClient):
|
|
|
1462
1462
|
"""
|
|
1463
1463
|
Retrieves configuration information for data frame analytics jobs.
|
|
1464
1464
|
|
|
1465
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1465
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-dfanalytics.html>`_
|
|
1466
1466
|
|
|
1467
1467
|
:param id: Identifier for the data frame analytics job. If you do not specify
|
|
1468
1468
|
this option, the API returns information for the first hundred data frame
|
|
@@ -1534,7 +1534,7 @@ class MlClient(NamespacedClient):
|
|
|
1534
1534
|
"""
|
|
1535
1535
|
Retrieves usage information for data frame analytics jobs.
|
|
1536
1536
|
|
|
1537
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1537
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-dfanalytics-stats.html>`_
|
|
1538
1538
|
|
|
1539
1539
|
:param id: Identifier for the data frame analytics job. If you do not specify
|
|
1540
1540
|
this option, the API returns information for the first hundred data frame
|
|
@@ -1599,7 +1599,7 @@ class MlClient(NamespacedClient):
|
|
|
1599
1599
|
"""
|
|
1600
1600
|
Retrieves usage information for datafeeds.
|
|
1601
1601
|
|
|
1602
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1602
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-get-datafeed-stats.html>`_
|
|
1603
1603
|
|
|
1604
1604
|
:param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier
|
|
1605
1605
|
or a wildcard expression. If you do not specify one of these options, the
|
|
@@ -1655,7 +1655,7 @@ class MlClient(NamespacedClient):
|
|
|
1655
1655
|
"""
|
|
1656
1656
|
Retrieves configuration information for datafeeds.
|
|
1657
1657
|
|
|
1658
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1658
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-get-datafeed.html>`_
|
|
1659
1659
|
|
|
1660
1660
|
:param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier
|
|
1661
1661
|
or a wildcard expression. If you do not specify one of these options, the
|
|
@@ -1718,7 +1718,7 @@ class MlClient(NamespacedClient):
|
|
|
1718
1718
|
"""
|
|
1719
1719
|
Retrieves filters.
|
|
1720
1720
|
|
|
1721
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1721
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-get-filter.html>`_
|
|
1722
1722
|
|
|
1723
1723
|
:param filter_id: A string that uniquely identifies a filter.
|
|
1724
1724
|
:param from_: Skips the specified number of filters.
|
|
@@ -1780,7 +1780,7 @@ class MlClient(NamespacedClient):
|
|
|
1780
1780
|
"""
|
|
1781
1781
|
Retrieves anomaly detection job results for one or more influencers.
|
|
1782
1782
|
|
|
1783
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1783
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-get-influencer.html>`_
|
|
1784
1784
|
|
|
1785
1785
|
:param job_id: Identifier for the anomaly detection job.
|
|
1786
1786
|
:param desc: If true, the results are sorted in descending order.
|
|
@@ -1861,7 +1861,7 @@ class MlClient(NamespacedClient):
|
|
|
1861
1861
|
"""
|
|
1862
1862
|
Retrieves usage information for anomaly detection jobs.
|
|
1863
1863
|
|
|
1864
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1864
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-get-job-stats.html>`_
|
|
1865
1865
|
|
|
1866
1866
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
1867
1867
|
a group name, a comma-separated list of jobs, or a wildcard expression. If
|
|
@@ -1918,7 +1918,7 @@ class MlClient(NamespacedClient):
|
|
|
1918
1918
|
"""
|
|
1919
1919
|
Retrieves configuration information for anomaly detection jobs.
|
|
1920
1920
|
|
|
1921
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1921
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-get-job.html>`_
|
|
1922
1922
|
|
|
1923
1923
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
1924
1924
|
a group name, or a wildcard expression. If you do not specify one of these
|
|
@@ -1981,7 +1981,7 @@ class MlClient(NamespacedClient):
|
|
|
1981
1981
|
"""
|
|
1982
1982
|
Returns information on how ML is using memory.
|
|
1983
1983
|
|
|
1984
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1984
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-ml-memory.html>`_
|
|
1985
1985
|
|
|
1986
1986
|
:param node_id: The names of particular nodes in the cluster to target. For example,
|
|
1987
1987
|
`nodeId1,nodeId2` or `ml:true`
|
|
@@ -2036,7 +2036,7 @@ class MlClient(NamespacedClient):
|
|
|
2036
2036
|
"""
|
|
2037
2037
|
Gets stats for anomaly detection job model snapshot upgrades that are in progress.
|
|
2038
2038
|
|
|
2039
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2039
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-get-job-model-snapshot-upgrade-stats.html>`_
|
|
2040
2040
|
|
|
2041
2041
|
:param job_id: Identifier for the anomaly detection job.
|
|
2042
2042
|
:param snapshot_id: A numerical character string that uniquely identifies the
|
|
@@ -2107,7 +2107,7 @@ class MlClient(NamespacedClient):
|
|
|
2107
2107
|
"""
|
|
2108
2108
|
Retrieves information about model snapshots.
|
|
2109
2109
|
|
|
2110
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2110
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-get-snapshot.html>`_
|
|
2111
2111
|
|
|
2112
2112
|
:param job_id: Identifier for the anomaly detection job.
|
|
2113
2113
|
:param snapshot_id: A numerical character string that uniquely identifies the
|
|
@@ -2209,7 +2209,7 @@ class MlClient(NamespacedClient):
|
|
|
2209
2209
|
Retrieves overall bucket results that summarize the bucket results of multiple
|
|
2210
2210
|
anomaly detection jobs.
|
|
2211
2211
|
|
|
2212
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2212
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-get-overall-buckets.html>`_
|
|
2213
2213
|
|
|
2214
2214
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
2215
2215
|
a group name, a comma-separated list of jobs or groups, or a wildcard expression.
|
|
@@ -2306,7 +2306,7 @@ class MlClient(NamespacedClient):
|
|
|
2306
2306
|
"""
|
|
2307
2307
|
Retrieves anomaly records for an anomaly detection job.
|
|
2308
2308
|
|
|
2309
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2309
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-get-record.html>`_
|
|
2310
2310
|
|
|
2311
2311
|
:param job_id: Identifier for the anomaly detection job.
|
|
2312
2312
|
:param desc: Refer to the description for the `desc` query parameter.
|
|
@@ -2395,7 +2395,7 @@ class MlClient(NamespacedClient):
|
|
|
2395
2395
|
"""
|
|
2396
2396
|
Retrieves configuration information for a trained inference model.
|
|
2397
2397
|
|
|
2398
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2398
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-trained-models.html>`_
|
|
2399
2399
|
|
|
2400
2400
|
:param model_id: The unique identifier of the trained model.
|
|
2401
2401
|
:param allow_no_match: Specifies what to do when the request: - Contains wildcard
|
|
@@ -2475,7 +2475,7 @@ class MlClient(NamespacedClient):
|
|
|
2475
2475
|
"""
|
|
2476
2476
|
Retrieves usage information for trained inference models.
|
|
2477
2477
|
|
|
2478
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2478
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-trained-models-stats.html>`_
|
|
2479
2479
|
|
|
2480
2480
|
:param model_id: The unique identifier of the trained model or a model alias.
|
|
2481
2481
|
It can be a comma-separated list or a wildcard expression.
|
|
@@ -2538,7 +2538,7 @@ class MlClient(NamespacedClient):
|
|
|
2538
2538
|
"""
|
|
2539
2539
|
Evaluate a trained model.
|
|
2540
2540
|
|
|
2541
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2541
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/infer-trained-model.html>`_
|
|
2542
2542
|
|
|
2543
2543
|
:param model_id: The unique identifier of the trained model.
|
|
2544
2544
|
:param docs: An array of objects to pass to the model for inference. The objects
|
|
@@ -2595,7 +2595,7 @@ class MlClient(NamespacedClient):
|
|
|
2595
2595
|
"""
|
|
2596
2596
|
Returns defaults and limits used by machine learning.
|
|
2597
2597
|
|
|
2598
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2598
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-ml-info.html>`_
|
|
2599
2599
|
"""
|
|
2600
2600
|
__path_parts: t.Dict[str, str] = {}
|
|
2601
2601
|
__path = "/_ml/info"
|
|
@@ -2635,7 +2635,7 @@ class MlClient(NamespacedClient):
|
|
|
2635
2635
|
"""
|
|
2636
2636
|
Opens one or more anomaly detection jobs.
|
|
2637
2637
|
|
|
2638
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2638
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-open-job.html>`_
|
|
2639
2639
|
|
|
2640
2640
|
:param job_id: Identifier for the anomaly detection job.
|
|
2641
2641
|
:param timeout: Refer to the description for the `timeout` query parameter.
|
|
@@ -2689,7 +2689,7 @@ class MlClient(NamespacedClient):
|
|
|
2689
2689
|
"""
|
|
2690
2690
|
Posts scheduled events in a calendar.
|
|
2691
2691
|
|
|
2692
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2692
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-post-calendar-event.html>`_
|
|
2693
2693
|
|
|
2694
2694
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
2695
2695
|
:param events: A list of one of more scheduled events. The event’s start and
|
|
@@ -2745,7 +2745,7 @@ class MlClient(NamespacedClient):
|
|
|
2745
2745
|
"""
|
|
2746
2746
|
Sends data to an anomaly detection job for analysis.
|
|
2747
2747
|
|
|
2748
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2748
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-post-data.html>`_
|
|
2749
2749
|
|
|
2750
2750
|
:param job_id: Identifier for the anomaly detection job. The job must have a
|
|
2751
2751
|
state of open to receive and process the data.
|
|
@@ -2808,7 +2808,7 @@ class MlClient(NamespacedClient):
|
|
|
2808
2808
|
"""
|
|
2809
2809
|
Previews that will be analyzed given a data frame analytics config.
|
|
2810
2810
|
|
|
2811
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2811
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/preview-dfanalytics.html>`_
|
|
2812
2812
|
|
|
2813
2813
|
:param id: Identifier for the data frame analytics job.
|
|
2814
2814
|
:param config: A data frame analytics config as described in create data frame
|
|
@@ -2870,7 +2870,7 @@ class MlClient(NamespacedClient):
|
|
|
2870
2870
|
"""
|
|
2871
2871
|
Previews a datafeed.
|
|
2872
2872
|
|
|
2873
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2873
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-preview-datafeed.html>`_
|
|
2874
2874
|
|
|
2875
2875
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
2876
2876
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -2946,7 +2946,7 @@ class MlClient(NamespacedClient):
|
|
|
2946
2946
|
"""
|
|
2947
2947
|
Instantiates a calendar.
|
|
2948
2948
|
|
|
2949
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2949
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-put-calendar.html>`_
|
|
2950
2950
|
|
|
2951
2951
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
2952
2952
|
:param description: A description of the calendar.
|
|
@@ -3000,7 +3000,7 @@ class MlClient(NamespacedClient):
|
|
|
3000
3000
|
"""
|
|
3001
3001
|
Adds an anomaly detection job to a calendar.
|
|
3002
3002
|
|
|
3003
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3003
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-put-calendar-job.html>`_
|
|
3004
3004
|
|
|
3005
3005
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
3006
3006
|
:param job_id: An identifier for the anomaly detection jobs. It can be a job
|
|
@@ -3072,7 +3072,7 @@ class MlClient(NamespacedClient):
|
|
|
3072
3072
|
"""
|
|
3073
3073
|
Instantiates a data frame analytics job.
|
|
3074
3074
|
|
|
3075
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3075
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-dfanalytics.html>`_
|
|
3076
3076
|
|
|
3077
3077
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
3078
3078
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -3240,7 +3240,7 @@ class MlClient(NamespacedClient):
|
|
|
3240
3240
|
"""
|
|
3241
3241
|
Instantiates a datafeed.
|
|
3242
3242
|
|
|
3243
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3243
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-put-datafeed.html>`_
|
|
3244
3244
|
|
|
3245
3245
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
3246
3246
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -3393,7 +3393,7 @@ class MlClient(NamespacedClient):
|
|
|
3393
3393
|
"""
|
|
3394
3394
|
Instantiates a filter.
|
|
3395
3395
|
|
|
3396
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3396
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-put-filter.html>`_
|
|
3397
3397
|
|
|
3398
3398
|
:param filter_id: A string that uniquely identifies a filter.
|
|
3399
3399
|
:param description: A description of the filter.
|
|
@@ -3479,7 +3479,7 @@ class MlClient(NamespacedClient):
|
|
|
3479
3479
|
"""
|
|
3480
3480
|
Instantiates an anomaly detection job.
|
|
3481
3481
|
|
|
3482
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3482
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-put-job.html>`_
|
|
3483
3483
|
|
|
3484
3484
|
:param job_id: The identifier for the anomaly detection job. This identifier
|
|
3485
3485
|
can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
|
|
@@ -3659,7 +3659,7 @@ class MlClient(NamespacedClient):
|
|
|
3659
3659
|
"""
|
|
3660
3660
|
Creates an inference trained model.
|
|
3661
3661
|
|
|
3662
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3662
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-trained-models.html>`_
|
|
3663
3663
|
|
|
3664
3664
|
:param model_id: The unique identifier of the trained model.
|
|
3665
3665
|
:param compressed_definition: The compressed (GZipped and Base64 encoded) inference
|
|
@@ -3762,7 +3762,7 @@ class MlClient(NamespacedClient):
|
|
|
3762
3762
|
Creates a new model alias (or reassigns an existing one) to refer to the trained
|
|
3763
3763
|
model
|
|
3764
3764
|
|
|
3765
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3765
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-trained-models-aliases.html>`_
|
|
3766
3766
|
|
|
3767
3767
|
:param model_id: The identifier for the trained model that the alias refers to.
|
|
3768
3768
|
:param model_alias: The alias to create or update. This value cannot end in numbers.
|
|
@@ -3820,7 +3820,7 @@ class MlClient(NamespacedClient):
|
|
|
3820
3820
|
"""
|
|
3821
3821
|
Creates part of a trained model definition
|
|
3822
3822
|
|
|
3823
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3823
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-trained-model-definition-part.html>`_
|
|
3824
3824
|
|
|
3825
3825
|
:param model_id: The unique identifier of the trained model.
|
|
3826
3826
|
:param part: The definition part number. When the definition is loaded for inference
|
|
@@ -3897,7 +3897,7 @@ class MlClient(NamespacedClient):
|
|
|
3897
3897
|
"""
|
|
3898
3898
|
Creates a trained model vocabulary
|
|
3899
3899
|
|
|
3900
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3900
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-trained-model-vocabulary.html>`_
|
|
3901
3901
|
|
|
3902
3902
|
:param model_id: The unique identifier of the trained model.
|
|
3903
3903
|
:param vocabulary: The model vocabulary, which must not be empty.
|
|
@@ -3953,7 +3953,7 @@ class MlClient(NamespacedClient):
|
|
|
3953
3953
|
"""
|
|
3954
3954
|
Resets an existing anomaly detection job.
|
|
3955
3955
|
|
|
3956
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3956
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-reset-job.html>`_
|
|
3957
3957
|
|
|
3958
3958
|
:param job_id: The ID of the job to reset.
|
|
3959
3959
|
:param delete_user_annotations: Specifies whether annotations that have been
|
|
@@ -4007,7 +4007,7 @@ class MlClient(NamespacedClient):
|
|
|
4007
4007
|
"""
|
|
4008
4008
|
Reverts to a specific snapshot.
|
|
4009
4009
|
|
|
4010
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4010
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-revert-snapshot.html>`_
|
|
4011
4011
|
|
|
4012
4012
|
:param job_id: Identifier for the anomaly detection job.
|
|
4013
4013
|
:param snapshot_id: You can specify `empty` as the <snapshot_id>. Reverting to
|
|
@@ -4068,7 +4068,7 @@ class MlClient(NamespacedClient):
|
|
|
4068
4068
|
Sets a cluster wide upgrade_mode setting that prepares machine learning indices
|
|
4069
4069
|
for an upgrade.
|
|
4070
4070
|
|
|
4071
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4071
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-set-upgrade-mode.html>`_
|
|
4072
4072
|
|
|
4073
4073
|
:param enabled: When `true`, it enables `upgrade_mode` which temporarily halts
|
|
4074
4074
|
all job and datafeed tasks and prohibits new job and datafeed tasks from
|
|
@@ -4114,7 +4114,7 @@ class MlClient(NamespacedClient):
|
|
|
4114
4114
|
"""
|
|
4115
4115
|
Starts a data frame analytics job.
|
|
4116
4116
|
|
|
4117
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4117
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/start-dfanalytics.html>`_
|
|
4118
4118
|
|
|
4119
4119
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
4120
4120
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -4166,7 +4166,7 @@ class MlClient(NamespacedClient):
|
|
|
4166
4166
|
"""
|
|
4167
4167
|
Starts one or more datafeeds.
|
|
4168
4168
|
|
|
4169
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4169
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-start-datafeed.html>`_
|
|
4170
4170
|
|
|
4171
4171
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
4172
4172
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -4235,7 +4235,7 @@ class MlClient(NamespacedClient):
|
|
|
4235
4235
|
"""
|
|
4236
4236
|
Start a trained model deployment.
|
|
4237
4237
|
|
|
4238
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4238
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/start-trained-model-deployment.html>`_
|
|
4239
4239
|
|
|
4240
4240
|
:param model_id: The unique identifier of the trained model. Currently, only
|
|
4241
4241
|
PyTorch models are supported.
|
|
@@ -4318,7 +4318,7 @@ class MlClient(NamespacedClient):
|
|
|
4318
4318
|
"""
|
|
4319
4319
|
Stops one or more data frame analytics jobs.
|
|
4320
4320
|
|
|
4321
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4321
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/stop-dfanalytics.html>`_
|
|
4322
4322
|
|
|
4323
4323
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
4324
4324
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -4383,7 +4383,7 @@ class MlClient(NamespacedClient):
|
|
|
4383
4383
|
"""
|
|
4384
4384
|
Stops one or more datafeeds.
|
|
4385
4385
|
|
|
4386
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4386
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-stop-datafeed.html>`_
|
|
4387
4387
|
|
|
4388
4388
|
:param datafeed_id: Identifier for the datafeed. You can stop multiple datafeeds
|
|
4389
4389
|
in a single API request by using a comma-separated list of datafeeds or a
|
|
@@ -4445,7 +4445,7 @@ class MlClient(NamespacedClient):
|
|
|
4445
4445
|
"""
|
|
4446
4446
|
Stop a trained model deployment.
|
|
4447
4447
|
|
|
4448
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4448
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/stop-trained-model-deployment.html>`_
|
|
4449
4449
|
|
|
4450
4450
|
:param model_id: The unique identifier of the trained model.
|
|
4451
4451
|
:param allow_no_match: Specifies what to do when the request: contains wildcard
|
|
@@ -4510,7 +4510,7 @@ class MlClient(NamespacedClient):
|
|
|
4510
4510
|
"""
|
|
4511
4511
|
Updates certain properties of a data frame analytics job.
|
|
4512
4512
|
|
|
4513
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4513
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/update-dfanalytics.html>`_
|
|
4514
4514
|
|
|
4515
4515
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
4516
4516
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -4618,7 +4618,7 @@ class MlClient(NamespacedClient):
|
|
|
4618
4618
|
"""
|
|
4619
4619
|
Updates certain properties of a datafeed.
|
|
4620
4620
|
|
|
4621
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4621
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-update-datafeed.html>`_
|
|
4622
4622
|
|
|
4623
4623
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
4624
4624
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -4781,7 +4781,7 @@ class MlClient(NamespacedClient):
|
|
|
4781
4781
|
"""
|
|
4782
4782
|
Updates the description of a filter, adds items, or removes items.
|
|
4783
4783
|
|
|
4784
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4784
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-update-filter.html>`_
|
|
4785
4785
|
|
|
4786
4786
|
:param filter_id: A string that uniquely identifies a filter.
|
|
4787
4787
|
:param add_items: The items to add to the filter.
|
|
@@ -4871,7 +4871,7 @@ class MlClient(NamespacedClient):
|
|
|
4871
4871
|
"""
|
|
4872
4872
|
Updates certain properties of an anomaly detection job.
|
|
4873
4873
|
|
|
4874
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4874
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-update-job.html>`_
|
|
4875
4875
|
|
|
4876
4876
|
:param job_id: Identifier for the job.
|
|
4877
4877
|
:param allow_lazy_open: Advanced configuration option. Specifies whether this
|
|
@@ -4999,7 +4999,7 @@ class MlClient(NamespacedClient):
|
|
|
4999
4999
|
"""
|
|
5000
5000
|
Updates certain properties of a snapshot.
|
|
5001
5001
|
|
|
5002
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5002
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-update-snapshot.html>`_
|
|
5003
5003
|
|
|
5004
5004
|
:param job_id: Identifier for the anomaly detection job.
|
|
5005
5005
|
:param snapshot_id: Identifier for the model snapshot.
|
|
@@ -5043,6 +5043,62 @@ class MlClient(NamespacedClient):
|
|
|
5043
5043
|
path_parts=__path_parts,
|
|
5044
5044
|
)
|
|
5045
5045
|
|
|
5046
|
+
@_rewrite_parameters(
|
|
5047
|
+
body_fields=("number_of_allocations",),
|
|
5048
|
+
)
|
|
5049
|
+
async def update_trained_model_deployment(
|
|
5050
|
+
self,
|
|
5051
|
+
*,
|
|
5052
|
+
model_id: str,
|
|
5053
|
+
error_trace: t.Optional[bool] = None,
|
|
5054
|
+
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
5055
|
+
human: t.Optional[bool] = None,
|
|
5056
|
+
number_of_allocations: t.Optional[int] = None,
|
|
5057
|
+
pretty: t.Optional[bool] = None,
|
|
5058
|
+
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
5059
|
+
) -> ObjectApiResponse[t.Any]:
|
|
5060
|
+
"""
|
|
5061
|
+
Updates certain properties of trained model deployment.
|
|
5062
|
+
|
|
5063
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/update-trained-model-deployment.html>`_
|
|
5064
|
+
|
|
5065
|
+
:param model_id: The unique identifier of the trained model. Currently, only
|
|
5066
|
+
PyTorch models are supported.
|
|
5067
|
+
:param number_of_allocations: The number of model allocations on each node where
|
|
5068
|
+
the model is deployed. All allocations on a node share the same copy of the
|
|
5069
|
+
model in memory but use a separate set of threads to evaluate the model.
|
|
5070
|
+
Increasing this value generally increases the throughput. If this setting
|
|
5071
|
+
is greater than the number of hardware threads it will automatically be changed
|
|
5072
|
+
to a value less than the number of hardware threads.
|
|
5073
|
+
"""
|
|
5074
|
+
if model_id in SKIP_IN_PATH:
|
|
5075
|
+
raise ValueError("Empty value passed for parameter 'model_id'")
|
|
5076
|
+
__path_parts: t.Dict[str, str] = {"model_id": _quote(model_id)}
|
|
5077
|
+
__path = f'/_ml/trained_models/{__path_parts["model_id"]}/deployment/_update'
|
|
5078
|
+
__query: t.Dict[str, t.Any] = {}
|
|
5079
|
+
__body: t.Dict[str, t.Any] = body if body is not None else {}
|
|
5080
|
+
if error_trace is not None:
|
|
5081
|
+
__query["error_trace"] = error_trace
|
|
5082
|
+
if filter_path is not None:
|
|
5083
|
+
__query["filter_path"] = filter_path
|
|
5084
|
+
if human is not None:
|
|
5085
|
+
__query["human"] = human
|
|
5086
|
+
if pretty is not None:
|
|
5087
|
+
__query["pretty"] = pretty
|
|
5088
|
+
if not __body:
|
|
5089
|
+
if number_of_allocations is not None:
|
|
5090
|
+
__body["number_of_allocations"] = number_of_allocations
|
|
5091
|
+
__headers = {"accept": "application/json", "content-type": "application/json"}
|
|
5092
|
+
return await self.perform_request( # type: ignore[return-value]
|
|
5093
|
+
"POST",
|
|
5094
|
+
__path,
|
|
5095
|
+
params=__query,
|
|
5096
|
+
headers=__headers,
|
|
5097
|
+
body=__body,
|
|
5098
|
+
endpoint_id="ml.update_trained_model_deployment",
|
|
5099
|
+
path_parts=__path_parts,
|
|
5100
|
+
)
|
|
5101
|
+
|
|
5046
5102
|
@_rewrite_parameters()
|
|
5047
5103
|
async def upgrade_job_snapshot(
|
|
5048
5104
|
self,
|
|
@@ -5059,7 +5115,7 @@ class MlClient(NamespacedClient):
|
|
|
5059
5115
|
"""
|
|
5060
5116
|
Upgrades a given job snapshot to the current major version.
|
|
5061
5117
|
|
|
5062
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5118
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ml-upgrade-job-model-snapshot.html>`_
|
|
5063
5119
|
|
|
5064
5120
|
:param job_id: Identifier for the anomaly detection job.
|
|
5065
5121
|
:param snapshot_id: A numerical character string that uniquely identifies the
|
|
@@ -5135,7 +5191,7 @@ class MlClient(NamespacedClient):
|
|
|
5135
5191
|
"""
|
|
5136
5192
|
Validates an anomaly detection job.
|
|
5137
5193
|
|
|
5138
|
-
`<https://www.elastic.co/guide/en/machine-learning/8.
|
|
5194
|
+
`<https://www.elastic.co/guide/en/machine-learning/8.14/ml-jobs.html>`_
|
|
5139
5195
|
|
|
5140
5196
|
:param analysis_config:
|
|
5141
5197
|
:param analysis_limits:
|
|
@@ -5205,7 +5261,7 @@ class MlClient(NamespacedClient):
|
|
|
5205
5261
|
"""
|
|
5206
5262
|
Validates an anomaly detection detector.
|
|
5207
5263
|
|
|
5208
|
-
`<https://www.elastic.co/guide/en/machine-learning/8.
|
|
5264
|
+
`<https://www.elastic.co/guide/en/machine-learning/8.14/ml-jobs.html>`_
|
|
5209
5265
|
|
|
5210
5266
|
:param detector:
|
|
5211
5267
|
"""
|