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

elasticsearch/_async/client/__init__.py

@@ -1936,6 +1936,7 @@ class AsyncElasticsearch(BaseClient):
         id: str,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        force_synthetic_source: t.Optional[bool] = None,
         human: t.Optional[bool] = None,
         preference: t.Optional[str] = None,
         pretty: t.Optional[bool] = None,
@@ -1958,6 +1959,10 @@ class AsyncElasticsearch(BaseClient):
 
         :param index: Name of the index that contains the document.
         :param id: Unique identifier of the document.
+        :param force_synthetic_source: Should this request force synthetic _source? Use
+            this to test if the mapping supports synthetic _source and to get a sense
+            of the worst case performance. Fetches with this enabled will be slower the
+            enabling synthetic source natively in the index.
         :param preference: Specifies the node or shard the operation should be performed
             on. Random by default.
         :param realtime: If `true`, the request is real-time as opposed to near-real-time.
@@ -1989,6 +1994,8 @@ class AsyncElasticsearch(BaseClient):
             __query["error_trace"] = error_trace
         if filter_path is not None:
             __query["filter_path"] = filter_path
+        if force_synthetic_source is not None:
+            __query["force_synthetic_source"] = force_synthetic_source
         if human is not None:
             __query["human"] = human
         if preference is not None:
@@ -2578,6 +2585,7 @@ class AsyncElasticsearch(BaseClient):
         docs: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        force_synthetic_source: t.Optional[bool] = None,
         human: t.Optional[bool] = None,
         ids: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         preference: t.Optional[str] = None,
@@ -2600,6 +2608,10 @@ class AsyncElasticsearch(BaseClient):
             or when a document in the `docs` array does not specify an index.
         :param docs: The documents you want to retrieve. Required if no index is specified
             in the request URI.
+        :param force_synthetic_source: Should this request force synthetic _source? Use
+            this to test if the mapping supports synthetic _source and to get a sense
+            of the worst case performance. Fetches with this enabled will be slower the
+            enabling synthetic source natively in the index.
         :param ids: The IDs of the documents you want to retrieve. Allowed when the index
             is specified in the request URI.
         :param preference: Specifies the node or shard the operation should be performed
@@ -2634,6 +2646,8 @@ class AsyncElasticsearch(BaseClient):
             __query["error_trace"] = error_trace
         if filter_path is not None:
             __query["filter_path"] = filter_path
+        if force_synthetic_source is not None:
+            __query["force_synthetic_source"] = force_synthetic_source
         if human is not None:
             __query["human"] = human
         if preference is not None:
@@ -3677,6 +3691,7 @@ class AsyncElasticsearch(BaseClient):
         ext: t.Optional[t.Mapping[str, t.Any]] = None,
         fields: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        force_synthetic_source: t.Optional[bool] = None,
         from_: t.Optional[int] = None,
         highlight: t.Optional[t.Mapping[str, t.Any]] = None,
         human: t.Optional[bool] = None,
@@ -3793,6 +3808,10 @@ class AsyncElasticsearch(BaseClient):
         :param fields: Array of wildcard (`*`) patterns. The request returns values for
             field names matching these patterns in the `hits.fields` property of the
             response.
+        :param force_synthetic_source: Should this request force synthetic _source? Use
+            this to test if the mapping supports synthetic _source and to get a sense
+            of the worst case performance. Fetches with this enabled will be slower the
+            enabling synthetic source natively in the index.
         :param from_: Starting document offset. Needs to be non-negative. By default,
             you cannot page through more than 10,000 hits using the `from` and `size`
             parameters. To page through more hits, use the `search_after` parameter.
@@ -3972,6 +3991,8 @@ class AsyncElasticsearch(BaseClient):
             __query["expand_wildcards"] = expand_wildcards
         if filter_path is not None:
             __query["filter_path"] = filter_path
+        if force_synthetic_source is not None:
+            __query["force_synthetic_source"] = force_synthetic_source
         if human is not None:
             __query["human"] = human
         if ignore_throttled is not None:

elasticsearch/_async/client/ml.py

