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

elasticsearch/_async/client/ml.py

@@ -36,11 +36,14 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Clear trained model deployment cache. Cache will be cleared on all nodes where
-        the trained model is assigned. A trained model deployment may have an inference
-        cache enabled. As requests are handled by each allocated node, their responses
-        may be cached on that individual node. Calling this API clears the caches without
-        restarting the deployment.
+        .. raw:: html
+
+          <p>Clear trained model deployment cache.
+          Cache will be cleared on all nodes where the trained model is assigned.
+          A trained model deployment may have an inference cache enabled.
+          As requests are handled by each allocated node, their responses may be cached on that individual node.
+          Calling this API clears the caches without restarting the deployment.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/clear-trained-model-deployment-cache.html>`_
 
@@ -88,19 +91,14 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Close anomaly detection jobs. A job can be opened and closed multiple times throughout
-        its lifecycle. A closed job cannot receive data or perform analysis operations,
-        but you can still explore and navigate results. When you close a job, it runs
-        housekeeping tasks such as pruning the model history, flushing buffers, calculating
-        final results and persisting the model snapshots. Depending upon the size of
-        the job, it could take several minutes to close and the equivalent time to re-open.
-        After it is closed, the job has a minimal overhead on the cluster except for
-        maintaining its meta data. Therefore it is a best practice to close jobs that
-        are no longer required to process data. If you close an anomaly detection job
-        whose datafeed is running, the request first tries to stop the datafeed. This
-        behavior is equivalent to calling stop datafeed API with the same timeout and
-        force parameters as the close job request. When a datafeed that has a specified
-        end date stops, it automatically closes its associated job.
+        .. raw:: html
+
+          <p>Close anomaly detection jobs.
+          A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
+          When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
+          If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
+          When a datafeed that has a specified end date stops, it automatically closes its associated job.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-close-job.html>`_
 
@@ -161,8 +159,11 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete a calendar. Removes all scheduled events from a calendar, then deletes
-        it.
+        .. raw:: html
+
+          <p>Delete a calendar.
+          Removes all scheduled events from a calendar, then deletes it.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar.html>`_
 
@@ -203,7 +204,10 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete events from a calendar.
+        .. raw:: html
+
+          <p>Delete events from a calendar.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar-event.html>`_
 
@@ -251,7 +255,10 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete anomaly jobs from a calendar.
+        .. raw:: html
+
+          <p>Delete anomaly jobs from a calendar.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-calendar-job.html>`_
 
@@ -300,7 +307,10 @@ class MlClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete a data frame analytics job.
+        .. raw:: html
+
+          <p>Delete a data frame analytics job.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-dfanalytics.html>`_
 
@@ -348,7 +358,10 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete a datafeed.
+        .. raw:: html
+
+          <p>Delete a datafeed.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-datafeed.html>`_
 
@@ -400,13 +413,18 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete expired ML data. Deletes all job results, model snapshots and forecast
-        data that have exceeded their retention days period. Machine learning state documents
-        that are not associated with any job are also deleted. You can limit the request
-        to a single or set of anomaly detection jobs by using a job identifier, a group
-        name, a comma-separated list of jobs, or a wildcard expression. You can delete
-        expired data for all anomaly detection jobs by using _all, by specifying * as
-        the <job_id>, or by omitting the <job_id>.
+        .. raw:: html
+
+          <p>Delete expired ML data.
+          Deletes all job results, model snapshots and forecast data that have exceeded
+          their retention days period. Machine learning state documents that are not
+          associated with any job are also deleted.
+          You can limit the request to a single or set of anomaly detection jobs by
+          using a job identifier, a group name, a comma-separated list of jobs, or a
+          wildcard expression. You can delete expired data for all anomaly detection
+          jobs by using _all, by specifying * as the &lt;job_id&gt;, or by omitting the
+          &lt;job_id&gt;.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-expired-data.html>`_
 
@@ -465,9 +483,12 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete a filter. If an anomaly detection job references the filter, you cannot
-        delete the filter. You must update or delete the job before you can delete the
-        filter.
+        .. raw:: html
+
+          <p>Delete a filter.
+          If an anomaly detection job references the filter, you cannot delete the
+          filter. You must update or delete the job before you can delete the filter.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-filter.html>`_
 
@@ -510,10 +531,14 @@ class MlClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete forecasts from a job. By default, forecasts are retained for 14 days.
-        You can specify a different retention period with the `expires_in` parameter
-        in the forecast jobs API. The delete forecast API enables you to delete one or
-        more forecasts before they expire.
+        .. raw:: html
+
+          <p>Delete forecasts from a job.
+          By default, forecasts are retained for 14 days. You can specify a
+          different retention period with the <code>expires_in</code> parameter in the forecast
+          jobs API. The delete forecast API enables you to delete one or more
+          forecasts before they expire.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-forecast.html>`_
 
@@ -580,12 +605,16 @@ class MlClient(NamespacedClient):
         wait_for_completion: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete an anomaly detection job. All job configuration, model state and results
