elasticsearch 8.18.0__py3-none-any.whl → 9.0.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 +62 -277
- elasticsearch/_async/client/_base.py +1 -1
- elasticsearch/_async/client/async_search.py +6 -10
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +26 -33
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +20 -20
- elasticsearch/_async/client/connector.py +44 -30
- 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 +7 -11
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +18 -20
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +18 -11
- elasticsearch/_async/client/indices.py +75 -163
- elasticsearch/_async/client/inference.py +132 -25
- elasticsearch/_async/client/ingest.py +12 -12
- 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 +80 -85
- elasticsearch/_async/client/monitoring.py +1 -1
- elasticsearch/_async/client/nodes.py +8 -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 +71 -68
- 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 +280 -130
- 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 +4 -4
- elasticsearch/_async/client/transform.py +11 -11
- elasticsearch/_async/client/watcher.py +14 -14
- elasticsearch/_async/client/xpack.py +2 -2
- elasticsearch/_sync/client/__init__.py +62 -277
- elasticsearch/_sync/client/_base.py +1 -1
- elasticsearch/_sync/client/async_search.py +6 -10
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +26 -33
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +20 -20
- elasticsearch/_sync/client/connector.py +44 -30
- 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 +7 -11
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +18 -20
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +18 -11
- elasticsearch/_sync/client/indices.py +75 -163
- elasticsearch/_sync/client/inference.py +132 -25
- elasticsearch/_sync/client/ingest.py +12 -12
- 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 +80 -85
- elasticsearch/_sync/client/monitoring.py +1 -1
- elasticsearch/_sync/client/nodes.py +8 -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 +71 -68
- 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 +280 -130
- 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 +4 -4
- elasticsearch/_sync/client/transform.py +11 -11
- elasticsearch/_sync/client/utils.py +0 -37
- elasticsearch/_sync/client/watcher.py +14 -14
- elasticsearch/_sync/client/xpack.py +2 -2
- elasticsearch/_version.py +1 -1
- elasticsearch/dsl/_async/search.py +7 -3
- elasticsearch/dsl/_sync/search.py +7 -3
- elasticsearch/dsl/aggs.py +11 -7
- elasticsearch/dsl/faceted_search_base.py +4 -4
- elasticsearch/dsl/field.py +139 -1
- elasticsearch/dsl/query.py +7 -1
- elasticsearch/dsl/search_base.py +16 -3
- elasticsearch/dsl/types.py +66 -84
- elasticsearch/dsl/wrappers.py +25 -0
- elasticsearch/exceptions.py +2 -0
- elasticsearch/helpers/vectorstore/_async/strategies.py +12 -12
- elasticsearch/helpers/vectorstore/_sync/strategies.py +12 -12
- {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/METADATA +17 -29
- elasticsearch-9.0.1.dist-info/RECORD +162 -0
- elasticsearch-9.0.1.dist-info/licenses/LICENSE.txt +175 -0
- elasticsearch-9.0.1.dist-info/licenses/NOTICE.txt +559 -0
- elasticsearch/transport.py +0 -57
- elasticsearch-8.18.0.dist-info/RECORD +0 -161
- {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/WHEEL +0 -0
- {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.1.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.18.0.dist-info → elasticsearch-9.0.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/
|
|
48
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
103
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
168
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
212
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
263
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
315
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
366
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
429
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
493
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
543
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
619
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
679
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
731
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
786
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
847
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
919
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
1004
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
1115
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
1190
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
1276
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
1374
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
1443
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
1519
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
1607
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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
|
|
@@ -1676,10 +1676,10 @@ class MlClient(NamespacedClient):
|
|
|
1676
1676
|
"""
|
|
1677
1677
|
.. raw:: html
|
|
1678
1678
|
|
|
1679
|
-
<p>Get data frame analytics
|
|
1679
|
+
<p>Get data frame analytics job stats.</p>
|
|
1680
1680
|
|
|
1681
1681
|
|
|
1682
|
-
`<https://www.elastic.co/
|
|
1682
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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
|
|
@@ -1744,7 +1744,7 @@ class MlClient(NamespacedClient):
|
|
|
1744
1744
|
"""
|
|
1745
1745
|
.. raw:: html
|
|
1746
1746
|
|
|
1747
|
-
<p>Get
|
|
1747
|
+
<p>Get datafeed stats.
|
|
1748
1748
|
You can get statistics for multiple datafeeds in a single API request by
|
|
1749
1749
|
using a comma-separated list of datafeeds or a wildcard expression. You can
|
|
1750
1750
|
get statistics for all datafeeds by using <code>_all</code>, by specifying <code>*</code> as the
|
|
@@ -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/
|
|
1756
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
1820
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
1887
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
1955
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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.
|
|
@@ -2033,10 +2033,10 @@ class MlClient(NamespacedClient):
|
|
|
2033
2033
|
"""
|
|
2034
2034
|
.. raw:: html
|
|
2035
2035
|
|
|
2036
|
-
<p>Get anomaly detection
|
|
2036
|
+
<p>Get anomaly detection job stats.</p>
|
|
2037
2037
|
|
|
2038
2038
|
|
|
2039
|
-
`<https://www.elastic.co/
|
|
2039
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
2103
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
2169
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
2227
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
2301
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
2421
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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/
|
|
2531
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/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.
|
|
@@ -2616,7 +2616,6 @@ class MlClient(NamespacedClient):
|
|
|
2616
2616
|
],
|
|
2617
2617
|
]
|
|
2618
2618
|
] = None,
|
|
2619
|
-
include_model_definition: t.Optional[bool] = None,
|
|
2620
2619
|
pretty: t.Optional[bool] = None,
|
|
2621
2620
|
size: t.Optional[int] = None,
|
|
2622
2621
|
tags: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
@@ -2627,7 +2626,7 @@ class MlClient(NamespacedClient):
|
|
|
2627
2626
|
<p>Get trained model configuration info.</p>
|
|
2628
2627
|
|
|
2629
2628
|
|
|
2630
|
-
`<https://www.elastic.co/
|
|
2629
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-trained-models>`_
|
|
2631
2630
|
|
|
2632
2631
|
:param model_id: The unique identifier of the trained model or a model alias.
|
|
2633
2632
|
You can get information for multiple trained models in a single API request
|
|
@@ -2646,8 +2645,6 @@ class MlClient(NamespacedClient):
|
|
|
2646
2645
|
:param from_: Skips the specified number of models.
|
|
2647
2646
|
:param include: A comma delimited string of optional fields to include in the
|
|
2648
2647
|
response body.
|
|
2649
|
-
:param include_model_definition: parameter is deprecated! Use [include=definition]
|
|
2650
|
-
instead
|
|
2651
2648
|
:param size: Specifies the maximum number of models to obtain.
|
|
2652
2649
|
:param tags: A comma delimited string of tags. A trained model can have many
|
|
2653
2650
|
tags, or none. When supplied, only trained models that contain all the supplied
|
|
@@ -2677,8 +2674,6 @@ class MlClient(NamespacedClient):
|
|
|
2677
2674
|
__query["human"] = human
|
|
2678
2675
|
if include is not None:
|
|
2679
2676
|
__query["include"] = include
|
|
2680
|
-
if include_model_definition is not None:
|
|
2681
|
-
__query["include_model_definition"] = include_model_definition
|
|
2682
2677
|
if pretty is not None:
|
|
2683
2678
|
__query["pretty"] = pretty
|
|
2684
2679
|
if size is not None:
|
|
@@ -2718,7 +2713,7 @@ class MlClient(NamespacedClient):
|
|
|
2718
2713
|
models in a single API request by using a comma-separated list of model IDs or a wildcard expression.</p>
|
|
2719
2714
|
|
|
2720
2715
|
|
|
2721
|
-
`<https://www.elastic.co/
|
|
2716
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-trained-models-stats>`_
|
|
2722
2717
|
|
|
2723
2718
|
:param model_id: The unique identifier of the trained model or a model alias.
|
|
2724
2719
|
It can be a comma-separated list or a wildcard expression.
|
|
@@ -2784,7 +2779,7 @@ class MlClient(NamespacedClient):
|
|
|
2784
2779
|
<p>Evaluate a trained model.</p>
|
|
2785
2780
|
|
|
2786
2781
|
|
|
2787
|
-
`<https://www.elastic.co/
|
|
2782
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-infer-trained-model>`_
|
|
2788
2783
|
|
|
2789
2784
|
:param model_id: The unique identifier of the trained model.
|
|
2790
2785
|
:param docs: An array of objects to pass to the model for inference. The objects
|
|
@@ -2851,7 +2846,7 @@ class MlClient(NamespacedClient):
|
|
|
2851
2846
|
cluster configuration.</p>
|
|
2852
2847
|
|
|
2853
2848
|
|
|
2854
|
-
`<https://www.elastic.co/
|
|
2849
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-info>`_
|
|
2855
2850
|
"""
|
|
2856
2851
|
__path_parts: t.Dict[str, str] = {}
|
|
2857
2852
|
__path = "/_ml/info"
|
|
@@ -2900,7 +2895,7 @@ class MlClient(NamespacedClient):
|
|
|
2900
2895
|
new data is received.</p>
|
|
2901
2896
|
|
|
2902
2897
|
|
|
2903
|
-
`<https://www.elastic.co/
|
|
2898
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-open-job>`_
|
|
2904
2899
|
|
|
2905
2900
|
:param job_id: Identifier for the anomaly detection job.
|
|
2906
2901
|
:param timeout: Refer to the description for the `timeout` query parameter.
|
|
@@ -2957,7 +2952,7 @@ class MlClient(NamespacedClient):
|
|
|
2957
2952
|
<p>Add scheduled events to the calendar.</p>
|
|
2958
2953
|
|
|
2959
2954
|
|
|
2960
|
-
`<https://www.elastic.co/
|
|
2955
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-post-calendar-events>`_
|
|
2961
2956
|
|
|
2962
2957
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
2963
2958
|
:param events: A list of one of more scheduled events. The event’s start and
|
|
@@ -3018,7 +3013,7 @@ class MlClient(NamespacedClient):
|
|
|
3018
3013
|
It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.</p>
|
|
3019
3014
|
|
|
3020
3015
|
|
|
3021
|
-
`<https://www.elastic.co/
|
|
3016
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-post-data>`_
|
|
3022
3017
|
|
|
3023
3018
|
:param job_id: Identifier for the anomaly detection job. The job must have a
|
|
3024
3019
|
state of open to receive and process the data.
|
|
@@ -3085,7 +3080,7 @@ class MlClient(NamespacedClient):
|
|
|
3085
3080
|
Preview the extracted features used by a data frame analytics config.</p>
|
|
3086
3081
|
|
|
3087
3082
|
|
|
3088
|
-
`<https://www.elastic.co/
|
|
3083
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-preview-data-frame-analytics>`_
|
|
3089
3084
|
|
|
3090
3085
|
:param id: Identifier for the data frame analytics job.
|
|
3091
3086
|
:param config: A data frame analytics config as described in create data frame
|
|
@@ -3158,7 +3153,7 @@ class MlClient(NamespacedClient):
|
|
|
3158
3153
|
You can also use secondary authorization headers to supply the credentials.</p>
|
|
3159
3154
|
|
|
3160
3155
|
|
|
3161
|
-
`<https://www.elastic.co/
|
|
3156
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-preview-datafeed>`_
|
|
3162
3157
|
|
|
3163
3158
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
3164
3159
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -3237,7 +3232,7 @@ class MlClient(NamespacedClient):
|
|
|
3237
3232
|
<p>Create a calendar.</p>
|
|
3238
3233
|
|
|
3239
3234
|
|
|
3240
|
-
`<https://www.elastic.co/
|
|
3235
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-calendar>`_
|
|
3241
3236
|
|
|
3242
3237
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
3243
3238
|
:param description: A description of the calendar.
|
|
@@ -3294,7 +3289,7 @@ class MlClient(NamespacedClient):
|
|
|
3294
3289
|
<p>Add anomaly detection job to calendar.</p>
|
|
3295
3290
|
|
|
3296
3291
|
|
|
3297
|
-
`<https://www.elastic.co/
|
|
3292
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-calendar-job>`_
|
|
3298
3293
|
|
|
3299
3294
|
:param calendar_id: A string that uniquely identifies a calendar.
|
|
3300
3295
|
:param job_id: An identifier for the anomaly detection jobs. It can be a job
|
|
@@ -3377,7 +3372,7 @@ class MlClient(NamespacedClient):
|
|
|
3377
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>
|
|
3378
3373
|
|
|
3379
3374
|
|
|
3380
|
-
`<https://www.elastic.co/
|
|
3375
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-data-frame-analytics>`_
|
|
3381
3376
|
|
|
3382
3377
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
3383
3378
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -3562,7 +3557,7 @@ class MlClient(NamespacedClient):
|
|
|
3562
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>
|
|
3563
3558
|
|
|
3564
3559
|
|
|
3565
|
-
`<https://www.elastic.co/
|
|
3560
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-datafeed>`_
|
|
3566
3561
|
|
|
3567
3562
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
3568
3563
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -3604,11 +3599,11 @@ class MlClient(NamespacedClient):
|
|
|
3604
3599
|
:param ignore_unavailable: If true, unavailable indices (missing or closed) are
|
|
3605
3600
|
ignored.
|
|
3606
3601
|
: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.
|
|
3602
|
+
indices are in remote clusters, the master nodes and the machine learning
|
|
3603
|
+
nodes must have the `remote_cluster_client` role.
|
|
3609
3604
|
: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.
|
|
3605
|
+
indices are in remote clusters, the master nodes and the machine learning
|
|
3606
|
+
nodes must have the `remote_cluster_client` role.
|
|
3612
3607
|
:param indices_options: Specifies index expansion options that are used during
|
|
3613
3608
|
search
|
|
3614
3609
|
:param job_id: Identifier for the anomaly detection job.
|
|
@@ -3724,7 +3719,7 @@ class MlClient(NamespacedClient):
|
|
|
3724
3719
|
Specifically, filters are referenced in the <code>custom_rules</code> property of detector configuration objects.</p>
|
|
3725
3720
|
|
|
3726
3721
|
|
|
3727
|
-
`<https://www.elastic.co/
|
|
3722
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-filter>`_
|
|
3728
3723
|
|
|
3729
3724
|
:param filter_id: A string that uniquely identifies a filter.
|
|
3730
3725
|
:param description: A description of the filter.
|
|
@@ -3826,7 +3821,7 @@ class MlClient(NamespacedClient):
|
|
|
3826
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>
|
|
3827
3822
|
|
|
3828
3823
|
|
|
3829
|
-
`<https://www.elastic.co/
|
|
3824
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-job>`_
|
|
3830
3825
|
|
|
3831
3826
|
:param job_id: The identifier for the anomaly detection job. This identifier
|
|
3832
3827
|
can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
|
|
@@ -4034,7 +4029,7 @@ class MlClient(NamespacedClient):
|
|
|
4034
4029
|
Enable you to supply a trained model that is not created by data frame analytics.</p>
|
|
4035
4030
|
|
|
4036
4031
|
|
|
4037
|
-
`<https://www.elastic.co/
|
|
4032
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model>`_
|
|
4038
4033
|
|
|
4039
4034
|
:param model_id: The unique identifier of the trained model.
|
|
4040
4035
|
:param compressed_definition: The compressed (GZipped and Base64 encoded) inference
|
|
@@ -4155,7 +4150,7 @@ class MlClient(NamespacedClient):
|
|
|
4155
4150
|
returns a warning.</p>
|
|
4156
4151
|
|
|
4157
4152
|
|
|
4158
|
-
`<https://www.elastic.co/
|
|
4153
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model-alias>`_
|
|
4159
4154
|
|
|
4160
4155
|
:param model_id: The identifier for the trained model that the alias refers to.
|
|
4161
4156
|
:param model_alias: The alias to create or update. This value cannot end in numbers.
|
|
@@ -4216,7 +4211,7 @@ class MlClient(NamespacedClient):
|
|
|
4216
4211
|
<p>Create part of a trained model definition.</p>
|
|
4217
4212
|
|
|
4218
4213
|
|
|
4219
|
-
`<https://www.elastic.co/
|
|
4214
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model-definition-part>`_
|
|
4220
4215
|
|
|
4221
4216
|
:param model_id: The unique identifier of the trained model.
|
|
4222
4217
|
:param part: The definition part number. When the definition is loaded for inference
|
|
@@ -4298,7 +4293,7 @@ class MlClient(NamespacedClient):
|
|
|
4298
4293
|
The vocabulary is stored in the index as described in <code>inference_config.*.vocabulary</code> of the trained model definition.</p>
|
|
4299
4294
|
|
|
4300
4295
|
|
|
4301
|
-
`<https://www.elastic.co/
|
|
4296
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model-vocabulary>`_
|
|
4302
4297
|
|
|
4303
4298
|
:param model_id: The unique identifier of the trained model.
|
|
4304
4299
|
:param vocabulary: The model vocabulary, which must not be empty.
|
|
@@ -4361,7 +4356,7 @@ class MlClient(NamespacedClient):
|
|
|
4361
4356
|
comma separated list.</p>
|
|
4362
4357
|
|
|
4363
4358
|
|
|
4364
|
-
`<https://www.elastic.co/
|
|
4359
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-reset-job>`_
|
|
4365
4360
|
|
|
4366
4361
|
:param job_id: The ID of the job to reset.
|
|
4367
4362
|
:param delete_user_annotations: Specifies whether annotations that have been
|
|
@@ -4425,7 +4420,7 @@ class MlClient(NamespacedClient):
|
|
|
4425
4420
|
snapshot after Black Friday or a critical system failure.</p>
|
|
4426
4421
|
|
|
4427
4422
|
|
|
4428
|
-
`<https://www.elastic.co/
|
|
4423
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-revert-model-snapshot>`_
|
|
4429
4424
|
|
|
4430
4425
|
:param job_id: Identifier for the anomaly detection job.
|
|
4431
4426
|
:param snapshot_id: You can specify `empty` as the <snapshot_id>. Reverting to
|
|
@@ -4500,7 +4495,7 @@ class MlClient(NamespacedClient):
|
|
|
4500
4495
|
machine learning info API.</p>
|
|
4501
4496
|
|
|
4502
4497
|
|
|
4503
|
-
`<https://www.elastic.co/
|
|
4498
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-set-upgrade-mode>`_
|
|
4504
4499
|
|
|
4505
4500
|
:param enabled: When `true`, it enables `upgrade_mode` which temporarily halts
|
|
4506
4501
|
all job and datafeed tasks and prohibits new job and datafeed tasks from
|
|
@@ -4560,7 +4555,7 @@ class MlClient(NamespacedClient):
|
|
|
4560
4555
|
the destination index in advance with custom settings and mappings.</p>
|
|
4561
4556
|
|
|
4562
4557
|
|
|
4563
|
-
`<https://www.elastic.co/
|
|
4558
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-start-data-frame-analytics>`_
|
|
4564
4559
|
|
|
4565
4560
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
4566
4561
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -4623,7 +4618,7 @@ class MlClient(NamespacedClient):
|
|
|
4623
4618
|
authorization headers when you created or updated the datafeed, those credentials are used instead.</p>
|
|
4624
4619
|
|
|
4625
4620
|
|
|
4626
|
-
`<https://www.elastic.co/
|
|
4621
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-start-datafeed>`_
|
|
4627
4622
|
|
|
4628
4623
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
4629
4624
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -4700,7 +4695,7 @@ class MlClient(NamespacedClient):
|
|
|
4700
4695
|
It allocates the model to every machine learning node.</p>
|
|
4701
4696
|
|
|
4702
4697
|
|
|
4703
|
-
`<https://www.elastic.co/
|
|
4698
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-start-trained-model-deployment>`_
|
|
4704
4699
|
|
|
4705
4700
|
:param model_id: The unique identifier of the trained model. Currently, only
|
|
4706
4701
|
PyTorch models are supported.
|
|
@@ -4801,7 +4796,7 @@ class MlClient(NamespacedClient):
|
|
|
4801
4796
|
throughout its lifecycle.</p>
|
|
4802
4797
|
|
|
4803
4798
|
|
|
4804
|
-
`<https://www.elastic.co/
|
|
4799
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-stop-data-frame-analytics>`_
|
|
4805
4800
|
|
|
4806
4801
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
4807
4802
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -4871,7 +4866,7 @@ class MlClient(NamespacedClient):
|
|
|
4871
4866
|
multiple times throughout its lifecycle.</p>
|
|
4872
4867
|
|
|
4873
4868
|
|
|
4874
|
-
`<https://www.elastic.co/
|
|
4869
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-stop-datafeed>`_
|
|
4875
4870
|
|
|
4876
4871
|
:param datafeed_id: Identifier for the datafeed. You can stop multiple datafeeds
|
|
4877
4872
|
in a single API request by using a comma-separated list of datafeeds or a
|
|
@@ -4936,7 +4931,7 @@ class MlClient(NamespacedClient):
|
|
|
4936
4931
|
<p>Stop a trained model deployment.</p>
|
|
4937
4932
|
|
|
4938
4933
|
|
|
4939
|
-
`<https://www.elastic.co/
|
|
4934
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-stop-trained-model-deployment>`_
|
|
4940
4935
|
|
|
4941
4936
|
:param model_id: The unique identifier of the trained model.
|
|
4942
4937
|
:param allow_no_match: Specifies what to do when the request: contains wildcard
|
|
@@ -5004,7 +4999,7 @@ class MlClient(NamespacedClient):
|
|
|
5004
4999
|
<p>Update a data frame analytics job.</p>
|
|
5005
5000
|
|
|
5006
5001
|
|
|
5007
|
-
`<https://www.elastic.co/
|
|
5002
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-data-frame-analytics>`_
|
|
5008
5003
|
|
|
5009
5004
|
:param id: Identifier for the data frame analytics job. This identifier can contain
|
|
5010
5005
|
lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores.
|
|
@@ -5119,7 +5114,7 @@ class MlClient(NamespacedClient):
|
|
|
5119
5114
|
those credentials are used instead.</p>
|
|
5120
5115
|
|
|
5121
5116
|
|
|
5122
|
-
`<https://www.elastic.co/
|
|
5117
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-datafeed>`_
|
|
5123
5118
|
|
|
5124
5119
|
:param datafeed_id: A numerical character string that uniquely identifies the
|
|
5125
5120
|
datafeed. This identifier can contain lowercase alphanumeric characters (a-z
|
|
@@ -5286,7 +5281,7 @@ class MlClient(NamespacedClient):
|
|
|
5286
5281
|
Updates the description of a filter, adds items, or removes items from the list.</p>
|
|
5287
5282
|
|
|
5288
5283
|
|
|
5289
|
-
`<https://www.elastic.co/
|
|
5284
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-filter>`_
|
|
5290
5285
|
|
|
5291
5286
|
:param filter_id: A string that uniquely identifies a filter.
|
|
5292
5287
|
:param add_items: The items to add to the filter.
|
|
@@ -5380,7 +5375,7 @@ class MlClient(NamespacedClient):
|
|
|
5380
5375
|
Updates certain properties of an anomaly detection job.</p>
|
|
5381
5376
|
|
|
5382
5377
|
|
|
5383
|
-
`<https://www.elastic.co/
|
|
5378
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-job>`_
|
|
5384
5379
|
|
|
5385
5380
|
:param job_id: Identifier for the job.
|
|
5386
5381
|
:param allow_lazy_open: Advanced configuration option. Specifies whether this
|
|
@@ -5512,7 +5507,7 @@ class MlClient(NamespacedClient):
|
|
|
5512
5507
|
Updates certain properties of a snapshot.</p>
|
|
5513
5508
|
|
|
5514
5509
|
|
|
5515
|
-
`<https://www.elastic.co/
|
|
5510
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-model-snapshot>`_
|
|
5516
5511
|
|
|
5517
5512
|
:param job_id: Identifier for the anomaly detection job.
|
|
5518
5513
|
:param snapshot_id: Identifier for the model snapshot.
|
|
@@ -5577,7 +5572,7 @@ class MlClient(NamespacedClient):
|
|
|
5577
5572
|
<p>Update a trained model deployment.</p>
|
|
5578
5573
|
|
|
5579
5574
|
|
|
5580
|
-
`<https://www.elastic.co/
|
|
5575
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-trained-model-deployment>`_
|
|
5581
5576
|
|
|
5582
5577
|
:param model_id: The unique identifier of the trained model. Currently, only
|
|
5583
5578
|
PyTorch models are supported.
|
|
@@ -5654,7 +5649,7 @@ class MlClient(NamespacedClient):
|
|
|
5654
5649
|
job.</p>
|
|
5655
5650
|
|
|
5656
5651
|
|
|
5657
|
-
`<https://www.elastic.co/
|
|
5652
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-upgrade-job-snapshot>`_
|
|
5658
5653
|
|
|
5659
5654
|
:param job_id: Identifier for the anomaly detection job.
|
|
5660
5655
|
:param snapshot_id: A numerical character string that uniquely identifies the
|
|
@@ -5733,7 +5728,7 @@ class MlClient(NamespacedClient):
|
|
|
5733
5728
|
<p>Validate an anomaly detection job.</p>
|
|
5734
5729
|
|
|
5735
5730
|
|
|
5736
|
-
`<https://www.elastic.co/guide/en/machine-learning/
|
|
5731
|
+
`<https://www.elastic.co/guide/en/machine-learning/9.0/ml-jobs.html>`_
|
|
5737
5732
|
|
|
5738
5733
|
:param analysis_config:
|
|
5739
5734
|
:param analysis_limits:
|
|
@@ -5806,7 +5801,7 @@ class MlClient(NamespacedClient):
|
|
|
5806
5801
|
<p>Validate an anomaly detection job.</p>
|
|
5807
5802
|
|
|
5808
5803
|
|
|
5809
|
-
`<https://www.elastic.co/docs/api/doc/elasticsearch/
|
|
5804
|
+
`<https://www.elastic.co/docs/api/doc/elasticsearch/v9/>`_
|
|
5810
5805
|
|
|
5811
5806
|
:param detector:
|
|
5812
5807
|
"""
|