elasticsearch 8.15.1__py3-none-any.whl → 8.17.0__py3-none-any.whl

elasticsearch/_sync/client/__init__.py

@@ -82,8 +82,10 @@ from .utils import (
     _TYPE_HOSTS,
     CLIENT_META_SERVICE,
     SKIP_IN_PATH,
+    Stability,
     _quote,
     _rewrite_parameters,
+    _stability_warning,
     client_node_configs,
     is_requests_http_auth,
     is_requests_node_class,
@@ -622,12 +624,14 @@ class Elasticsearch(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,
@@ -638,14 +642,17 @@ class Elasticsearch(BaseClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Performs multiple indexing or delete operations in a single API call. This reduces
-        overhead and can greatly increase indexing speed.
+        Bulk index or delete documents. Performs multiple indexing or delete operations
+        in a single API call. This reduces overhead and can greatly increase indexing
+        speed.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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
@@ -656,6 +663,8 @@ class Elasticsearch(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.
@@ -689,6 +698,8 @@ class Elasticsearch(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:
@@ -697,6 +708,8 @@ class Elasticsearch(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:
@@ -738,9 +751,10 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Clears the search context and results for a scrolling search.
+        Clear a scrolling search. Clear the search context and results for a scrolling
+        search.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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`.
         """
@@ -788,9 +802,13 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Closes a point-in-time.
+        Close a point in time. 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. A point in time is automatically closed when the `keep_alive`
+        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.15/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.
         """
@@ -862,9 +880,9 @@ class Elasticsearch(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.15/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
@@ -995,11 +1013,11 @@ class Elasticsearch(BaseClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Adds a JSON document to the specified data stream or index and makes it searchable.
-        If the target is an index and the document already exists, the request updates
-        the document and increments its version.
+        Index a document. Adds a JSON document to the specified data stream or index
+        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.15/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
@@ -1101,9 +1119,9 @@ class Elasticsearch(BaseClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Removes a JSON document from the specified index.
+        Delete a document. Removes a JSON document from the specified index.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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.
@@ -1223,9 +1241,9 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes documents that match the specified query.
+        Delete documents. Deletes documents that match the specified query.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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
@@ -1401,9 +1419,12 @@ class Elasticsearch(BaseClient):
         requests_per_second: t.Optional[float] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Changes the number of requests per second for a particular Delete By Query operation.
+        Throttle a delete by query operation. Change the number of requests per second
+        for a particular delete by query operation. Rethrottling that speeds up the query
+        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.15/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
@@ -1447,9 +1468,9 @@ class Elasticsearch(BaseClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes a stored script or search template.
+        Delete a script or search template. Deletes a stored script or search template.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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
@@ -1515,9 +1536,9 @@ class Elasticsearch(BaseClient):
         ] = None,
     ) -> HeadApiResponse:
         """
-        Checks if a document in an index exists.
+        Check a document. Checks if a specified document exists.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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 (`*`).
@@ -1616,9 +1637,9 @@ class Elasticsearch(BaseClient):
         ] = None,
     ) -> HeadApiResponse:
         """
-        Checks if a document's `_source` is stored.
+        Check for a document source. Checks if a document's `_source` is stored.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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 (`*`).
@@ -1716,10 +1737,10 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns information about why a specific document matches (or doesn’t match)
-        a query.
+        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.15/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.
@@ -1836,12 +1857,13 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        The field capabilities API returns the information about the capabilities of
-        fields among multiple indices. The field capabilities API returns runtime fields
-        like any other field. For example, a runtime field with a type of keyword is
-        returned as any other field that belongs to the `keyword` family.
+        Get the field capabilities. Get information about the capabilities of fields
+        among multiple indices. For data streams, the API returns field capabilities
+        among the stream’s backing indices. It returns runtime fields like any other
+        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.15/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
@@ -1955,9 +1977,10 @@ class Elasticsearch(BaseClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns a document.
+        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.15/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.
@@ -2044,9 +2067,9 @@ class Elasticsearch(BaseClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves a stored script or search template.
+        Get a script or search template. Retrieves a stored script or search template.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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
@@ -2086,9 +2109,9 @@ class Elasticsearch(BaseClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns all script contexts.
+        Get script contexts. Get a list of supported script contexts and their methods.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/painless/8.15/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"
@@ -2121,9 +2144,9 @@ class Elasticsearch(BaseClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns available script types, languages and contexts
+        Get script languages. Get a list of available script types, languages, and contexts.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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"
@@ -2176,9 +2199,9 @@ class Elasticsearch(BaseClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns the source of a document.
+        Get a document's source. Returns the source of a document.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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.
@@ -2259,9 +2282,28 @@ class Elasticsearch(BaseClient):
         verbose: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns the health of the cluster.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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.
@@ -2334,11 +2376,11 @@ class Elasticsearch(BaseClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Adds a JSON document to the specified data stream or index and makes it searchable.
-        If the target is an index and the document already exists, the request updates
-        the document and increments its version.
+        Index a document. Adds a JSON document to the specified data stream or index
+        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.15/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:
@@ -2445,9 +2487,9 @@ class Elasticsearch(BaseClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns basic information about the cluster.
+        Get cluster info. Returns basic information about the cluster.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/index.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/index.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/"
@@ -2481,6 +2523,7 @@ class Elasticsearch(BaseClient):
         ),
         parameter_aliases={"_source": "source"},
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     def knn_search(
         self,
         *,
@@ -2501,9 +2544,17 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Performs a kNN search.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/search-search.html>`_
+        Run a knn search. NOTE: The kNN search API has been replaced by the `knn` option
+        in the search API. Perform a k-nearest neighbor (kNN) search on a dense_vector
+        field and return the matching documents. Given a query vector, the API finds
+        the k closest vectors and returns those documents as search hits. Elasticsearch
+        uses the HNSW algorithm to support efficient kNN search. Like most kNN algorithms,
+        HNSW is an approximate method that sacrifices result accuracy for improved search
+        speed. This means the results returned are not always the true k closest neighbors.
+        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.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
@@ -2602,9 +2653,12 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Allows to get multiple documents in one request.
+        Get multiple documents. Get multiple JSON documents by ID from one or more indices.
+        If you specify an index in the request URI, you only need to specify the document
+        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.15/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.
@@ -2723,9 +2777,15 @@ class Elasticsearch(BaseClient):
         typed_keys: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Allows to execute several search operations in one request.
+        Run multiple searches. The format of the request is similar to the bulk API format
+        and makes use of the newline delimited JSON (NDJSON) format. The structure is
+        as follows: ``` header\\n body\\n header\\n body\\n ``` This structure is specifically
+        optimized to reduce parsing if a specific search ends up redirected to another
+        node. IMPORTANT: The final line of data must end with a newline character `\\n`.
+        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.15/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
@@ -2855,9 +2915,9 @@ class Elasticsearch(BaseClient):
         typed_keys: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Runs multiple templated searches with a single request.
+        Run multiple templated searches.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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.
@@ -2950,9 +3010,13 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns multiple termvectors in one request.
+        Get multiple term vectors. You can specify existing documents by index and ID
+        or provide artificial documents in the body of the request. You can specify the
+        index in the request body or request URI. The response contains a `docs` array
+        with all the fetched termvectors. Each element has the structure provided by
+        the termvectors API.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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.
@@ -3034,12 +3098,15 @@ class Elasticsearch(BaseClient):
             path_parts=__path_parts,
         )
 
-    @_rewrite_parameters()
+    @_rewrite_parameters(
+        body_fields=("index_filter",),
+    )
     def open_point_in_time(
         self,
         *,
         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[
@@ -3052,43 +3119,56 @@ class Elasticsearch(BaseClient):
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
         ignore_unavailable: t.Optional[bool] = None,
+        index_filter: t.Optional[t.Mapping[str, t.Any]] = None,
         preference: t.Optional[str] = None,
         pretty: t.Optional[bool] = None,
         routing: t.Optional[str] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        A search request by default executes against the most recent visible data of
-        the target indices, which is called point in time. Elasticsearch pit (point in
-        time) is a lightweight view into the state of the data as it existed when initiated.
-        In some cases, it’s preferred to perform multiple search requests using the same
-        point in time. For example, if refreshes happen between `search_after` requests,
-        then the results of those requests might not be consistent as changes happening
-        between searches are only visible to the more recent point in time.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/point-in-time-api.html>`_
+        Open a point in time. A search request by default runs against the most recent
+        visible data of the target indices, which is called point in time. Elasticsearch
+        pit (point in time) is a lightweight view into the state of the data as it existed
+        when initiated. In some cases, it’s preferred to perform multiple search requests
+        using the same point in time. For example, if refreshes happen between `search_after`
+        requests, then the results of those requests might not be consistent as changes
+        happening between searches are only visible to the more recent point in time.
+        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.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
             as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
         :param ignore_unavailable: If `false`, the request returns an error if it targets
             a missing or closed index.
+        :param index_filter: Allows to filter indices if the provided query rewrites
+            to `match_none` on every shard.
         :param preference: Specifies the node or shard the operation should be performed
             on. Random by default.
         :param routing: Custom value used to route operations to a specific shard.
         """
         if index in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'index'")
-        if keep_alive is None:
+        if keep_alive is None and body is None:
             raise ValueError("Empty value passed for parameter 'keep_alive'")
         __path_parts: t.Dict[str, str] = {"index": _quote(index)}
         __path = f'/{__path_parts["index"]}/_pit'
         __query: t.Dict[str, t.Any] = {}
+        __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:
@@ -3105,12 +3185,20 @@ class Elasticsearch(BaseClient):
             __query["pretty"] = pretty
         if routing is not None:
             __query["routing"] = routing
+        if not __body:
+            if index_filter is not None:
+                __body["index_filter"] = index_filter
+        if not __body:
+            __body = None  # type: ignore[assignment]
         __headers = {"accept": "application/json"}
+        if __body is not None:
+            __headers["content-type"] = "application/json"
         return self.perform_request(  # type: ignore[return-value]
             "POST",
             __path,
             params=__query,
             headers=__headers,
+            body=__body,
             endpoint_id="open_point_in_time",
             path_parts=__path_parts,
         )
@@ -3133,9 +3221,10 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates or updates a stored script or search template.
+        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.15/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.
@@ -3218,10 +3307,10 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Enables you to evaluate the quality of ranked search results over a set of typical
-        search queries.
+        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.15/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.
@@ -3313,11 +3402,11 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Allows to copy documents from one index to another, optionally filtering the
-        source documents by a query, changing the destination index settings, or fetching
-        the documents from a remote cluster.
+        Reindex documents. Copies documents from a source to a destination. The source
+        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.15/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.
@@ -3411,9 +3500,10 @@ class Elasticsearch(BaseClient):
         requests_per_second: t.Optional[float] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Copies documents from a source to a destination.
+        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.15/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
@@ -3462,9 +3552,9 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Renders a search template as a search request body.
+        Render a search template. Render a search template as a search request body.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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.
@@ -3517,6 +3607,7 @@ class Elasticsearch(BaseClient):
     @_rewrite_parameters(
         body_fields=("context", "context_setup", "script"),
     )
+    @_stability_warning(Stability.EXPERIMENTAL)
     def scripts_painless_execute(
         self,
         *,
@@ -3530,9 +3621,9 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Runs a script and returns a result.
+        Run a script. Runs a script and returns a result.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/painless/8.15/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`.
@@ -3588,9 +3679,24 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Allows to retrieve a large numbers of results from a single search request.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/search-request-body.html#request-body-search-scroll>`_
+        Run a scrolling search. IMPORTANT: The scroll API is no longer recommend for
+        deep pagination. If you need to preserve the index state while paging through
+        more than 10,000 hits, use the `search_after` parameter with a point in time
+        (PIT). The scroll API gets large sets of results from a single scrolling search
+        request. To get the necessary scroll ID, submit a search API request that includes
+        an argument for the `scroll` query parameter. The `scroll` parameter indicates
+        how long Elasticsearch should retain the search context for the request. The
+        search response returns a scroll ID in the `_scroll_id` response body parameter.
+        You can then use the scroll ID with the scroll API to retrieve the next batch
+        of results for the request. If the Elasticsearch security features are enabled,
+        the access to the results of a specific scroll ID is restricted to the user or
+        API key that submitted the search. You can also use the scroll API to specify
+        a new scroll parameter that extends or shortens the retention period for the
+        search context. IMPORTANT: Results from a scrolling search reflect the state
+        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.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
@@ -3778,11 +3884,11 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns search hits that match the query defined in the request. You can provide
-        search queries using the `q` query string parameter or the request body. If both
-        are specified, only the query parameter is used.
+        Run a search. Get search hits that match the query defined in the request. You
+        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.15/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
@@ -4210,10 +4316,9 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> BinaryApiResponse:
         """
-        Searches a vector tile for geospatial values. Returns results as a binary Mapbox
-        vector tile.
+        Search a vector tile. Search a vector tile for geospatial values.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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
@@ -4365,10 +4470,12 @@ class Elasticsearch(BaseClient):
         routing: t.Optional[str] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns information about the indices and shards that a search request would
-        be executed against.
+        Get the search shards. Get the indices and shards that a search request would
+        be run against. This information can be useful for working out issues or planning
+        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.15/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.
@@ -4467,9 +4574,9 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Runs a search with a search template.
+        Run a search with a search template.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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 (*).
@@ -4599,11 +4706,17 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        The terms enum API can be used to discover terms in the index that begin with
-        the provided string. It is designed for low-latency look-ups used in auto-complete
-        scenarios.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/search-terms-enum.html>`_
+        Get terms in an index. Discover terms that match a partial string in an index.
+        This "terms enum" API is designed for low-latency look-ups used in auto-complete
+        scenarios. If the `complete` property in the response is false, the returned
+        terms set may be incomplete and should be treated as approximate. This can occur
+        due to a few reasons, such as a request timeout or a node error. NOTE: The terms
+        enum API may return terms from deleted documents. Deleted documents are initially
+        only marked as deleted. It is not until their segments are merged that documents
+        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.17/search-terms-enum.html>`_
 
         :param index: Comma-separated list of data streams, indices, and index aliases
             to search. Wildcard (*) expressions are supported.
@@ -4699,10 +4812,10 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns information and statistics about terms in the fields of a particular
-        document.
+        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.15/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.
@@ -4842,9 +4955,10 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates a document with a script or partial document.
+        Update a document. Updates a document by running a script or passing a partial
+        document.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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
@@ -5006,11 +5120,11 @@ class Elasticsearch(BaseClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Updates documents that match the specified query. If no query 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.
+        Update documents. Updates documents that match the specified query. If no query
+        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.15/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
@@ -5204,9 +5318,12 @@ class Elasticsearch(BaseClient):
         requests_per_second: t.Optional[float] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Changes the number of requests per second for a particular Update By Query operation.
+        Throttle an update by query operation. Change the number of requests per second
+        for a particular update by query operation. Rethrottling that speeds up the query
+        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.15/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