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

elasticsearch/_async/client/inference.py

@@ -255,7 +255,21 @@ class InferenceClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create an inference endpoint
+        Create an inference endpoint. When you create an inference endpoint, the associated
+        machine learning model is automatically deployed if it is not already running.
+        After creating the endpoint, wait for the model deployment to complete before
+        using it. To verify the deployment status, use the get trained model statistics
+        API. Look for `"state": "fully_allocated"` in the response and ensure that the
+        `"allocation_count"` matches the `"target_allocation_count"`. Avoid creating
+        multiple endpoints for the same model unless required, as each endpoint consumes
+        significant resources. IMPORTANT: The inference APIs enable you to use certain
+        services, such as built-in machine learning models (ELSER, E5), models uploaded
+        through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google
+        Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models
+        uploaded through Eland, the inference APIs offer an alternative way to use and
+        manage trained models. However, if you do not plan to use the inference APIs
+        to use these models or if you want to use non-NLP models, use the machine learning
+        trained model APIs.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-inference-api.html>`_
 
@@ -303,3 +317,82 @@ class InferenceClient(NamespacedClient):
             endpoint_id="inference.put",
             path_parts=__path_parts,
         )
+
+    @_rewrite_parameters(
+        body_name="inference_config",
+    )
+    async def update(
+        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[
+                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,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        Update an inference endpoint. Modify `task_settings`, secrets (within `service_settings`),
+        or `num_allocations` for an inference endpoint, depending on the specific endpoint
+        service and `task_type`. IMPORTANT: The inference APIs enable you to use certain
+        services, such as built-in machine learning models (ELSER, E5), models uploaded
+        through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic,
+        Watsonx.ai, or Hugging Face. For built-in models and models uploaded through
+        Eland, the inference APIs offer an alternative way to use and manage trained
+        models. However, if you do not plan to use the inference APIs to use these models
+        or if you want to use non-NLP models, use the machine learning trained model
+        APIs.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-inference-api.html>`_
+
+        :param inference_id: The unique identifier of the inference endpoint.
+        :param inference_config:
+        :param task_type: The type of inference task that the model performs.
+        """
+        if inference_id in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for parameter 'inference_id'")
+        if inference_config is None and body is None:
+            raise ValueError(
+                "Empty value passed for parameters 'inference_config' and 'body', one of them should be set."
+            )
+        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 = {
+                "task_type": _quote(task_type),
+                "inference_id": _quote(inference_id),
+            }
+            __path = f'/_inference/{__path_parts["task_type"]}/{__path_parts["inference_id"]}/_update'
+        elif inference_id not in SKIP_IN_PATH:
+            __path_parts = {"inference_id": _quote(inference_id)}
+            __path = f'/_inference/{__path_parts["inference_id"]}/_update'
+        else:
+            raise ValueError("Couldn't find a path for the given parameters")
+        __query: t.Dict[str, t.Any] = {}
+        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
+        __body = inference_config if inference_config is not None else body
+        __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="inference.update",
+            path_parts=__path_parts,
+        )

elasticsearch/_async/client/ingest.py

@@ -77,6 +77,59 @@ class IngestClient(NamespacedClient):
             path_parts=__path_parts,
         )
 
+    @_rewrite_parameters()
+    async def delete_ip_location_database(
+        self,
+        *,
+        id: t.Union[str, t.Sequence[str]],
+        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[str, t.Literal[-1], t.Literal[0]]] = None,
+        pretty: t.Optional[bool] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        Delete IP geolocation database configurations.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-ip-location-database-api.html>`_
+
+        :param id: A comma-separated list of IP location database configurations.
+        :param master_timeout: The period to wait for a connection to the master node.
+            If no response is received before the timeout expires, the request fails
+            and returns an error. A value of `-1` indicates that the request should never
+            time out.
+        :param timeout: The period to wait for a response. If no response is received
+            before the timeout expires, the request fails and returns an error. A value
+            of `-1` indicates that the request should never time out.
+        """
+        if id in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for parameter 'id'")
+        __path_parts: t.Dict[str, str] = {"id": _quote(id)}
+        __path = f'/_ingest/ip_location/database/{__path_parts["id"]}'
+        __query: t.Dict[str, t.Any] = {}
+        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 master_timeout is not None:
+            __query["master_timeout"] = master_timeout
+        if pretty is not None:
+            __query["pretty"] = pretty
+        if timeout is not None:
+            __query["timeout"] = timeout
+        __headers = {"accept": "application/json"}
+        return await self.perform_request(  # type: ignore[return-value]
+            "DELETE",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="ingest.delete_ip_location_database",
+            path_parts=__path_parts,
+        )
+
     @_rewrite_parameters()
     async def delete_pipeline(
         self,
@@ -217,6 +270,58 @@ class IngestClient(NamespacedClient):
             path_parts=__path_parts,
         )
 
