elasticsearch9 9.0.2__py3-none-any.whl → 9.1.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.
- elasticsearch9/__init__.py +3 -3
- elasticsearch9/_async/client/__init__.py +88 -244
- elasticsearch9/_async/client/async_search.py +4 -4
- elasticsearch9/_async/client/autoscaling.py +4 -4
- elasticsearch9/_async/client/cat.py +419 -51
- elasticsearch9/_async/client/ccr.py +13 -13
- elasticsearch9/_async/client/cluster.py +32 -22
- elasticsearch9/_async/client/connector.py +30 -30
- elasticsearch9/_async/client/dangling_indices.py +3 -3
- elasticsearch9/_async/client/enrich.py +5 -5
- elasticsearch9/_async/client/eql.py +14 -6
- elasticsearch9/_async/client/esql.py +125 -9
- elasticsearch9/_async/client/features.py +2 -2
- elasticsearch9/_async/client/fleet.py +3 -3
- elasticsearch9/_async/client/graph.py +1 -1
- elasticsearch9/_async/client/ilm.py +11 -11
- elasticsearch9/_async/client/indices.py +592 -113
- elasticsearch9/_async/client/inference.py +521 -44
- elasticsearch9/_async/client/ingest.py +9 -16
- elasticsearch9/_async/client/license.py +11 -11
- elasticsearch9/_async/client/logstash.py +3 -3
- elasticsearch9/_async/client/migration.py +3 -3
- elasticsearch9/_async/client/ml.py +75 -87
- elasticsearch9/_async/client/monitoring.py +1 -1
- elasticsearch9/_async/client/nodes.py +7 -7
- elasticsearch9/_async/client/query_rules.py +8 -8
- elasticsearch9/_async/client/rollup.py +9 -30
- elasticsearch9/_async/client/search_application.py +10 -10
- elasticsearch9/_async/client/searchable_snapshots.py +4 -4
- elasticsearch9/_async/client/security.py +79 -81
- elasticsearch9/_async/client/shutdown.py +3 -3
- elasticsearch9/_async/client/simulate.py +1 -1
- elasticsearch9/_async/client/slm.py +9 -9
- elasticsearch9/_async/client/snapshot.py +64 -21
- elasticsearch9/_async/client/sql.py +6 -6
- elasticsearch9/_async/client/ssl.py +1 -1
- elasticsearch9/_async/client/synonyms.py +26 -7
- elasticsearch9/_async/client/tasks.py +4 -4
- elasticsearch9/_async/client/text_structure.py +4 -4
- elasticsearch9/_async/client/transform.py +11 -11
- elasticsearch9/_async/client/watcher.py +17 -15
- elasticsearch9/_async/client/xpack.py +2 -2
- elasticsearch9/_otel.py +8 -8
- elasticsearch9/_sync/client/__init__.py +88 -244
- elasticsearch9/_sync/client/async_search.py +4 -4
- elasticsearch9/_sync/client/autoscaling.py +4 -4
- elasticsearch9/_sync/client/cat.py +419 -51
- elasticsearch9/_sync/client/ccr.py +13 -13
- elasticsearch9/_sync/client/cluster.py +32 -22
- elasticsearch9/_sync/client/connector.py +30 -30
- elasticsearch9/_sync/client/dangling_indices.py +3 -3
- elasticsearch9/_sync/client/enrich.py +5 -5
- elasticsearch9/_sync/client/eql.py +14 -6
- elasticsearch9/_sync/client/esql.py +125 -9
- elasticsearch9/_sync/client/features.py +2 -2
- elasticsearch9/_sync/client/fleet.py +3 -3
- elasticsearch9/_sync/client/graph.py +1 -1
- elasticsearch9/_sync/client/ilm.py +11 -11
- elasticsearch9/_sync/client/indices.py +592 -113
- elasticsearch9/_sync/client/inference.py +521 -44
- elasticsearch9/_sync/client/ingest.py +9 -16
- elasticsearch9/_sync/client/license.py +11 -11
- elasticsearch9/_sync/client/logstash.py +3 -3
- elasticsearch9/_sync/client/migration.py +3 -3
- elasticsearch9/_sync/client/ml.py +75 -87
- elasticsearch9/_sync/client/monitoring.py +1 -1
- elasticsearch9/_sync/client/nodes.py +7 -7
- elasticsearch9/_sync/client/query_rules.py +8 -8
- elasticsearch9/_sync/client/rollup.py +9 -30
- elasticsearch9/_sync/client/search_application.py +10 -10
- elasticsearch9/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch9/_sync/client/security.py +79 -81
- elasticsearch9/_sync/client/shutdown.py +3 -3
- elasticsearch9/_sync/client/simulate.py +1 -1
- elasticsearch9/_sync/client/slm.py +9 -9
- elasticsearch9/_sync/client/snapshot.py +64 -21
- elasticsearch9/_sync/client/sql.py +6 -6
- elasticsearch9/_sync/client/ssl.py +1 -1
- elasticsearch9/_sync/client/synonyms.py +26 -7
- elasticsearch9/_sync/client/tasks.py +4 -4
- elasticsearch9/_sync/client/text_structure.py +4 -4
- elasticsearch9/_sync/client/transform.py +11 -11
- elasticsearch9/_sync/client/watcher.py +17 -15
- elasticsearch9/_sync/client/xpack.py +2 -2
- elasticsearch9/_version.py +1 -1
- elasticsearch9/compat.py +5 -0
- elasticsearch9/dsl/__init__.py +2 -1
- elasticsearch9/dsl/aggs.py +20 -0
- elasticsearch9/dsl/document_base.py +177 -17
- elasticsearch9/dsl/field.py +230 -37
- elasticsearch9/dsl/query.py +6 -3
- elasticsearch9/dsl/response/__init__.py +1 -1
- elasticsearch9/dsl/types.py +169 -11
- elasticsearch9/dsl/utils.py +1 -1
- elasticsearch9/{dsl/_sync/_sync_check → esql}/__init__.py +2 -0
- elasticsearch9/esql/esql.py +1105 -0
- elasticsearch9/esql/esql1.py1 +307 -0
- elasticsearch9/esql/functions.py +1738 -0
- {elasticsearch9-9.0.2.dist-info → elasticsearch9-9.1.0.dist-info}/METADATA +3 -4
- elasticsearch9-9.1.0.dist-info/RECORD +164 -0
- elasticsearch9/dsl/_sync/_sync_check/document.py +0 -514
- elasticsearch9/dsl/_sync/_sync_check/faceted_search.py +0 -50
- elasticsearch9/dsl/_sync/_sync_check/index.py +0 -597
- elasticsearch9/dsl/_sync/_sync_check/mapping.py +0 -49
- elasticsearch9/dsl/_sync/_sync_check/search.py +0 -230
- elasticsearch9/dsl/_sync/_sync_check/update_by_query.py +0 -45
- elasticsearch9-9.0.2.dist-info/RECORD +0 -167
- {elasticsearch9-9.0.2.dist-info → elasticsearch9-9.1.0.dist-info}/WHEEL +0 -0
- {elasticsearch9-9.0.2.dist-info → elasticsearch9-9.1.0.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch9-9.0.2.dist-info → elasticsearch9-9.1.0.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/docs/api/doc/elasticsearch/
|
|
48
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-clear-trained-model-deployment-cache>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
103
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-close-job>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
168
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
212
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-event>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
263
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-calendar-job>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
315
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-data-frame-analytics>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
366
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-datafeed>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
429
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-expired-data>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
493
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-filter>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
543
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-forecast>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
619
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-job>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
679
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-model-snapshot>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
731
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
786
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-trained-model-alias>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
847
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-estimate-model-memory>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
919
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-evaluate-data-frame>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
1004
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-explain-data-frame-analytics>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
1115
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-flush-job>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
1190
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-forecast>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
1276
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-buckets>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
1374
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendar-events>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
1443
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-calendars>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
1519
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-categories>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
1607
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
1682
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-data-frame-analytics-stats>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
1756
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeed-stats>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
1820
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeeds>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
1887
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-filters>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
1955
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-influencers>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
2039
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-job-stats>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
2103
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-jobs>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
2169
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-memory-stats>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
2227
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-model-snapshot-upgrade-stats>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
2301
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-model-snapshots>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
2421
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-overall-buckets>`_
|
|
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/docs/api/doc/elasticsearch/
|
|
2531
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-records>`_
|
|
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.
|
|
@@ -2626,7 +2626,7 @@ class MlClient(NamespacedClient):
|
|
|
2626
2626
|
<p>Get trained model configuration info.</p>
|
|
2627
2627
|
|
|
2628
2628
|
|
|
2629
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2629
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models>`_
|
|
2630
2630
|
|
|
2631
2631
|
:param model_id: The unique identifier of the trained model or a model alias.
|
|
2632
2632
|
You can get information for multiple trained models in a single API request
|
|
@@ -2713,7 +2713,7 @@ class MlClient(NamespacedClient):
|
|
|
2713
2713
|
models in a single API request by using a comma-separated list of model IDs or a wildcard expression.</p>
|
|
2714
2714
|
|
|
2715
2715
|
|
|
2716
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2716
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-trained-models-stats>`_
|
|
2717
2717
|
|
|
2718
2718
|
:param model_id: The unique identifier of the trained model or a model alias.
|
|
2719
2719
|
It can be a comma-separated list or a wildcard expression.
|
|
@@ -2779,7 +2779,7 @@ class MlClient(NamespacedClient):
|
|
|
2779
2779
|
<p>Evaluate a trained model.</p>
|
|
2780
2780
|
|
|
2781
2781
|
|
|
2782
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2782
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-infer-trained-model>`_
|
|
2783
2783
|
|
|
2784
2784
|
:param model_id: The unique identifier of the trained model.
|
|
2785
2785
|
:param docs: An array of objects to pass to the model for inference. The objects
|
|
@@ -2846,7 +2846,7 @@ class MlClient(NamespacedClient):
|
|
|
2846
2846
|
cluster configuration.</p>
|
|
2847
2847
|
|
|
2848
2848
|
|
|
2849
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2849
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-info>`_
|
|
2850
2850
|
"""
|
|
2851
2851
|
__path_parts: t.Dict[str, str] = {}
|
|
2852
2852
|
__path = "/_ml/info"
|
|
@@ -2895,7 +2895,7 @@ class MlClient(NamespacedClient):
|
|
|
2895
2895
|
new data is received.</p>
|
|
2896
2896
|
|
|
2897
2897
|
|
|
2898
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2898
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-open-job>`_
|
|
2899
2899
|
|
|
2900
2900
|
:param job_id: Identifier for the anomaly detection job.
|
|
2901
2901
|
:param timeout: Refer to the description for the `timeout` query parameter.
|
|
@@ -2952,7 +2952,7 @@ class MlClient(NamespacedClient):
|
|
|
2952
2952
|
<p>Add scheduled events to the calendar.</p>
|
|
2953
2953
|
|
|
2954
2954
|
|
|
2955
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
2955
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-calendar-events>`_
|
|
2956
2956
|
|
|
2957
2957
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
2958
2958
|
:param events: A list of one of more scheduled events. The event’s start and
|
|
@@ -3013,7 +3013,7 @@ class MlClient(NamespacedClient):
|
|
|
3013
3013
|
It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.</p>
|
|
3014
3014
|
|
|
3015
3015
|
|
|
3016
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3016
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-post-data>`_
|
|
3017
3017
|
|
|
3018
3018
|
:param job_id: Identifier for the anomaly detection job. The job must have a
|
|
3019
3019
|
state of open to receive and process the data.
|
|
@@ -3080,7 +3080,7 @@ class MlClient(NamespacedClient):
|
|
|
3080
3080
|
Preview the extracted features used by a data frame analytics config.</p>
|
|
3081
3081
|
|
|
3082
3082
|
|
|
3083
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3083
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-data-frame-analytics>`_
|
|
3084
3084
|
|
|
3085
3085
|
:param id: Identifier for the data frame analytics job.
|
|
3086
3086
|
:param config: A data frame analytics config as described in create data frame
|
|
@@ -3153,7 +3153,7 @@ class MlClient(NamespacedClient):
|
|
|
3153
3153
|
You can also use secondary authorization headers to supply the credentials.</p>
|
|
3154
3154
|
|
|
3155
3155
|
|
|
3156
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3156
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-preview-datafeed>`_
|
|
3157
3157
|
|
|
3158
3158
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
3159
3159
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -3232,7 +3232,7 @@ class MlClient(NamespacedClient):
|
|
|
3232
3232
|
<p>Create a calendar.</p>
|
|
3233
3233
|
|
|
3234
3234
|
|
|
3235
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3235
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar>`_
|
|
3236
3236
|
|
|
3237
3237
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
3238
3238
|
:param description: A description of the calendar.
|
|
@@ -3289,7 +3289,7 @@ class MlClient(NamespacedClient):
|
|
|
3289
3289
|
<p>Add anomaly detection job to calendar.</p>
|
|
3290
3290
|
|
|
3291
3291
|
|
|
3292
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3292
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-calendar-job>`_
|
|
3293
3293
|
|
|
3294
3294
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
3295
3295
|
:param job_id: An identifier for the anomaly detection jobs. It can be a job
|
|
@@ -3372,7 +3372,7 @@ class MlClient(NamespacedClient):
|
|
|
3372
3372
|
<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>
|
|
3373
3373
|
|
|
3374
3374
|
|
|
3375
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3375
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-data-frame-analytics>`_
|
|
3376
3376
|
|
|
3377
3377
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
3378
3378
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -3557,7 +3557,7 @@ class MlClient(NamespacedClient):
|
|
|
3557
3557
|
directly to the <code>.ml-config</code> index. Do not give users <code>write</code> privileges on the <code>.ml-config</code> index.</p>
|
|
3558
3558
|
|
|
3559
3559
|
|
|
3560
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3560
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-datafeed>`_
|
|
3561
3561
|
|
|
3562
3562
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
3563
3563
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -3719,7 +3719,7 @@ class MlClient(NamespacedClient):
|
|
|
3719
3719
|
Specifically, filters are referenced in the <code>custom_rules</code> property of detector configuration objects.</p>
|
|
3720
3720
|
|
|
3721
3721
|
|
|
3722
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3722
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-filter>`_
|
|
3723
3723
|
|
|
3724
3724
|
:param filter_id: A string that uniquely identifies a filter.
|
|
3725
3725
|
:param description: A description of the filter.
|
|
@@ -3821,7 +3821,7 @@ class MlClient(NamespacedClient):
|
|
|
3821
3821
|
If you include a <code>datafeed_config</code> but do not provide a query, the datafeed uses <code>{"match_all": {"boost": 1}}</code>.</p>
|
|
3822
3822
|
|
|
3823
3823
|
|
|
3824
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
3824
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-job>`_
|
|
3825
3825
|
|
|
3826
3826
|
:param job_id: The identifier for the anomaly detection job. This identifier
|
|
3827
3827
|
can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
|
|
@@ -3871,13 +3871,7 @@ class MlClient(NamespacedClient):
|
|
|
3871
3871
|
:param description: A description of the job.
|
|
3872
3872
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
3873
3873
|
request can target data streams, this argument determines whether wildcard
|
|
3874
|
-
expressions match hidden data streams. Supports comma-separated values.
|
|
3875
|
-
values are: * `all`: Match any data stream or index, including hidden ones.
|
|
3876
|
-
* `closed`: Match closed, non-hidden indices. Also matches any non-hidden
|
|
3877
|
-
data stream. Data streams cannot be closed. * `hidden`: Match hidden data
|
|
3878
|
-
streams and hidden indices. Must be combined with `open`, `closed`, or both.
|
|
3879
|
-
* `none`: Wildcard patterns are not accepted. * `open`: Match open, non-hidden
|
|
3880
|
-
indices. Also matches any non-hidden data stream.
|
|
3874
|
+
expressions match hidden data streams. Supports comma-separated values.
|
|
3881
3875
|
:param groups: A list of job groups. A job can belong to no groups or many.
|
|
3882
3876
|
:param ignore_throttled: If `true`, concrete, expanded or aliased indices are
|
|
3883
3877
|
ignored when frozen.
|
|
@@ -4029,7 +4023,7 @@ class MlClient(NamespacedClient):
|
|
|
4029
4023
|
Enable you to supply a trained model that is not created by data frame analytics.</p>
|
|
4030
4024
|
|
|
4031
4025
|
|
|
4032
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4026
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model>`_
|
|
4033
4027
|
|
|
4034
4028
|
:param model_id: The unique identifier of the trained model.
|
|
4035
4029
|
:param compressed_definition: The compressed (GZipped and Base64 encoded) inference
|
|
@@ -4150,7 +4144,7 @@ class MlClient(NamespacedClient):
|
|
|
4150
4144
|
returns a warning.</p>
|
|
4151
4145
|
|
|
4152
4146
|
|
|
4153
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4147
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-alias>`_
|
|
4154
4148
|
|
|
4155
4149
|
:param model_id: The identifier for the trained model that the alias refers to.
|
|
4156
4150
|
:param model_alias: The alias to create or update. This value cannot end in numbers.
|
|
@@ -4211,7 +4205,7 @@ class MlClient(NamespacedClient):
|
|
|
4211
4205
|
<p>Create part of a trained model definition.</p>
|
|
4212
4206
|
|
|
4213
4207
|
|
|
4214
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4208
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-definition-part>`_
|
|
4215
4209
|
|
|
4216
4210
|
:param model_id: The unique identifier of the trained model.
|
|
4217
4211
|
:param part: The definition part number. When the definition is loaded for inference
|
|
@@ -4293,7 +4287,7 @@ class MlClient(NamespacedClient):
|
|
|
4293
4287
|
The vocabulary is stored in the index as described in <code>inference_config.*.vocabulary</code> of the trained model definition.</p>
|
|
4294
4288
|
|
|
4295
4289
|
|
|
4296
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4290
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-trained-model-vocabulary>`_
|
|
4297
4291
|
|
|
4298
4292
|
:param model_id: The unique identifier of the trained model.
|
|
4299
4293
|
:param vocabulary: The model vocabulary, which must not be empty.
|
|
@@ -4356,7 +4350,7 @@ class MlClient(NamespacedClient):
|
|
|
4356
4350
|
comma separated list.</p>
|
|
4357
4351
|
|
|
4358
4352
|
|
|
4359
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4353
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-reset-job>`_
|
|
4360
4354
|
|
|
4361
4355
|
:param job_id: The ID of the job to reset.
|
|
4362
4356
|
:param delete_user_annotations: Specifies whether annotations that have been
|
|
@@ -4420,7 +4414,7 @@ class MlClient(NamespacedClient):
|
|
|
4420
4414
|
snapshot after Black Friday or a critical system failure.</p>
|
|
4421
4415
|
|
|
4422
4416
|
|
|
4423
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4417
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-revert-model-snapshot>`_
|
|
4424
4418
|
|
|
4425
4419
|
:param job_id: Identifier for the anomaly detection job.
|
|
4426
4420
|
:param snapshot_id: You can specify `empty` as the <snapshot_id>. Reverting to
|
|
@@ -4495,7 +4489,7 @@ class MlClient(NamespacedClient):
|
|
|
4495
4489
|
machine learning info API.</p>
|
|
4496
4490
|
|
|
4497
4491
|
|
|
4498
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4492
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-set-upgrade-mode>`_
|
|
4499
4493
|
|
|
4500
4494
|
:param enabled: When `true`, it enables `upgrade_mode` which temporarily halts
|
|
4501
4495
|
all job and datafeed tasks and prohibits new job and datafeed tasks from
|
|
@@ -4555,7 +4549,7 @@ class MlClient(NamespacedClient):
|
|
|
4555
4549
|
the destination index in advance with custom settings and mappings.</p>
|
|
4556
4550
|
|
|
4557
4551
|
|
|
4558
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4552
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-data-frame-analytics>`_
|
|
4559
4553
|
|
|
4560
4554
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
4561
4555
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -4618,7 +4612,7 @@ class MlClient(NamespacedClient):
|
|
|
4618
4612
|
authorization headers when you created or updated the datafeed, those credentials are used instead.</p>
|
|
4619
4613
|
|
|
4620
4614
|
|
|
4621
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4615
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-datafeed>`_
|
|
4622
4616
|
|
|
4623
4617
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
4624
4618
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -4695,7 +4689,7 @@ class MlClient(NamespacedClient):
|
|
|
4695
4689
|
It allocates the model to every machine learning node.</p>
|
|
4696
4690
|
|
|
4697
4691
|
|
|
4698
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4692
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-trained-model-deployment>`_
|
|
4699
4693
|
|
|
4700
4694
|
:param model_id: The unique identifier of the trained model. Currently, only
|
|
4701
4695
|
PyTorch models are supported.
|
|
@@ -4796,7 +4790,7 @@ class MlClient(NamespacedClient):
|
|
|
4796
4790
|
throughout its lifecycle.</p>
|
|
4797
4791
|
|
|
4798
4792
|
|
|
4799
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4793
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-data-frame-analytics>`_
|
|
4800
4794
|
|
|
4801
4795
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
4802
4796
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -4866,7 +4860,7 @@ class MlClient(NamespacedClient):
|
|
|
4866
4860
|
multiple times throughout its lifecycle.</p>
|
|
4867
4861
|
|
|
4868
4862
|
|
|
4869
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4863
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-datafeed>`_
|
|
4870
4864
|
|
|
4871
4865
|
:param datafeed_id: Identifier for the datafeed. You can stop multiple datafeeds
|
|
4872
4866
|
in a single API request by using a comma-separated list of datafeeds or a
|
|
@@ -4931,7 +4925,7 @@ class MlClient(NamespacedClient):
|
|
|
4931
4925
|
<p>Stop a trained model deployment.</p>
|
|
4932
4926
|
|
|
4933
4927
|
|
|
4934
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4928
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-trained-model-deployment>`_
|
|
4935
4929
|
|
|
4936
4930
|
:param model_id: The unique identifier of the trained model.
|
|
4937
4931
|
:param allow_no_match: Specifies what to do when the request: contains wildcard
|
|
@@ -4999,7 +4993,7 @@ class MlClient(NamespacedClient):
|
|
|
4999
4993
|
<p>Update a data frame analytics job.</p>
|
|
5000
4994
|
|
|
5001
4995
|
|
|
5002
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
4996
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-data-frame-analytics>`_
|
|
5003
4997
|
|
|
5004
4998
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
5005
4999
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -5114,7 +5108,7 @@ class MlClient(NamespacedClient):
|
|
|
5114
5108
|
those credentials are used instead.</p>
|
|
5115
5109
|
|
|
5116
5110
|
|
|
5117
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5111
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-datafeed>`_
|
|
5118
5112
|
|
|
5119
5113
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
5120
5114
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -5140,13 +5134,7 @@ class MlClient(NamespacedClient):
|
|
|
5140
5134
|
check runs only on real-time datafeeds.
|
|
5141
5135
|
:param expand_wildcards: Type of index that wildcard patterns can match. If the
|
|
5142
5136
|
request can target data streams, this argument determines whether wildcard
|
|
5143
|
-
expressions match hidden data streams. Supports comma-separated values.
|
|
5144
|
-
values are: * `all`: Match any data stream or index, including hidden ones.
|
|
5145
|
-
* `closed`: Match closed, non-hidden indices. Also matches any non-hidden
|
|
5146
|
-
data stream. Data streams cannot be closed. * `hidden`: Match hidden data
|
|
5147
|
-
streams and hidden indices. Must be combined with `open`, `closed`, or both.
|
|
5148
|
-
* `none`: Wildcard patterns are not accepted. * `open`: Match open, non-hidden
|
|
5149
|
-
indices. Also matches any non-hidden data stream.
|
|
5137
|
+
expressions match hidden data streams. Supports comma-separated values.
|
|
5150
5138
|
:param frequency: The interval at which scheduled queries are made while the
|
|
5151
5139
|
datafeed runs in real time. The default value is either the bucket span for
|
|
5152
5140
|
short bucket spans, or, for longer bucket spans, a sensible fraction of the
|
|
@@ -5281,7 +5269,7 @@ class MlClient(NamespacedClient):
|
|
|
5281
5269
|
Updates the description of a filter, adds items, or removes items from the list.</p>
|
|
5282
5270
|
|
|
5283
5271
|
|
|
5284
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5272
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-filter>`_
|
|
5285
5273
|
|
|
5286
5274
|
:param filter_id: A string that uniquely identifies a filter.
|
|
5287
5275
|
:param add_items: The items to add to the filter.
|
|
@@ -5375,7 +5363,7 @@ class MlClient(NamespacedClient):
|
|
|
5375
5363
|
Updates certain properties of an anomaly detection job.</p>
|
|
5376
5364
|
|
|
5377
5365
|
|
|
5378
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5366
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-job>`_
|
|
5379
5367
|
|
|
5380
5368
|
:param job_id: Identifier for the job.
|
|
5381
5369
|
:param allow_lazy_open: Advanced configuration option. Specifies whether this
|
|
@@ -5507,7 +5495,7 @@ class MlClient(NamespacedClient):
|
|
|
5507
5495
|
Updates certain properties of a snapshot.</p>
|
|
5508
5496
|
|
|
5509
5497
|
|
|
5510
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5498
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-model-snapshot>`_
|
|
5511
5499
|
|
|
5512
5500
|
:param job_id: Identifier for the anomaly detection job.
|
|
5513
5501
|
:param snapshot_id: Identifier for the model snapshot.
|
|
@@ -5572,7 +5560,7 @@ class MlClient(NamespacedClient):
|
|
|
5572
5560
|
<p>Update a trained model deployment.</p>
|
|
5573
5561
|
|
|
5574
5562
|
|
|
5575
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5563
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-trained-model-deployment>`_
|
|
5576
5564
|
|
|
5577
5565
|
:param model_id: The unique identifier of the trained model. Currently, only
|
|
5578
5566
|
PyTorch models are supported.
|
|
@@ -5649,7 +5637,7 @@ class MlClient(NamespacedClient):
|
|
|
5649
5637
|
job.</p>
|
|
5650
5638
|
|
|
5651
5639
|
|
|
5652
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5640
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-upgrade-job-snapshot>`_
|
|
5653
5641
|
|
|
5654
5642
|
:param job_id: Identifier for the anomaly detection job.
|
|
5655
5643
|
:param snapshot_id: A numerical character string that uniquely identifies the
|
|
@@ -5728,7 +5716,7 @@ class MlClient(NamespacedClient):
|
|
|
5728
5716
|
<p>Validate an anomaly detection job.</p>
|
|
5729
5717
|
|
|
5730
5718
|
|
|
5731
|
-
`<https://www.elastic.co/guide/en/machine-learning/9.
|
|
5719
|
+
`<https://www.elastic.co/guide/en/machine-learning/9.1/ml-jobs.html>`_
|
|
5732
5720
|
|
|
5733
5721
|
:param analysis_config:
|
|
5734
5722
|
:param analysis_limits:
|
|
@@ -5801,7 +5789,7 @@ class MlClient(NamespacedClient):
|
|
|
5801
5789
|
<p>Validate an anomaly detection job.</p>
|
|
5802
5790
|
|
|
5803
5791
|
|
|
5804
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch
|
|
5792
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch>`_
|
|
5805
5793
|
|
|
5806
5794
|
:param detector:
|
|
5807
5795
|
"""
|