-        are deleted. It is not currently possible to delete multiple jobs using wildcards
-        or a comma separated list. If you delete a job that has a datafeed, the request
-        first tries to delete the datafeed. This behavior is equivalent to calling the
-        delete datafeed API with the same timeout and force parameters as the delete
-        job request.
+        .. raw:: html
+
+          <p>Delete an anomaly detection job.
+          All job configuration, model state and results are deleted.
+          It is not currently possible to delete multiple jobs using wildcards or a
+          comma separated list. If you delete a job that has a datafeed, the request
+          first tries to delete the datafeed. This behavior is equivalent to calling
+          the delete datafeed API with the same timeout and force parameters as the
+          delete job request.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-job.html>`_
 
@@ -639,9 +668,13 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete a model snapshot. You cannot delete the active model snapshot. To delete
-        that snapshot, first revert to a different one. To identify the active model
-        snapshot, refer to the `model_snapshot_id` in the results from the get jobs API.
+        .. raw:: html
+
+          <p>Delete a model snapshot.
+          You cannot delete the active model snapshot. To delete that snapshot, first
+          revert to a different one. To identify the active model snapshot, refer to
+          the <code>model_snapshot_id</code> in the results from the get jobs API.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-snapshot.html>`_
 
@@ -688,8 +721,11 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete an unreferenced trained model. The request deletes a trained inference
-        model that is not referenced by an ingest pipeline.
+        .. raw:: html
+
+          <p>Delete an unreferenced trained model.
+          The request deletes a trained inference model that is not referenced by an ingest pipeline.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-trained-models.html>`_
 
@@ -734,9 +770,13 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete a trained model alias. This API deletes an existing model alias that refers
-        to a trained model. If the model alias is missing or refers to a model other
-        than the one identified by the `model_id`, this API returns an error.
+        .. raw:: html
+
+          <p>Delete a trained model alias.
+          This API deletes an existing model alias that refers to a trained model. If
+          the model alias is missing or refers to a model other than the one identified
+          by the <code>model_id</code>, this API returns an error.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-trained-models-aliases.html>`_
 
@@ -791,9 +831,13 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Estimate job model memory usage. Makes an estimation of the memory usage for
-        an anomaly detection job model. It is based on analysis configuration details
-        for the job and cardinality estimates for the fields it references.
+        .. raw:: html
+
+          <p>Estimate job model memory usage.
+          Makes an estimation of the memory usage for an anomaly detection job model.
+          It is based on analysis configuration details for the job and cardinality
+          estimates for the fields it references.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-apis.html>`_
 
@@ -858,10 +902,14 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Evaluate data frame analytics. The API packages together commonly used evaluation
-        metrics for various types of machine learning features. This has been designed
-        for use on indexes created by data frame analytics. Evaluation requires both
-        a ground truth field and an analytics result field to be present.
+        .. raw:: html
+
+          <p>Evaluate data frame analytics.
+          The API packages together commonly used evaluation metrics for various types
+          of machine learning features. This has been designed for use on indexes
+          created by data frame analytics. Evaluation requires both a ground truth
+          field and an analytics result field to be present.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/evaluate-dfanalytics.html>`_
 
@@ -935,13 +983,18 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Explain data frame analytics config. This API provides explanations for a data
-        frame analytics config that either exists already or one that has not been created
-        yet. The following explanations are provided: * which fields are included or
-        not in the analysis and why, * how much memory is estimated to be required. The
-        estimate can be used when deciding the appropriate value for model_memory_limit
-        setting later on. If you have object fields or fields that are excluded via source
-        filtering, they are not included in the explanation.
+        .. raw:: html
+
+          <p>Explain data frame analytics config.
+          This API provides explanations for a data frame analytics config that either
+          exists already or one that has not been created yet. The following
+          explanations are provided:</p>
+          <ul>
+          <li>which fields are included or not in the analysis and why,</li>
+          <li>how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.
+          If you have object fields or fields that are excluded via source filtering, they are not included in the explanation.</li>
+          </ul>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/explain-dfanalytics.html>`_
 
@@ -1041,14 +1094,18 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Force buffered data to be processed. The flush jobs API is only applicable when
-        sending data for analysis using the post data API. Depending on the content of
-        the buffer, then it might additionally calculate new results. Both flush and
-        close operations are similar, however the flush is more efficient if you are
-        expecting to send more data for analysis. When flushing, the job remains open
-        and is available to continue analyzing data. A close operation additionally prunes
-        and persists the model state to disk and the job must be opened again before
-        analyzing further data.
+        .. raw:: html
+
+          <p>Force buffered data to be processed.
+          The flush jobs API is only applicable when sending data for analysis using
+          the post data API. Depending on the content of the buffer, then it might
+          additionally calculate new results. Both flush and close operations are
+          similar, however the flush is more efficient if you are expecting to send
+          more data for analysis. When flushing, the job remains open and is available
+          to continue analyzing data. A close operation additionally prunes and
+          persists the model state to disk and the job must be opened again before
+          analyzing further data.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-flush-job.html>`_
 