+    @_rewrite_parameters()
+    async def get_ip_location_database(
+        self,
+        *,
+        id: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        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[str, t.Literal[-1], t.Literal[0]]] = None,
+        pretty: t.Optional[bool] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        Get IP geolocation database configurations.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-ip-location-database-api.html>`_
+
+        :param id: Comma-separated list of database configuration IDs to retrieve. Wildcard
+            (`*`) expressions are supported. To get all database configurations, omit
+            this parameter or use `*`.
+        :param master_timeout: The period to wait for a connection to the master node.
+            If no response is received before the timeout expires, the request fails
+            and returns an error. A value of `-1` indicates that the request should never
+            time out.
+        """
+        __path_parts: t.Dict[str, str]
+        if id not in SKIP_IN_PATH:
+            __path_parts = {"id": _quote(id)}
+            __path = f'/_ingest/ip_location/database/{__path_parts["id"]}'
+        else:
+            __path_parts = {}
+            __path = "/_ingest/ip_location/database"
+        __query: t.Dict[str, t.Any] = {}
+        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 master_timeout is not None:
+            __query["master_timeout"] = master_timeout
+        if pretty is not None:
+            __query["pretty"] = pretty
+        __headers = {"accept": "application/json"}
+        return await self.perform_request(  # type: ignore[return-value]
+            "GET",
+            __path,
+            params=__query,
+            headers=__headers,
+            endpoint_id="ingest.get_ip_location_database",
+            path_parts=__path_parts,
+        )
+
     @_rewrite_parameters()
     async def get_pipeline(
         self,
@@ -328,8 +433,8 @@ class IngestClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update GeoIP database configurations. Create or update IP geolocation
-        database configurations.
+        Create or update a GeoIP database configuration. Refer to the create or update
+        IP geolocation database configuration API.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-geoip-database-api.html>`_
 
@@ -384,6 +489,74 @@ class IngestClient(NamespacedClient):
             path_parts=__path_parts,
         )
 
+    @_rewrite_parameters(
+        body_name="configuration",
+    )
+    async def put_ip_location_database(
+        self,
+        *,
+        id: str,
+        configuration: t.Optional[t.Mapping[str, t.Any]] = None,
+        body: t.Optional[t.Mapping[str, t.Any]] = None,
+        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[str, t.Literal[-1], t.Literal[0]]] = None,
+        pretty: t.Optional[bool] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        Create or update an IP geolocation database configuration.
+
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-ip-location-database-api.html>`_
+
+        :param id: The database configuration identifier.
+        :param configuration:
+        :param master_timeout: The period to wait for a connection to the master node.
+            If no response is received before the timeout expires, the request fails
+            and returns an error. A value of `-1` indicates that the request should never
+            time out.
+        :param timeout: The period to wait for a response from all relevant nodes in
+            the cluster after updating the cluster metadata. If no response is received
+            before the timeout expires, the cluster metadata update still applies but
+            the response indicates that it was not completely acknowledged. A value of
+            `-1` indicates that the request should never time out.
+        """
+        if id in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for parameter 'id'")
+        if configuration is None and body is None:
+            raise ValueError(
+                "Empty value passed for parameters 'configuration' and 'body', one of them should be set."
+            )
+        elif configuration is not None and body is not None:
+            raise ValueError("Cannot set both 'configuration' and 'body'")
+        __path_parts: t.Dict[str, str] = {"id": _quote(id)}
+        __path = f'/_ingest/ip_location/database/{__path_parts["id"]}'
+        __query: t.Dict[str, t.Any] = {}
+        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 master_timeout is not None:
+            __query["master_timeout"] = master_timeout
+        if pretty is not None:
+            __query["pretty"] = pretty
+        if timeout is not None:
+            __query["timeout"] = timeout
+        __body = configuration if configuration is not None else body
+        __headers = {"accept": "application/json", "content-type": "application/json"}
+        return await self.perform_request(  # type: ignore[return-value]
+            "PUT",
+            __path,
+            params=__query,
+            headers=__headers,
+            body=__body,
+            endpoint_id="ingest.put_ip_location_database",
+            path_parts=__path_parts,
+        )
+
     @_rewrite_parameters(
         body_fields=(
             "deprecated",

elasticsearch/_async/client/logstash.py

@@ -36,11 +36,13 @@ class LogstashClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Deletes a pipeline used for Logstash Central Management.
+        Delete a Logstash pipeline. Delete a pipeline that is used for Logstash Central
+        Management. If the request succeeds, you receive an empty response with an appropriate
+        status code.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/logstash-api-delete-pipeline.html>`_
 
