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

elasticsearch/_sync/client/inference.py

@@ -31,7 +31,10 @@ class InferenceClient(NamespacedClient):
         *,
         inference_id: str,
         task_type: t.Optional[
-            t.Union["t.Literal['sparse_embedding', 'text_embedding']", str]
+            t.Union[
+                "t.Literal['completion', 'rerank', 'sparse_embedding', 'text_embedding']",
+                str,
+            ]
         ] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -41,7 +44,7 @@ class InferenceClient(NamespacedClient):
         """
         Delete model in the Inference API
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/delete-inference-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/delete-inference-api.html>`_
 
         :param inference_id: The inference Id
         :param task_type: The task type
@@ -85,7 +88,10 @@ class InferenceClient(NamespacedClient):
         *,
         inference_id: str,
         task_type: t.Optional[
-            t.Union["t.Literal['sparse_embedding', 'text_embedding']", str]
+            t.Union[
+                "t.Literal['completion', 'rerank', 'sparse_embedding', 'text_embedding']",
+                str,
+            ]
         ] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
@@ -95,7 +101,7 @@ class InferenceClient(NamespacedClient):
         """
         Get a model in the Inference API
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/get-inference-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-inference-api.html>`_
 
         :param inference_id: The inference Id
         :param task_type: The task type
@@ -134,7 +140,7 @@ class InferenceClient(NamespacedClient):
         )
 
     @_rewrite_parameters(
-        body_fields=("input", "task_settings"),
+        body_fields=("input", "query", "task_settings"),
     )
     def inference(
         self,
@@ -142,24 +148,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[
+                "t.Literal['completion', 'rerank', 'sparse_embedding', 'text_embedding']",
+                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,
+        query: t.Optional[str] = None,
         task_settings: t.Optional[t.Any] = None,
+        timeout: t.Optional[t.Union["t.Literal[-1]", "t.Literal[0]", str]] = None,
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
         Perform inference on a model
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/post-inference-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/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 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 +201,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:
@@ -214,24 +232,27 @@ class InferenceClient(NamespacedClient):
         self,
         *,
         inference_id: str,
+        model_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[
+                "t.Literal['completion', 'rerank', 'sparse_embedding', 'text_embedding']",
+                str,
+            ]
         ] = 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
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/put-inference-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-inference-api.html>`_
 
         :param inference_id: The inference Id
-        :param task_type: The task type
         :param model_config:
+        :param task_type: The task type
         """
         if inference_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'inference_id'")
@@ -263,11 +284,7 @@ class InferenceClient(NamespacedClient):
         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"
+        __headers = {"accept": "application/json", "content-type": "application/json"}
         return self.perform_request(  # type: ignore[return-value]
             "PUT",
             __path,

elasticsearch/_sync/client/ingest.py

@@ -42,7 +42,7 @@ class IngestClient(NamespacedClient):
         """
         Deletes a pipeline.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/delete-pipeline-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/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 `*`.
@@ -91,7 +91,7 @@ class IngestClient(NamespacedClient):
         """
         Returns statistical information about geoip databases
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/geoip-processor.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/geoip-processor.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_ingest/geoip/stats"
@@ -131,7 +131,7 @@ class IngestClient(NamespacedClient):
         """
         Returns a pipeline.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/get-pipeline-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/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 `*`.
@@ -182,7 +182,7 @@ class IngestClient(NamespacedClient):
         """
         Returns a list of the built-in patterns.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/grok-processor.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/grok-processor.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_ingest/processor/grok"
@@ -232,7 +232,7 @@ class IngestClient(NamespacedClient):
         """
         Creates or updates a pipeline.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/ingest.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/ingest.html>`_
 
         :param id: ID of the ingest pipeline to create or update.
         :param description: Description of the ingest pipeline.
@@ -318,7 +318,7 @@ class IngestClient(NamespacedClient):
         """
         Allows to simulate a pipeline with example documents.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/simulate-pipeline-api.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/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.14/delete-license.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_license"
@@ -74,7 +74,7 @@ class LicenseClient(NamespacedClient):
         """
         Retrieves licensing information for the cluster
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/get-license.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/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 +120,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.14/get-basic-status.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_license/basic_status"
@@ -155,7 +155,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.14/get-trial-status.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_license/trial_status"
@@ -196,7 +196,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.14/update-license.html>`_
 
         :param acknowledge: Specifies whether you acknowledge the license changes.
         :param license:
@@ -250,7 +250,7 @@ class LicenseClient(NamespacedClient):
         """
         Starts an indefinite basic license.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/start-basic.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/start-basic.html>`_
 
         :param acknowledge: whether the user has acknowledged acknowledge messages (default:
             false)
@@ -292,7 +292,7 @@ class LicenseClient(NamespacedClient):
         """
         starts a limited time trial license.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/start-trial.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/start-trial.html>`_
 
         :param acknowledge: whether the user has acknowledged acknowledge messages (default:
             false)

elasticsearch/_sync/client/logstash.py

@@ -38,7 +38,7 @@ class LogstashClient(NamespacedClient):
         """
         Deletes Logstash Pipelines used by 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.14/logstash-api-delete-pipeline.html>`_
 
         :param id: Identifier for the pipeline.
         """
@@ -78,7 +78,7 @@ class LogstashClient(NamespacedClient):
         """
         Retrieves Logstash Pipelines used by 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.14/logstash-api-get-pipeline.html>`_
 
         :param id: Comma-separated list of pipeline identifiers.
         """
@@ -125,7 +125,7 @@ class LogstashClient(NamespacedClient):
         """
         Adds and updates Logstash Pipelines used for 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.14/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.14/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.14/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.14/migration-api-feature-upgrade.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_migration/system_features"