@@ -1116,10 +1173,14 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Predict future behavior of a time series. Forecasts are not supported for jobs
-        that perform population analysis; an error occurs if you try to create a forecast
-        for a job that has an `over_field_name` in its configuration. Forcasts predict
-        future behavior based on historical data.
+        .. raw:: html
+
+          <p>Predict future behavior of a time series.</p>
+          <p>Forecasts are not supported for jobs that perform population analysis; an
+          error occurs if you try to create a forecast for a job that has an
+          <code>over_field_name</code> in its configuration. Forcasts predict future behavior
+          based on historical data.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-forecast.html>`_
 
@@ -1201,8 +1262,11 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get anomaly detection job results for buckets. The API presents a chronological
-        view of the records, grouped by bucket.
+        .. raw:: html
+
+          <p>Get anomaly detection job results for buckets.
+          The API presents a chronological view of the records, grouped by bucket.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-bucket.html>`_
 
@@ -1297,7 +1361,10 @@ class MlClient(NamespacedClient):
         start: t.Optional[t.Union[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get info about events in calendars.
+        .. raw:: html
+
+          <p>Get info about events in calendars.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-calendar-event.html>`_
 
@@ -1363,7 +1430,10 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get calendar configuration info.
+        .. raw:: html
+
+          <p>Get calendar configuration info.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-calendar.html>`_
 
@@ -1436,7 +1506,10 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get anomaly detection job results for categories.
+        .. raw:: html
+
+          <p>Get anomaly detection job results for categories.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-category.html>`_
 
@@ -1518,9 +1591,13 @@ class MlClient(NamespacedClient):
         size: t.Optional[int] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get data frame analytics job configuration info. You can get information for
-        multiple data frame analytics jobs in a single API request by using a comma-separated
-        list of data frame analytics jobs or a wildcard expression.
+        .. raw:: html
+
+          <p>Get data frame analytics job configuration info.
+          You can get information for multiple data frame analytics jobs in a single
+          API request by using a comma-separated list of data frame analytics jobs or a
+          wildcard expression.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-dfanalytics.html>`_
 
@@ -1592,7 +1669,10 @@ class MlClient(NamespacedClient):
         verbose: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get data frame analytics jobs usage info.
+        .. raw:: html
+
+          <p>Get data frame analytics jobs usage info.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-dfanalytics-stats.html>`_
 
@@ -1657,12 +1737,16 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get datafeeds usage info. You can get statistics for multiple datafeeds in a
-        single API request by using a comma-separated list of datafeeds or a wildcard
-        expression. You can get statistics for all datafeeds by using `_all`, by specifying
-        `*` as the `<feed_id>`, or by omitting the `<feed_id>`. If the datafeed is stopped,
-        the only information you receive is the `datafeed_id` and the `state`. This API
-        returns a maximum of 10,000 datafeeds.
+        .. raw:: html
+
+          <p>Get datafeeds usage info.
+          You can get statistics for multiple datafeeds in a single API request by
+          using a comma-separated list of datafeeds or a wildcard expression. You can
+          get statistics for all datafeeds by using <code>_all</code>, by specifying <code>*</code> as the
+          <code>&lt;feed_id&gt;</code>, or by omitting the <code>&lt;feed_id&gt;</code>. If the datafeed is stopped, the
+          only information you receive is the <code>datafeed_id</code> and the <code>state</code>.
+          This API returns a maximum of 10,000 datafeeds.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-datafeed-stats.html>`_
 
@@ -1718,11 +1802,15 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get datafeeds configuration info. You can get information for multiple datafeeds
-        in a single API request by using a comma-separated list of datafeeds or a wildcard
-        expression. You can get information for all datafeeds by using `_all`, by specifying
-        `*` as the `<feed_id>`, or by omitting the `<feed_id>`. This API returns a maximum
-        of 10,000 datafeeds.
+        .. raw:: html
+
+          <p>Get datafeeds configuration info.
+          You can get information for multiple datafeeds in a single API request by
+          using a comma-separated list of datafeeds or a wildcard expression. You can
+          get information for all datafeeds by using <code>_all</code>, by specifying <code>*</code> as the
+          <code>&lt;feed_id&gt;</code>, or by omitting the <code>&lt;feed_id&gt;</code>.
+          This API returns a maximum of 10,000 datafeeds.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-datafeed.html>`_
 
@@ -1785,7 +1873,11 @@ class MlClient(NamespacedClient):
         size: t.Optional[int] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get filters. You can get a single filter or all filters.
+        .. raw:: html
+
+          <p>Get filters.
+          You can get a single filter or all filters.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-filter.html>`_
 
@@ -1847,9 +1939,13 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get anomaly detection job results for influencers. Influencers are the entities
-        that have contributed to, or are to blame for, the anomalies. Influencer results
-        are available only if an `influencer_field_name` is specified in the job configuration.
+        .. raw:: html
+
+          <p>Get anomaly detection job results for influencers.
+          Influencers are the entities that have contributed to, or are to blame for,
+          the anomalies. Influencer results are available only if an
+          <code>influencer_field_name</code> is specified in the job configuration.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-influencer.html>`_
 
@@ -1930,7 +2026,10 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get anomaly detection jobs usage info.
+        .. raw:: html
+
+          <p>Get anomaly detection jobs usage info.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-job-stats.html>`_
 
@@ -1987,11 +2086,14 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get anomaly detection jobs configuration info. You can get information for multiple
-        anomaly detection jobs in a single API request by using a group name, a comma-separated
-        list of jobs, or a wildcard expression. You can get information for all anomaly
-        detection jobs by using `_all`, by specifying `*` as the `<job_id>`, or by omitting
-        the `<job_id>`.
+        .. raw:: html
+
+          <p>Get anomaly detection jobs configuration info.
+          You can get information for multiple anomaly detection jobs in a single API
+          request by using a group name, a comma-separated list of jobs, or a wildcard
+          expression. You can get information for all anomaly detection jobs by using
+          <code>_all</code>, by specifying <code>*</code> as the <code>&lt;job_id&gt;</code>, or by omitting the <code>&lt;job_id&gt;</code>.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-job.html>`_
 
@@ -2052,9 +2154,12 @@ class MlClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get machine learning memory usage info. Get information about how machine learning
-        jobs and trained models are using memory, on each node, both within the JVM heap,
-        and natively, outside of the JVM.
+        .. raw:: html
+
+          <p>Get machine learning memory usage info.
+          Get information about how machine learning jobs and trained models are using memory,
+          on each node, both within the JVM heap, and natively, outside of the JVM.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-ml-memory.html>`_
 
@@ -2109,7 +2214,10 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get anomaly detection job model snapshot upgrade usage info.
+        .. raw:: html
+
+          <p>Get anomaly detection job model snapshot upgrade usage info.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-job-model-snapshot-upgrade-stats.html>`_
 
@@ -2180,7 +2288,10 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get model snapshots info.
+        .. raw:: html
+
+          <p>Get model snapshots info.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-snapshot.html>`_
 
@@ -2281,19 +2392,26 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get overall bucket results. Retrievs overall bucket results that summarize the
-        bucket results of multiple anomaly detection jobs. The `overall_score` is calculated
-        by combining the scores of all the buckets within the overall bucket span. First,
-        the maximum `anomaly_score` per anomaly detection job in the overall bucket is
-        calculated. Then the `top_n` of those scores are averaged to result in the `overall_score`.
-        This means that you can fine-tune the `overall_score` so that it is more or less
-        sensitive to the number of jobs that detect an anomaly at the same time. For
-        example, if you set `top_n` to `1`, the `overall_score` is the maximum bucket
-        score in the overall bucket. Alternatively, if you set `top_n` to the number
-        of jobs, the `overall_score` is high only when all jobs detect anomalies in that
-        overall bucket. If you set the `bucket_span` parameter (to a value greater than
-        its default), the `overall_score` is the maximum `overall_score` of the overall
-        buckets that have a span equal to the jobs' largest bucket span.
+        .. raw:: html
+
+          <p>Get overall bucket results.</p>
+          <p>Retrievs overall bucket results that summarize the bucket results of
+          multiple anomaly detection jobs.</p>
+          <p>The <code>overall_score</code> is calculated by combining the scores of all the
+          buckets within the overall bucket span. First, the maximum
+          <code>anomaly_score</code> per anomaly detection job in the overall bucket is
+          calculated. Then the <code>top_n</code> of those scores are averaged to result in
+          the <code>overall_score</code>. This means that you can fine-tune the
+          <code>overall_score</code> so that it is more or less sensitive to the number of
+          jobs that detect an anomaly at the same time. For example, if you set
+          <code>top_n</code> to <code>1</code>, the <code>overall_score</code> is the maximum bucket score in the
+          overall bucket. Alternatively, if you set <code>top_n</code> to the number of jobs,
+          the <code>overall_score</code> is high only when all jobs detect anomalies in that
+          overall bucket. If you set the <code>bucket_span</code> parameter (to a value
+          greater than its default), the <code>overall_score</code> is the maximum
+          <code>overall_score</code> of the overall buckets that have a span equal to the
+          jobs' largest bucket span.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-overall-buckets.html>`_
 
@@ -2390,15 +2508,20 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get anomaly records for an anomaly detection job. Records contain the detailed
-        analytical results. They describe the anomalous activity that has been identified
-        in the input data based on the detector configuration. There can be many anomaly
-        records depending on the characteristics and size of the input data. In practice,
-        there are often too many to be able to manually process them. The machine learning
-        features therefore perform a sophisticated aggregation of the anomaly records
-        into buckets. The number of record results depends on the number of anomalies
-        found in each bucket, which relates to the number of time series being modeled
-        and the number of detectors.
+        .. raw:: html
+
+          <p>Get anomaly records for an anomaly detection job.
+          Records contain the detailed analytical results. They describe the anomalous
+          activity that has been identified in the input data based on the detector
+          configuration.
+          There can be many anomaly records depending on the characteristics and size
+          of the input data. In practice, there are often too many to be able to
+          manually process them. The machine learning features therefore perform a
+          sophisticated aggregation of the anomaly records into buckets.
+          The number of record results depends on the number of anomalies found in each
+          bucket, which relates to the number of time series being modeled and the
+          number of detectors.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-record.html>`_
 
@@ -2494,7 +2617,10 @@ class MlClient(NamespacedClient):
         tags: t.Optional[t.Union[str, t.Sequence[str]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get trained model configuration info.
+        .. raw:: html
+
+          <p>Get trained model configuration info.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-trained-models.html>`_
 
@@ -2580,9 +2706,12 @@ class MlClient(NamespacedClient):
         size: t.Optional[int] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get trained models usage info. You can get usage information for multiple trained
-        models in a single API request by using a comma-separated list of model IDs or
-        a wildcard expression.
+        .. raw:: html
+
+          <p>Get trained models usage info.
+          You can get usage information for multiple trained
+          models in a single API request by using a comma-separated list of model IDs or a wildcard expression.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-trained-models-stats.html>`_
 
@@ -2645,7 +2774,10 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Evaluate a trained model.
+        .. raw:: html
+
+          <p>Evaluate a trained model.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/infer-trained-model.html>`_
 
@@ -2702,12 +2834,17 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Return ML defaults and limits. Returns 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
-        what those defaults are. It also provides information about the maximum size
-        of machine learning jobs that could run in the current cluster configuration.
+        .. raw:: html
+
+          <p>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 what those defaults are. It also provides information about
+          the maximum size of machine learning jobs that could run in the current
+          cluster configuration.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-ml-info.html>`_
         """
@@ -2747,12 +2884,16 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Open anomaly detection jobs. An anomaly detection job must be opened to be ready
-        to receive and analyze data. It can be opened and closed multiple times throughout
-        its lifecycle. When you open a new job, it starts with an empty model. When you
-        open an existing job, the most recent model state is automatically loaded. The
-        job is ready to resume its analysis from where it left off, once new data is
-        received.
+        .. raw:: html
+
+          <p>Open anomaly detection jobs.
+          An anomaly detection job must be opened to be ready to receive and analyze
+          data. It can be opened and closed multiple times throughout its lifecycle.
+          When you open a new job, it starts with an empty model.
+          When you open an existing job, the most recent model state is automatically
+          loaded. The job is ready to resume its analysis from where it left off, once
+          new data is received.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-open-job.html>`_
 
@@ -2806,7 +2947,10 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Add scheduled events to the calendar.
+        .. raw:: html
+
+          <p>Add scheduled events to the calendar.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-post-calendar-event.html>`_
 
@@ -2862,9 +3006,12 @@ class MlClient(NamespacedClient):
         reset_start: t.Optional[t.Union[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Send data to an anomaly detection job for analysis. IMPORTANT: For each job,
-        data can be accepted from only a single connection at a time. It is not currently
-        possible to post data to multiple jobs using wildcards or a comma-separated list.
+        .. raw:: html
+
+          <p>Send data to an anomaly detection job for analysis.</p>
+          <p>IMPORTANT: For each job, data can be accepted from only a single connection at a time.
+          It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-post-data.html>`_
 
@@ -2927,8 +3074,11 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Preview features used by data frame analytics. Previews the extracted features
-        used by a data frame analytics config.
+        .. raw:: html
+
+          <p>Preview features used by data frame analytics.
+          Previews the extracted features used by a data frame analytics config.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/preview-dfanalytics.html>`_
 
@@ -2990,15 +3140,18 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Preview a datafeed. This API returns the first "page" of search results from
-        a datafeed. You can preview an existing datafeed or provide configuration details
-        for a datafeed and anomaly detection job in the API. The preview shows the structure
-        of the data that will be passed to the anomaly detection engine. IMPORTANT: When
-        Elasticsearch security features are enabled, the preview uses the credentials
-        of the user that called the API. However, when the datafeed starts it uses the
-        roles of the last user that created or updated the datafeed. To get a preview
-        that accurately reflects the behavior of the datafeed, use the appropriate credentials.
-        You can also use secondary authorization headers to supply the credentials.
+        .. raw:: html
+
+          <p>Preview a datafeed.
+          This API returns the first &quot;page&quot; of search results from a datafeed.
+          You can preview an existing datafeed or provide configuration details for a datafeed
+          and anomaly detection job in the API. The preview shows the structure of the data
+          that will be passed to the anomaly detection engine.
+          IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that
+          called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the
+          datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials.
+          You can also use secondary authorization headers to supply the credentials.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-preview-datafeed.html>`_
 
@@ -3074,7 +3227,10 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create a calendar.
+        .. raw:: html
+
+          <p>Create a calendar.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-put-calendar.html>`_
 
@@ -3128,7 +3284,10 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Add anomaly detection job to calendar.
+        .. raw:: html
+
+          <p>Add anomaly detection job to calendar.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-put-calendar-job.html>`_
 
@@ -3203,9 +3362,15 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        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.
+        .. raw:: html
+
+          <p>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.
+          By default, the query used in the source configuration is <code>{&quot;match_all&quot;: {}}</code>.</p>
+          <p>If the destination index does not exist, it is created automatically when you start the job.</p>
+          <p>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.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-dfanalytics.html>`_
 
@@ -3378,17 +3543,19 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by
-        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
-        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
-        the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
-        directly to the `.ml-config` index. Do not give users `write` privileges on the
-        `.ml-config` index.
+        .. raw:: html
+
+          <p>Create a datafeed.
+          Datafeeds retrieve data from Elasticsearch for analysis by 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 (<code>frequency</code>).
+          If you are concerned about delayed data, you can add a delay (<code>query_delay') at each interval. By default, the datafeed uses the following query: </code>{&quot;match_all&quot;: {&quot;boost&quot;: 1}}`.</p>
+          <p>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 the create anomaly detection jobs API to create a datafeed. Do not add a datafeed
+          directly to the <code>.ml-config</code> index. Do not give users <code>write</code> privileges on the <code>.ml-config</code> index.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-put-datafeed.html>`_
 
@@ -3545,9 +3712,12 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create a filter. A filter contains a list of strings. It can be used by one or
-        more anomaly detection jobs. Specifically, filters are referenced in the `custom_rules`
-        property of detector configuration objects.
+        .. raw:: html
+
+          <p>Create a filter.
+          A filter contains a list of strings. It can be used by one or more anomaly detection jobs.
+          Specifically, filters are referenced in the <code>custom_rules</code> property of detector configuration objects.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-put-filter.html>`_
 
@@ -3644,8 +3814,12 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create an anomaly detection job. If you include a `datafeed_config`, you must
-        have read index privileges on the source index.
+        .. raw:: html
+
+          <p>Create an anomaly detection job.
+          If you include a <code>datafeed_config</code>, you must have read index privileges on the source index.
+          If you include a <code>datafeed_config</code> but do not provide a query, the datafeed uses <code>{&quot;match_all&quot;: {&quot;boost&quot;: 1}}</code>.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-put-job.html>`_
 
@@ -3849,8 +4023,11 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create a trained model. Enable you to supply a trained model that is not created
-        by data frame analytics.
+        .. raw:: html
+
+          <p>Create a trained model.
+          Enable you to supply a trained model that is not created by data frame analytics.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-trained-models.html>`_
 
@@ -3952,19 +4129,26 @@ class MlClient(NamespacedClient):
         reassign: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update a trained model alias. A trained model alias is a logical name
-        used to reference a single trained model. You can use aliases instead of trained
-        model identifiers to make it easier to reference your models. For example, you
-        can use aliases in inference aggregations and processors. An alias must be unique
-        and refer to only a single trained model. However, you can have multiple aliases
-        for each trained model. If you use this API to update an alias such that it references
-        a different trained model ID and the model uses a different type of data frame
-        analytics, an error occurs. For example, this situation occurs if you have a
-        trained model for regression analysis and a trained model for classification
-        analysis; you cannot reassign an alias from one type of trained model to another.
-        If you use this API to update an alias and there are very few input fields in
-        common between the old and new trained models for the model alias, the API returns
-        a warning.
+        .. raw:: html
+
+          <p>Create or update a trained model alias.
+          A trained model alias is a logical name used to reference a single trained
+          model.
+          You can use aliases instead of trained model identifiers to make it easier to
+          reference your models. For example, you can use aliases in inference
+          aggregations and processors.
+          An alias must be unique and refer to only a single trained model. However,
+          you can have multiple aliases for each trained model.
+          If you use this API to update an alias such that it references a different
+          trained model ID and the model uses a different type of data frame analytics,
+          an error occurs. For example, this situation occurs if you have a trained
+          model for regression analysis and a trained model for classification
+          analysis; you cannot reassign an alias from one type of trained model to
+          another.
+          If you use this API to update an alias and there are very few input fields in
+          common between the old and new trained models for the model alias, the API
+          returns a warning.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-trained-models-aliases.html>`_
 
@@ -4022,7 +4206,10 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create part of a trained model definition.
+        .. raw:: html
+
+          <p>Create part of a trained model definition.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-trained-model-definition-part.html>`_
 
@@ -4099,9 +4286,12 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create a trained model vocabulary. This API is supported only for natural language
-        processing (NLP) models. The vocabulary is stored in the index as described in
-        `inference_config.*.vocabulary` of the trained model definition.
+        .. raw:: html
+
+          <p>Create a trained model vocabulary.
+          This API is supported only for natural language processing (NLP) models.
+          The vocabulary is stored in the index as described in <code>inference_config.*.vocabulary</code> of the trained model definition.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-trained-model-vocabulary.html>`_
 
@@ -4157,9 +4347,14 @@ class MlClient(NamespacedClient):
         wait_for_completion: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Reset an anomaly detection job. All model state and results are deleted. The
-        job is ready to start over as if it had just been created. It is not currently
-        possible to reset multiple jobs using wildcards or a comma separated list.
+        .. raw:: html
+
+          <p>Reset an anomaly detection job.
+          All model state and results are deleted. The job is ready to start over as if
+          it had just been created.
+          It is not currently possible to reset multiple jobs using wildcards or a
+          comma separated list.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-reset-job.html>`_
 
@@ -4213,13 +4408,17 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Revert to a snapshot. The machine learning features react quickly to anomalous
-        input, learning new behaviors in data. Highly anomalous input increases the variance
-        in the models whilst the system learns whether this is a new step-change in behavior
-        or a one-off event. In the case where this anomalous input is known to be a one-off,
-        then it might be appropriate to reset the model state to a time before this event.
-        For example, you might consider reverting to a saved snapshot after Black Friday
-        or a critical system failure.
+        .. raw:: html
+
+          <p>Revert to a snapshot.
+          The machine learning features react quickly to anomalous input, learning new
+          behaviors in data. Highly anomalous input increases the variance in the
+          models whilst the system learns whether this is a new step-change in behavior
+          or a one-off event. In the case where this anomalous input is known to be a
+          one-off, then it might be appropriate to reset the model state to a time
+          before this event. For example, you might consider reverting to a saved
+          snapshot after Black Friday or a critical system failure.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-revert-snapshot.html>`_
 
@@ -4279,17 +4478,22 @@ class MlClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Set upgrade_mode for ML indices. Sets a cluster wide upgrade_mode setting that
-        prepares machine learning indices for an upgrade. When upgrading your cluster,
-        in some circumstances you must restart your nodes and reindex your machine learning
-        indices. In those circumstances, there must be no machine learning jobs running.
-        You can close the machine learning jobs, do the upgrade, then open all the jobs
-        again. Alternatively, you can use this API to temporarily halt tasks associated
-        with the jobs and datafeeds and prevent new jobs from opening. You can also use
-        this API during upgrades that do not require you to reindex your machine learning
-        indices, though stopping jobs is not a requirement in that case. You can see
-        the current value for the upgrade_mode setting by using the get machine learning
-        info API.
+        .. raw:: html
+
+          <p>Set upgrade_mode for ML indices.
+          Sets a cluster wide upgrade_mode setting that prepares machine learning
+          indices for an upgrade.
+          When upgrading your cluster, in some circumstances you must restart your
+          nodes and reindex your machine learning indices. In those circumstances,
+          there must be no machine learning jobs running. You can close the machine
+          learning jobs, do the upgrade, then open all the jobs again. Alternatively,
+          you can use this API to temporarily halt tasks associated with the jobs and
+          datafeeds and prevent new jobs from opening. You can also use this API
+          during upgrades that do not require you to reindex your machine learning
+          indices, though stopping jobs is not a requirement in that case.
+          You can see the current value for the upgrade_mode setting by using the get
+          machine learning info API.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-set-upgrade-mode.html>`_
 
@@ -4335,16 +4539,21 @@ class MlClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Start a data frame analytics job. A data frame analytics job can be started and
-        stopped multiple times throughout its lifecycle. If the destination index does
-        not exist, it is created automatically the first time you start the data frame
-        analytics job. The `index.number_of_shards` and `index.number_of_replicas` settings
-        for the destination index are copied from the source index. If there are multiple
-        source indices, the destination index copies the highest setting values. The
-        mappings for the destination index are also copied from the source indices. If
-        there are any mapping conflicts, the job fails to start. If the destination index
-        exists, it is used as is. You can therefore set up the destination index in advance
-        with custom settings and mappings.
+        .. raw:: html
+
+          <p>Start a data frame analytics job.
+          A data frame analytics job can be started and stopped multiple times
+          throughout its lifecycle.
+          If the destination index does not exist, it is created automatically the
+          first time you start the data frame analytics job. The
+          <code>index.number_of_shards</code> and <code>index.number_of_replicas</code> settings for the
+          destination index are copied from the source index. If there are multiple
+          source indices, the destination index copies the highest setting values. The
+          mappings for the destination index are also copied from the source indices.
+          If there are any mapping conflicts, the job fails to start.
+          If the destination index exists, it is used as is. You can therefore set up
+          the destination index in advance with custom settings and mappings.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-dfanalytics.html>`_
 
@@ -4396,17 +4605,18 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Start datafeeds. A datafeed must be started in order to retrieve data from Elasticsearch.
-        A datafeed can be started and stopped multiple times throughout its lifecycle.
-        Before you can start a datafeed, the anomaly detection job must be open. Otherwise,
-        an error occurs. If you restart a stopped datafeed, it continues processing input
-        data from the next millisecond after it was stopped. If new data was indexed
-        for that exact millisecond between stopping and starting, it will be ignored.
-        When Elasticsearch security features are enabled, your datafeed remembers which
-        roles the last user to create or update it had at the time of creation or update
-        and runs the query using those same roles. If you provided secondary authorization
-        headers when you created or updated the datafeed, those credentials are used
-        instead.
+        .. raw:: html
+
+          <p>Start datafeeds.</p>
+          <p>A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped
+          multiple times throughout its lifecycle.</p>
+          <p>Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.</p>
+          <p>If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped.
+          If new data was indexed for that exact millisecond between stopping and starting, it will be ignored.</p>
+          <p>When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or
+          update it had at the time of creation or update and runs the query using those same roles. If you provided secondary
+          authorization headers when you created or updated the datafeed, those credentials are used instead.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-start-datafeed.html>`_
 
@@ -4475,8 +4685,11 @@ class MlClient(NamespacedClient):
         ] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Start a trained model deployment. It allocates the model to every machine learning
-        node.
+        .. raw:: html
+
+          <p>Start a trained model deployment.
+          It allocates the model to every machine learning node.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-trained-model-deployment.html>`_
 
@@ -4559,8 +4772,12 @@ class MlClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Stop data frame analytics jobs. A data frame analytics job can be started and
-        stopped multiple times throughout its lifecycle.
+        .. raw:: html
+
+          <p>Stop data frame analytics jobs.
+          A data frame analytics job can be started and stopped multiple times
+          throughout its lifecycle.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/stop-dfanalytics.html>`_
 
@@ -4625,8 +4842,12 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Stop datafeeds. A datafeed that is stopped ceases to retrieve data from Elasticsearch.
-        A datafeed can be started and stopped multiple times throughout its lifecycle.
+        .. raw:: html
+
+          <p>Stop datafeeds.
+          A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped
+          multiple times throughout its lifecycle.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-stop-datafeed.html>`_
 
@@ -4688,7 +4909,10 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Stop a trained model deployment.
+        .. raw:: html
+
+          <p>Stop a trained model deployment.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/stop-trained-model-deployment.html>`_
 
@@ -4753,7 +4977,10 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Update a data frame analytics job.
+        .. raw:: html
+
+          <p>Update a data frame analytics job.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-dfanalytics.html>`_
 
@@ -4861,11 +5088,14 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Update a datafeed. You must stop and start the datafeed for the changes to be
-        applied. When Elasticsearch security features are enabled, your datafeed remembers
-        which roles the user who updated it had at the time of the update and runs the
-        query using those same roles. If you provide secondary authorization headers,
-        those credentials are used instead.
+        .. raw:: html
+
+          <p>Update a datafeed.
+          You must stop and start the datafeed for the changes to be applied.
+          When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at
+          the time of the update and runs the query using those same roles. If you provide secondary authorization headers,
+          those credentials are used instead.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-update-datafeed.html>`_
 
@@ -5028,8 +5258,11 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Update a filter. Updates the description of a filter, adds items, or removes
-        items from the list.
+        .. raw:: html
+
+          <p>Update a filter.
+          Updates the description of a filter, adds items, or removes items from the list.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-update-filter.html>`_
 
@@ -5119,8 +5352,11 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Update an anomaly detection job. Updates certain properties of an anomaly detection
-        job.
+        .. raw:: html
+
+          <p>Update an anomaly detection job.
+          Updates certain properties of an anomaly detection job.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-update-job.html>`_
 
@@ -5248,7 +5484,11 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Update a snapshot. Updates certain properties of a snapshot.
+        .. raw:: html
+
+          <p>Update a snapshot.
+          Updates certain properties of a snapshot.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-update-snapshot.html>`_
 
@@ -5309,7 +5549,10 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Update a trained model deployment.
+        .. raw:: html
+
+          <p>Update a trained model deployment.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-trained-model-deployment.html>`_
 
@@ -5368,14 +5611,19 @@ class MlClient(NamespacedClient):
         wait_for_completion: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Upgrade a snapshot. Upgrades an anomaly detection model snapshot to the latest
-        major version. Over time, older snapshot formats are deprecated and removed.
-        Anomaly detection jobs support only snapshots that are from the current or previous
-        major version. This API provides a means to upgrade a snapshot to the current
-        major version. This aids in preparing the cluster for an upgrade to the next
-        major version. Only one snapshot per anomaly detection job can be upgraded at
-        a time and the upgraded snapshot cannot be the current snapshot of the anomaly
-        detection job.
+        .. raw:: html
+
+          <p>Upgrade a snapshot.
+          Upgrades an anomaly detection model snapshot to the latest major version.
+          Over time, older snapshot formats are deprecated and removed. Anomaly
+          detection jobs support only snapshots that are from the current or previous
+          major version.
+          This API provides a means to upgrade a snapshot to the current major version.
+          This aids in preparing the cluster for an upgrade to the next major version.
+          Only one snapshot per anomaly detection job can be upgraded at a time and the
+          upgraded snapshot cannot be the current snapshot of the anomaly detection
+          job.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-upgrade-job-model-snapshot.html>`_
 
@@ -5451,7 +5699,10 @@ class MlClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Validates an anomaly detection job.
+        .. raw:: html
+
+          <p>Validate an anomaly detection job.</p>
+
 
         `<https://www.elastic.co/guide/en/machine-learning/8.17/ml-jobs.html>`_
 
@@ -5521,7 +5772,10 @@ class MlClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Validates an anomaly detection detector.
+        .. raw:: html
+
+          <p>Validate an anomaly detection job.</p>
+
 
         `<https://www.elastic.co/guide/en/machine-learning/8.17/ml-jobs.html>`_