-        :param id: Identifier for the pipeline.
+        :param id: An identifier for the pipeline.
         """
         if id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'id'")
@@ -76,11 +78,11 @@ class LogstashClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves pipelines used for Logstash Central Management.
+        Get Logstash pipelines. Get pipelines that are used for Logstash Central Management.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/logstash-api-get-pipeline.html>`_
 
-        :param id: Comma-separated list of pipeline identifiers.
+        :param id: A comma-separated list of pipeline identifiers.
         """
         __path_parts: t.Dict[str, str]
         if id not in SKIP_IN_PATH:
@@ -123,11 +125,12 @@ class LogstashClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Creates or updates a pipeline used for Logstash Central Management.
+        Create or update a Logstash pipeline. Create a pipeline that is used for Logstash
+        Central Management. If the specified pipeline exists, it is replaced.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/logstash-api-put-pipeline.html>`_
 
-        :param id: Identifier for the pipeline.
+        :param id: An identifier for the pipeline.
         :param pipeline:
         """
         if id in SKIP_IN_PATH:

elasticsearch/_async/client/migration.py

@@ -36,9 +36,10 @@ class MigrationClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Retrieves information about different cluster, node, and index level settings
-        that use deprecated features that will be removed or changed in the next major
-        version.
+        Get deprecation information. Get information about different cluster, node, and
+        index level settings that use deprecated features that will be removed or changed
+        in the next major version. TIP: This APIs is designed for indirect use by the
+        Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/migration-api-deprecation.html>`_
 
@@ -81,9 +82,13 @@ class MigrationClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Find out whether system features need to be upgraded or not
+        Get feature migration information. Version upgrades sometimes require changes
+        to how features store configuration information and data in system indices. Check
+        which features need to be migrated and the status of any migrations that are
+        in progress. TIP: This API is designed for indirect use by the Upgrade Assistant.
+        You are strongly recommended to use the Upgrade Assistant.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/migration-api-feature-upgrade.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/feature-migration-api.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_migration/system_features"
@@ -116,9 +121,13 @@ class MigrationClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Begin upgrades for system features
+        Start the feature migration. Version upgrades sometimes require changes to how
+        features store configuration information and data in system indices. This API
+        starts the automatic migration process. Some functionality might be temporarily
+        unavailable during the migration process. TIP: The API is designed for indirect
+        use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.
 
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/migration-api-feature-upgrade.html>`_
+        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/feature-migration-api.html>`_
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_migration/system_features"

elasticsearch/_async/client/ml.py

@@ -2702,7 +2702,7 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Return ML defaults and limits. Returns defaults and limits used by machine learning.
+        Get machine learning information. Get defaults and limits used by machine learning.
         This endpoint is designed to be used by a user interface that needs to fully
         understand machine learning configurations where some options are not specified,
         meaning that the defaults should be used. This endpoint may be used to find out
@@ -3205,7 +3205,11 @@ class MlClient(NamespacedClient):
         """
         Create a data frame analytics job. This API creates a data frame analytics job
         that performs an analysis on the source indices and stores the outcome in a destination
-        index.
+        index. By default, the query used in the source configuration is `{"match_all":
+        {}}`. If the destination index does not exist, it is created automatically when
+        you start the job. If you supply only a subset of the regression or classification
+        parameters, hyperparameter optimization occurs. It determines a value for each
+        of the undefined parameters.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-dfanalytics.html>`_
 
@@ -3382,7 +3386,8 @@ class MlClient(NamespacedClient):
         an anomaly detection job. You can associate only one datafeed with each anomaly
         detection job. The datafeed contains a query that runs at a defined interval
         (`frequency`). If you are concerned about delayed data, you can add a delay (`query_delay')
-        at each interval. When Elasticsearch security features are enabled, your datafeed
+        at each interval. By default, the datafeed uses the following query: `{"match_all":
+        {"boost": 1}}`. When Elasticsearch security features are enabled, your datafeed
         remembers which roles the user who created it had at the time of creation and
         runs the query using those same roles. If you provide secondary authorization
         headers, those credentials are used instead. You must use Kibana, this API, or
@@ -3645,7 +3650,8 @@ class MlClient(NamespacedClient):
     ) -> ObjectApiResponse[t.Any]:
         """
         Create an anomaly detection job. If you include a `datafeed_config`, you must
-        have read index privileges on the source index.
+        have read index privileges on the source index. If you include a `datafeed_config`
+        but do not provide a query, the datafeed uses `{"match_all": {"boost": 1}}`.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-put-job.html>`_
 
@@ -5451,7 +5457,7 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Validates an anomaly detection job.
+        Validate an anomaly detection job.
 
         `<https://www.elastic.co/guide/en/machine-learning/8.17/ml-jobs.html>`_
 
