elasticsearch 8.13.2__py3-none-any.whl → 8.15.0__py3-none-any.whl

elasticsearch/_sync/client/inference.py

@@ -26,25 +26,34 @@ from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
 class InferenceClient(NamespacedClient):
 
     @_rewrite_parameters()
-    def delete_model(
+    def delete(
         self,
         *,
         inference_id: str,
         task_type: t.Optional[
-            t.Union["t.Literal['sparse_embedding', 'text_embedding']", str]
+            t.Union[
+                str,
+                t.Literal["completion", "rerank", "sparse_embedding", "text_embedding"],
+            ]
         ] = None,
+        dry_run: t.Optional[bool] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        force: t.Optional[bool] = None,
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete model in the Inference API
+        Delete an inference endpoint
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/delete-inference-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-inference-api.html>`_
 
         :param inference_id: The inference Id
         :param task_type: The task type
+        :param dry_run: When true, the endpoint is not deleted, and a list of ingest
+            processors which reference this endpoint is returned
+        :param force: When true, the inference endpoint is forcefully deleted even if
+            it is still being used by ingest processors or semantic text fields
         """
         if inference_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'inference_id'")
@@ -61,10 +70,14 @@ class InferenceClient(NamespacedClient):
         else:
             raise ValueError("Couldn't find a path for the given parameters")
         __query: t.Dict[str, t.Any] = {}
+        if dry_run is not None:
+            __query["dry_run"] = dry_run
         if error_trace is not None:
             __query["error_trace"] = error_trace
         if filter_path is not None:
             __query["filter_path"] = filter_path
+        if force is not None:
+            __query["force"] = force
         if human is not None:
             __query["human"] = human
         if pretty is not None:
@@ -75,33 +88,34 @@ class InferenceClient(NamespacedClient):
             __path,
             params=__query,
             headers=__headers,
-            endpoint_id="inference.delete_model",
+            endpoint_id="inference.delete",
             path_parts=__path_parts,
         )
 
     @_rewrite_parameters()
-    def get_model(
+    def get(
         self,
         *,
-        inference_id: str,
         task_type: t.Optional[
-            t.Union["t.Literal['sparse_embedding', 'text_embedding']", str]
+            t.Union[
+                str,
+                t.Literal["completion", "rerank", "sparse_embedding", "text_embedding"],
+            ]
         ] = None,
+        inference_id: t.Optional[str] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get a model in the Inference API
+        Get an inference endpoint
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/get-inference-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-inference-api.html>`_
 
-        :param inference_id: The inference Id
         :param task_type: The task type
+        :param inference_id: The inference Id
         """
-        if inference_id in SKIP_IN_PATH:
-            raise ValueError("Empty value passed for parameter 'inference_id'")
         __path_parts: t.Dict[str, str]
         if task_type not in SKIP_IN_PATH and inference_id not in SKIP_IN_PATH:
             __path_parts = {
@@ -113,7 +127,8 @@ class InferenceClient(NamespacedClient):
             __path_parts = {"inference_id": _quote(inference_id)}
             __path = f'/_inference/{__path_parts["inference_id"]}'
         else:
-            raise ValueError("Couldn't find a path for the given parameters")
+            __path_parts = {}
+            __path = "/_inference"
         __query: t.Dict[str, t.Any] = {}
         if error_trace is not None:
             __query["error_trace"] = error_trace
@@ -129,12 +144,12 @@ class InferenceClient(NamespacedClient):
             __path,
             params=__query,
             headers=__headers,
-            endpoint_id="inference.get_model",
+            endpoint_id="inference.get",
             path_parts=__path_parts,
         )
 
     @_rewrite_parameters(
-        body_fields=("input", "task_settings"),
+        body_fields=("input", "query", "task_settings"),
     )
     def inference(
         self,
@@ -142,24 +157,32 @@ class InferenceClient(NamespacedClient):
         inference_id: str,
         input: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         task_type: t.Optional[
-            t.Union["t.Literal['sparse_embedding', 'text_embedding']", str]
+            t.Union[
+                str,
+                t.Literal["completion", "rerank", "sparse_embedding", "text_embedding"],
+            ]
         ] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
         pretty: t.Optional[bool] = None,
+        query: t.Optional[str] = None,
         task_settings: t.Optional[t.Any] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Perform inference on a model
+        Perform inference on the service
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/post-inference-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/post-inference-api.html>`_
 
         :param inference_id: The inference Id
-        :param input: Text input to the model. Either a string or an array of strings.
+        :param input: Inference input. Either a string or an array of strings.
         :param task_type: The task type
+        :param query: Query input, required for rerank task. Not required for other tasks.
         :param task_settings: Optional task settings
+        :param timeout: Specifies the amount of time to wait for the inference request
+            to complete.
         """
         if inference_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'inference_id'")
@@ -187,9 +210,13 @@ class InferenceClient(NamespacedClient):
             __query["human"] = human
         if pretty is not None:
             __query["pretty"] = pretty
+        if timeout is not None:
+            __query["timeout"] = timeout
         if not __body:
             if input is not None:
                 __body["input"] = input
+            if query is not None:
+                __body["query"] = query
             if task_settings is not None:
                 __body["task_settings"] = task_settings
         if not __body:
@@ -208,39 +235,42 @@ class InferenceClient(NamespacedClient):
         )
 
     @_rewrite_parameters(
-        body_name="model_config",
+        body_name="inference_config",
     )
-    def put_model(
+    def put(
         self,
         *,
         inference_id: str,
+        inference_config: t.Optional[t.Mapping[str, t.Any]] = None,
+        body: t.Optional[t.Mapping[str, t.Any]] = None,
         task_type: t.Optional[
-            t.Union["t.Literal['sparse_embedding', 'text_embedding']", str]
+            t.Union[
+                str,
+                t.Literal["completion", "rerank", "sparse_embedding", "text_embedding"],
+            ]
         ] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
-        model_config: t.Optional[t.Mapping[str, t.Any]] = None,
-        body: t.Optional[t.Mapping[str, t.Any]] = None,
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Configure a model for use in the Inference API
+        Create an inference endpoint
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/put-inference-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/put-inference-api.html>`_
 
         :param inference_id: The inference Id
+        :param inference_config:
         :param task_type: The task type
-        :param model_config:
         """
         if inference_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'inference_id'")
-        if model_config is None and body is None:
+        if inference_config is None and body is None:
             raise ValueError(
-                "Empty value passed for parameters 'model_config' and 'body', one of them should be set."
+                "Empty value passed for parameters 'inference_config' and 'body', one of them should be set."
             )
-        elif model_config is not None and body is not None:
-            raise ValueError("Cannot set both 'model_config' and 'body'")
+        elif inference_config is not None and body is not None:
+            raise ValueError("Cannot set both 'inference_config' and 'body'")
         __path_parts: t.Dict[str, str]
         if task_type not in SKIP_IN_PATH and inference_id not in SKIP_IN_PATH:
             __path_parts = {
@@ -262,18 +292,14 @@ class InferenceClient(NamespacedClient):
             __query["human"] = human
         if pretty is not None:
             __query["pretty"] = pretty
-        __body = model_config if model_config is not None else body
-        if not __body:
-            __body = None
-        __headers = {"accept": "application/json"}
-        if __body is not None:
-            __headers["content-type"] = "application/json"
+        __body = inference_config if inference_config is not None else body
+        __headers = {"accept": "application/json", "content-type": "application/json"}
         return self.perform_request(  # type: ignore[return-value]
             "PUT",
             __path,
             params=__query,
             headers=__headers,
             body=__body,
-            endpoint_id="inference.put_model",
+            endpoint_id="inference.put",
             path_parts=__path_parts,
         )

elasticsearch/_sync/client/ingest.py

@@ -33,16 +33,14 @@ class IngestClient(NamespacedClient):
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
-        master_timeout: t.Optional[
-            t.Union["t.Literal[-1]", "t.Literal[0]", str]
-        ] = None,
+        master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         pretty: t.Optional[bool] = None,
-        timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes a pipeline.
+        Deletes one or more existing ingest pipeline.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/delete-pipeline-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-pipeline-api.html>`_
 
         :param id: Pipeline ID or wildcard expression of pipeline IDs used to limit the
             request. To delete all ingest pipelines in a cluster, use a value of `*`.
@@ -89,9 +87,9 @@ class IngestClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns statistical information about geoip databases
+        Gets download statistics for GeoIP2 databases used with the geoip processor.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/geoip-processor.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/geoip-processor.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_ingest/geoip/stats"
@@ -122,16 +120,15 @@ class IngestClient(NamespacedClient):
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
-        master_timeout: t.Optional[
-            t.Union["t.Literal[-1]", "t.Literal[0]", str]
-        ] = None,
+        master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         pretty: t.Optional[bool] = None,
         summary: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns a pipeline.
+        Returns information about one or more ingest pipelines. This API returns a local
+        reference of the pipeline.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/get-pipeline-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-pipeline-api.html>`_
 
         :param id: Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions
             are supported. To get all ingest pipelines, omit this parameter or use `*`.
@@ -180,9 +177,12 @@ class IngestClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Returns a list of the built-in patterns.
+        Extracts structured fields out of a single text field within a document. You
+        choose which field to extract matched fields from, as well as the grok pattern
+        you expect will match. A grok pattern is like a regular expression that supports
+        aliased expressions that can be reused.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/grok-processor.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/grok-processor.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_ingest/processor/grok"
@@ -218,21 +218,20 @@ class IngestClient(NamespacedClient):
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         human: t.Optional[bool] = None,
         if_version: t.Optional[int] = None,
-        master_timeout: t.Optional[
-            t.Union["t.Literal[-1]", "t.Literal[0]", str]
-        ] = None,
+        master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         meta: t.Optional[t.Mapping[str, t.Any]] = None,
         on_failure: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
         pretty: t.Optional[bool] = None,
         processors: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
-        timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         version: t.Optional[int] = None,
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates or updates a pipeline.
+        Creates or updates an ingest pipeline. Changes made using this API take effect
+        immediately.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/ingest.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/ingest.html>`_
 
         :param id: ID of the ingest pipeline to create or update.
         :param description: Description of the ingest pipeline.
@@ -316,9 +315,9 @@ class IngestClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Allows to simulate a pipeline with example documents.
+        Executes an ingest pipeline against a set of provided documents.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/simulate-pipeline-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/simulate-pipeline-api.html>`_
 
         :param id: Pipeline to test. If you don’t specify a `pipeline` in the request
             body, this parameter is required.

elasticsearch/_sync/client/license.py

@@ -37,7 +37,7 @@ class LicenseClient(NamespacedClient):
         """
         Deletes licensing information for the cluster
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/delete-license.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/delete-license.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_license"
@@ -72,9 +72,11 @@ class LicenseClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves licensing information for the cluster
+        This API returns information about the type of license, when it was issued, and
+        when it expires, for example. For more information about the different types
+        of licenses, see https://www.elastic.co/subscriptions.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/get-license.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-license.html>`_
 
         :param accept_enterprise: If `true`, this parameter returns enterprise for Enterprise
             license types. If `false`, this parameter returns platinum for both platinum
@@ -120,7 +122,7 @@ class LicenseClient(NamespacedClient):
         """
         Retrieves information about the status of the basic license.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/get-basic-status.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-basic-status.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_license/basic_status"
@@ -155,7 +157,7 @@ class LicenseClient(NamespacedClient):
         """
         Retrieves information about the status of the trial license.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/get-trial-status.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/get-trial-status.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_license/trial_status"
@@ -196,7 +198,7 @@ class LicenseClient(NamespacedClient):
         """
         Updates the license for the cluster.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/update-license.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/update-license.html>`_
 
         :param acknowledge: Specifies whether you acknowledge the license changes.
         :param license:
@@ -248,9 +250,14 @@ class LicenseClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Starts an indefinite basic license.
+        The start basic API enables you to initiate an indefinite basic license, which
+        gives access to all the basic features. If the basic license does not support
+        all of the features that are available with your current license, however, you
+        are notified in the response. You must then re-submit the API request with the
+        acknowledge parameter set to true. To check the status of your basic license,
+        use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html).
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/start-basic.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/start-basic.html>`_
 
         :param acknowledge: whether the user has acknowledged acknowledge messages (default:
             false)
@@ -290,9 +297,10 @@ class LicenseClient(NamespacedClient):
         type_query_string: t.Optional[str] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        starts a limited time trial license.
+        The start trial API enables you to start a 30-day trial, which gives access to
+        all subscription features.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/start-trial.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/start-trial.html>`_
 
         :param acknowledge: whether the user has acknowledged acknowledge messages (default:
             false)

elasticsearch/_sync/client/logstash.py

@@ -36,9 +36,9 @@ class LogstashClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes Logstash Pipelines used by Central Management
+        Deletes a pipeline used for Logstash Central Management.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/logstash-api-delete-pipeline.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/logstash-api-delete-pipeline.html>`_
 
         :param id: Identifier for the pipeline.
         """
@@ -76,9 +76,9 @@ class LogstashClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves Logstash Pipelines used by Central Management
+        Retrieves pipelines used for Logstash Central Management.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/logstash-api-get-pipeline.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/logstash-api-get-pipeline.html>`_
 
         :param id: Comma-separated list of pipeline identifiers.
         """
@@ -123,9 +123,9 @@ class LogstashClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Adds and updates Logstash Pipelines used for Central Management
+        Creates or updates a pipeline used for Logstash Central Management.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/logstash-api-put-pipeline.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/logstash-api-put-pipeline.html>`_
 
         :param id: Identifier for the pipeline.
         :param pipeline:

elasticsearch/_sync/client/migration.py

@@ -40,7 +40,7 @@ class MigrationClient(NamespacedClient):
         that use deprecated features that will be removed or changed in the next major
         version.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/migration-api-deprecation.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/migration-api-deprecation.html>`_
 
         :param index: Comma-separate list of data streams or indices to check. Wildcard
             (*) expressions are supported.
@@ -83,7 +83,7 @@ class MigrationClient(NamespacedClient):
         """
         Find out whether system features need to be upgraded or not
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/migration-api-feature-upgrade.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/migration-api-feature-upgrade.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_migration/system_features"
@@ -118,7 +118,7 @@ class MigrationClient(NamespacedClient):
         """
         Begin upgrades for system features
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/migration-api-feature-upgrade.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.15/migration-api-feature-upgrade.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_migration/system_features"