@@ -3653,6 +3653,7 @@ class MlClient(NamespacedClient):
         prefix_strings: t.Optional[t.Mapping[str, t.Any]] = None,
         pretty: t.Optional[bool] = None,
         tags: t.Optional[t.Sequence[str]] = None,
+        wait_for_completion: t.Optional[bool] = None,
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
@@ -3690,6 +3691,8 @@ class MlClient(NamespacedClient):
             this field unset.
         :param prefix_strings: Optional prefix strings applied at inference
         :param tags: An array of tags to organize the model.
+        :param wait_for_completion: Whether to wait for all child operations (e.g. model
+            download) to complete.
         """
         if model_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'model_id'")
@@ -3707,6 +3710,8 @@ class MlClient(NamespacedClient):
             __query["human"] = human
         if pretty is not None:
             __query["pretty"] = pretty
+        if wait_for_completion is not None:
+            __query["wait_for_completion"] = wait_for_completion
         if not __body:
             if compressed_definition is not None:
                 __body["compressed_definition"] = compressed_definition
@@ -5038,6 +5043,62 @@ class MlClient(NamespacedClient):
             path_parts=__path_parts,
         )
 
+    @_rewrite_parameters(
+        body_fields=("number_of_allocations",),
+    )
+    async def update_trained_model_deployment(
+        self,
+        *,
+        model_id: str,
+        error_trace: t.Optional[bool] = None,
+        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        human: t.Optional[bool] = None,
+        number_of_allocations: t.Optional[int] = None,
+        pretty: t.Optional[bool] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        Updates certain properties of trained model deployment.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/update-trained-model-deployment.html>`_
+
+        :param model_id: The unique identifier of the trained model. Currently, only
+            PyTorch models are supported.
+        :param number_of_allocations: The number of model allocations on each node where
+            the model is deployed. All allocations on a node share the same copy of the
+            model in memory but use a separate set of threads to evaluate the model.
+            Increasing this value generally increases the throughput. If this setting
+            is greater than the number of hardware threads it will automatically be changed
+            to a value less than the number of hardware threads.
+        """
+        if model_id in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for parameter 'model_id'")
+        __path_parts: t.Dict[str, str] = {"model_id": _quote(model_id)}
+        __path = f'/_ml/trained_models/{__path_parts["model_id"]}/deployment/_update'
+        __query: t.Dict[str, t.Any] = {}
+        __body: t.Dict[str, t.Any] = body if body is not None else {}
+        if error_trace is not None:
+            __query["error_trace"] = error_trace
+        if filter_path is not None:
+            __query["filter_path"] = filter_path
+        if human is not None:
+            __query["human"] = human
+        if pretty is not None:
+            __query["pretty"] = pretty
+        if not __body:
+            if number_of_allocations is not None:
+                __body["number_of_allocations"] = number_of_allocations
+        __headers = {"accept": "application/json", "content-type": "application/json"}
+        return await self.perform_request(  # type: ignore[return-value]
+            "POST",
+            __path,
+            params=__query,
+            headers=__headers,
+            body=__body,
+            endpoint_id="ml.update_trained_model_deployment",
+            path_parts=__path_parts,
+        )
+
     @_rewrite_parameters()
     async def upgrade_job_snapshot(
         self,

elasticsearch/_async/client/security.py

@@ -1756,7 +1756,7 @@ class SecurityClient(NamespacedClient):
         cluster: t.Optional[
             t.Sequence[
                 t.Union[
-                    "t.Literal['all', 'cancel_task', 'create_snapshot', 'grant_api_key', 'manage', 'manage_api_key', 'manage_ccr', 'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_ingest_pipelines', 'manage_logstash_pipelines', 'manage_ml', 'manage_oidc', 'manage_own_api_key', 'manage_pipeline', 'manage_rollup', 'manage_saml', 'manage_security', 'manage_service_account', 'manage_slm', 'manage_token', 'manage_transform', 'manage_user_profile', 'manage_watcher', 'monitor', 'monitor_ml', 'monitor_rollup', 'monitor_snapshot', 'monitor_text_structure', 'monitor_transform', 'monitor_watcher', 'read_ccr', 'read_ilm', 'read_pipeline', 'read_slm', 'transport_client']",
+                    "t.Literal['all', 'cancel_task', 'create_snapshot', 'cross_cluster_replication', 'cross_cluster_search', 'delegate_pki', 'grant_api_key', 'manage', 'manage_api_key', 'manage_autoscaling', 'manage_behavioral_analytics', 'manage_ccr', 'manage_data_frame_transforms', 'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_ingest_pipelines', 'manage_logstash_pipelines', 'manage_ml', 'manage_oidc', 'manage_own_api_key', 'manage_pipeline', 'manage_rollup', 'manage_saml', 'manage_search_application', 'manage_search_query_rules', 'manage_search_synonyms', 'manage_security', 'manage_service_account', 'manage_slm', 'manage_token', 'manage_transform', 'manage_user_profile', 'manage_watcher', 'monitor', 'monitor_data_frame_transforms', 'monitor_enrich', 'monitor_ml', 'monitor_rollup', 'monitor_snapshot', 'monitor_text_structure', 'monitor_transform', 'monitor_watcher', 'none', 'post_behavioral_analytics_event', 'read_ccr', 'read_connector_secrets', 'read_fleet_secrets', 'read_ilm', 'read_pipeline', 'read_security', 'read_slm', 'transport_client', 'write_connector_secrets', 'write_fleet_secrets']",
                     str,
                 ]
             ]
@@ -2079,7 +2079,7 @@ class SecurityClient(NamespacedClient):
         cluster: t.Optional[
             t.Sequence[
                 t.Union[
-                    "t.Literal['all', 'cancel_task', 'create_snapshot', 'grant_api_key', 'manage', 'manage_api_key', 'manage_ccr', 'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_ingest_pipelines', 'manage_logstash_pipelines', 'manage_ml', 'manage_oidc', 'manage_own_api_key', 'manage_pipeline', 'manage_rollup', 'manage_saml', 'manage_security', 'manage_service_account', 'manage_slm', 'manage_token', 'manage_transform', 'manage_user_profile', 'manage_watcher', 'monitor', 'monitor_ml', 'monitor_rollup', 'monitor_snapshot', 'monitor_text_structure', 'monitor_transform', 'monitor_watcher', 'read_ccr', 'read_ilm', 'read_pipeline', 'read_slm', 'transport_client']",
+                    "t.Literal['all', 'cancel_task', 'create_snapshot', 'cross_cluster_replication', 'cross_cluster_search', 'delegate_pki', 'grant_api_key', 'manage', 'manage_api_key', 'manage_autoscaling', 'manage_behavioral_analytics', 'manage_ccr', 'manage_data_frame_transforms', 'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_ingest_pipelines', 'manage_logstash_pipelines', 'manage_ml', 'manage_oidc', 'manage_own_api_key', 'manage_pipeline', 'manage_rollup', 'manage_saml', 'manage_search_application', 'manage_search_query_rules', 'manage_search_synonyms', 'manage_security', 'manage_service_account', 'manage_slm', 'manage_token', 'manage_transform', 'manage_user_profile', 'manage_watcher', 'monitor', 'monitor_data_frame_transforms', 'monitor_enrich', 'monitor_ml', 'monitor_rollup', 'monitor_snapshot', 'monitor_text_structure', 'monitor_transform', 'monitor_watcher', 'none', 'post_behavioral_analytics_event', 'read_ccr', 'read_connector_secrets', 'read_fleet_secrets', 'read_ilm', 'read_pipeline', 'read_security', 'read_slm', 'transport_client', 'write_connector_secrets', 'write_fleet_secrets']",
                     str,
                 ]
             ]
@@ -2375,6 +2375,7 @@ class SecurityClient(NamespacedClient):
                 t.Union[str, t.Mapping[str, t.Any]],
             ]
         ] = None,
+        typed_keys: t.Optional[bool] = None,
         with_limited_by: t.Optional[bool] = None,
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
@@ -2412,6 +2413,8 @@ class SecurityClient(NamespacedClient):
         :param sort: Other than `id`, all public fields of an API key are eligible for
             sorting. In addition, sort can also be applied to the `_doc` field to sort
             by index order.
+        :param typed_keys: Determines whether aggregation names are prefixed by their
+            respective types in the response.
         :param with_limited_by: Return the snapshot of the owner user's role descriptors
             associated with the API key. An API key's actual permission is the intersection
             of its assigned role descriptors and the owner user's role descriptors.
@@ -2439,6 +2442,8 @@ class SecurityClient(NamespacedClient):
             __query["human"] = human
         if pretty is not None:
             __query["pretty"] = pretty
+        if typed_keys is not None:
+            __query["typed_keys"] = typed_keys
         if with_limited_by is not None:
             __query["with_limited_by"] = with_limited_by
         if not __body:

elasticsearch/_sync/client/__init__.py

@@ -1934,6 +1934,7 @@ class Elasticsearch(BaseClient):
         id: str,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        force_synthetic_source: t.Optional[bool] = None,
         human: t.Optional[bool] = None,
         preference: t.Optional[str] = None,
         pretty: t.Optional[bool] = None,
@@ -1956,6 +1957,10 @@ class Elasticsearch(BaseClient):
 
         :param index: Name of the index that contains the document.
         :param id: Unique identifier of the document.
+        :param force_synthetic_source: Should this request force synthetic _source? Use
+            this to test if the mapping supports synthetic _source and to get a sense
+            of the worst case performance. Fetches with this enabled will be slower the
+            enabling synthetic source natively in the index.
         :param preference: Specifies the node or shard the operation should be performed
             on. Random by default.
         :param realtime: If `true`, the request is real-time as opposed to near-real-time.
@@ -1987,6 +1992,8 @@ class Elasticsearch(BaseClient):
             __query["error_trace"] = error_trace
         if filter_path is not None:
             __query["filter_path"] = filter_path
+        if force_synthetic_source is not None:
+            __query["force_synthetic_source"] = force_synthetic_source
         if human is not None:
             __query["human"] = human
         if preference is not None:
@@ -2576,6 +2583,7 @@ class Elasticsearch(BaseClient):
         docs: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
         error_trace: t.Optional[bool] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        force_synthetic_source: t.Optional[bool] = None,
         human: t.Optional[bool] = None,
         ids: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         preference: t.Optional[str] = None,
@@ -2598,6 +2606,10 @@ class Elasticsearch(BaseClient):
             or when a document in the `docs` array does not specify an index.
         :param docs: The documents you want to retrieve. Required if no index is specified
             in the request URI.
+        :param force_synthetic_source: Should this request force synthetic _source? Use
+            this to test if the mapping supports synthetic _source and to get a sense
+            of the worst case performance. Fetches with this enabled will be slower the
+            enabling synthetic source natively in the index.
         :param ids: The IDs of the documents you want to retrieve. Allowed when the index
             is specified in the request URI.
         :param preference: Specifies the node or shard the operation should be performed
@@ -2632,6 +2644,8 @@ class Elasticsearch(BaseClient):
             __query["error_trace"] = error_trace
         if filter_path is not None:
             __query["filter_path"] = filter_path
+        if force_synthetic_source is not None:
+            __query["force_synthetic_source"] = force_synthetic_source
         if human is not None:
             __query["human"] = human
         if preference is not None:
@@ -3675,6 +3689,7 @@ class Elasticsearch(BaseClient):
         ext: t.Optional[t.Mapping[str, t.Any]] = None,
         fields: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        force_synthetic_source: t.Optional[bool] = None,
         from_: t.Optional[int] = None,
         highlight: t.Optional[t.Mapping[str, t.Any]] = None,
         human: t.Optional[bool] = None,
@@ -3791,6 +3806,10 @@ class Elasticsearch(BaseClient):
         :param fields: Array of wildcard (`*`) patterns. The request returns values for
             field names matching these patterns in the `hits.fields` property of the
             response.
+        :param force_synthetic_source: Should this request force synthetic _source? Use
+            this to test if the mapping supports synthetic _source and to get a sense
+            of the worst case performance. Fetches with this enabled will be slower the
+            enabling synthetic source natively in the index.
         :param from_: Starting document offset. Needs to be non-negative. By default,
             you cannot page through more than 10,000 hits using the `from` and `size`
             parameters. To page through more hits, use the `search_after` parameter.
@@ -3970,6 +3989,8 @@ class Elasticsearch(BaseClient):
             __query["expand_wildcards"] = expand_wildcards
         if filter_path is not None:
             __query["filter_path"] = filter_path
+        if force_synthetic_source is not None:
+            __query["force_synthetic_source"] = force_synthetic_source
         if human is not None:
             __query["human"] = human
         if ignore_throttled is not None:

elasticsearch/_sync/client/ml.py

@@ -3653,6 +3653,7 @@ class MlClient(NamespacedClient):
         prefix_strings: t.Optional[t.Mapping[str, t.Any]] = None,
         pretty: t.Optional[bool] = None,
         tags: t.Optional[t.Sequence[str]] = None,
+        wait_for_completion: t.Optional[bool] = None,
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
@@ -3690,6 +3691,8 @@ class MlClient(NamespacedClient):
             this field unset.
         :param prefix_strings: Optional prefix strings applied at inference
         :param tags: An array of tags to organize the model.
+        :param wait_for_completion: Whether to wait for all child operations (e.g. model
+            download) to complete.
         """
         if model_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'model_id'")
@@ -3707,6 +3710,8 @@ class MlClient(NamespacedClient):
             __query["human"] = human
         if pretty is not None:
             __query["pretty"] = pretty
+        if wait_for_completion is not None:
+            __query["wait_for_completion"] = wait_for_completion
         if not __body:
             if compressed_definition is not None:
                 __body["compressed_definition"] = compressed_definition
@@ -5038,6 +5043,62 @@ class MlClient(NamespacedClient):
             path_parts=__path_parts,
         )
 
+    @_rewrite_parameters(
+        body_fields=("number_of_allocations",),
+    )
+    def update_trained_model_deployment(
+        self,
+        *,
+        model_id: str,
+        error_trace: t.Optional[bool] = None,
+        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        human: t.Optional[bool] = None,
+        number_of_allocations: t.Optional[int] = None,
+        pretty: t.Optional[bool] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        Updates certain properties of trained model deployment.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.13/update-trained-model-deployment.html>`_
+
+        :param model_id: The unique identifier of the trained model. Currently, only
+            PyTorch models are supported.
+        :param number_of_allocations: The number of model allocations on each node where
+            the model is deployed. All allocations on a node share the same copy of the
+            model in memory but use a separate set of threads to evaluate the model.
+            Increasing this value generally increases the throughput. If this setting
+            is greater than the number of hardware threads it will automatically be changed
+            to a value less than the number of hardware threads.
+        """
+        if model_id in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for parameter 'model_id'")
+        __path_parts: t.Dict[str, str] = {"model_id": _quote(model_id)}
+        __path = f'/_ml/trained_models/{__path_parts["model_id"]}/deployment/_update'
+        __query: t.Dict[str, t.Any] = {}
+        __body: t.Dict[str, t.Any] = body if body is not None else {}
+        if error_trace is not None:
+            __query["error_trace"] = error_trace
+        if filter_path is not None:
+            __query["filter_path"] = filter_path
+        if human is not None:
+            __query["human"] = human
+        if pretty is not None:
+            __query["pretty"] = pretty
+        if not __body:
+            if number_of_allocations is not None:
+                __body["number_of_allocations"] = number_of_allocations
+        __headers = {"accept": "application/json", "content-type": "application/json"}
+        return self.perform_request(  # type: ignore[return-value]
+            "POST",
+            __path,
+            params=__query,
+            headers=__headers,
+            body=__body,
+            endpoint_id="ml.update_trained_model_deployment",
+            path_parts=__path_parts,
+        )
+
     @_rewrite_parameters()
     def upgrade_job_snapshot(
         self,

elasticsearch/_sync/client/security.py

@@ -1756,7 +1756,7 @@ class SecurityClient(NamespacedClient):
         cluster: t.Optional[
             t.Sequence[
                 t.Union[
-                    "t.Literal['all', 'cancel_task', 'create_snapshot', 'grant_api_key', 'manage', 'manage_api_key', 'manage_ccr', 'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_ingest_pipelines', 'manage_logstash_pipelines', 'manage_ml', 'manage_oidc', 'manage_own_api_key', 'manage_pipeline', 'manage_rollup', 'manage_saml', 'manage_security', 'manage_service_account', 'manage_slm', 'manage_token', 'manage_transform', 'manage_user_profile', 'manage_watcher', 'monitor', 'monitor_ml', 'monitor_rollup', 'monitor_snapshot', 'monitor_text_structure', 'monitor_transform', 'monitor_watcher', 'read_ccr', 'read_ilm', 'read_pipeline', 'read_slm', 'transport_client']",
+                    "t.Literal['all', 'cancel_task', 'create_snapshot', 'cross_cluster_replication', 'cross_cluster_search', 'delegate_pki', 'grant_api_key', 'manage', 'manage_api_key', 'manage_autoscaling', 'manage_behavioral_analytics', 'manage_ccr', 'manage_data_frame_transforms', 'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_ingest_pipelines', 'manage_logstash_pipelines', 'manage_ml', 'manage_oidc', 'manage_own_api_key', 'manage_pipeline', 'manage_rollup', 'manage_saml', 'manage_search_application', 'manage_search_query_rules', 'manage_search_synonyms', 'manage_security', 'manage_service_account', 'manage_slm', 'manage_token', 'manage_transform', 'manage_user_profile', 'manage_watcher', 'monitor', 'monitor_data_frame_transforms', 'monitor_enrich', 'monitor_ml', 'monitor_rollup', 'monitor_snapshot', 'monitor_text_structure', 'monitor_transform', 'monitor_watcher', 'none', 'post_behavioral_analytics_event', 'read_ccr', 'read_connector_secrets', 'read_fleet_secrets', 'read_ilm', 'read_pipeline', 'read_security', 'read_slm', 'transport_client', 'write_connector_secrets', 'write_fleet_secrets']",
                     str,
                 ]
             ]
@@ -2079,7 +2079,7 @@ class SecurityClient(NamespacedClient):
         cluster: t.Optional[
             t.Sequence[
                 t.Union[
-                    "t.Literal['all', 'cancel_task', 'create_snapshot', 'grant_api_key', 'manage', 'manage_api_key', 'manage_ccr', 'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_ingest_pipelines', 'manage_logstash_pipelines', 'manage_ml', 'manage_oidc', 'manage_own_api_key', 'manage_pipeline', 'manage_rollup', 'manage_saml', 'manage_security', 'manage_service_account', 'manage_slm', 'manage_token', 'manage_transform', 'manage_user_profile', 'manage_watcher', 'monitor', 'monitor_ml', 'monitor_rollup', 'monitor_snapshot', 'monitor_text_structure', 'monitor_transform', 'monitor_watcher', 'read_ccr', 'read_ilm', 'read_pipeline', 'read_slm', 'transport_client']",
+                    "t.Literal['all', 'cancel_task', 'create_snapshot', 'cross_cluster_replication', 'cross_cluster_search', 'delegate_pki', 'grant_api_key', 'manage', 'manage_api_key', 'manage_autoscaling', 'manage_behavioral_analytics', 'manage_ccr', 'manage_data_frame_transforms', 'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_ingest_pipelines', 'manage_logstash_pipelines', 'manage_ml', 'manage_oidc', 'manage_own_api_key', 'manage_pipeline', 'manage_rollup', 'manage_saml', 'manage_search_application', 'manage_search_query_rules', 'manage_search_synonyms', 'manage_security', 'manage_service_account', 'manage_slm', 'manage_token', 'manage_transform', 'manage_user_profile', 'manage_watcher', 'monitor', 'monitor_data_frame_transforms', 'monitor_enrich', 'monitor_ml', 'monitor_rollup', 'monitor_snapshot', 'monitor_text_structure', 'monitor_transform', 'monitor_watcher', 'none', 'post_behavioral_analytics_event', 'read_ccr', 'read_connector_secrets', 'read_fleet_secrets', 'read_ilm', 'read_pipeline', 'read_security', 'read_slm', 'transport_client', 'write_connector_secrets', 'write_fleet_secrets']",
                     str,
                 ]
             ]
@@ -2375,6 +2375,7 @@ class SecurityClient(NamespacedClient):
                 t.Union[str, t.Mapping[str, t.Any]],
             ]
         ] = None,
+        typed_keys: t.Optional[bool] = None,
         with_limited_by: t.Optional[bool] = None,
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
@@ -2412,6 +2413,8 @@ class SecurityClient(NamespacedClient):
         :param sort: Other than `id`, all public fields of an API key are eligible for
             sorting. In addition, sort can also be applied to the `_doc` field to sort
             by index order.
+        :param typed_keys: Determines whether aggregation names are prefixed by their
+            respective types in the response.
         :param with_limited_by: Return the snapshot of the owner user's role descriptors
             associated with the API key. An API key's actual permission is the intersection
             of its assigned role descriptors and the owner user's role descriptors.
@@ -2439,6 +2442,8 @@ class SecurityClient(NamespacedClient):
             __query["human"] = human
         if pretty is not None:
             __query["pretty"] = pretty
+        if typed_keys is not None:
+            __query["typed_keys"] = typed_keys
         if with_limited_by is not None:
             __query["with_limited_by"] = with_limited_by
         if not __body:

elasticsearch/_version.py

@@ -15,4 +15,4 @@
 #  specific language governing permissions and limitations
 #  under the License.
 
-__versionstr__ = "8.13.0"
+__versionstr__ = "8.13.2"

elasticsearch/helpers/vectorstore/__init__.py

@@ -0,0 +1,62 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
+
+from elasticsearch.helpers.vectorstore._async.embedding_service import (
+    AsyncElasticsearchEmbeddings,
+    AsyncEmbeddingService,
+)
+from elasticsearch.helpers.vectorstore._async.strategies import (
+    AsyncBM25Strategy,
+    AsyncDenseVectorScriptScoreStrategy,
+    AsyncDenseVectorStrategy,
+    AsyncRetrievalStrategy,
+    AsyncSparseVectorStrategy,
+)
+from elasticsearch.helpers.vectorstore._async.vectorstore import AsyncVectorStore
+from elasticsearch.helpers.vectorstore._sync.embedding_service import (
+    ElasticsearchEmbeddings,
+    EmbeddingService,
+)
+from elasticsearch.helpers.vectorstore._sync.strategies import (
+    BM25Strategy,
+    DenseVectorScriptScoreStrategy,
+    DenseVectorStrategy,
+    RetrievalStrategy,
+    SparseVectorStrategy,
+)
+from elasticsearch.helpers.vectorstore._sync.vectorstore import VectorStore
+from elasticsearch.helpers.vectorstore._utils import DistanceMetric
+
+__all__ = [
+    "AsyncBM25Strategy",
+    "AsyncDenseVectorScriptScoreStrategy",
+    "AsyncDenseVectorStrategy",
+    "AsyncElasticsearchEmbeddings",
+    "AsyncEmbeddingService",
+    "AsyncRetrievalStrategy",
+    "AsyncSparseVectorStrategy",
+    "AsyncVectorStore",
+    "BM25Strategy",
+    "DenseVectorScriptScoreStrategy",
+    "DenseVectorStrategy",
+    "DistanceMetric",
+    "ElasticsearchEmbeddings",
+    "EmbeddingService",
+    "RetrievalStrategy",
+    "SparseVectorStrategy",
+    "VectorStore",
+]

elasticsearch/helpers/vectorstore/_async/__init__.py

@@ -0,0 +1,16 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.

elasticsearch/helpers/vectorstore/_async/_utils.py

@@ -0,0 +1,39 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
+
+from elasticsearch import AsyncElasticsearch, BadRequestError, NotFoundError
+
+
+async def model_must_be_deployed(client: AsyncElasticsearch, model_id: str) -> None:
+    """
+    :raises [NotFoundError]: if the model is neither downloaded nor deployed.
+    :raises [ConflictError]: if the model is downloaded but not yet deployed.
+    """
+    doc = {"text_field": f"test if the model '{model_id}' is deployed"}
+    try:
+        await client.ml.infer_trained_model(model_id=model_id, docs=[doc])
+    except BadRequestError:
+        # The model is deployed but expects a different input field name.
+        pass
+
+
+async def model_is_deployed(client: AsyncElasticsearch, model_id: str) -> bool:
+    try:
+        await model_must_be_deployed(client, model_id)
+        return True
+    except NotFoundError:
+        return False

elasticsearch/helpers/vectorstore/_async/embedding_service.py

@@ -0,0 +1,89 @@
+#  Licensed to Elasticsearch B.V. under one or more contributor
+#  license agreements. See the NOTICE file distributed with
+#  this work for additional information regarding copyright
+#  ownership. Elasticsearch B.V. licenses this file to you under
+#  the Apache License, Version 2.0 (the "License"); you may
+#  not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing,
+#  software distributed under the License is distributed on an
+#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+#  specific language governing permissions and limitations
+#  under the License.
+
+from abc import ABC, abstractmethod
+from typing import List
+
+from elasticsearch import AsyncElasticsearch
+from elasticsearch._version import __versionstr__ as lib_version
+
+
+class AsyncEmbeddingService(ABC):
+    @abstractmethod
+    async def embed_documents(self, texts: List[str]) -> List[List[float]]:
+        """Generate embeddings for a list of documents.
+
+        :param texts: A list of document strings to generate embeddings for.
+
+        :return: A list of embeddings, one for each document in the input.
+        """
+
+    @abstractmethod
+    async def embed_query(self, query: str) -> List[float]:
+        """Generate an embedding for a single query text.
+
+        :param text: The query text to generate an embedding for.
+
+        :return: The embedding for the input query text.
+        """
+
+
+class AsyncElasticsearchEmbeddings(AsyncEmbeddingService):
+    """Elasticsearch as a service for embedding model inference.
+
+    You need to have an embedding model downloaded and deployed in Elasticsearch:
+    - https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-trained-model.html
+    - https://www.elastic.co/guide/en/machine-learning/current/ml-nlp-deploy-models.html
+    """  # noqa: E501
+
+    def __init__(
+        self,
+        *,
+        client: AsyncElasticsearch,
+        model_id: str,
+        input_field: str = "text_field",
+        user_agent: str = f"elasticsearch-py-es/{lib_version}",
+    ):
+        """
+        :param agent_header: user agent header specific to the 3rd party integration.
+            Used for usage tracking in Elastic Cloud.
+        :param model_id: The model_id of the model deployed in the Elasticsearch cluster.
+        :param input_field: The name of the key for the input text field in the
+            document. Defaults to 'text_field'.
+        :param client: Elasticsearch client connection. Alternatively specify the
+            Elasticsearch connection with the other es_* parameters.
+        """
+        # Add integration-specific usage header for tracking usage in Elastic Cloud.
+        # client.options preserves existing (non-user-agent) headers.
+        client = client.options(headers={"User-Agent": user_agent})
+
+        self.client = client
+        self.model_id = model_id
+        self.input_field = input_field
+
+    async def embed_documents(self, texts: List[str]) -> List[List[float]]:
+        return await self._embedding_func(texts)
+
+    async def embed_query(self, text: str) -> List[float]:
+        result = await self._embedding_func([text])
+        return result[0]
+
+    async def _embedding_func(self, texts: List[str]) -> List[List[float]]:
+        response = await self.client.ml.infer_trained_model(
+            model_id=self.model_id, docs=[{self.input_field: text} for text in texts]
+        )
+        return [doc["predicted_value"] for doc in response["inference_results"]]