elasticsearch 8.16.0__tar.gz → 8.17.0__tar.gz

{elasticsearch-8.16.0 → elasticsearch-8.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: elasticsearch
-Version: 8.16.0
+Version: 8.17.0
 Summary: Python client for Elasticsearch
 Project-URL: Documentation, https://elasticsearch-py.readthedocs.io/
 Project-URL: Homepage, https://github.com/elastic/elasticsearch-py
@@ -8,7 +8,9 @@ Project-URL: Issue Tracker, https://github.com/elastic/elasticsearch-py/issues
 Project-URL: Source Code, https://github.com/elastic/elasticsearch-py
 Author-email: Elastic Client Library Maintainers <client-libs@elastic.co>
 Maintainer-email: Elastic Client Library Maintainers <client-libs@elastic.co>
-License: Apache-2.0
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
 Keywords: REST,client,elastic,elasticsearch,index,kibana,mapping,search
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
@@ -47,7 +49,7 @@ Requires-Dist: pytest-cov; extra == 'dev'
 Requires-Dist: python-dateutil; extra == 'dev'
 Requires-Dist: pyyaml>=5.4; extra == 'dev'
 Requires-Dist: requests<3,>=2; extra == 'dev'
-Requires-Dist: simsimd; (python_version < '3.13') and extra == 'dev'
+Requires-Dist: simsimd; extra == 'dev'
 Requires-Dist: twine; extra == 'dev'
 Requires-Dist: unasync; extra == 'dev'
 Provides-Extra: docs

{elasticsearch-8.16.0 → elasticsearch-8.17.0}/elasticsearch/_async/client/__init__.py

@@ -626,12 +626,14 @@ class AsyncElasticsearch(BaseClient):
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
+        list_executed_pipelines: t.Optional[bool] = None,
         pipeline: t.Optional[str] = None,
         pretty: t.Optional[bool] = None,
         refresh: t.Optional[
             t.Union[bool, str, t.Literal["false", "true", "wait_for"]]
         ] = None,
         require_alias: t.Optional[bool] = None,
+        require_data_stream: t.Optional[bool] = None,
         routing: t.Optional[str] = None,
         source: t.Optional[t.Union[bool, t.Union[str, t.Sequence[str]]]] = None,
         source_excludes: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -646,11 +648,13 @@ class AsyncElasticsearch(BaseClient):
         in a single API call. This reduces overhead and can greatly increase indexing
         speed.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-bulk.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-bulk.html>`_
 
         :param operations:
         :param index: Name of the data stream, index, or index alias to perform bulk
             actions on.
+        :param list_executed_pipelines: If `true`, the response will include the ingest
+            pipelines that were executed for each index or create.
         :param pipeline: ID of the pipeline to use to preprocess incoming documents.
             If the index has a default ingest pipeline specified, then setting the value
             to `_none` disables the default ingest pipeline for this request. If a final
@@ -661,6 +665,8 @@ class AsyncElasticsearch(BaseClient):
             make this operation visible to search, if `false` do nothing with refreshes.
             Valid values: `true`, `false`, `wait_for`.
         :param require_alias: If `true`, the request’s actions must target an index alias.
+        :param require_data_stream: If `true`, the request's actions must target a data
+            stream (existing or to-be-created).
         :param routing: Custom value used to route operations to a specific shard.
         :param source: `true` or `false` to return the `_source` field or not, or a list
             of fields to return.
@@ -694,6 +700,8 @@ class AsyncElasticsearch(BaseClient):
             __query["filter_path"] = filter_path
         if human is not None:
             __query["human"] = human
+        if list_executed_pipelines is not None:
+            __query["list_executed_pipelines"] = list_executed_pipelines
         if pipeline is not None:
             __query["pipeline"] = pipeline
         if pretty is not None:
@@ -702,6 +710,8 @@ class AsyncElasticsearch(BaseClient):
             __query["refresh"] = refresh
         if require_alias is not None:
             __query["require_alias"] = require_alias
+        if require_data_stream is not None:
+            __query["require_data_stream"] = require_data_stream
         if routing is not None:
             __query["routing"] = routing
         if source is not None:
@@ -746,7 +756,7 @@ class AsyncElasticsearch(BaseClient):
         Clear a scrolling search. Clear the search context and results for a scrolling
         search.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-scroll-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-scroll-api.html>`_
 
         :param scroll_id: Scroll IDs to clear. To clear all scroll IDs, use `_all`.
         """
@@ -800,7 +810,7 @@ class AsyncElasticsearch(BaseClient):
         period has elapsed. However, keeping points in time has a cost; close them as
         soon as they are no longer required for search requests.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/point-in-time-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/point-in-time-api.html>`_
 
         :param id: The ID of the point-in-time.
         """
@@ -872,9 +882,9 @@ class AsyncElasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns number of documents matching a query.
+        Count search results. Get the number of documents matching a query.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-count.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-count.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases to search.
             Supports wildcards (`*`). To search all data streams and indices, omit this
@@ -1009,7 +1019,7 @@ class AsyncElasticsearch(BaseClient):
         and makes it searchable. If the target is an index and the document already exists,
         the request updates the document and increments its version.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-index_.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-index_.html>`_
 
         :param index: Name of the data stream or index to target. If the target doesn’t
             exist and matches the name or wildcard (`*`) pattern of an index template
@@ -1113,7 +1123,7 @@ class AsyncElasticsearch(BaseClient):
         """
         Delete a document. Removes a JSON document from the specified index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-delete.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-delete.html>`_
 
         :param index: Name of the target index.
         :param id: Unique identifier for the document.
@@ -1235,7 +1245,7 @@ class AsyncElasticsearch(BaseClient):
         """
         Delete documents. Deletes documents that match the specified query.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-delete-by-query.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-delete-by-query.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases to search.
             Supports wildcards (`*`). To search all data streams or indices, omit this
@@ -1416,7 +1426,7 @@ class AsyncElasticsearch(BaseClient):
         takes effect immediately but rethrotting that slows down the query takes effect
         after completing the current batch to prevent scroll timeouts.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-delete-by-query.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-delete-by-query.html>`_
 
         :param task_id: The ID for the task.
         :param requests_per_second: The throttle for this request in sub-requests per
@@ -1462,7 +1472,7 @@ class AsyncElasticsearch(BaseClient):
         """
         Delete a script or search template. Deletes a stored script or search template.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-scripting.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-scripting.html>`_
 
         :param id: Identifier for the stored script or search template.
         :param master_timeout: Period to wait for a connection to the master node. If
@@ -1530,7 +1540,7 @@ class AsyncElasticsearch(BaseClient):
         """
         Check a document. Checks if a specified document exists.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-get.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-get.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases. Supports
             wildcards (`*`).
@@ -1631,7 +1641,7 @@ class AsyncElasticsearch(BaseClient):
         """
         Check for a document source. Checks if a document's `_source` is stored.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-get.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-get.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases. Supports
             wildcards (`*`).
@@ -1732,7 +1742,7 @@ class AsyncElasticsearch(BaseClient):
         Explain a document match result. Returns information about why a specific document
         matches, or doesn’t match, a query.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-explain.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-explain.html>`_
 
         :param index: Index names used to limit the request. Only a single index name
             can be provided to this parameter.
@@ -1855,7 +1865,7 @@ class AsyncElasticsearch(BaseClient):
         field. For example, a runtime field with a type of keyword is returned the same
         as any other field that belongs to the `keyword` family.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-field-caps.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-field-caps.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (*). To target all data streams
@@ -1972,7 +1982,7 @@ class AsyncElasticsearch(BaseClient):
         Get a document by its ID. Retrieves the document with the specified ID from an
         index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-get.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-get.html>`_
 
         :param index: Name of the index that contains the document.
         :param id: Unique identifier of the document.
@@ -2061,7 +2071,7 @@ class AsyncElasticsearch(BaseClient):
         """
         Get a script or search template. Retrieves a stored script or search template.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-scripting.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-scripting.html>`_
 
         :param id: Identifier for the stored script or search template.
         :param master_timeout: Specify timeout for connection to master
@@ -2103,7 +2113,7 @@ class AsyncElasticsearch(BaseClient):
         """
         Get script contexts. Get a list of supported script contexts and their methods.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/painless/8.16/painless-contexts.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/painless/8.17/painless-contexts.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_script_context"
@@ -2138,7 +2148,7 @@ class AsyncElasticsearch(BaseClient):
         """
         Get script languages. Get a list of available script types, languages, and contexts.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-scripting.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-scripting.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_script_language"
@@ -2193,7 +2203,7 @@ class AsyncElasticsearch(BaseClient):
         """
         Get a document's source. Returns the source of a document.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-get.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-get.html>`_
 
         :param index: Name of the index that contains the document.
         :param id: Unique identifier of the document.
@@ -2274,9 +2284,28 @@ class AsyncElasticsearch(BaseClient):
         verbose: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns the health of the cluster.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/health-api.html>`_
+        Get the cluster health. Get a report with the health status of an Elasticsearch
+        cluster. The report contains a list of indicators that compose Elasticsearch
+        functionality. Each indicator has a health status of: green, unknown, yellow
+        or red. The indicator will provide an explanation and metadata describing the
+        reason for its current health status. The cluster’s status is controlled by the
+        worst indicator status. In the event that an indicator’s status is non-green,
+        a list of impacts may be present in the indicator result which detail the functionalities
+        that are negatively affected by the health issue. Each impact carries with it
+        a severity level, an area of the system that is affected, and a simple description
+        of the impact on the system. Some health indicators can determine the root cause
+        of a health problem and prescribe a set of steps that can be performed in order
+        to improve the health of the system. The root cause and remediation steps are
+        encapsulated in a diagnosis. A diagnosis contains a cause detailing a root cause
+        analysis, an action containing a brief description of the steps to take to fix
+        the problem, the list of affected resources (if applicable), and a detailed step-by-step
+        troubleshooting guide to fix the diagnosed problem. NOTE: The health indicators
+        perform root cause analysis of non-green health statuses. This can be computationally
+        expensive when called frequently. When setting up automated polling of the API
+        for health status, set verbose to false to disable the more expensive analysis
+        logic.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/health-api.html>`_
 
         :param feature: A feature of the cluster, as returned by the top-level health
             report API.
@@ -2353,7 +2382,7 @@ class AsyncElasticsearch(BaseClient):
         and makes it searchable. If the target is an index and the document already exists,
         the request updates the document and increments its version.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-index_.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-index_.html>`_
 
         :param index: Name of the data stream or index to target.
         :param document:
@@ -2462,7 +2491,7 @@ class AsyncElasticsearch(BaseClient):
         """
         Get cluster info. Returns basic information about the cluster.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/index.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/index.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/"
@@ -2527,7 +2556,7 @@ class AsyncElasticsearch(BaseClient):
         The kNN search API supports restricting the search using a filter. The search
         will return the top k documents that also match the filter query.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-search.html>`_
 
         :param index: A comma-separated list of index names to search; use `_all` or
             to perform the operation on all indices
@@ -2631,7 +2660,7 @@ class AsyncElasticsearch(BaseClient):
         IDs in the request body. To ensure fast responses, this multi get (mget) API
         responds with partial results if one or more shards fail.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-multi-get.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-multi-get.html>`_
 
         :param index: Name of the index to retrieve documents from when `ids` are specified,
             or when a document in the `docs` array does not specify an index.
@@ -2758,7 +2787,7 @@ class AsyncElasticsearch(BaseClient):
         Each newline character may be preceded by a carriage return `\\r`. When sending
         requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-multi-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-multi-search.html>`_
 
         :param searches:
         :param index: Comma-separated list of data streams, indices, and index aliases
@@ -2890,7 +2919,7 @@ class AsyncElasticsearch(BaseClient):
         """
         Run multiple templated searches.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-multi-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-multi-search.html>`_
 
         :param search_templates:
         :param index: Comma-separated list of data streams, indices, and aliases to search.
@@ -2989,7 +3018,7 @@ class AsyncElasticsearch(BaseClient):
         with all the fetched termvectors. Each element has the structure provided by
         the termvectors API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-multi-termvectors.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-multi-termvectors.html>`_
 
         :param index: Name of the index that contains the documents.
         :param docs: Array of existing or artificial documents.
@@ -3079,6 +3108,7 @@ class AsyncElasticsearch(BaseClient):
         *,
         index: t.Union[str, t.Sequence[str]],
         keep_alive: t.Union[str, t.Literal[-1], t.Literal[0]],
+        allow_partial_search_results: t.Optional[bool] = None,
         error_trace: t.Optional[bool] = None,
         expand_wildcards: t.Optional[
             t.Union[
@@ -3108,11 +3138,15 @@ class AsyncElasticsearch(BaseClient):
         A point in time must be opened explicitly before being used in search requests.
         The `keep_alive` parameter tells Elasticsearch how long it should persist.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/point-in-time-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/point-in-time-api.html>`_
 
         :param index: A comma-separated list of index names to open point in time; use
             `_all` or empty string to perform the operation on all indices
         :param keep_alive: Extends the time to live of the corresponding point in time.
+        :param allow_partial_search_results: If `false`, creating a point in time request
+            when a shard is missing or unavailable will throw an exception. If `true`,
+            the point in time will contain all the shards that are available at the time
+            of the request.
         :param expand_wildcards: Type of index that wildcard patterns can match. If the
             request can target data streams, this argument determines whether wildcard
             expressions match hidden data streams. Supports comma-separated values, such
@@ -3135,6 +3169,8 @@ class AsyncElasticsearch(BaseClient):
         __body: t.Dict[str, t.Any] = body if body is not None else {}
         if keep_alive is not None:
             __query["keep_alive"] = keep_alive
+        if allow_partial_search_results is not None:
+            __query["allow_partial_search_results"] = allow_partial_search_results
         if error_trace is not None:
             __query["error_trace"] = error_trace
         if expand_wildcards is not None:
@@ -3190,7 +3226,7 @@ class AsyncElasticsearch(BaseClient):
         Create or update a script or search template. Creates or updates a stored script
         or search template.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/modules-scripting.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/modules-scripting.html>`_
 
         :param id: Identifier for the stored script or search template. Must be unique
             within the cluster.
@@ -3276,7 +3312,7 @@ class AsyncElasticsearch(BaseClient):
         Evaluate ranked search results. Evaluate the quality of ranked search results
         over a set of typical search queries.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-rank-eval.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-rank-eval.html>`_
 
         :param requests: A set of typical search requests, together with their provided
             ratings.
@@ -3372,7 +3408,7 @@ class AsyncElasticsearch(BaseClient):
         can be any existing index, alias, or data stream. The destination must differ
         from the source. For example, you cannot reindex a data stream into itself.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-reindex.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-reindex.html>`_
 
         :param dest: The destination you are copying to.
         :param source: The source you are copying from.
@@ -3469,7 +3505,7 @@ class AsyncElasticsearch(BaseClient):
         Throttle a reindex operation. Change the number of requests per second for a
         particular reindex operation.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-reindex.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-reindex.html>`_
 
         :param task_id: Identifier for the task.
         :param requests_per_second: The throttle for this request in sub-requests per
@@ -3520,7 +3556,7 @@ class AsyncElasticsearch(BaseClient):
         """
         Render a search template. Render a search template as a search request body.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/render-search-template-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/render-search-template-api.html>`_
 
         :param id: ID of the search template to render. If no `source` is specified,
             this or the `id` request body parameter is required.
@@ -3589,7 +3625,7 @@ class AsyncElasticsearch(BaseClient):
         """
         Run a script. Runs a script and returns a result.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/painless/8.16/painless-execute-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/painless/8.17/painless-execute-api.html>`_
 
         :param context: The context that the script should run in.
         :param context_setup: Additional parameters for the `context`.
@@ -3662,7 +3698,7 @@ class AsyncElasticsearch(BaseClient):
         of the index at the time of the initial search request. Subsequent indexing or
         document changes only affect later search and scroll requests.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-request-body.html#request-body-search-scroll>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-request-body.html#request-body-search-scroll>`_
 
         :param scroll_id: Scroll ID of the search.
         :param rest_total_hits_as_int: If true, the API response’s hit.total property
@@ -3854,7 +3890,7 @@ class AsyncElasticsearch(BaseClient):
         can provide search queries using the `q` query string parameter or the request
         body. If both are specified, only the query parameter is used.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-search.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases to search.
             Supports wildcards (`*`). To search all data streams and indices, omit this
@@ -4284,7 +4320,7 @@ class AsyncElasticsearch(BaseClient):
         """
         Search a vector tile. Search a vector tile for geospatial values.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-vector-tile-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-vector-tile-api.html>`_
 
         :param index: Comma-separated list of data streams, indices, or aliases to search
         :param field: Field containing geospatial data to return
@@ -4441,7 +4477,7 @@ class AsyncElasticsearch(BaseClient):
         optimizations with routing and shard preferences. When filtered aliases are used,
         the filter is returned as part of the indices section.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-shards.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-shards.html>`_
 
         :param index: Returns the indices and shards that a search request would be executed
             against.
@@ -4542,7 +4578,7 @@ class AsyncElasticsearch(BaseClient):
         """
         Run a search with a search template.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-template.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-template.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases to search.
             Supports wildcards (*).
@@ -4682,7 +4718,7 @@ class AsyncElasticsearch(BaseClient):
         are actually deleted. Until that happens, the terms enum API will return terms
         from these documents.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-terms-enum.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/search-terms-enum.html>`_
 
         :param index: Comma-separated list of data streams, indices, and index aliases
             to search. Wildcard (*) expressions are supported.
@@ -4781,7 +4817,7 @@ class AsyncElasticsearch(BaseClient):
         Get term vector information. Get information and statistics about terms in the
         fields of a particular document.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-termvectors.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-termvectors.html>`_
 
         :param index: Name of the index that contains the document.
         :param id: Unique identifier of the document.
@@ -4924,7 +4960,7 @@ class AsyncElasticsearch(BaseClient):
         Update a document. Updates a document by running a script or passing a partial
         document.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-update.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-update.html>`_
 
         :param index: The name of the index
         :param id: Document ID
@@ -5090,7 +5126,7 @@ class AsyncElasticsearch(BaseClient):
         is specified, performs an update on every document in the data stream or index
         without modifying the source, which is useful for picking up mapping changes.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-update-by-query.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-update-by-query.html>`_
 
         :param index: Comma-separated list of data streams, indices, and aliases to search.
             Supports wildcards (`*`). To search all data streams or indices, omit this
@@ -5289,7 +5325,7 @@ class AsyncElasticsearch(BaseClient):
         takes effect immediately but rethrotting that slows down the query takes effect
         after completing the current batch to prevent scroll timeouts.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/docs-update-by-query.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/docs-update-by-query.html>`_
 
         :param task_id: The ID for the task.
         :param requests_per_second: The throttle for this request in sub-requests per

{elasticsearch-8.16.0 → elasticsearch-8.17.0}/elasticsearch/_async/client/async_search.py

@@ -42,7 +42,7 @@ class AsyncSearchClient(NamespacedClient):
         the authenticated user that submitted the original search request; users that
         have the `cancel_task` cluster privilege.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
 
         :param id: A unique identifier for the async search.
         """
@@ -90,7 +90,7 @@ class AsyncSearchClient(NamespacedClient):
         the results of a specific async search is restricted to the user or API key that
         submitted it.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
 
         :param id: A unique identifier for the async search.
         :param keep_alive: Specifies how long the async search should be available in
@@ -145,6 +145,7 @@ class AsyncSearchClient(NamespacedClient):
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
+        keep_alive: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
@@ -153,9 +154,12 @@ class AsyncSearchClient(NamespacedClient):
         security features are enabled, use of this API is restricted to the `monitoring_user`
         role.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
 
         :param id: A unique identifier for the async search.
+        :param keep_alive: Specifies how long the async search needs to be available.
+            Ongoing async searches and any saved search results are deleted after this
+            period.
         """
         if id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'id'")
@@ -168,6 +172,8 @@ class AsyncSearchClient(NamespacedClient):
             __query["filter_path"] = filter_path
         if human is not None:
             __query["human"] = human
+        if keep_alive is not None:
+            __query["keep_alive"] = keep_alive
         if pretty is not None:
             __query["pretty"] = pretty
         __headers = {"accept": "application/json"}
@@ -258,7 +264,6 @@ class AsyncSearchClient(NamespacedClient):
         ignore_throttled: t.Optional[bool] = None,
         ignore_unavailable: t.Optional[bool] = None,
         indices_boost: t.Optional[t.Sequence[t.Mapping[str, float]]] = None,
-        keep_alive: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         keep_on_completion: t.Optional[bool] = None,
         knn: t.Optional[
             t.Union[t.Mapping[str, t.Any], t.Sequence[t.Mapping[str, t.Any]]]
@@ -269,7 +274,6 @@ class AsyncSearchClient(NamespacedClient):
         min_score: t.Optional[float] = None,
         pit: t.Optional[t.Mapping[str, t.Any]] = None,
         post_filter: t.Optional[t.Mapping[str, t.Any]] = None,
-        pre_filter_shard_size: t.Optional[int] = None,
         preference: t.Optional[str] = None,
         pretty: t.Optional[bool] = None,
         profile: t.Optional[bool] = None,
@@ -283,7 +287,6 @@ class AsyncSearchClient(NamespacedClient):
         routing: t.Optional[str] = None,
         runtime_mappings: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
         script_fields: t.Optional[t.Mapping[str, t.Mapping[str, t.Any]]] = None,
-        scroll: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         search_after: t.Optional[
             t.Sequence[t.Union[None, bool, float, int, str, t.Any]]
         ] = None,
@@ -333,7 +336,7 @@ class AsyncSearchClient(NamespacedClient):
         can be set by changing the `search.max_async_search_response_size` cluster level
         setting.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.16/async-search.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/async-search.html>`_
 
         :param index: A comma-separated list of index names to search; use `_all` or
             empty string to perform the operation on all indices
@@ -376,9 +379,6 @@ class AsyncSearchClient(NamespacedClient):
         :param ignore_unavailable: Whether specified concrete indices should be ignored
             when unavailable (missing or closed)
         :param indices_boost: Boosts the _score of documents from specified indices.
-        :param keep_alive: Specifies how long the async search needs to be available.
-            Ongoing async searches and any saved search results are deleted after this
-            period.
         :param keep_on_completion: If `true`, results are stored for later retrieval
             when the search completes within the `wait_for_completion_timeout`.
         :param knn: Defines the approximate kNN search to run.
@@ -394,10 +394,6 @@ class AsyncSearchClient(NamespacedClient):
         :param pit: Limits the search to a point in time (PIT). If you provide a PIT,
             you cannot specify an <index> in the request path.
         :param post_filter:
-        :param pre_filter_shard_size: The default value cannot be changed, which enforces
-            the execution of a pre-filter roundtrip to retrieve statistics from each
-            shard so that the ones that surely don’t hold any document matching the query
-            get skipped.
         :param preference: Specify the node or shard the operation should be performed
             on (default: random)
         :param profile:
@@ -406,13 +402,13 @@ class AsyncSearchClient(NamespacedClient):
         :param request_cache: Specify if request cache should be used for this request
             or not, defaults to true
         :param rescore:
-        :param rest_total_hits_as_int:
+        :param rest_total_hits_as_int: Indicates whether hits.total should be rendered
+            as an integer or an object in the rest search response
         :param routing: A comma-separated list of specific routing values
         :param runtime_mappings: Defines one or more runtime fields in the search request.
             These fields take precedence over mapped fields with the same name.
         :param script_fields: Retrieve a script evaluation (based on different fields)
             for each hit.
-        :param scroll:
         :param search_after:
         :param search_type: Search operation type
         :param seq_no_primary_term: If true, returns sequence number and primary term
@@ -509,8 +505,6 @@ class AsyncSearchClient(NamespacedClient):
             __query["ignore_throttled"] = ignore_throttled
         if ignore_unavailable is not None:
             __query["ignore_unavailable"] = ignore_unavailable
-        if keep_alive is not None:
-            __query["keep_alive"] = keep_alive
         if keep_on_completion is not None:
             __query["keep_on_completion"] = keep_on_completion
         if lenient is not None:
@@ -519,8 +513,6 @@ class AsyncSearchClient(NamespacedClient):
             __query["max_concurrent_shard_requests"] = max_concurrent_shard_requests
         if min_compatible_shard_node is not None:
             __query["min_compatible_shard_node"] = min_compatible_shard_node
-        if pre_filter_shard_size is not None:
-            __query["pre_filter_shard_size"] = pre_filter_shard_size
         if preference is not None:
             __query["preference"] = preference
         if pretty is not None:
@@ -533,8 +525,6 @@ class AsyncSearchClient(NamespacedClient):
             __query["rest_total_hits_as_int"] = rest_total_hits_as_int
         if routing is not None:
             __query["routing"] = routing
-        if scroll is not None:
-            __query["scroll"] = scroll
         if search_type is not None:
             __query["search_type"] = search_type
         if source_excludes is not None: