elasticsearch 8.18.1__py3-none-any.whl → 8.19.1__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 +68 -82
- elasticsearch/_async/client/async_search.py +5 -9
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +744 -75
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +38 -24
- elasticsearch/_async/client/connector.py +30 -30
- elasticsearch/_async/client/dangling_indices.py +3 -3
- elasticsearch/_async/client/enrich.py +5 -5
- elasticsearch/_async/client/eql.py +13 -5
- elasticsearch/_async/client/esql.py +54 -15
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +13 -13
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +11 -11
- elasticsearch/_async/client/indices.py +132 -83
- elasticsearch/_async/client/inference.py +519 -112
- elasticsearch/_async/client/ingest.py +9 -16
- elasticsearch/_async/client/license.py +10 -10
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +76 -88
- elasticsearch/_async/client/nodes.py +9 -8
- elasticsearch/_async/client/query_rules.py +8 -8
- elasticsearch/_async/client/rollup.py +8 -8
- elasticsearch/_async/client/search_application.py +10 -10
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +72 -80
- elasticsearch/_async/client/shutdown.py +3 -3
- elasticsearch/_async/client/simulate.py +1 -1
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +286 -130
- elasticsearch/_async/client/sql.py +7 -7
- 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 +4 -4
- elasticsearch/_async/client/transform.py +69 -9
- elasticsearch/_async/client/xpack.py +1 -1
- elasticsearch/_sync/client/__init__.py +68 -82
- elasticsearch/_sync/client/async_search.py +5 -9
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +744 -75
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +38 -24
- elasticsearch/_sync/client/connector.py +30 -30
- elasticsearch/_sync/client/dangling_indices.py +3 -3
- elasticsearch/_sync/client/enrich.py +5 -5
- elasticsearch/_sync/client/eql.py +13 -5
- elasticsearch/_sync/client/esql.py +54 -15
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +13 -13
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +11 -11
- elasticsearch/_sync/client/indices.py +132 -83
- elasticsearch/_sync/client/inference.py +519 -112
- elasticsearch/_sync/client/ingest.py +9 -16
- elasticsearch/_sync/client/license.py +10 -10
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +76 -88
- elasticsearch/_sync/client/nodes.py +9 -8
- elasticsearch/_sync/client/query_rules.py +8 -8
- elasticsearch/_sync/client/rollup.py +8 -8
- elasticsearch/_sync/client/search_application.py +10 -10
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +72 -80
- elasticsearch/_sync/client/shutdown.py +3 -3
- elasticsearch/_sync/client/simulate.py +1 -1
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +286 -130
- elasticsearch/_sync/client/sql.py +7 -7
- 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 +4 -4
- elasticsearch/_sync/client/transform.py +69 -9
- elasticsearch/_sync/client/xpack.py +1 -1
- elasticsearch/_version.py +1 -1
- elasticsearch/compat.py +5 -0
- elasticsearch/dsl/__init__.py +2 -1
- elasticsearch/dsl/_async/document.py +85 -1
- elasticsearch/dsl/_sync/document.py +85 -1
- elasticsearch/dsl/aggs.py +22 -3
- elasticsearch/dsl/document_base.py +219 -16
- elasticsearch/dsl/field.py +272 -48
- elasticsearch/dsl/query.py +49 -4
- elasticsearch/dsl/response/aggs.py +1 -1
- elasticsearch/dsl/types.py +247 -27
- elasticsearch/dsl/utils.py +2 -2
- elasticsearch/esql/__init__.py +19 -0
- elasticsearch/esql/esql.py +1156 -0
- elasticsearch/esql/functions.py +1750 -0
- elasticsearch/exceptions.py +2 -0
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.dist-info}/METADATA +1 -5
- elasticsearch-8.19.1.dist-info/RECORD +164 -0
- elasticsearch-8.18.1.dist-info/RECORD +0 -163
- elasticsearch-8.18.1.dist-info/licenses/LICENSE.txt +0 -175
- elasticsearch-8.18.1.dist-info/licenses/NOTICE.txt +0 -559
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.dist-info}/WHEEL +0 -0
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.18.1.dist-info → elasticsearch-8.19.1.dist-info}/licenses/NOTICE +0 -0
|
@@ -45,7 +45,7 @@ class MlClient(NamespacedClient):
|
|
|
45
45
|
Calling this API clears the caches without restarting the deployment.</p>
|
|
46
46
|
|
|
47
47
|
|
|
48
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
48
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/clear-trained-model-deployment-cache.html>`_
|
|
49
49
|
|
|
50
50
|
:param model_id: The unique identifier of the trained model.
|
|
51
51
|
"""
|
|
@@ -100,7 +100,7 @@ class MlClient(NamespacedClient):
|
|
|
100
100
|
When a datafeed that has a specified end date stops, it automatically closes its associated job.</p>
|
|
101
101
|
|
|
102
102
|
|
|
103
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
103
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-close-job.html>`_
|
|
104
104
|
|
|
105
105
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
106
106
|
a group name, or a wildcard expression. You can close multiple anomaly detection
|
|
@@ -165,7 +165,7 @@ class MlClient(NamespacedClient):
|
|
|
165
165
|
<p>Remove all scheduled events from a calendar, then delete it.</p>
|
|
166
166
|
|
|
167
167
|
|
|
168
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
168
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-calendar.html>`_
|
|
169
169
|
|
|
170
170
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
171
171
|
"""
|
|
@@ -209,7 +209,7 @@ class MlClient(NamespacedClient):
|
|
|
209
209
|
<p>Delete events from a calendar.</p>
|
|
210
210
|
|
|
211
211
|
|
|
212
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
212
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-calendar-event.html>`_
|
|
213
213
|
|
|
214
214
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
215
215
|
:param event_id: Identifier for the scheduled event. You can obtain this identifier
|
|
@@ -260,7 +260,7 @@ class MlClient(NamespacedClient):
|
|
|
260
260
|
<p>Delete anomaly jobs from a calendar.</p>
|
|
261
261
|
|
|
262
262
|
|
|
263
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
263
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-calendar-job.html>`_
|
|
264
264
|
|
|
265
265
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
266
266
|
:param job_id: An identifier for the anomaly detection jobs. It can be a job
|
|
@@ -312,7 +312,7 @@ class MlClient(NamespacedClient):
|
|
|
312
312
|
<p>Delete a data frame analytics job.</p>
|
|
313
313
|
|
|
314
314
|
|
|
315
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
315
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-dfanalytics.html>`_
|
|
316
316
|
|
|
317
317
|
:param id: Identifier for the data frame analytics job.
|
|
318
318
|
:param force: If `true`, it deletes a job that is not stopped; this method is
|
|
@@ -363,7 +363,7 @@ class MlClient(NamespacedClient):
|
|
|
363
363
|
<p>Delete a datafeed.</p>
|
|
364
364
|
|
|
365
365
|
|
|
366
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
366
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-datafeed.html>`_
|
|
367
367
|
|
|
368
368
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
369
369
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -426,7 +426,7 @@ class MlClient(NamespacedClient):
|
|
|
426
426
|
<code><job_id></code>.</p>
|
|
427
427
|
|
|
428
428
|
|
|
429
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
429
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-expired-data.html>`_
|
|
430
430
|
|
|
431
431
|
:param job_id: Identifier for an anomaly detection job. It can be a job identifier,
|
|
432
432
|
a group name, or a wildcard expression.
|
|
@@ -490,7 +490,7 @@ class MlClient(NamespacedClient):
|
|
|
490
490
|
filter. You must update or delete the job before you can delete the filter.</p>
|
|
491
491
|
|
|
492
492
|
|
|
493
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
493
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-filter.html>`_
|
|
494
494
|
|
|
495
495
|
:param filter_id: A string that uniquely identifies a filter.
|
|
496
496
|
"""
|
|
@@ -540,7 +540,7 @@ class MlClient(NamespacedClient):
|
|
|
540
540
|
forecasts before they expire.</p>
|
|
541
541
|
|
|
542
542
|
|
|
543
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
543
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-forecast.html>`_
|
|
544
544
|
|
|
545
545
|
:param job_id: Identifier for the anomaly detection job.
|
|
546
546
|
:param forecast_id: A comma-separated list of forecast identifiers. If you do
|
|
@@ -616,7 +616,7 @@ class MlClient(NamespacedClient):
|
|
|
616
616
|
delete job request.</p>
|
|
617
617
|
|
|
618
618
|
|
|
619
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
619
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-job.html>`_
|
|
620
620
|
|
|
621
621
|
:param job_id: Identifier for the anomaly detection job.
|
|
622
622
|
:param delete_user_annotations: Specifies whether annotations that have been
|
|
@@ -676,7 +676,7 @@ class MlClient(NamespacedClient):
|
|
|
676
676
|
the <code>model_snapshot_id</code> in the results from the get jobs API.</p>
|
|
677
677
|
|
|
678
678
|
|
|
679
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
679
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-delete-snapshot.html>`_
|
|
680
680
|
|
|
681
681
|
:param job_id: Identifier for the anomaly detection job.
|
|
682
682
|
:param snapshot_id: Identifier for the model snapshot.
|
|
@@ -728,7 +728,7 @@ class MlClient(NamespacedClient):
|
|
|
728
728
|
<p>The request deletes a trained inference model that is not referenced by an ingest pipeline.</p>
|
|
729
729
|
|
|
730
730
|
|
|
731
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
731
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-trained-models.html>`_
|
|
732
732
|
|
|
733
733
|
:param model_id: The unique identifier of the trained model.
|
|
734
734
|
:param force: Forcefully deletes a trained model that is referenced by ingest
|
|
@@ -783,7 +783,7 @@ class MlClient(NamespacedClient):
|
|
|
783
783
|
by the <code>model_id</code>, this API returns an error.</p>
|
|
784
784
|
|
|
785
785
|
|
|
786
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
786
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-trained-models-aliases.html>`_
|
|
787
787
|
|
|
788
788
|
:param model_id: The trained model ID to which the model alias refers.
|
|
789
789
|
:param model_alias: The model alias to delete.
|
|
@@ -844,7 +844,7 @@ class MlClient(NamespacedClient):
|
|
|
844
844
|
estimates for the fields it references.</p>
|
|
845
845
|
|
|
846
846
|
|
|
847
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
847
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-estimate-model-memory.html>`_
|
|
848
848
|
|
|
849
849
|
:param analysis_config: For a list of the properties that you can specify in
|
|
850
850
|
the `analysis_config` component of the body of this API.
|
|
@@ -916,7 +916,7 @@ class MlClient(NamespacedClient):
|
|
|
916
916
|
field and an analytics result field to be present.</p>
|
|
917
917
|
|
|
918
918
|
|
|
919
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
919
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/evaluate-dfanalytics.html>`_
|
|
920
920
|
|
|
921
921
|
:param evaluation: Defines the type of evaluation you want to perform.
|
|
922
922
|
:param index: Defines the `index` in which the evaluation will be performed.
|
|
@@ -1001,7 +1001,7 @@ class MlClient(NamespacedClient):
|
|
|
1001
1001
|
</ul>
|
|
1002
1002
|
|
|
1003
1003
|
|
|
1004
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1004
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/explain-dfanalytics.html>`_
|
|
1005
1005
|
|
|
1006
1006
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
1007
1007
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -1112,7 +1112,7 @@ class MlClient(NamespacedClient):
|
|
|
1112
1112
|
analyzing further data.</p>
|
|
1113
1113
|
|
|
1114
1114
|
|
|
1115
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1115
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-flush-job.html>`_
|
|
1116
1116
|
|
|
1117
1117
|
:param job_id: Identifier for the anomaly detection job.
|
|
1118
1118
|
:param advance_time: Refer to the description for the `advance_time` query parameter.
|
|
@@ -1187,7 +1187,7 @@ class MlClient(NamespacedClient):
|
|
|
1187
1187
|
based on historical data.</p>
|
|
1188
1188
|
|
|
1189
1189
|
|
|
1190
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1190
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-forecast.html>`_
|
|
1191
1191
|
|
|
1192
1192
|
:param job_id: Identifier for the anomaly detection job. The job must be open
|
|
1193
1193
|
when you create a forecast; otherwise, an error occurs.
|
|
@@ -1273,7 +1273,7 @@ class MlClient(NamespacedClient):
|
|
|
1273
1273
|
The API presents a chronological view of the records, grouped by bucket.</p>
|
|
1274
1274
|
|
|
1275
1275
|
|
|
1276
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1276
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-bucket.html>`_
|
|
1277
1277
|
|
|
1278
1278
|
:param job_id: Identifier for the anomaly detection job.
|
|
1279
1279
|
:param timestamp: The timestamp of a single bucket result. If you do not specify
|
|
@@ -1371,7 +1371,7 @@ class MlClient(NamespacedClient):
|
|
|
1371
1371
|
<p>Get info about events in calendars.</p>
|
|
1372
1372
|
|
|
1373
1373
|
|
|
1374
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1374
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-calendar-event.html>`_
|
|
1375
1375
|
|
|
1376
1376
|
:param calendar_id: A string that uniquely identifies a calendar. You can get
|
|
1377
1377
|
information for multiple calendars by using a comma-separated list of ids
|
|
@@ -1440,7 +1440,7 @@ class MlClient(NamespacedClient):
|
|
|
1440
1440
|
<p>Get calendar configuration info.</p>
|
|
1441
1441
|
|
|
1442
1442
|
|
|
1443
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1443
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-calendar.html>`_
|
|
1444
1444
|
|
|
1445
1445
|
:param calendar_id: A string that uniquely identifies a calendar. You can get
|
|
1446
1446
|
information for multiple calendars by using a comma-separated list of ids
|
|
@@ -1516,7 +1516,7 @@ class MlClient(NamespacedClient):
|
|
|
1516
1516
|
<p>Get anomaly detection job results for categories.</p>
|
|
1517
1517
|
|
|
1518
1518
|
|
|
1519
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1519
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-category.html>`_
|
|
1520
1520
|
|
|
1521
1521
|
:param job_id: Identifier for the anomaly detection job.
|
|
1522
1522
|
:param category_id: Identifier for the category, which is unique in the job.
|
|
@@ -1604,7 +1604,7 @@ class MlClient(NamespacedClient):
|
|
|
1604
1604
|
wildcard expression.</p>
|
|
1605
1605
|
|
|
1606
1606
|
|
|
1607
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1607
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-dfanalytics.html>`_
|
|
1608
1608
|
|
|
1609
1609
|
:param id: Identifier for the data frame analytics job. If you do not specify
|
|
1610
1610
|
this option, the API returns information for the first hundred data frame
|
|
@@ -1679,7 +1679,7 @@ class MlClient(NamespacedClient):
|
|
|
1679
1679
|
<p>Get data frame analytics job stats.</p>
|
|
1680
1680
|
|
|
1681
1681
|
|
|
1682
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1682
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-dfanalytics-stats.html>`_
|
|
1683
1683
|
|
|
1684
1684
|
:param id: Identifier for the data frame analytics job. If you do not specify
|
|
1685
1685
|
this option, the API returns information for the first hundred data frame
|
|
@@ -1753,7 +1753,7 @@ class MlClient(NamespacedClient):
|
|
|
1753
1753
|
This API returns a maximum of 10,000 datafeeds.</p>
|
|
1754
1754
|
|
|
1755
1755
|
|
|
1756
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1756
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-datafeed-stats.html>`_
|
|
1757
1757
|
|
|
1758
1758
|
:param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier
|
|
1759
1759
|
or a wildcard expression. If you do not specify one of these options, the
|
|
@@ -1817,7 +1817,7 @@ class MlClient(NamespacedClient):
|
|
|
1817
1817
|
This API returns a maximum of 10,000 datafeeds.</p>
|
|
1818
1818
|
|
|
1819
1819
|
|
|
1820
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1820
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-datafeed.html>`_
|
|
1821
1821
|
|
|
1822
1822
|
:param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier
|
|
1823
1823
|
or a wildcard expression. If you do not specify one of these options, the
|
|
@@ -1884,7 +1884,7 @@ class MlClient(NamespacedClient):
|
|
|
1884
1884
|
You can get a single filter or all filters.</p>
|
|
1885
1885
|
|
|
1886
1886
|
|
|
1887
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1887
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-filter.html>`_
|
|
1888
1888
|
|
|
1889
1889
|
:param filter_id: A string that uniquely identifies a filter.
|
|
1890
1890
|
:param from_: Skips the specified number of filters.
|
|
@@ -1952,7 +1952,7 @@ class MlClient(NamespacedClient):
|
|
|
1952
1952
|
<code>influencer_field_name</code> is specified in the job configuration.</p>
|
|
1953
1953
|
|
|
1954
1954
|
|
|
1955
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1955
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-influencer.html>`_
|
|
1956
1956
|
|
|
1957
1957
|
:param job_id: Identifier for the anomaly detection job.
|
|
1958
1958
|
:param desc: If true, the results are sorted in descending order.
|
|
@@ -2036,7 +2036,7 @@ class MlClient(NamespacedClient):
|
|
|
2036
2036
|
<p>Get anomaly detection job stats.</p>
|
|
2037
2037
|
|
|
2038
2038
|
|
|
2039
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2039
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-job-stats.html>`_
|
|
2040
2040
|
|
|
2041
2041
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
2042
2042
|
a group name, a comma-separated list of jobs, or a wildcard expression. If
|
|
@@ -2100,7 +2100,7 @@ class MlClient(NamespacedClient):
|
|
|
2100
2100
|
<code>_all</code>, by specifying <code>*</code> as the <code><job_id></code>, or by omitting the <code><job_id></code>.</p>
|
|
2101
2101
|
|
|
2102
2102
|
|
|
2103
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2103
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-job.html>`_
|
|
2104
2104
|
|
|
2105
2105
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
2106
2106
|
a group name, or a wildcard expression. If you do not specify one of these
|
|
@@ -2166,7 +2166,7 @@ class MlClient(NamespacedClient):
|
|
|
2166
2166
|
on each node, both within the JVM heap, and natively, outside of the JVM.</p>
|
|
2167
2167
|
|
|
2168
2168
|
|
|
2169
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2169
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-ml-memory.html>`_
|
|
2170
2170
|
|
|
2171
2171
|
:param node_id: The names of particular nodes in the cluster to target. For example,
|
|
2172
2172
|
`nodeId1,nodeId2` or `ml:true`
|
|
@@ -2224,7 +2224,7 @@ class MlClient(NamespacedClient):
|
|
|
2224
2224
|
<p>Get anomaly detection job model snapshot upgrade usage info.</p>
|
|
2225
2225
|
|
|
2226
2226
|
|
|
2227
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2227
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-job-model-snapshot-upgrade-stats.html>`_
|
|
2228
2228
|
|
|
2229
2229
|
:param job_id: Identifier for the anomaly detection job.
|
|
2230
2230
|
:param snapshot_id: A numerical character string that uniquely identifies the
|
|
@@ -2298,7 +2298,7 @@ class MlClient(NamespacedClient):
|
|
|
2298
2298
|
<p>Get model snapshots info.</p>
|
|
2299
2299
|
|
|
2300
2300
|
|
|
2301
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2301
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-snapshot.html>`_
|
|
2302
2302
|
|
|
2303
2303
|
:param job_id: Identifier for the anomaly detection job.
|
|
2304
2304
|
:param snapshot_id: A numerical character string that uniquely identifies the
|
|
@@ -2418,7 +2418,7 @@ class MlClient(NamespacedClient):
|
|
|
2418
2418
|
jobs' largest bucket span.</p>
|
|
2419
2419
|
|
|
2420
2420
|
|
|
2421
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2421
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-overall-buckets.html>`_
|
|
2422
2422
|
|
|
2423
2423
|
:param job_id: Identifier for the anomaly detection job. It can be a job identifier,
|
|
2424
2424
|
a group name, a comma-separated list of jobs or groups, or a wildcard expression.
|
|
@@ -2528,7 +2528,7 @@ class MlClient(NamespacedClient):
|
|
|
2528
2528
|
number of detectors.</p>
|
|
2529
2529
|
|
|
2530
2530
|
|
|
2531
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2531
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-get-record.html>`_
|
|
2532
2532
|
|
|
2533
2533
|
:param job_id: Identifier for the anomaly detection job.
|
|
2534
2534
|
:param desc: Refer to the description for the `desc` query parameter.
|
|
@@ -2627,7 +2627,7 @@ class MlClient(NamespacedClient):
|
|
|
2627
2627
|
<p>Get trained model configuration info.</p>
|
|
2628
2628
|
|
|
2629
2629
|
|
|
2630
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2630
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-trained-models.html>`_
|
|
2631
2631
|
|
|
2632
2632
|
:param model_id: The unique identifier of the trained model or a model alias.
|
|
2633
2633
|
You can get information for multiple trained models in a single API request
|
|
@@ -2718,7 +2718,7 @@ class MlClient(NamespacedClient):
|
|
|
2718
2718
|
models in a single API request by using a comma-separated list of model IDs or a wildcard expression.</p>
|
|
2719
2719
|
|
|
2720
2720
|
|
|
2721
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2721
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-trained-models-stats.html>`_
|
|
2722
2722
|
|
|
2723
2723
|
:param model_id: The unique identifier of the trained model or a model alias.
|
|
2724
2724
|
It can be a comma-separated list or a wildcard expression.
|
|
@@ -2784,7 +2784,7 @@ class MlClient(NamespacedClient):
|
|
|
2784
2784
|
<p>Evaluate a trained model.</p>
|
|
2785
2785
|
|
|
2786
2786
|
|
|
2787
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2787
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-trained-model.html>`_
|
|
2788
2788
|
|
|
2789
2789
|
:param model_id: The unique identifier of the trained model.
|
|
2790
2790
|
:param docs: An array of objects to pass to the model for inference. The objects
|
|
@@ -2851,7 +2851,7 @@ class MlClient(NamespacedClient):
|
|
|
2851
2851
|
cluster configuration.</p>
|
|
2852
2852
|
|
|
2853
2853
|
|
|
2854
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2854
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-ml-info.html>`_
|
|
2855
2855
|
"""
|
|
2856
2856
|
__path_parts: t.Dict[str, str] = {}
|
|
2857
2857
|
__path = "/_ml/info"
|
|
@@ -2900,7 +2900,7 @@ class MlClient(NamespacedClient):
|
|
|
2900
2900
|
new data is received.</p>
|
|
2901
2901
|
|
|
2902
2902
|
|
|
2903
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2903
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-open-job.html>`_
|
|
2904
2904
|
|
|
2905
2905
|
:param job_id: Identifier for the anomaly detection job.
|
|
2906
2906
|
:param timeout: Refer to the description for the `timeout` query parameter.
|
|
@@ -2957,7 +2957,7 @@ class MlClient(NamespacedClient):
|
|
|
2957
2957
|
<p>Add scheduled events to the calendar.</p>
|
|
2958
2958
|
|
|
2959
2959
|
|
|
2960
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2960
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-post-calendar-event.html>`_
|
|
2961
2961
|
|
|
2962
2962
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
2963
2963
|
:param events: A list of one of more scheduled events. The event’s start and
|
|
@@ -3018,7 +3018,7 @@ class MlClient(NamespacedClient):
|
|
|
3018
3018
|
It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.</p>
|
|
3019
3019
|
|
|
3020
3020
|
|
|
3021
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3021
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-post-data.html>`_
|
|
3022
3022
|
|
|
3023
3023
|
:param job_id: Identifier for the anomaly detection job. The job must have a
|
|
3024
3024
|
state of open to receive and process the data.
|
|
@@ -3085,7 +3085,7 @@ class MlClient(NamespacedClient):
|
|
|
3085
3085
|
Preview the extracted features used by a data frame analytics config.</p>
|
|
3086
3086
|
|
|
3087
3087
|
|
|
3088
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3088
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/preview-dfanalytics.html>`_
|
|
3089
3089
|
|
|
3090
3090
|
:param id: Identifier for the data frame analytics job.
|
|
3091
3091
|
:param config: A data frame analytics config as described in create data frame
|
|
@@ -3158,7 +3158,7 @@ class MlClient(NamespacedClient):
|
|
|
3158
3158
|
You can also use secondary authorization headers to supply the credentials.</p>
|
|
3159
3159
|
|
|
3160
3160
|
|
|
3161
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3161
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-preview-datafeed.html>`_
|
|
3162
3162
|
|
|
3163
3163
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
3164
3164
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -3237,7 +3237,7 @@ class MlClient(NamespacedClient):
|
|
|
3237
3237
|
<p>Create a calendar.</p>
|
|
3238
3238
|
|
|
3239
3239
|
|
|
3240
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3240
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-put-calendar.html>`_
|
|
3241
3241
|
|
|
3242
3242
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
3243
3243
|
:param description: A description of the calendar.
|
|
@@ -3294,7 +3294,7 @@ class MlClient(NamespacedClient):
|
|
|
3294
3294
|
<p>Add anomaly detection job to calendar.</p>
|
|
3295
3295
|
|
|
3296
3296
|
|
|
3297
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3297
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-put-calendar-job.html>`_
|
|
3298
3298
|
|
|
3299
3299
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
3300
3300
|
:param job_id: An identifier for the anomaly detection jobs. It can be a job
|
|
@@ -3377,7 +3377,7 @@ class MlClient(NamespacedClient):
|
|
|
3377
3377
|
<p>If you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters.</p>
|
|
3378
3378
|
|
|
3379
3379
|
|
|
3380
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3380
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-dfanalytics.html>`_
|
|
3381
3381
|
|
|
3382
3382
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
3383
3383
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -3562,7 +3562,7 @@ class MlClient(NamespacedClient):
|
|
|
3562
3562
|
directly to the <code>.ml-config</code> index. Do not give users <code>write</code> privileges on the <code>.ml-config</code> index.</p>
|
|
3563
3563
|
|
|
3564
3564
|
|
|
3565
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3565
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-put-datafeed.html>`_
|
|
3566
3566
|
|
|
3567
3567
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
3568
3568
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -3604,11 +3604,11 @@ class MlClient(NamespacedClient):
|
|
|
3604
3604
|
:param ignore_unavailable: If true, unavailable indices (missing or closed) are
|
|
3605
3605
|
ignored.
|
|
3606
3606
|
:param indexes: An array of index names. Wildcards are supported. If any of the
|
|
3607
|
-
indices are in remote clusters, the
|
|
3608
|
-
`remote_cluster_client` role.
|
|
3607
|
+
indices are in remote clusters, the master nodes and the machine learning
|
|
3608
|
+
nodes must have the `remote_cluster_client` role.
|
|
3609
3609
|
:param indices: An array of index names. Wildcards are supported. If any of the
|
|
3610
|
-
indices are in remote clusters, the
|
|
3611
|
-
`remote_cluster_client` role.
|
|
3610
|
+
indices are in remote clusters, the master nodes and the machine learning
|
|
3611
|
+
nodes must have the `remote_cluster_client` role.
|
|
3612
3612
|
:param indices_options: Specifies index expansion options that are used during
|
|
3613
3613
|
search
|
|
3614
3614
|
:param job_id: Identifier for the anomaly detection job.
|
|
@@ -3724,7 +3724,7 @@ class MlClient(NamespacedClient):
|
|
|
3724
3724
|
Specifically, filters are referenced in the <code>custom_rules</code> property of detector configuration objects.</p>
|
|
3725
3725
|
|
|
3726
3726
|
|
|
3727
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3727
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-put-filter.html>`_
|
|
3728
3728
|
|
|
3729
3729
|
:param filter_id: A string that uniquely identifies a filter.
|
|
3730
3730
|
:param description: A description of the filter.
|
|
@@ -3826,7 +3826,7 @@ class MlClient(NamespacedClient):
|
|
|
3826
3826
|
If you include a <code>datafeed_config</code> but do not provide a query, the datafeed uses <code>{"match_all": {"boost": 1}}</code>.</p>
|
|
3827
3827
|
|
|
3828
3828
|
|
|
3829
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3829
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-put-job.html>`_
|
|
3830
3830
|
|
|
3831
3831
|
:param job_id: The identifier for the anomaly detection job. This identifier
|
|
3832
3832
|
can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
|
|
@@ -3876,13 +3876,7 @@ class MlClient(NamespacedClient):
|
|
|
3876
3876
|
:param description: A description of the job.
|
|
3877
3877
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
3878
3878
|
request can target data streams, this argument determines whether wildcard
|
|
3879
|
-
expressions match hidden data streams. Supports comma-separated values.
|
|
3880
|
-
values are: * `all`: Match any data stream or index, including hidden ones.
|
|
3881
|
-
* `closed`: Match closed, non-hidden indices. Also matches any non-hidden
|
|
3882
|
-
data stream. Data streams cannot be closed. * `hidden`: Match hidden data
|
|
3883
|
-
streams and hidden indices. Must be combined with `open`, `closed`, or both.
|
|
3884
|
-
* `none`: Wildcard patterns are not accepted. * `open`: Match open, non-hidden
|
|
3885
|
-
indices. Also matches any non-hidden data stream.
|
|
3879
|
+
expressions match hidden data streams. Supports comma-separated values.
|
|
3886
3880
|
:param groups: A list of job groups. A job can belong to no groups or many.
|
|
3887
3881
|
:param ignore_throttled: If `true`, concrete, expanded or aliased indices are
|
|
3888
3882
|
ignored when frozen.
|
|
@@ -4034,7 +4028,7 @@ class MlClient(NamespacedClient):
|
|
|
4034
4028
|
Enable you to supply a trained model that is not created by data frame analytics.</p>
|
|
4035
4029
|
|
|
4036
4030
|
|
|
4037
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4031
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-trained-models.html>`_
|
|
4038
4032
|
|
|
4039
4033
|
:param model_id: The unique identifier of the trained model.
|
|
4040
4034
|
:param compressed_definition: The compressed (GZipped and Base64 encoded) inference
|
|
@@ -4155,7 +4149,7 @@ class MlClient(NamespacedClient):
|
|
|
4155
4149
|
returns a warning.</p>
|
|
4156
4150
|
|
|
4157
4151
|
|
|
4158
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4152
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-trained-models-aliases.html>`_
|
|
4159
4153
|
|
|
4160
4154
|
:param model_id: The identifier for the trained model that the alias refers to.
|
|
4161
4155
|
:param model_alias: The alias to create or update. This value cannot end in numbers.
|
|
@@ -4216,7 +4210,7 @@ class MlClient(NamespacedClient):
|
|
|
4216
4210
|
<p>Create part of a trained model definition.</p>
|
|
4217
4211
|
|
|
4218
4212
|
|
|
4219
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4213
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-trained-model-definition-part.html>`_
|
|
4220
4214
|
|
|
4221
4215
|
:param model_id: The unique identifier of the trained model.
|
|
4222
4216
|
:param part: The definition part number. When the definition is loaded for inference
|
|
@@ -4298,7 +4292,7 @@ class MlClient(NamespacedClient):
|
|
|
4298
4292
|
The vocabulary is stored in the index as described in <code>inference_config.*.vocabulary</code> of the trained model definition.</p>
|
|
4299
4293
|
|
|
4300
4294
|
|
|
4301
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4295
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-trained-model-vocabulary.html>`_
|
|
4302
4296
|
|
|
4303
4297
|
:param model_id: The unique identifier of the trained model.
|
|
4304
4298
|
:param vocabulary: The model vocabulary, which must not be empty.
|
|
@@ -4361,7 +4355,7 @@ class MlClient(NamespacedClient):
|
|
|
4361
4355
|
comma separated list.</p>
|
|
4362
4356
|
|
|
4363
4357
|
|
|
4364
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4358
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-reset-job.html>`_
|
|
4365
4359
|
|
|
4366
4360
|
:param job_id: The ID of the job to reset.
|
|
4367
4361
|
:param delete_user_annotations: Specifies whether annotations that have been
|
|
@@ -4425,7 +4419,7 @@ class MlClient(NamespacedClient):
|
|
|
4425
4419
|
snapshot after Black Friday or a critical system failure.</p>
|
|
4426
4420
|
|
|
4427
4421
|
|
|
4428
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4422
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-revert-snapshot.html>`_
|
|
4429
4423
|
|
|
4430
4424
|
:param job_id: Identifier for the anomaly detection job.
|
|
4431
4425
|
:param snapshot_id: You can specify `empty` as the <snapshot_id>. Reverting to
|
|
@@ -4500,7 +4494,7 @@ class MlClient(NamespacedClient):
|
|
|
4500
4494
|
machine learning info API.</p>
|
|
4501
4495
|
|
|
4502
4496
|
|
|
4503
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4497
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-set-upgrade-mode.html>`_
|
|
4504
4498
|
|
|
4505
4499
|
:param enabled: When `true`, it enables `upgrade_mode` which temporarily halts
|
|
4506
4500
|
all job and datafeed tasks and prohibits new job and datafeed tasks from
|
|
@@ -4560,7 +4554,7 @@ class MlClient(NamespacedClient):
|
|
|
4560
4554
|
the destination index in advance with custom settings and mappings.</p>
|
|
4561
4555
|
|
|
4562
4556
|
|
|
4563
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4557
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/start-dfanalytics.html>`_
|
|
4564
4558
|
|
|
4565
4559
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
4566
4560
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -4623,7 +4617,7 @@ class MlClient(NamespacedClient):
|
|
|
4623
4617
|
authorization headers when you created or updated the datafeed, those credentials are used instead.</p>
|
|
4624
4618
|
|
|
4625
4619
|
|
|
4626
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4620
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-start-datafeed.html>`_
|
|
4627
4621
|
|
|
4628
4622
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
4629
4623
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -4700,7 +4694,7 @@ class MlClient(NamespacedClient):
|
|
|
4700
4694
|
It allocates the model to every machine learning node.</p>
|
|
4701
4695
|
|
|
4702
4696
|
|
|
4703
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4697
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/start-trained-model-deployment.html>`_
|
|
4704
4698
|
|
|
4705
4699
|
:param model_id: The unique identifier of the trained model. Currently, only
|
|
4706
4700
|
PyTorch models are supported.
|
|
@@ -4801,7 +4795,7 @@ class MlClient(NamespacedClient):
|
|
|
4801
4795
|
throughout its lifecycle.</p>
|
|
4802
4796
|
|
|
4803
4797
|
|
|
4804
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4798
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/stop-dfanalytics.html>`_
|
|
4805
4799
|
|
|
4806
4800
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
4807
4801
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -4871,7 +4865,7 @@ class MlClient(NamespacedClient):
|
|
|
4871
4865
|
multiple times throughout its lifecycle.</p>
|
|
4872
4866
|
|
|
4873
4867
|
|
|
4874
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4868
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-stop-datafeed.html>`_
|
|
4875
4869
|
|
|
4876
4870
|
:param datafeed_id: Identifier for the datafeed. You can stop multiple datafeeds
|
|
4877
4871
|
in a single API request by using a comma-separated list of datafeeds or a
|
|
@@ -4936,7 +4930,7 @@ class MlClient(NamespacedClient):
|
|
|
4936
4930
|
<p>Stop a trained model deployment.</p>
|
|
4937
4931
|
|
|
4938
4932
|
|
|
4939
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4933
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/stop-trained-model-deployment.html>`_
|
|
4940
4934
|
|
|
4941
4935
|
:param model_id: The unique identifier of the trained model.
|
|
4942
4936
|
:param allow_no_match: Specifies what to do when the request: contains wildcard
|
|
@@ -5119,7 +5113,7 @@ class MlClient(NamespacedClient):
|
|
|
5119
5113
|
those credentials are used instead.</p>
|
|
5120
5114
|
|
|
5121
5115
|
|
|
5122
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5116
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-update-datafeed.html>`_
|
|
5123
5117
|
|
|
5124
5118
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
5125
5119
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -5145,13 +5139,7 @@ class MlClient(NamespacedClient):
|
|
|
5145
5139
|
check runs only on real-time datafeeds.
|
|
5146
5140
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
5147
5141
|
request can target data streams, this argument determines whether wildcard
|
|
5148
|
-
expressions match hidden data streams. Supports comma-separated values.
|
|
5149
|
-
values are: * `all`: Match any data stream or index, including hidden ones.
|
|
5150
|
-
* `closed`: Match closed, non-hidden indices. Also matches any non-hidden
|
|
5151
|
-
data stream. Data streams cannot be closed. * `hidden`: Match hidden data
|
|
5152
|
-
streams and hidden indices. Must be combined with `open`, `closed`, or both.
|
|
5153
|
-
* `none`: Wildcard patterns are not accepted. * `open`: Match open, non-hidden
|
|
5154
|
-
indices. Also matches any non-hidden data stream.
|
|
5142
|
+
expressions match hidden data streams. Supports comma-separated values.
|
|
5155
5143
|
:param frequency: The interval at which scheduled queries are made while the
|
|
5156
5144
|
datafeed runs in real time. The default value is either the bucket span for
|
|
5157
5145
|
short bucket spans, or, for longer bucket spans, a sensible fraction of the
|
|
@@ -5286,7 +5274,7 @@ class MlClient(NamespacedClient):
|
|
|
5286
5274
|
Updates the description of a filter, adds items, or removes items from the list.</p>
|
|
5287
5275
|
|
|
5288
5276
|
|
|
5289
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5277
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-update-filter.html>`_
|
|
5290
5278
|
|
|
5291
5279
|
:param filter_id: A string that uniquely identifies a filter.
|
|
5292
5280
|
:param add_items: The items to add to the filter.
|
|
@@ -5380,7 +5368,7 @@ class MlClient(NamespacedClient):
|
|
|
5380
5368
|
Updates certain properties of an anomaly detection job.</p>
|
|
5381
5369
|
|
|
5382
5370
|
|
|
5383
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5371
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-update-job.html>`_
|
|
5384
5372
|
|
|
5385
5373
|
:param job_id: Identifier for the job.
|
|
5386
5374
|
:param allow_lazy_open: Advanced configuration option. Specifies whether this
|
|
@@ -5512,7 +5500,7 @@ class MlClient(NamespacedClient):
|
|
|
5512
5500
|
Updates certain properties of a snapshot.</p>
|
|
5513
5501
|
|
|
5514
5502
|
|
|
5515
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5503
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-update-snapshot.html>`_
|
|
5516
5504
|
|
|
5517
5505
|
:param job_id: Identifier for the anomaly detection job.
|
|
5518
5506
|
:param snapshot_id: Identifier for the model snapshot.
|
|
@@ -5654,7 +5642,7 @@ class MlClient(NamespacedClient):
|
|
|
5654
5642
|
job.</p>
|
|
5655
5643
|
|
|
5656
5644
|
|
|
5657
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5645
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-upgrade-job-model-snapshot.html>`_
|
|
5658
5646
|
|
|
5659
5647
|
:param job_id: Identifier for the anomaly detection job.
|
|
5660
5648
|
:param snapshot_id: A numerical character string that uniquely identifies the
|
|
@@ -5733,7 +5721,7 @@ class MlClient(NamespacedClient):
|
|
|
5733
5721
|
<p>Validate an anomaly detection job.</p>
|
|
5734
5722
|
|
|
5735
5723
|
|
|
5736
|
-
`<https://www.elastic.co/guide/en/machine-learning/8.
|
|
5724
|
+
`<https://www.elastic.co/guide/en/machine-learning/8.19/ml-jobs.html>`_
|
|
5737
5725
|
|
|
5738
5726
|
:param analysis_config:
|
|
5739
5727
|
:param analysis_limits:
|