elasticsearch 8.13.1__py3-none-any.whl → 8.14.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- elasticsearch/_async/client/__init__.py +51 -44
- elasticsearch/_async/client/async_search.py +4 -4
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +26 -26
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +23 -25
- elasticsearch/_async/client/dangling_indices.py +3 -3
- elasticsearch/_async/client/enrich.py +5 -5
- elasticsearch/_async/client/eql.py +4 -4
- elasticsearch/_async/client/esql.py +1 -1
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +1 -1
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +11 -11
- elasticsearch/_async/client/indices.py +182 -157
- elasticsearch/_async/client/inference.py +34 -17
- elasticsearch/_async/client/ingest.py +6 -6
- elasticsearch/_async/client/license.py +7 -7
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +128 -72
- elasticsearch/_async/client/monitoring.py +1 -1
- elasticsearch/_async/client/nodes.py +7 -7
- elasticsearch/_async/client/query_ruleset.py +4 -4
- elasticsearch/_async/client/rollup.py +8 -8
- elasticsearch/_async/client/search_application.py +13 -8
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +63 -53
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +11 -11
- elasticsearch/_async/client/sql.py +6 -6
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +7 -7
- elasticsearch/_async/client/tasks.py +3 -3
- elasticsearch/_async/client/text_structure.py +2 -2
- elasticsearch/_async/client/transform.py +11 -11
- elasticsearch/_async/client/watcher.py +11 -11
- elasticsearch/_async/client/xpack.py +2 -2
- elasticsearch/_sync/client/__init__.py +51 -44
- elasticsearch/_sync/client/async_search.py +4 -4
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +26 -26
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +23 -25
- elasticsearch/_sync/client/dangling_indices.py +3 -3
- elasticsearch/_sync/client/enrich.py +5 -5
- elasticsearch/_sync/client/eql.py +4 -4
- elasticsearch/_sync/client/esql.py +1 -1
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +1 -1
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +11 -11
- elasticsearch/_sync/client/indices.py +182 -157
- elasticsearch/_sync/client/inference.py +34 -17
- elasticsearch/_sync/client/ingest.py +6 -6
- elasticsearch/_sync/client/license.py +7 -7
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +128 -72
- elasticsearch/_sync/client/monitoring.py +1 -1
- elasticsearch/_sync/client/nodes.py +7 -7
- elasticsearch/_sync/client/query_ruleset.py +4 -4
- elasticsearch/_sync/client/rollup.py +8 -8
- elasticsearch/_sync/client/search_application.py +13 -8
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +63 -53
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +11 -11
- elasticsearch/_sync/client/sql.py +6 -6
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +7 -7
- elasticsearch/_sync/client/tasks.py +3 -3
- elasticsearch/_sync/client/text_structure.py +2 -2
- elasticsearch/_sync/client/transform.py +11 -11
- elasticsearch/_sync/client/watcher.py +11 -11
- elasticsearch/_sync/client/xpack.py +2 -2
- elasticsearch/_version.py +1 -1
- elasticsearch/serializer.py +0 -1
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/METADATA +16 -2
- elasticsearch-8.14.0.dist-info/RECORD +116 -0
- elasticsearch-8.13.1.dist-info/RECORD +0 -116
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/LICENSE +0 -0
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/NOTICE +0 -0
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/WHEEL +0 -0
- {elasticsearch-8.13.1.dist-info → elasticsearch-8.14.0.dist-info}/top_level.txt +0 -0
|
@@ -352,7 +352,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
352
352
|
if node_class is not DEFAULT:
|
|
353
353
|
transport_kwargs["node_class"] = node_class
|
|
354
354
|
if node_pool_class is not DEFAULT:
|
|
355
|
-
transport_kwargs["node_pool_class"] =
|
|
355
|
+
transport_kwargs["node_pool_class"] = node_pool_class
|
|
356
356
|
if randomize_nodes_in_pool is not DEFAULT:
|
|
357
357
|
transport_kwargs["randomize_nodes_in_pool"] = randomize_nodes_in_pool
|
|
358
358
|
if node_selector_class is not DEFAULT:
|
|
@@ -640,7 +640,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
640
640
|
"""
|
|
641
641
|
Allows to perform multiple index/update/delete operations in a single request.
|
|
642
642
|
|
|
643
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
643
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-bulk.html>`_
|
|
644
644
|
|
|
645
645
|
:param operations:
|
|
646
646
|
:param index: Name of the data stream, index, or index alias to perform bulk
|
|
@@ -739,7 +739,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
739
739
|
"""
|
|
740
740
|
Explicitly clears the search context for a scroll.
|
|
741
741
|
|
|
742
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
742
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/clear-scroll-api.html>`_
|
|
743
743
|
|
|
744
744
|
:param scroll_id: Scroll IDs to clear. To clear all scroll IDs, use `_all`.
|
|
745
745
|
"""
|
|
@@ -789,7 +789,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
789
789
|
"""
|
|
790
790
|
Close a point in time
|
|
791
791
|
|
|
792
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
792
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/point-in-time-api.html>`_
|
|
793
793
|
|
|
794
794
|
:param id: The ID of the point-in-time.
|
|
795
795
|
"""
|
|
@@ -863,7 +863,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
863
863
|
"""
|
|
864
864
|
Returns number of documents matching a query.
|
|
865
865
|
|
|
866
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
866
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-count.html>`_
|
|
867
867
|
|
|
868
868
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
869
869
|
Supports wildcards (`*`). To search all data streams and indices, omit this
|
|
@@ -997,7 +997,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
997
997
|
Creates a new document in the index. Returns a 409 response when a document with
|
|
998
998
|
a same ID already exists in the index.
|
|
999
999
|
|
|
1000
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1000
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-index_.html>`_
|
|
1001
1001
|
|
|
1002
1002
|
:param index: Name of the data stream or index to target. If the target doesn’t
|
|
1003
1003
|
exist and matches the name or wildcard (`*`) pattern of an index template
|
|
@@ -1101,7 +1101,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1101
1101
|
"""
|
|
1102
1102
|
Removes a document from the index.
|
|
1103
1103
|
|
|
1104
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1104
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-delete.html>`_
|
|
1105
1105
|
|
|
1106
1106
|
:param index: Name of the target index.
|
|
1107
1107
|
:param id: Unique identifier for the document.
|
|
@@ -1225,7 +1225,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1225
1225
|
"""
|
|
1226
1226
|
Deletes documents matching the provided query.
|
|
1227
1227
|
|
|
1228
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1228
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-delete-by-query.html>`_
|
|
1229
1229
|
|
|
1230
1230
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
1231
1231
|
Supports wildcards (`*`). To search all data streams or indices, omit this
|
|
@@ -1403,7 +1403,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1403
1403
|
"""
|
|
1404
1404
|
Changes the number of requests per second for a particular Delete By Query operation.
|
|
1405
1405
|
|
|
1406
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1406
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-delete-by-query.html>`_
|
|
1407
1407
|
|
|
1408
1408
|
:param task_id: The ID for the task.
|
|
1409
1409
|
:param requests_per_second: The throttle for this request in sub-requests per
|
|
@@ -1451,7 +1451,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1451
1451
|
"""
|
|
1452
1452
|
Deletes a script.
|
|
1453
1453
|
|
|
1454
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1454
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-scripting.html>`_
|
|
1455
1455
|
|
|
1456
1456
|
:param id: Identifier for the stored script or search template.
|
|
1457
1457
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -1519,7 +1519,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1519
1519
|
"""
|
|
1520
1520
|
Returns information about whether a document exists in an index.
|
|
1521
1521
|
|
|
1522
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1522
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-get.html>`_
|
|
1523
1523
|
|
|
1524
1524
|
:param index: Comma-separated list of data streams, indices, and aliases. Supports
|
|
1525
1525
|
wildcards (`*`).
|
|
@@ -1620,7 +1620,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1620
1620
|
"""
|
|
1621
1621
|
Returns information about whether a document source exists in an index.
|
|
1622
1622
|
|
|
1623
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1623
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-get.html>`_
|
|
1624
1624
|
|
|
1625
1625
|
:param index: Comma-separated list of data streams, indices, and aliases. Supports
|
|
1626
1626
|
wildcards (`*`).
|
|
@@ -1720,7 +1720,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1720
1720
|
"""
|
|
1721
1721
|
Returns information about why a specific matches (or doesn't match) a query.
|
|
1722
1722
|
|
|
1723
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1723
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-explain.html>`_
|
|
1724
1724
|
|
|
1725
1725
|
:param index: Index names used to limit the request. Only a single index name
|
|
1726
1726
|
can be provided to this parameter.
|
|
@@ -1839,7 +1839,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1839
1839
|
"""
|
|
1840
1840
|
Returns the information about the capabilities of fields among multiple indices.
|
|
1841
1841
|
|
|
1842
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1842
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-field-caps.html>`_
|
|
1843
1843
|
|
|
1844
1844
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
1845
1845
|
to limit the request. Supports wildcards (*). To target all data streams
|
|
@@ -1955,7 +1955,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
1955
1955
|
"""
|
|
1956
1956
|
Returns a document.
|
|
1957
1957
|
|
|
1958
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1958
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-get.html>`_
|
|
1959
1959
|
|
|
1960
1960
|
:param index: Name of the index that contains the document.
|
|
1961
1961
|
:param id: Unique identifier of the document.
|
|
@@ -2046,7 +2046,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2046
2046
|
"""
|
|
2047
2047
|
Returns a script.
|
|
2048
2048
|
|
|
2049
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2049
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-scripting.html>`_
|
|
2050
2050
|
|
|
2051
2051
|
:param id: Identifier for the stored script or search template.
|
|
2052
2052
|
:param master_timeout: Specify timeout for connection to master
|
|
@@ -2088,7 +2088,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2088
2088
|
"""
|
|
2089
2089
|
Returns all script contexts.
|
|
2090
2090
|
|
|
2091
|
-
`<https://www.elastic.co/guide/en/elasticsearch/painless/8.
|
|
2091
|
+
`<https://www.elastic.co/guide/en/elasticsearch/painless/8.14/painless-contexts.html>`_
|
|
2092
2092
|
"""
|
|
2093
2093
|
__path_parts: t.Dict[str, str] = {}
|
|
2094
2094
|
__path = "/_script_context"
|
|
@@ -2123,7 +2123,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2123
2123
|
"""
|
|
2124
2124
|
Returns available script types, languages and contexts
|
|
2125
2125
|
|
|
2126
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2126
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-scripting.html>`_
|
|
2127
2127
|
"""
|
|
2128
2128
|
__path_parts: t.Dict[str, str] = {}
|
|
2129
2129
|
__path = "/_script_language"
|
|
@@ -2178,7 +2178,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2178
2178
|
"""
|
|
2179
2179
|
Returns the source of a document.
|
|
2180
2180
|
|
|
2181
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2181
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-get.html>`_
|
|
2182
2182
|
|
|
2183
2183
|
:param index: Name of the index that contains the document.
|
|
2184
2184
|
:param id: Unique identifier of the document.
|
|
@@ -2261,7 +2261,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2261
2261
|
"""
|
|
2262
2262
|
Returns the health of the cluster.
|
|
2263
2263
|
|
|
2264
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2264
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/health-api.html>`_
|
|
2265
2265
|
|
|
2266
2266
|
:param feature: A feature of the cluster, as returned by the top-level health
|
|
2267
2267
|
report API.
|
|
@@ -2336,7 +2336,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2336
2336
|
"""
|
|
2337
2337
|
Creates or updates a document in an index.
|
|
2338
2338
|
|
|
2339
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2339
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-index_.html>`_
|
|
2340
2340
|
|
|
2341
2341
|
:param index: Name of the data stream or index to target.
|
|
2342
2342
|
:param document:
|
|
@@ -2445,7 +2445,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2445
2445
|
"""
|
|
2446
2446
|
Returns basic information about the cluster.
|
|
2447
2447
|
|
|
2448
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2448
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/index.html>`_
|
|
2449
2449
|
"""
|
|
2450
2450
|
__path_parts: t.Dict[str, str] = {}
|
|
2451
2451
|
__path = "/"
|
|
@@ -2501,7 +2501,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2501
2501
|
"""
|
|
2502
2502
|
Performs a kNN search.
|
|
2503
2503
|
|
|
2504
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2504
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-search.html>`_
|
|
2505
2505
|
|
|
2506
2506
|
:param index: A comma-separated list of index names to search; use `_all` or
|
|
2507
2507
|
to perform the operation on all indices
|
|
@@ -2602,7 +2602,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2602
2602
|
"""
|
|
2603
2603
|
Allows to get multiple documents in one request.
|
|
2604
2604
|
|
|
2605
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2605
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-multi-get.html>`_
|
|
2606
2606
|
|
|
2607
2607
|
:param index: Name of the index to retrieve documents from when `ids` are specified,
|
|
2608
2608
|
or when a document in the `docs` array does not specify an index.
|
|
@@ -2722,7 +2722,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2722
2722
|
"""
|
|
2723
2723
|
Allows to execute several search operations in one request.
|
|
2724
2724
|
|
|
2725
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2725
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-multi-search.html>`_
|
|
2726
2726
|
|
|
2727
2727
|
:param searches:
|
|
2728
2728
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
@@ -2845,7 +2845,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2845
2845
|
"""
|
|
2846
2846
|
Allows to execute several search template operations in one request.
|
|
2847
2847
|
|
|
2848
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2848
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-multi-search.html>`_
|
|
2849
2849
|
|
|
2850
2850
|
:param search_templates:
|
|
2851
2851
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
@@ -2940,7 +2940,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
2940
2940
|
"""
|
|
2941
2941
|
Returns multiple termvectors in one request.
|
|
2942
2942
|
|
|
2943
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2943
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-multi-termvectors.html>`_
|
|
2944
2944
|
|
|
2945
2945
|
:param index: Name of the index that contains the documents.
|
|
2946
2946
|
:param docs: Array of existing or artificial documents.
|
|
@@ -3047,7 +3047,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3047
3047
|
"""
|
|
3048
3048
|
Open a point in time that can be used in subsequent searches
|
|
3049
3049
|
|
|
3050
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3050
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/point-in-time-api.html>`_
|
|
3051
3051
|
|
|
3052
3052
|
:param index: A comma-separated list of index names to open point in time; use
|
|
3053
3053
|
`_all` or empty string to perform the operation on all indices
|
|
@@ -3119,7 +3119,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3119
3119
|
"""
|
|
3120
3120
|
Creates or updates a script.
|
|
3121
3121
|
|
|
3122
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3122
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-scripting.html>`_
|
|
3123
3123
|
|
|
3124
3124
|
:param id: Identifier for the stored script or search template. Must be unique
|
|
3125
3125
|
within the cluster.
|
|
@@ -3205,7 +3205,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3205
3205
|
Allows to evaluate the quality of ranked search results over a set of typical
|
|
3206
3206
|
search queries
|
|
3207
3207
|
|
|
3208
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3208
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-rank-eval.html>`_
|
|
3209
3209
|
|
|
3210
3210
|
:param requests: A set of typical search requests, together with their provided
|
|
3211
3211
|
ratings.
|
|
@@ -3301,7 +3301,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3301
3301
|
source documents by a query, changing the destination index settings, or fetching
|
|
3302
3302
|
the documents from a remote cluster.
|
|
3303
3303
|
|
|
3304
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3304
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-reindex.html>`_
|
|
3305
3305
|
|
|
3306
3306
|
:param dest: The destination you are copying to.
|
|
3307
3307
|
:param source: The source you are copying from.
|
|
@@ -3397,7 +3397,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3397
3397
|
"""
|
|
3398
3398
|
Changes the number of requests per second for a particular Reindex operation.
|
|
3399
3399
|
|
|
3400
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3400
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-reindex.html>`_
|
|
3401
3401
|
|
|
3402
3402
|
:param task_id: Identifier for the task.
|
|
3403
3403
|
:param requests_per_second: The throttle for this request in sub-requests per
|
|
@@ -3448,7 +3448,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3448
3448
|
"""
|
|
3449
3449
|
Allows to use the Mustache language to pre-render a search definition.
|
|
3450
3450
|
|
|
3451
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3451
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/render-search-template-api.html>`_
|
|
3452
3452
|
|
|
3453
3453
|
:param id: ID of the search template to render. If no `source` is specified,
|
|
3454
3454
|
this or the `id` request body parameter is required.
|
|
@@ -3516,7 +3516,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3516
3516
|
"""
|
|
3517
3517
|
Allows an arbitrary script to be executed and a result to be returned
|
|
3518
3518
|
|
|
3519
|
-
`<https://www.elastic.co/guide/en/elasticsearch/painless/8.
|
|
3519
|
+
`<https://www.elastic.co/guide/en/elasticsearch/painless/8.14/painless-execute-api.html>`_
|
|
3520
3520
|
|
|
3521
3521
|
:param context: The context that the script should run in.
|
|
3522
3522
|
:param context_setup: Additional parameters for the `context`.
|
|
@@ -3574,7 +3574,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3574
3574
|
"""
|
|
3575
3575
|
Allows to retrieve a large numbers of results from a single search request.
|
|
3576
3576
|
|
|
3577
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3577
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-request-body.html#request-body-search-scroll>`_
|
|
3578
3578
|
|
|
3579
3579
|
:param scroll_id: Scroll ID of the search.
|
|
3580
3580
|
:param rest_total_hits_as_int: If true, the API response’s hit.total property
|
|
@@ -3638,6 +3638,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3638
3638
|
"query",
|
|
3639
3639
|
"rank",
|
|
3640
3640
|
"rescore",
|
|
3641
|
+
"retriever",
|
|
3641
3642
|
"runtime_mappings",
|
|
3642
3643
|
"script_fields",
|
|
3643
3644
|
"search_after",
|
|
@@ -3719,6 +3720,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3719
3720
|
t.Union[t.Mapping[str, t.Any], t.Sequence[t.Mapping[str, t.Any]]]
|
|
3720
3721
|
] = None,
|
|
3721
3722
|
rest_total_hits_as_int: t.Optional[bool] = None,
|
|
3723
|
+
retriever: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3722
3724
|
routing: t.Optional[str] = None,
|
|
3723
3725
|
runtime_mappings: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
|
|
3724
3726
|
script_fields: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
|
|
@@ -3761,7 +3763,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3761
3763
|
"""
|
|
3762
3764
|
Returns results matching a query.
|
|
3763
3765
|
|
|
3764
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3766
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-search.html>`_
|
|
3765
3767
|
|
|
3766
3768
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
3767
3769
|
Supports wildcards (`*`). To search all data streams and indices, omit this
|
|
@@ -3878,6 +3880,9 @@ class AsyncElasticsearch(BaseClient):
|
|
|
3878
3880
|
example 100 - 500) documents returned by the `query` and `post_filter` phases.
|
|
3879
3881
|
:param rest_total_hits_as_int: Indicates whether `hits.total` should be rendered
|
|
3880
3882
|
as an integer or an object in the rest search response.
|
|
3883
|
+
:param retriever: A retriever is a specification to describe top documents returned
|
|
3884
|
+
from a search. A retriever replaces other elements of the search API that
|
|
3885
|
+
also return top documents such as query and knn.
|
|
3881
3886
|
:param routing: Custom value used to route operations to a specific shard.
|
|
3882
3887
|
:param runtime_mappings: Defines one or more runtime fields in the search request.
|
|
3883
3888
|
These fields take precedence over mapped fields with the same name.
|
|
@@ -4074,6 +4079,8 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4074
4079
|
__body["rank"] = rank
|
|
4075
4080
|
if rescore is not None:
|
|
4076
4081
|
__body["rescore"] = rescore
|
|
4082
|
+
if retriever is not None:
|
|
4083
|
+
__body["retriever"] = retriever
|
|
4077
4084
|
if runtime_mappings is not None:
|
|
4078
4085
|
__body["runtime_mappings"] = runtime_mappings
|
|
4079
4086
|
if script_fields is not None:
|
|
@@ -4178,7 +4185,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4178
4185
|
Searches a vector tile for geospatial values. Returns results as a binary Mapbox
|
|
4179
4186
|
vector tile.
|
|
4180
4187
|
|
|
4181
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4188
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-vector-tile-api.html>`_
|
|
4182
4189
|
|
|
4183
4190
|
:param index: Comma-separated list of data streams, indices, or aliases to search
|
|
4184
4191
|
:param field: Field containing geospatial data to return
|
|
@@ -4333,7 +4340,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4333
4340
|
Returns information about the indices and shards that a search request would
|
|
4334
4341
|
be executed against.
|
|
4335
4342
|
|
|
4336
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4343
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-shards.html>`_
|
|
4337
4344
|
|
|
4338
4345
|
:param index: Returns the indices and shards that a search request would be executed
|
|
4339
4346
|
against.
|
|
@@ -4434,7 +4441,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4434
4441
|
"""
|
|
4435
4442
|
Allows to use the Mustache language to pre-render a search definition.
|
|
4436
4443
|
|
|
4437
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4444
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-template.html>`_
|
|
4438
4445
|
|
|
4439
4446
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
4440
4447
|
Supports wildcards (*).
|
|
@@ -4568,7 +4575,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4568
4575
|
the provided string. It is designed for low-latency look-ups used in auto-complete
|
|
4569
4576
|
scenarios.
|
|
4570
4577
|
|
|
4571
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4578
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-terms-enum.html>`_
|
|
4572
4579
|
|
|
4573
4580
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
4574
4581
|
to search. Wildcard (*) expressions are supported.
|
|
@@ -4667,7 +4674,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4667
4674
|
Returns information and statistics about terms in the fields of a particular
|
|
4668
4675
|
document.
|
|
4669
4676
|
|
|
4670
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4677
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-termvectors.html>`_
|
|
4671
4678
|
|
|
4672
4679
|
:param index: Name of the index that contains the document.
|
|
4673
4680
|
:param id: Unique identifier of the document.
|
|
@@ -4809,7 +4816,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4809
4816
|
"""
|
|
4810
4817
|
Updates a document with a script or partial document.
|
|
4811
4818
|
|
|
4812
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4819
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-update.html>`_
|
|
4813
4820
|
|
|
4814
4821
|
:param index: The name of the index
|
|
4815
4822
|
:param id: Document ID
|
|
@@ -4976,7 +4983,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
4976
4983
|
an update on every document in the index without changing the source, for example
|
|
4977
4984
|
to pick up a mapping change.
|
|
4978
4985
|
|
|
4979
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4986
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-update-by-query.html>`_
|
|
4980
4987
|
|
|
4981
4988
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
4982
4989
|
Supports wildcards (`*`). To search all data streams or indices, omit this
|
|
@@ -5169,7 +5176,7 @@ class AsyncElasticsearch(BaseClient):
|
|
|
5169
5176
|
"""
|
|
5170
5177
|
Changes the number of requests per second for a particular Update By Query operation.
|
|
5171
5178
|
|
|
5172
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5179
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-update-by-query.html>`_
|
|
5173
5180
|
|
|
5174
5181
|
:param task_id: The ID for the task.
|
|
5175
5182
|
:param requests_per_second: The throttle for this request in sub-requests per
|
|
@@ -39,7 +39,7 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
39
39
|
Deletes an async search by ID. If the search is still running, the search request
|
|
40
40
|
will be cancelled. Otherwise, the saved search results are deleted.
|
|
41
41
|
|
|
42
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
42
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/async-search.html>`_
|
|
43
43
|
|
|
44
44
|
:param id: A unique identifier for the async search.
|
|
45
45
|
"""
|
|
@@ -85,7 +85,7 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
85
85
|
Retrieves the results of a previously submitted async search request given its
|
|
86
86
|
ID.
|
|
87
87
|
|
|
88
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
88
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/async-search.html>`_
|
|
89
89
|
|
|
90
90
|
:param id: A unique identifier for the async search.
|
|
91
91
|
:param keep_alive: Specifies how long the async search should be available in
|
|
@@ -146,7 +146,7 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
146
146
|
Retrieves the status of a previously submitted async search request given its
|
|
147
147
|
ID.
|
|
148
148
|
|
|
149
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
149
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/async-search.html>`_
|
|
150
150
|
|
|
151
151
|
:param id: A unique identifier for the async search.
|
|
152
152
|
"""
|
|
@@ -318,7 +318,7 @@ class AsyncSearchClient(NamespacedClient):
|
|
|
318
318
|
"""
|
|
319
319
|
Executes a search request asynchronously.
|
|
320
320
|
|
|
321
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
321
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/async-search.html>`_
|
|
322
322
|
|
|
323
323
|
:param index: A comma-separated list of index names to search; use `_all` or
|
|
324
324
|
empty string to perform the operation on all indices
|
|
@@ -39,7 +39,7 @@ class AutoscalingClient(NamespacedClient):
|
|
|
39
39
|
Deletes an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
|
|
40
40
|
Direct use is not supported.
|
|
41
41
|
|
|
42
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
42
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/autoscaling-delete-autoscaling-policy.html>`_
|
|
43
43
|
|
|
44
44
|
:param name: the name of the autoscaling policy
|
|
45
45
|
"""
|
|
@@ -79,7 +79,7 @@ class AutoscalingClient(NamespacedClient):
|
|
|
79
79
|
Gets the current autoscaling capacity based on the configured autoscaling policy.
|
|
80
80
|
Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.
|
|
81
81
|
|
|
82
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
82
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/autoscaling-get-autoscaling-capacity.html>`_
|
|
83
83
|
"""
|
|
84
84
|
__path_parts: t.Dict[str, str] = {}
|
|
85
85
|
__path = "/_autoscaling/capacity"
|
|
@@ -116,7 +116,7 @@ class AutoscalingClient(NamespacedClient):
|
|
|
116
116
|
Retrieves an autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
|
|
117
117
|
Direct use is not supported.
|
|
118
118
|
|
|
119
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
119
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/autoscaling-get-autoscaling-capacity.html>`_
|
|
120
120
|
|
|
121
121
|
:param name: the name of the autoscaling policy
|
|
122
122
|
"""
|
|
@@ -161,7 +161,7 @@ class AutoscalingClient(NamespacedClient):
|
|
|
161
161
|
Creates a new autoscaling policy. Designed for indirect use by ECE/ESS and ECK.
|
|
162
162
|
Direct use is not supported.
|
|
163
163
|
|
|
164
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
164
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/autoscaling-put-autoscaling-policy.html>`_
|
|
165
165
|
|
|
166
166
|
:param name: the name of the autoscaling policy
|
|
167
167
|
:param policy:
|