elasticsearch-api 8.18.0 → 9.0.1

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

@@ -15,20 +15,27 @@
 # 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
-        # Instantiates a data frame analytics job.
+        # 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 +{"match_all": {}}+.
+        # If the destination index does not exist, it is created automatically when you start the job.
+        # If you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters.
         #
-        # @option arguments [String] :id The ID of the data frame analytics to create
+        # @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. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The data frame analytics configuration (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-dfanalytics.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-data-frame-analytics
         #
         def put_data_frame_analytics(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.put_data_frame_analytics' }
@@ -49,7 +56,7 @@ module Elasticsearch
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_ml/data_frame/analytics/#{Utils.__listify(_id)}"
+          path   = "_ml/data_frame/analytics/#{Utils.listify(_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(

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

@@ -15,24 +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
-        # Instantiates a datafeed.
+        # 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.
+        # By default, the datafeed uses the following query:+{"match_all": {"boost": 1}}+.
+        # When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had
+        # at the time of creation and runs the query using those same roles. If you provide secondary authorization headers,
+        # those credentials are used instead.
+        # You must use Kibana, this API, or 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.
         #
-        # @option arguments [String] :datafeed_id The ID of the datafeed to create
-        # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false)
-        # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true)
-        # @option arguments [Boolean] :ignore_throttled Ignore indices that are marked as throttled (default: true)
-        # @option arguments [String] :expand_wildcards Whether source index expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all)
+        # @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] :allow_no_indices If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the +_all+
+        #  string or when no indices are specified. Server default: true.
+        # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
+        #  whether wildcard expressions match hidden data streams. Supports comma-separated values. Server default: open.
+        # @option arguments [Boolean] :ignore_throttled If true, concrete, expanded, or aliased indices are ignored when frozen. Server default: true.
+        # @option arguments [Boolean] :ignore_unavailable If true, unavailable indices (missing or closed) are ignored.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The datafeed config (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-put-datafeed.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-datafeed
         #
         def put_datafeed(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.put_datafeed' }
@@ -53,7 +67,7 @@ module Elasticsearch
           _datafeed_id = arguments.delete(:datafeed_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          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/put_filter.rb

@@ -15,20 +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
-        # Instantiates a filter.
+        # 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.
         #
-        # @option arguments [String] :filter_id The ID of the filter to create
+        # @option arguments [String] :filter_id A string that uniquely identifies a filter. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The filter details (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-put-filter.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-filter
         #
         def put_filter(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.put_filter' }
@@ -49,7 +51,7 @@ module Elasticsearch
           _filter_id = arguments.delete(:filter_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          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/put_job.rb

@@ -15,24 +15,33 @@
 # 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
-        # Instantiates an anomaly detection job.
+        # Create an anomaly detection job.
+        # If you include a +datafeed_config+, you must have read index privileges on the source index.
+        # If you include a +datafeed_config+ but do not provide a query, the datafeed uses +{"match_all": {"boost": 1}}+.
         #
-        # @option arguments [String] :job_id The ID of the job to create
-        # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false). Only set if datafeed_config is provided.
-        # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true). Only set if datafeed_config is provided.
-        # @option arguments [Boolean] :ignore_throttled Ignore indices that are marked as throttled (default: true). Only set if datafeed_config is provided.
-        # @option arguments [String] :expand_wildcards Whether source index expressions should get expanded to open or closed indices (default: open). Only set if datafeed_config is provided. (options: open, closed, hidden, none, all)
+        # @option arguments [String] :job_id The identifier for the anomaly detection job. 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] :allow_no_indices If +true+, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the
+        #  +_all+ string or when no indices are specified. Server default: true.
+        # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
+        #  whether wildcard expressions match hidden data streams. Supports comma-separated values. Valid values are:
+        #  - +all+: Match any data stream or index, including hidden ones.
+        #  - +closed+: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
+        #  - +hidden+: Match hidden data streams and hidden indices. Must be combined with +open+, +closed+, or both.
+        #  - +none+: Wildcard patterns are not accepted.
+        #  - +open+: Match open, non-hidden indices. Also matches any non-hidden data stream. Server default: open.
+        # @option arguments [Boolean] :ignore_throttled If +true+, concrete, expanded or aliased indices are ignored when frozen. Server default: true.
+        # @option arguments [Boolean] :ignore_unavailable If +true+, unavailable indices (missing or closed) are ignored.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The job (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-put-job.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-job
         #
         def put_job(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.put_job' }
@@ -53,7 +62,7 @@ module Elasticsearch
           _job_id = arguments.delete(:job_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          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/put_trained_model.rb

@@ -15,22 +15,26 @@
 # 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
-        # Creates an inference trained model.
+        # Create a trained model.
+        # Enable you to supply a trained model that is not created by data frame analytics.
         #
-        # @option arguments [String] :model_id The ID of the trained models to store
-        # @option arguments [Boolean] :defer_definition_decompression If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations.
-        # @option arguments [Boolean] :wait_for_completion Whether to wait for all child operations(e.g. model download) to complete, before returning or not. Default to false
+        # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
+        # @option arguments [Boolean] :defer_definition_decompression If set to +true+ and a +compressed_definition+ is provided,
+        #  the request defers definition decompression and skips relevant
+        #  validations.
+        # @option arguments [Boolean] :wait_for_completion Whether to wait for all child operations (e.g. model download)
+        #  to complete.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The trained model configuration (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-trained-models.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model
         #
         def put_trained_model(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.put_trained_model' }
@@ -51,7 +55,7 @@ module Elasticsearch
           _model_id = arguments.delete(:model_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          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/put_trained_model_alias.rb

@@ -15,26 +15,44 @@
 # 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
-        # Creates a new model alias (or reassigns an existing one) to refer to the trained model
+        # 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.
         #
-        # @option arguments [String] :model_alias The trained model alias to update
-        # @option arguments [String] :model_id The trained model where the model alias should be assigned
-        # @option arguments [Boolean] :reassign If the model_alias already exists and points to a separate model_id, this parameter must be true. Defaults to false.
+        # @option arguments [String] :model_alias The alias to create or update. This value cannot end in numbers. (*Required*)
+        # @option arguments [String] :model_id The identifier for the trained model that the alias refers to. (*Required*)
+        # @option arguments [Boolean] :reassign Specifies whether the alias gets reassigned to the specified trained
+        #  model if it is already assigned to a different model. If the alias is
+        #  already assigned and this parameter is false, the API returns an error.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-trained-models-aliases.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model-alias
         #
         def put_trained_model_alias(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.put_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?
@@ -52,7 +70,7 @@ module Elasticsearch
           _model_id = arguments.delete(:model_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          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 = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,26 +15,27 @@
 # 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
-        # Creates part of a trained model definition
+        # Create part of a trained model definition.
         #
-        # @option arguments [String] :model_id The ID of the trained model for this definition part
-        # @option arguments [Integer] :part The part number
+        # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
+        # @option arguments [Integer] :part The definition part number. When the definition is loaded for inference the definition parts are streamed in the
+        #  order of their part number. The first part must be +0+ and the final part must be +total_parts - 1+. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The trained model definition part (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-trained-model-definition-part.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model-definition-part
         #
         def put_trained_model_definition_part(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.put_trained_model_definition_part' }
 
-          defined_params = %i[model_id part].each_with_object({}) do |variable, set_variables|
+          defined_params = [:model_id, :part].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,7 +54,7 @@ module Elasticsearch
           _part = arguments.delete(:part)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_ml/trained_models/#{Utils.__listify(_model_id)}/definition/#{Utils.__listify(_part)}"
+          path   = "_ml/trained_models/#{Utils.listify(_model_id)}/definition/#{Utils.listify(_part)}"
           params = {}
 
           Elasticsearch::API::Response.new(

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

@@ -15,20 +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
-        # Creates a trained model vocabulary
+        # 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.
         #
-        # @option arguments [String] :model_id The ID of the trained model for this vocabulary
+        # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The trained model vocabulary (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-trained-model-vocabulary.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model-vocabulary
         #
         def put_trained_model_vocabulary(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.put_trained_model_vocabulary' }
@@ -49,7 +51,7 @@ module Elasticsearch
           _model_id = arguments.delete(:model_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_ml/trained_models/#{Utils.__listify(_model_id)}/vocabulary"
+          path   = "_ml/trained_models/#{Utils.listify(_model_id)}/vocabulary"
           params = {}
 
           Elasticsearch::API::Response.new(

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

@@ -15,21 +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
-        # Resets an existing anomaly detection job.
+        # 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.
         #
-        # @option arguments [String] :job_id The ID of the job to reset
-        # @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 The ID of the job to reset. (*Required*)
+        # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before
+        #  returning. Server default: true.
+        # @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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-reset-job.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-reset-job
         #
         def reset_job(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.reset_job' }
@@ -49,7 +56,7 @@ module Elasticsearch
           _job_id = arguments.delete(:job_id)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_reset"
+          path   = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_reset"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,27 +15,41 @@
 # 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
-        # Reverts to a specific snapshot.
+        # 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.
         #
-        # @option arguments [String] :job_id The ID of the job to fetch
-        # @option arguments [String] :snapshot_id The ID of the snapshot to revert to
-        # @option arguments [Boolean] :delete_intervening_results Should we reset the results back to the time of the snapshot?
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [String] :snapshot_id You can specify +empty+ as the <snapshot_id>. Reverting to the empty
+        #  snapshot means the anomaly detection job starts learning a new model from
+        #  scratch when it is started. (*Required*)
+        # @option arguments [Boolean] :delete_intervening_results If true, deletes the results in the time period between the latest
+        #  results and the time of the reverted snapshot. It also resets the model
+        #  to accept records for this time period. If you choose not to delete
+        #  intervening results when reverting a snapshot, the job will not accept
+        #  input data that is older than the current time. If you want to resend
+        #  data, then delete the intervening results.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Reversion options
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-revert-snapshot.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-revert-model-snapshot
         #
         def revert_model_snapshot(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.revert_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?
@@ -53,7 +67,7 @@ module Elasticsearch
           _snapshot_id = arguments.delete(:snapshot_id)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots/#{Utils.__listify(_snapshot_id)}/_revert"
+          path   = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/model_snapshots/#{Utils.listify(_snapshot_id)}/_revert"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,20 +15,34 @@
 # 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
-        # Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade.
+        # 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.
         #
-        # @option arguments [Boolean] :enabled Whether to enable upgrade_mode ML setting or not. Defaults to false.
-        # @option arguments [Time] :timeout Controls the time to wait before action times out. Defaults to 30 seconds
+        # @option arguments [Boolean] :enabled When +true+, it enables +upgrade_mode+ which temporarily halts all job
+        #  and datafeed tasks and prohibits new job and datafeed tasks from
+        #  starting.
+        # @option arguments [Time] :timeout The time to wait for the request to be completed. Server default: 30s.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-set-upgrade-mode.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-set-upgrade-mode
         #
         def set_upgrade_mode(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.set_upgrade_mode' }
@@ -36,7 +50,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_ml/set_upgrade_mode'

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

@@ -15,21 +15,34 @@
 # 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
-        # Starts a data frame analytics job.
+        # 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.
         #
-        # @option arguments [String] :id The ID of the data frame analytics to start
-        # @option arguments [Time] :timeout Controls the time to wait until the task has started. Defaults to 20 seconds
+        # @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. (*Required*)
+        # @option arguments [Time] :timeout Controls the amount of time to wait until the data frame analytics job
+        #  starts. Server default: 20s.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The start data frame analytics parameters
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-dfanalytics.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-start-data-frame-analytics
         #
         def start_data_frame_analytics(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.start_data_frame_analytics' }
@@ -44,12 +57,12 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body = arguments.delete(:body)
+          body = nil
 
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_ml/data_frame/analytics/#{Utils.__listify(_id)}/_start"
+          path   = "_ml/data_frame/analytics/#{Utils.listify(_id)}/_start"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(