elasticsearch-api 8.17.2 → 9.0.0

data/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb

@@ -15,21 +15,21 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module MachineLearning
       module Actions
-        # Deletes an existing data frame analytics job.
+        # Delete a data frame analytics job.
         #
-        # @option arguments [String] :id The ID of the data frame analytics to delete
-        # @option arguments [Boolean] :force True if the job should be forcefully deleted
-        # @option arguments [Time] :timeout Controls the time to wait until a job is deleted. Defaults to 1 minute
+        # @option arguments [String] :id Identifier for the data frame analytics job. (*Required*)
+        # @option arguments [Boolean] :force If +true+, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.
+        # @option arguments [Time] :timeout The time to wait for the job to be deleted. Server default: 1m.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-dfanalytics.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-data-frame-analytics
         #
         def delete_data_frame_analytics(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_data_frame_analytics' }
@@ -49,7 +49,7 @@ module Elasticsearch
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_ml/data_frame/analytics/#{Utils.__listify(_id)}"
+          path   = "_ml/data_frame/analytics/#{Utils.listify(_id)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb

@@ -15,20 +15,24 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module MachineLearning
       module Actions
-        # Deletes an existing datafeed.
+        # Delete a datafeed.
         #
-        # @option arguments [String] :datafeed_id The ID of the datafeed to delete
-        # @option arguments [Boolean] :force True if the datafeed should be forcefully deleted
+        # @option arguments [String] :datafeed_id A numerical character string that uniquely identifies the datafeed. This
+        #  identifier can contain lowercase alphanumeric characters (a-z and 0-9),
+        #  hyphens, and underscores. It must start and end with alphanumeric
+        #  characters. (*Required*)
+        # @option arguments [Boolean] :force Use to forcefully delete a started datafeed; this method is quicker than
+        #  stopping and deleting the datafeed.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-datafeed.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-datafeed
         #
         def delete_datafeed(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_datafeed' }
@@ -48,7 +52,7 @@ module Elasticsearch
           _datafeed_id = arguments.delete(:datafeed_id)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_ml/datafeeds/#{Utils.__listify(_datafeed_id)}"
+          path   = "_ml/datafeeds/#{Utils.listify(_datafeed_id)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb

@@ -15,22 +15,32 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module MachineLearning
       module Actions
-        # Deletes expired and unused machine learning data.
+        # Delete expired ML data.
+        # Delete 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>+.
         #
-        # @option arguments [String] :job_id The ID of the job(s) to perform expired data hygiene for
-        # @option arguments [Number] :requests_per_second The desired requests per second for the deletion processes.
-        # @option arguments [Time] :timeout How long can the underlying delete processes run until they are canceled
+        # @option arguments [String] :job_id Identifier for an anomaly detection job. It can be a job identifier, a
+        #  group name, or a wildcard expression.
+        # @option arguments [Float] :requests_per_second The desired requests per second for the deletion processes. The default
+        #  behavior is no throttling.
+        # @option arguments [Time] :timeout How long can the underlying delete processes run until they are canceled. Server default: 8h.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body deleting expired data parameters
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-expired-data.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-expired-data
         #
         def delete_expired_data(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_expired_data' }
@@ -49,7 +59,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_DELETE
           path   = if _job_id
-                     "_ml/_delete_expired_data/#{Utils.__listify(_job_id)}"
+                     "_ml/_delete_expired_data/#{Utils.listify(_job_id)}"
                    else
                      '_ml/_delete_expired_data'
                    end

data/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb

@@ -15,19 +15,21 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module MachineLearning
       module Actions
-        # Deletes a filter.
+        # 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.
         #
-        # @option arguments [String] :filter_id The ID of the filter to delete
+        # @option arguments [String] :filter_id A string that uniquely identifies a filter. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-filter.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-filter
         #
         def delete_filter(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_filter' }
@@ -47,7 +49,7 @@ module Elasticsearch
           _filter_id = arguments.delete(:filter_id)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_ml/filters/#{Utils.__listify(_filter_id)}"
+          path   = "_ml/filters/#{Utils.listify(_filter_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb

@@ -15,27 +15,38 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module MachineLearning
       module Actions
-        # Deletes forecasts from a machine learning job.
+        # 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.
         #
-        # @option arguments [String] :job_id The ID of the job from which to delete forecasts
-        # @option arguments [String] :forecast_id The ID of the forecast to delete, can be comma delimited list. Leaving blank implies `_all`
-        # @option arguments [Boolean] :allow_no_forecasts Whether to ignore if `_all` matches no forecasts
-        # @option arguments [Time] :timeout Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [String] :forecast_id A comma-separated list of forecast identifiers. If you do not specify
+        #  this optional parameter or if you specify +_all+ or +*+ the API deletes
+        #  all forecasts from the job.
+        # @option arguments [Boolean] :allow_no_forecasts Specifies whether an error occurs when there are no forecasts. In
+        #  particular, if this parameter is set to +false+ and there are no
+        #  forecasts associated with the job, attempts to delete all forecasts
+        #  return an error. Server default: true.
+        # @option arguments [Time] :timeout Specifies the period of time to wait for the completion of the delete
+        #  operation. When this period of time elapses, the API fails and returns an
+        #  error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-forecast.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-forecast
         #
         def delete_forecast(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_forecast' }
 
-          defined_params = %i[job_id forecast_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:job_id, :forecast_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -53,9 +64,9 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_DELETE
           path   = if _job_id && _forecast_id
-                     "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_forecast/#{Utils.__listify(_forecast_id)}"
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_forecast/#{Utils.listify(_forecast_id)}"
                    else
-                     "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_forecast"
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_forecast"
                    end
           params = Utils.process_params(arguments)
 

data/lib/elasticsearch/api/actions/machine_learning/delete_job.rb

@@ -15,22 +15,32 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module MachineLearning
       module Actions
-        # Deletes an existing anomaly detection job.
+        # 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.
         #
-        # @option arguments [String] :job_id The ID of the job to delete
-        # @option arguments [Boolean] :force True if the job should be forcefully deleted
-        # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning
-        # @option arguments [Boolean] :delete_user_annotations Should annotations added by the user be deleted
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [Boolean] :force Use to forcefully delete an opened job; this method is quicker than
+        #  closing and deleting the job.
+        # @option arguments [Boolean] :delete_user_annotations Specifies whether annotations that have been added by the
+        #  user should be deleted along with any auto-generated annotations when the job is
+        #  reset.
+        # @option arguments [Boolean] :wait_for_completion Specifies whether the request should return immediately or wait until the
+        #  job deletion completes. Server default: true.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-job.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-job
         #
         def delete_job(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_job' }
@@ -50,7 +60,7 @@ module Elasticsearch
           _job_id = arguments.delete(:job_id)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}"
+          path   = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb

@@ -15,25 +15,28 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module MachineLearning
       module Actions
-        # Deletes an existing model snapshot.
+        # 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.
         #
-        # @option arguments [String] :job_id The ID of the job to fetch
-        # @option arguments [String] :snapshot_id The ID of the snapshot to delete
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [String] :snapshot_id Identifier for the model snapshot. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-delete-snapshot.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-model-snapshot
         #
         def delete_model_snapshot(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_model_snapshot' }
 
-          defined_params = %i[job_id snapshot_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:job_id, :snapshot_id].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -51,7 +54,7 @@ module Elasticsearch
           _snapshot_id = arguments.delete(:snapshot_id)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots/#{Utils.__listify(_snapshot_id)}"
+          path   = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/model_snapshots/#{Utils.listify(_snapshot_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb

@@ -15,21 +15,22 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module MachineLearning
       module Actions
-        # Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.
+        # Delete an unreferenced trained model.
+        # The request deletes a trained inference model that is not referenced by an ingest pipeline.
         #
-        # @option arguments [String] :model_id The ID of the trained model to delete
-        # @option arguments [Time] :timeout Controls the amount of time to wait for the model to be deleted.
-        # @option arguments [Boolean] :force True if the model should be forcefully deleted
+        # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
+        # @option arguments [Boolean] :force Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.
+        # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-trained-models.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-trained-model
         #
         def delete_trained_model(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_trained_model' }
@@ -49,7 +50,7 @@ module Elasticsearch
           _model_id = arguments.delete(:model_id)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_ml/trained_models/#{Utils.__listify(_model_id)}"
+          path   = "_ml/trained_models/#{Utils.listify(_model_id)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb

@@ -15,25 +15,28 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module MachineLearning
       module Actions
-        # Deletes a model alias that refers to the trained model
+        # 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.
         #
-        # @option arguments [String] :model_alias The trained model alias to delete
-        # @option arguments [String] :model_id The trained model where the model alias is assigned
+        # @option arguments [String] :model_alias The model alias to delete. (*Required*)
+        # @option arguments [String] :model_id The trained model ID to which the model alias refers. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-trained-models-aliases.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-trained-model-alias
         #
         def delete_trained_model_alias(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_trained_model_alias' }
 
-          defined_params = %i[model_id model_alias].each_with_object({}) do |variable, set_variables|
+          defined_params = [:model_id, :model_alias].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -51,7 +54,7 @@ module Elasticsearch
           _model_id = arguments.delete(:model_id)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_ml/trained_models/#{Utils.__listify(_model_id)}/model_aliases/#{Utils.__listify(_model_alias)}"
+          path   = "_ml/trained_models/#{Utils.listify(_model_id)}/model_aliases/#{Utils.listify(_model_alias)}"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb

@@ -15,19 +15,22 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module MachineLearning
       module Actions
-        # Estimates the model memory
+        # Estimate job model memory usage.
+        # Make an estimation of the memory usage for an anomaly detection job model.
+        # The estimate is based on analysis configuration details for the job and cardinality
+        # estimates for the fields it references.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The analysis config, plus cardinality estimates for fields it references (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-apis.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-estimate-model-memory
         #
         def estimate_model_memory(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.estimate_model_memory' }
@@ -37,7 +40,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_ml/anomaly_detectors/_estimate_model_memory'

data/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb

@@ -15,19 +15,23 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module MachineLearning
       module Actions
-        # Evaluates the data frame analytics for an annotated index.
+        # 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.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The evaluation definition (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/evaluate-dfanalytics.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-evaluate-data-frame
         #
         def evaluate_data_frame(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.evaluate_data_frame' }
@@ -37,7 +41,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_ml/data_frame/_evaluate'

data/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb

@@ -15,20 +15,28 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module MachineLearning
       module Actions
-        # Explains a data frame analytics config.
+        # 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.
         #
-        # @option arguments [String] :id The ID of the data frame analytics to explain
+        # @option arguments [String] :id Identifier for the data frame analytics job. This identifier can contain
+        #  lowercase alphanumeric characters (a-z and 0-9), hyphens, and
+        #  underscores. It must start and end with alphanumeric characters.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The data frame analytics config to explain
+        # @option arguments [Hash] :body request body
         #
-        # @see http://www.elastic.co/guide/en/elasticsearch/reference/8.17/explain-dfanalytics.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-explain-data-frame-analytics
         #
         def explain_data_frame_analytics(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.explain_data_frame_analytics' }
@@ -51,11 +59,11 @@ module Elasticsearch
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = if _id
-                   "_ml/data_frame/analytics/#{Utils.__listify(_id)}/_explain"
-                 else
-                   '_ml/data_frame/analytics/_explain'
-                 end
+          path   = if _id
+                     "_ml/data_frame/analytics/#{Utils.listify(_id)}/_explain"
+                   else
+                     '_ml/data_frame/analytics/_explain'
+                   end
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/machine_learning/flush_job.rb

@@ -15,25 +15,38 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module MachineLearning
       module Actions
-        # Forces any buffered data to be processed by the job.
+        # 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.
         #
-        # @option arguments [String] :job_id The name of the job to flush
-        # @option arguments [Boolean] :calc_interim Calculates interim results for the most recent bucket or all buckets within the latency period
-        # @option arguments [String] :start When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
-        # @option arguments [String] :end When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
-        # @option arguments [String] :advance_time Advances time to the given value generating results and updating the model for the advanced interval
-        # @option arguments [String] :skip_time Skips time to the given value without generating results or updating the model for the skipped interval
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [String, Time] :advance_time Specifies to advance to a particular time value. Results are generated
+        #  and the model is updated for data from the specified time interval.
+        # @option arguments [Boolean] :calc_interim If true, calculates the interim results for the most recent bucket or all
+        #  buckets within the latency period.
+        # @option arguments [String, Time] :end When used in conjunction with +calc_interim+ and +start+, specifies the
+        #  range of buckets on which to calculate interim results.
+        # @option arguments [String, Time] :skip_time Specifies to skip to a particular time value. Results are not generated
+        #  and the model is not updated for data from the specified time interval.
+        # @option arguments [String, Time] :start When used in conjunction with +calc_interim+, specifies the range of
+        #  buckets on which to calculate interim results.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Flush parameters
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-flush-job.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-flush-job
         #
         def flush_job(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.flush_job' }
@@ -53,7 +66,7 @@ module Elasticsearch
           _job_id = arguments.delete(:job_id)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_flush"
+          path   = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_flush"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(