@@ -5521,7 +5527,7 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Validates an anomaly detection detector.
+        Validate an anomaly detection job.
 
         `<https://www.elastic.co/guide/en/machine-learning/8.17/ml-jobs.html>`_
 

elasticsearch/_async/client/monitoring.py

@@ -42,7 +42,8 @@ class MonitoringClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Used by the monitoring features to send monitoring data.
+        Send monitoring data. This API is used by the monitoring features to send monitoring
+        data.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/monitor-elasticsearch-cluster.html>`_
 

elasticsearch/_async/client/nodes.py

@@ -50,9 +50,9 @@ class NodesClient(NamespacedClient):
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-repositories-metering-archive-api.html>`_
 
         :param node_id: Comma-separated list of node IDs or names used to limit returned
-            information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes).
-        :param max_archive_version: Specifies the maximum [archive_version](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html#get-repositories-metering-api-response-body)
-            to be cleared from the archive.
+            information.
+        :param max_archive_version: Specifies the maximum `archive_version` to be cleared
+            from the archive.
         """
         if node_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'node_id'")

elasticsearch/_async/client/query_rules.py

@@ -37,7 +37,9 @@ class QueryRulesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete a query rule. Delete a query rule within a query ruleset.
+        Delete a query rule. Delete a query rule within a query ruleset. This is a destructive
+        action that is only recoverable by re-adding the same rule with the create or
+        update query rule API.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-query-rule.html>`_
 
@@ -85,7 +87,8 @@ class QueryRulesClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete a query ruleset.
+        Delete a query ruleset. Remove a query ruleset and its associated data. This
+        is a destructive action that is not recoverable.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-query-ruleset.html>`_
 
@@ -221,8 +224,8 @@ class QueryRulesClient(NamespacedClient):
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/list-query-rulesets.html>`_
 
-        :param from_: Starting offset (default: 0)
-        :param size: specifies a max number of results to get
+        :param from_: The offset from the first result to fetch.
+        :param size: The maximum number of results to retrieve.
         """
         __path_parts: t.Dict[str, str] = {}
         __path = "/_query_rules"
@@ -271,16 +274,25 @@ class QueryRulesClient(NamespacedClient):
     ) -> ObjectApiResponse[t.Any]:
         """
         Create or update a query rule. Create or update a query rule within a query ruleset.
+        IMPORTANT: Due to limitations within pinned queries, you can only pin documents
+        using ids or docs, but cannot use both in single rule. It is advised to use one
+        or the other in query rulesets, to avoid errors. Additionally, pinned queries
+        have a maximum limit of 100 pinned hits. If multiple matching rules pin more
+        than 100 documents, only the first 100 documents are pinned in the order they
+        are specified in the ruleset.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-query-rule.html>`_
 
         :param ruleset_id: The unique identifier of the query ruleset containing the
-            rule to be created or updated
+            rule to be created or updated.
         :param rule_id: The unique identifier of the query rule within the specified
-            ruleset to be created or updated
-        :param actions:
-        :param criteria:
-        :param type:
+            ruleset to be created or updated.
+        :param actions: The actions to take when the rule is matched. The format of this
+            action depends on the rule type.
+        :param criteria: The criteria that must be met for the rule to be applied. If
+            multiple criteria are specified for a rule, all criteria must be met for
+            the rule to be applied.
+        :param type: The type of rule.
         :param priority:
         """
         if ruleset_id in SKIP_IN_PATH:
@@ -345,12 +357,19 @@ class QueryRulesClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update a query ruleset.
+        Create or update a query ruleset. There is a limit of 100 rules per ruleset.
+        This limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset`
+        cluster setting. IMPORTANT: Due to limitations within pinned queries, you can
+        only select documents using `ids` or `docs`, but cannot use both in single rule.
+        It is advised to use one or the other in query rulesets, to avoid errors. Additionally,
+        pinned queries have a maximum limit of 100 pinned hits. If multiple matching
+        rules pin more than 100 documents, only the first 100 documents are pinned in
+        the order they are specified in the ruleset.
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-query-ruleset.html>`_
 
         :param ruleset_id: The unique identifier of the query ruleset to be created or
-            updated
+            updated.
         :param rules:
         """
         if ruleset_id in SKIP_IN_PATH:
@@ -405,7 +424,9 @@ class QueryRulesClient(NamespacedClient):
 
         :param ruleset_id: The unique identifier of the query ruleset to be created or
             updated
-        :param match_criteria:
+        :param match_criteria: The match criteria to apply to rules in the given query
+            ruleset. Match criteria should match the keys defined in the `criteria.metadata`
+            field of the rule.
         """
         if ruleset_id in SKIP_IN_PATH:
             raise ValueError("Empty value passed for parameter 'ruleset_id'")