elasticsearch 8.13.2__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 +73 -73
- 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 +73 -73
- 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.2.dist-info → elasticsearch-8.14.0.dist-info}/METADATA +15 -1
- elasticsearch-8.14.0.dist-info/RECORD +116 -0
- elasticsearch-8.13.2.dist-info/RECORD +0 -116
- {elasticsearch-8.13.2.dist-info → elasticsearch-8.14.0.dist-info}/LICENSE +0 -0
- {elasticsearch-8.13.2.dist-info → elasticsearch-8.14.0.dist-info}/NOTICE +0 -0
- {elasticsearch-8.13.2.dist-info → elasticsearch-8.14.0.dist-info}/WHEEL +0 -0
- {elasticsearch-8.13.2.dist-info → elasticsearch-8.14.0.dist-info}/top_level.txt +0 -0
|
@@ -352,7 +352,7 @@ class Elasticsearch(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:
|
|
@@ -638,7 +638,7 @@ class Elasticsearch(BaseClient):
|
|
|
638
638
|
"""
|
|
639
639
|
Allows to perform multiple index/update/delete operations in a single request.
|
|
640
640
|
|
|
641
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
641
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-bulk.html>`_
|
|
642
642
|
|
|
643
643
|
:param operations:
|
|
644
644
|
:param index: Name of the data stream, index, or index alias to perform bulk
|
|
@@ -737,7 +737,7 @@ class Elasticsearch(BaseClient):
|
|
|
737
737
|
"""
|
|
738
738
|
Explicitly clears the search context for a scroll.
|
|
739
739
|
|
|
740
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
740
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/clear-scroll-api.html>`_
|
|
741
741
|
|
|
742
742
|
:param scroll_id: Scroll IDs to clear. To clear all scroll IDs, use `_all`.
|
|
743
743
|
"""
|
|
@@ -787,7 +787,7 @@ class Elasticsearch(BaseClient):
|
|
|
787
787
|
"""
|
|
788
788
|
Close a point in time
|
|
789
789
|
|
|
790
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
790
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/point-in-time-api.html>`_
|
|
791
791
|
|
|
792
792
|
:param id: The ID of the point-in-time.
|
|
793
793
|
"""
|
|
@@ -861,7 +861,7 @@ class Elasticsearch(BaseClient):
|
|
|
861
861
|
"""
|
|
862
862
|
Returns number of documents matching a query.
|
|
863
863
|
|
|
864
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
864
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-count.html>`_
|
|
865
865
|
|
|
866
866
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
867
867
|
Supports wildcards (`*`). To search all data streams and indices, omit this
|
|
@@ -995,7 +995,7 @@ class Elasticsearch(BaseClient):
|
|
|
995
995
|
Creates a new document in the index. Returns a 409 response when a document with
|
|
996
996
|
a same ID already exists in the index.
|
|
997
997
|
|
|
998
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
998
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-index_.html>`_
|
|
999
999
|
|
|
1000
1000
|
:param index: Name of the data stream or index to target. If the target doesn’t
|
|
1001
1001
|
exist and matches the name or wildcard (`*`) pattern of an index template
|
|
@@ -1099,7 +1099,7 @@ class Elasticsearch(BaseClient):
|
|
|
1099
1099
|
"""
|
|
1100
1100
|
Removes a document from the index.
|
|
1101
1101
|
|
|
1102
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1102
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-delete.html>`_
|
|
1103
1103
|
|
|
1104
1104
|
:param index: Name of the target index.
|
|
1105
1105
|
:param id: Unique identifier for the document.
|
|
@@ -1223,7 +1223,7 @@ class Elasticsearch(BaseClient):
|
|
|
1223
1223
|
"""
|
|
1224
1224
|
Deletes documents matching the provided query.
|
|
1225
1225
|
|
|
1226
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1226
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-delete-by-query.html>`_
|
|
1227
1227
|
|
|
1228
1228
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
1229
1229
|
Supports wildcards (`*`). To search all data streams or indices, omit this
|
|
@@ -1401,7 +1401,7 @@ class Elasticsearch(BaseClient):
|
|
|
1401
1401
|
"""
|
|
1402
1402
|
Changes the number of requests per second for a particular Delete By Query operation.
|
|
1403
1403
|
|
|
1404
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1404
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-delete-by-query.html>`_
|
|
1405
1405
|
|
|
1406
1406
|
:param task_id: The ID for the task.
|
|
1407
1407
|
:param requests_per_second: The throttle for this request in sub-requests per
|
|
@@ -1449,7 +1449,7 @@ class Elasticsearch(BaseClient):
|
|
|
1449
1449
|
"""
|
|
1450
1450
|
Deletes a script.
|
|
1451
1451
|
|
|
1452
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1452
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-scripting.html>`_
|
|
1453
1453
|
|
|
1454
1454
|
:param id: Identifier for the stored script or search template.
|
|
1455
1455
|
:param master_timeout: Period to wait for a connection to the master node. If
|
|
@@ -1517,7 +1517,7 @@ class Elasticsearch(BaseClient):
|
|
|
1517
1517
|
"""
|
|
1518
1518
|
Returns information about whether a document exists in an index.
|
|
1519
1519
|
|
|
1520
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1520
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-get.html>`_
|
|
1521
1521
|
|
|
1522
1522
|
:param index: Comma-separated list of data streams, indices, and aliases. Supports
|
|
1523
1523
|
wildcards (`*`).
|
|
@@ -1618,7 +1618,7 @@ class Elasticsearch(BaseClient):
|
|
|
1618
1618
|
"""
|
|
1619
1619
|
Returns information about whether a document source exists in an index.
|
|
1620
1620
|
|
|
1621
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1621
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-get.html>`_
|
|
1622
1622
|
|
|
1623
1623
|
:param index: Comma-separated list of data streams, indices, and aliases. Supports
|
|
1624
1624
|
wildcards (`*`).
|
|
@@ -1718,7 +1718,7 @@ class Elasticsearch(BaseClient):
|
|
|
1718
1718
|
"""
|
|
1719
1719
|
Returns information about why a specific matches (or doesn't match) a query.
|
|
1720
1720
|
|
|
1721
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1721
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-explain.html>`_
|
|
1722
1722
|
|
|
1723
1723
|
:param index: Index names used to limit the request. Only a single index name
|
|
1724
1724
|
can be provided to this parameter.
|
|
@@ -1837,7 +1837,7 @@ class Elasticsearch(BaseClient):
|
|
|
1837
1837
|
"""
|
|
1838
1838
|
Returns the information about the capabilities of fields among multiple indices.
|
|
1839
1839
|
|
|
1840
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1840
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-field-caps.html>`_
|
|
1841
1841
|
|
|
1842
1842
|
:param index: Comma-separated list of data streams, indices, and aliases used
|
|
1843
1843
|
to limit the request. Supports wildcards (*). To target all data streams
|
|
@@ -1953,7 +1953,7 @@ class Elasticsearch(BaseClient):
|
|
|
1953
1953
|
"""
|
|
1954
1954
|
Returns a document.
|
|
1955
1955
|
|
|
1956
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
1956
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-get.html>`_
|
|
1957
1957
|
|
|
1958
1958
|
:param index: Name of the index that contains the document.
|
|
1959
1959
|
:param id: Unique identifier of the document.
|
|
@@ -2044,7 +2044,7 @@ class Elasticsearch(BaseClient):
|
|
|
2044
2044
|
"""
|
|
2045
2045
|
Returns a script.
|
|
2046
2046
|
|
|
2047
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2047
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-scripting.html>`_
|
|
2048
2048
|
|
|
2049
2049
|
:param id: Identifier for the stored script or search template.
|
|
2050
2050
|
:param master_timeout: Specify timeout for connection to master
|
|
@@ -2086,7 +2086,7 @@ class Elasticsearch(BaseClient):
|
|
|
2086
2086
|
"""
|
|
2087
2087
|
Returns all script contexts.
|
|
2088
2088
|
|
|
2089
|
-
`<https://www.elastic.co/guide/en/elasticsearch/painless/8.
|
|
2089
|
+
`<https://www.elastic.co/guide/en/elasticsearch/painless/8.14/painless-contexts.html>`_
|
|
2090
2090
|
"""
|
|
2091
2091
|
__path_parts: t.Dict[str, str] = {}
|
|
2092
2092
|
__path = "/_script_context"
|
|
@@ -2121,7 +2121,7 @@ class Elasticsearch(BaseClient):
|
|
|
2121
2121
|
"""
|
|
2122
2122
|
Returns available script types, languages and contexts
|
|
2123
2123
|
|
|
2124
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2124
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-scripting.html>`_
|
|
2125
2125
|
"""
|
|
2126
2126
|
__path_parts: t.Dict[str, str] = {}
|
|
2127
2127
|
__path = "/_script_language"
|
|
@@ -2176,7 +2176,7 @@ class Elasticsearch(BaseClient):
|
|
|
2176
2176
|
"""
|
|
2177
2177
|
Returns the source of a document.
|
|
2178
2178
|
|
|
2179
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2179
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-get.html>`_
|
|
2180
2180
|
|
|
2181
2181
|
:param index: Name of the index that contains the document.
|
|
2182
2182
|
:param id: Unique identifier of the document.
|
|
@@ -2259,7 +2259,7 @@ class Elasticsearch(BaseClient):
|
|
|
2259
2259
|
"""
|
|
2260
2260
|
Returns the health of the cluster.
|
|
2261
2261
|
|
|
2262
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2262
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/health-api.html>`_
|
|
2263
2263
|
|
|
2264
2264
|
:param feature: A feature of the cluster, as returned by the top-level health
|
|
2265
2265
|
report API.
|
|
@@ -2334,7 +2334,7 @@ class Elasticsearch(BaseClient):
|
|
|
2334
2334
|
"""
|
|
2335
2335
|
Creates or updates a document in an index.
|
|
2336
2336
|
|
|
2337
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2337
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-index_.html>`_
|
|
2338
2338
|
|
|
2339
2339
|
:param index: Name of the data stream or index to target.
|
|
2340
2340
|
:param document:
|
|
@@ -2443,7 +2443,7 @@ class Elasticsearch(BaseClient):
|
|
|
2443
2443
|
"""
|
|
2444
2444
|
Returns basic information about the cluster.
|
|
2445
2445
|
|
|
2446
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2446
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/index.html>`_
|
|
2447
2447
|
"""
|
|
2448
2448
|
__path_parts: t.Dict[str, str] = {}
|
|
2449
2449
|
__path = "/"
|
|
@@ -2499,7 +2499,7 @@ class Elasticsearch(BaseClient):
|
|
|
2499
2499
|
"""
|
|
2500
2500
|
Performs a kNN search.
|
|
2501
2501
|
|
|
2502
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2502
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-search.html>`_
|
|
2503
2503
|
|
|
2504
2504
|
:param index: A comma-separated list of index names to search; use `_all` or
|
|
2505
2505
|
to perform the operation on all indices
|
|
@@ -2600,7 +2600,7 @@ class Elasticsearch(BaseClient):
|
|
|
2600
2600
|
"""
|
|
2601
2601
|
Allows to get multiple documents in one request.
|
|
2602
2602
|
|
|
2603
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2603
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-multi-get.html>`_
|
|
2604
2604
|
|
|
2605
2605
|
:param index: Name of the index to retrieve documents from when `ids` are specified,
|
|
2606
2606
|
or when a document in the `docs` array does not specify an index.
|
|
@@ -2720,7 +2720,7 @@ class Elasticsearch(BaseClient):
|
|
|
2720
2720
|
"""
|
|
2721
2721
|
Allows to execute several search operations in one request.
|
|
2722
2722
|
|
|
2723
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2723
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-multi-search.html>`_
|
|
2724
2724
|
|
|
2725
2725
|
:param searches:
|
|
2726
2726
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
@@ -2843,7 +2843,7 @@ class Elasticsearch(BaseClient):
|
|
|
2843
2843
|
"""
|
|
2844
2844
|
Allows to execute several search template operations in one request.
|
|
2845
2845
|
|
|
2846
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2846
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-multi-search.html>`_
|
|
2847
2847
|
|
|
2848
2848
|
:param search_templates:
|
|
2849
2849
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
@@ -2938,7 +2938,7 @@ class Elasticsearch(BaseClient):
|
|
|
2938
2938
|
"""
|
|
2939
2939
|
Returns multiple termvectors in one request.
|
|
2940
2940
|
|
|
2941
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2941
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-multi-termvectors.html>`_
|
|
2942
2942
|
|
|
2943
2943
|
:param index: Name of the index that contains the documents.
|
|
2944
2944
|
:param docs: Array of existing or artificial documents.
|
|
@@ -3045,7 +3045,7 @@ class Elasticsearch(BaseClient):
|
|
|
3045
3045
|
"""
|
|
3046
3046
|
Open a point in time that can be used in subsequent searches
|
|
3047
3047
|
|
|
3048
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3048
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/point-in-time-api.html>`_
|
|
3049
3049
|
|
|
3050
3050
|
:param index: A comma-separated list of index names to open point in time; use
|
|
3051
3051
|
`_all` or empty string to perform the operation on all indices
|
|
@@ -3117,7 +3117,7 @@ class Elasticsearch(BaseClient):
|
|
|
3117
3117
|
"""
|
|
3118
3118
|
Creates or updates a script.
|
|
3119
3119
|
|
|
3120
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3120
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/modules-scripting.html>`_
|
|
3121
3121
|
|
|
3122
3122
|
:param id: Identifier for the stored script or search template. Must be unique
|
|
3123
3123
|
within the cluster.
|
|
@@ -3203,7 +3203,7 @@ class Elasticsearch(BaseClient):
|
|
|
3203
3203
|
Allows to evaluate the quality of ranked search results over a set of typical
|
|
3204
3204
|
search queries
|
|
3205
3205
|
|
|
3206
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3206
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-rank-eval.html>`_
|
|
3207
3207
|
|
|
3208
3208
|
:param requests: A set of typical search requests, together with their provided
|
|
3209
3209
|
ratings.
|
|
@@ -3299,7 +3299,7 @@ class Elasticsearch(BaseClient):
|
|
|
3299
3299
|
source documents by a query, changing the destination index settings, or fetching
|
|
3300
3300
|
the documents from a remote cluster.
|
|
3301
3301
|
|
|
3302
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3302
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-reindex.html>`_
|
|
3303
3303
|
|
|
3304
3304
|
:param dest: The destination you are copying to.
|
|
3305
3305
|
:param source: The source you are copying from.
|
|
@@ -3395,7 +3395,7 @@ class Elasticsearch(BaseClient):
|
|
|
3395
3395
|
"""
|
|
3396
3396
|
Changes the number of requests per second for a particular Reindex operation.
|
|
3397
3397
|
|
|
3398
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3398
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-reindex.html>`_
|
|
3399
3399
|
|
|
3400
3400
|
:param task_id: Identifier for the task.
|
|
3401
3401
|
:param requests_per_second: The throttle for this request in sub-requests per
|
|
@@ -3446,7 +3446,7 @@ class Elasticsearch(BaseClient):
|
|
|
3446
3446
|
"""
|
|
3447
3447
|
Allows to use the Mustache language to pre-render a search definition.
|
|
3448
3448
|
|
|
3449
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3449
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/render-search-template-api.html>`_
|
|
3450
3450
|
|
|
3451
3451
|
:param id: ID of the search template to render. If no `source` is specified,
|
|
3452
3452
|
this or the `id` request body parameter is required.
|
|
@@ -3514,7 +3514,7 @@ class Elasticsearch(BaseClient):
|
|
|
3514
3514
|
"""
|
|
3515
3515
|
Allows an arbitrary script to be executed and a result to be returned
|
|
3516
3516
|
|
|
3517
|
-
`<https://www.elastic.co/guide/en/elasticsearch/painless/8.
|
|
3517
|
+
`<https://www.elastic.co/guide/en/elasticsearch/painless/8.14/painless-execute-api.html>`_
|
|
3518
3518
|
|
|
3519
3519
|
:param context: The context that the script should run in.
|
|
3520
3520
|
:param context_setup: Additional parameters for the `context`.
|
|
@@ -3572,7 +3572,7 @@ class Elasticsearch(BaseClient):
|
|
|
3572
3572
|
"""
|
|
3573
3573
|
Allows to retrieve a large numbers of results from a single search request.
|
|
3574
3574
|
|
|
3575
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3575
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-request-body.html#request-body-search-scroll>`_
|
|
3576
3576
|
|
|
3577
3577
|
:param scroll_id: Scroll ID of the search.
|
|
3578
3578
|
:param rest_total_hits_as_int: If true, the API response’s hit.total property
|
|
@@ -3636,6 +3636,7 @@ class Elasticsearch(BaseClient):
|
|
|
3636
3636
|
"query",
|
|
3637
3637
|
"rank",
|
|
3638
3638
|
"rescore",
|
|
3639
|
+
"retriever",
|
|
3639
3640
|
"runtime_mappings",
|
|
3640
3641
|
"script_fields",
|
|
3641
3642
|
"search_after",
|
|
@@ -3717,6 +3718,7 @@ class Elasticsearch(BaseClient):
|
|
|
3717
3718
|
t.Union[t.Mapping[str, t.Any], t.Sequence[t.Mapping[str, t.Any]]]
|
|
3718
3719
|
] = None,
|
|
3719
3720
|
rest_total_hits_as_int: t.Optional[bool] = None,
|
|
3721
|
+
retriever: t.Optional[t.Mapping[str, t.Any]] = None,
|
|
3720
3722
|
routing: t.Optional[str] = None,
|
|
3721
3723
|
runtime_mappings: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
|
|
3722
3724
|
script_fields: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
|
|
@@ -3759,7 +3761,7 @@ class Elasticsearch(BaseClient):
|
|
|
3759
3761
|
"""
|
|
3760
3762
|
Returns results matching a query.
|
|
3761
3763
|
|
|
3762
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3764
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-search.html>`_
|
|
3763
3765
|
|
|
3764
3766
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
3765
3767
|
Supports wildcards (`*`). To search all data streams and indices, omit this
|
|
@@ -3876,6 +3878,9 @@ class Elasticsearch(BaseClient):
|
|
|
3876
3878
|
example 100 - 500) documents returned by the `query` and `post_filter` phases.
|
|
3877
3879
|
:param rest_total_hits_as_int: Indicates whether `hits.total` should be rendered
|
|
3878
3880
|
as an integer or an object in the rest search response.
|
|
3881
|
+
:param retriever: A retriever is a specification to describe top documents returned
|
|
3882
|
+
from a search. A retriever replaces other elements of the search API that
|
|
3883
|
+
also return top documents such as query and knn.
|
|
3879
3884
|
:param routing: Custom value used to route operations to a specific shard.
|
|
3880
3885
|
:param runtime_mappings: Defines one or more runtime fields in the search request.
|
|
3881
3886
|
These fields take precedence over mapped fields with the same name.
|
|
@@ -4072,6 +4077,8 @@ class Elasticsearch(BaseClient):
|
|
|
4072
4077
|
__body["rank"] = rank
|
|
4073
4078
|
if rescore is not None:
|
|
4074
4079
|
__body["rescore"] = rescore
|
|
4080
|
+
if retriever is not None:
|
|
4081
|
+
__body["retriever"] = retriever
|
|
4075
4082
|
if runtime_mappings is not None:
|
|
4076
4083
|
__body["runtime_mappings"] = runtime_mappings
|
|
4077
4084
|
if script_fields is not None:
|
|
@@ -4176,7 +4183,7 @@ class Elasticsearch(BaseClient):
|
|
|
4176
4183
|
Searches a vector tile for geospatial values. Returns results as a binary Mapbox
|
|
4177
4184
|
vector tile.
|
|
4178
4185
|
|
|
4179
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4186
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-vector-tile-api.html>`_
|
|
4180
4187
|
|
|
4181
4188
|
:param index: Comma-separated list of data streams, indices, or aliases to search
|
|
4182
4189
|
:param field: Field containing geospatial data to return
|
|
@@ -4331,7 +4338,7 @@ class Elasticsearch(BaseClient):
|
|
|
4331
4338
|
Returns information about the indices and shards that a search request would
|
|
4332
4339
|
be executed against.
|
|
4333
4340
|
|
|
4334
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4341
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-shards.html>`_
|
|
4335
4342
|
|
|
4336
4343
|
:param index: Returns the indices and shards that a search request would be executed
|
|
4337
4344
|
against.
|
|
@@ -4432,7 +4439,7 @@ class Elasticsearch(BaseClient):
|
|
|
4432
4439
|
"""
|
|
4433
4440
|
Allows to use the Mustache language to pre-render a search definition.
|
|
4434
4441
|
|
|
4435
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4442
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-template.html>`_
|
|
4436
4443
|
|
|
4437
4444
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
4438
4445
|
Supports wildcards (*).
|
|
@@ -4566,7 +4573,7 @@ class Elasticsearch(BaseClient):
|
|
|
4566
4573
|
the provided string. It is designed for low-latency look-ups used in auto-complete
|
|
4567
4574
|
scenarios.
|
|
4568
4575
|
|
|
4569
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4576
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/search-terms-enum.html>`_
|
|
4570
4577
|
|
|
4571
4578
|
:param index: Comma-separated list of data streams, indices, and index aliases
|
|
4572
4579
|
to search. Wildcard (*) expressions are supported.
|
|
@@ -4665,7 +4672,7 @@ class Elasticsearch(BaseClient):
|
|
|
4665
4672
|
Returns information and statistics about terms in the fields of a particular
|
|
4666
4673
|
document.
|
|
4667
4674
|
|
|
4668
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4675
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-termvectors.html>`_
|
|
4669
4676
|
|
|
4670
4677
|
:param index: Name of the index that contains the document.
|
|
4671
4678
|
:param id: Unique identifier of the document.
|
|
@@ -4807,7 +4814,7 @@ class Elasticsearch(BaseClient):
|
|
|
4807
4814
|
"""
|
|
4808
4815
|
Updates a document with a script or partial document.
|
|
4809
4816
|
|
|
4810
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4817
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-update.html>`_
|
|
4811
4818
|
|
|
4812
4819
|
:param index: The name of the index
|
|
4813
4820
|
:param id: Document ID
|
|
@@ -4974,7 +4981,7 @@ class Elasticsearch(BaseClient):
|
|
|
4974
4981
|
an update on every document in the index without changing the source, for example
|
|
4975
4982
|
to pick up a mapping change.
|
|
4976
4983
|
|
|
4977
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4984
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-update-by-query.html>`_
|
|
4978
4985
|
|
|
4979
4986
|
:param index: Comma-separated list of data streams, indices, and aliases to search.
|
|
4980
4987
|
Supports wildcards (`*`). To search all data streams or indices, omit this
|
|
@@ -5167,7 +5174,7 @@ class Elasticsearch(BaseClient):
|
|
|
5167
5174
|
"""
|
|
5168
5175
|
Changes the number of requests per second for a particular Update By Query operation.
|
|
5169
5176
|
|
|
5170
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
5177
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/docs-update-by-query.html>`_
|
|
5171
5178
|
|
|
5172
5179
|
:param task_id: The ID for the task.
|
|
5173
5180
|
: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:
|