elasticsearch-api 8.18.0 → 9.0.1

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

@@ -15,20 +15,35 @@
 # 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
-        # Retrieves usage information for datafeeds.
+        # 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.
         #
-        # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch
-        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
+        # @option arguments [String, Array] :datafeed_id Identifier for the datafeed. It can be a datafeed identifier or a
+        #  wildcard expression. If you do not specify one of these options, the API
+        #  returns information about all datafeeds.
+        # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
+        #  - Contains wildcard expressions and there are no datafeeds that match.
+        #  - Contains the +_all+ string or no identifiers and there are no matches.
+        #  - Contains wildcard expressions and there are only partial matches.
+        #  The default value is +true+, which returns an empty +datafeeds+ array
+        #  when there are no matches and the subset of results when there are
+        #  partial matches. If this parameter is +false+, the request returns a
+        #  +404+ status code when there are no matches or only partial matches.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-datafeed-stats.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-datafeed-stats
         #
         def get_datafeed_stats(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_datafeed_stats' }
@@ -47,7 +62,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _datafeed_id
-                     "_ml/datafeeds/#{Utils.__listify(_datafeed_id)}/_stats"
+                     "_ml/datafeeds/#{Utils.listify(_datafeed_id)}/_stats"
                    else
                      '_ml/datafeeds/_stats'
                    end

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

@@ -15,21 +15,37 @@
 # 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
-        # Retrieves configuration information for datafeeds.
+        # 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.
         #
-        # @option arguments [String] :datafeed_id The ID of the datafeeds to fetch
-        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
-        # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on datafeed PUT
+        # @option arguments [String, Array] :datafeed_id Identifier for the datafeed. It can be a datafeed identifier or a
+        #  wildcard expression. If you do not specify one of these options, the API
+        #  returns information about all datafeeds.
+        # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
+        #  - Contains wildcard expressions and there are no datafeeds that match.
+        #  - Contains the +_all+ string or no identifiers and there are no matches.
+        #  - Contains wildcard expressions and there are only partial matches.
+        #  The default value is +true+, which returns an empty +datafeeds+ array
+        #  when there are no matches and the subset of results when there are
+        #  partial matches. If this parameter is +false+, the request returns a
+        #  +404+ status code when there are no matches or only partial matches.
+        # @option arguments [Boolean] :exclude_generated Indicates if certain fields should be removed from the configuration on
+        #  retrieval. This allows the configuration to be in an acceptable format to
+        #  be retrieved and then added to another cluster.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-datafeed.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-datafeeds
         #
         def get_datafeeds(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_datafeeds' }
@@ -48,7 +64,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _datafeed_id
-                     "_ml/datafeeds/#{Utils.__listify(_datafeed_id)}"
+                     "_ml/datafeeds/#{Utils.listify(_datafeed_id)}"
                    else
                      '_ml/datafeeds'
                    end

data/lib/elasticsearch/api/actions/machine_learning/get_filters.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
-        # Retrieves filters.
+        # Get filters.
+        # You can get a single filter or all filters.
         #
-        # @option arguments [String] :filter_id The ID of the filter to fetch
-        # @option arguments [Integer] :from skips a number of filters
-        # @option arguments [Integer] :size specifies a max number of filters to get
+        # @option arguments [String, Array] :filter_id A string that uniquely identifies a filter.
+        # @option arguments [Integer] :from Skips the specified number of filters. Server default: 0.
+        # @option arguments [Integer] :size Specifies the maximum number of filters to obtain. Server default: 100.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-filter.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-filters
         #
         def get_filters(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_filters' }
@@ -48,7 +49,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _filter_id
-                     "_ml/filters/#{Utils.__listify(_filter_id)}"
+                     "_ml/filters/#{Utils.listify(_filter_id)}"
                    else
                      '_ml/filters'
                    end

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

@@ -15,28 +15,37 @@
 # 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
-        # Retrieves anomaly detection job results for one or more influencers.
+        # 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.
         #
-        # @option arguments [String] :job_id Identifier for the anomaly detection job
-        # @option arguments [Boolean] :exclude_interim Exclude interim results
-        # @option arguments [Integer] :from skips a number of influencers
-        # @option arguments [Integer] :size specifies a max number of influencers to get
-        # @option arguments [String] :start start timestamp for the requested influencers
-        # @option arguments [String] :end end timestamp for the requested influencers
-        # @option arguments [Double] :influencer_score influencer score threshold for the requested influencers
-        # @option arguments [String] :sort sort field for the requested influencers
-        # @option arguments [Boolean] :desc whether the results should be sorted in decending order
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [Boolean] :desc If true, the results are sorted in descending order.
+        # @option arguments [String, Time] :end Returns influencers with timestamps earlier than this time.
+        #  The default value means it is unset and results are not limited to
+        #  specific timestamps. Server default: -1.
+        # @option arguments [Boolean] :exclude_interim If true, the output excludes interim results. By default, interim results
+        #  are included.
+        # @option arguments [Float] :influencer_score Returns influencers with anomaly scores greater than or equal to this
+        #  value. Server default: 0.
+        # @option arguments [Integer] :from Skips the specified number of influencers. Server default: 0.
+        # @option arguments [Integer] :size Specifies the maximum number of influencers to obtain. Server default: 100.
+        # @option arguments [String] :sort Specifies the sort field for the requested influencers. By default, the
+        #  influencers are sorted by the +influencer_score+ value.
+        # @option arguments [String, Time] :start Returns influencers with timestamps after this time. The default value
+        #  means it is unset and results are not limited to specific timestamps. Server default: -1.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Influencer selection criteria
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-influencer.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-influencers
         #
         def get_influencers(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_influencers' }
@@ -61,7 +70,7 @@ module Elasticsearch
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/influencers"
+          path   = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/influencers"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,20 +15,30 @@
 # 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
-        # Retrieves usage information for anomaly detection jobs.
+        # Get anomaly detection jobs usage info.
         #
-        # @option arguments [String] :job_id The ID of the jobs stats to fetch
-        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. It can be a job identifier, a
+        #  group name, a comma-separated list of jobs, or a wildcard expression. If
+        #  you do not specify one of these options, the API returns information for
+        #  all anomaly detection jobs.
+        # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
+        #  - Contains wildcard expressions and there are no jobs that match.
+        #  - Contains the _all string or no identifiers and there are no matches.
+        #  - Contains wildcard expressions and there are only partial matches.
+        #  If +true+, the API returns an empty +jobs+ array when
+        #  there are no matches and the subset of results when there are partial
+        #  matches. If +false+, the API returns a +404+ status
+        #  code when there are no matches or only partial matches. Server default: true.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-job-stats.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-job-stats
         #
         def get_job_stats(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_job_stats' }
@@ -47,7 +57,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _job_id
-                     "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_stats"
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_stats"
                    else
                      '_ml/anomaly_detectors/_stats'
                    end

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

@@ -15,21 +15,36 @@
 # 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
-        # Retrieves configuration information for anomaly detection jobs.
+        # 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>+.
         #
-        # @option arguments [String] :job_id The ID of the jobs to fetch
-        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
-        # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on job PUT
+        # @option arguments [String, Array] :job_id Identifier for the anomaly detection job. It can be a job identifier, a
+        #  group name, or a wildcard expression. If you do not specify one of these
+        #  options, the API returns information for all anomaly detection jobs.
+        # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
+        #  - Contains wildcard expressions and there are no jobs that match.
+        #  - Contains the _all string or no identifiers and there are no matches.
+        #  - Contains wildcard expressions and there are only partial matches.
+        #  The default value is +true+, which returns an empty +jobs+ array when
+        #  there are no matches and the subset of results when there are partial
+        #  matches. If this parameter is +false+, the request returns a +404+ status
+        #  code when there are no matches or only partial matches. Server default: true.
+        # @option arguments [Boolean] :exclude_generated Indicates if certain fields should be removed from the configuration on
+        #  retrieval. This allows the configuration to be in an acceptable format to
+        #  be retrieved and then added to another cluster.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-job.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-jobs
         #
         def get_jobs(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_jobs' }
@@ -48,7 +63,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _job_id
-                     "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}"
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}"
                    else
                      '_ml/anomaly_detectors'
                    end

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

@@ -15,21 +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
-        # Returns information on how ML is using memory.
+        # 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.
         #
-        # @option arguments [String] :node_id Specifies the node or nodes to retrieve stats for.
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
-        # @option arguments [Time] :timeout Explicit operation timeout
+        # @option arguments [String] :node_id The names of particular nodes in the cluster to target. For example, +nodeId1,nodeId2+ or
+        #  +ml:true+
+        # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout
+        #  expires, the request fails and returns an error. Server default: 30s.
+        # @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/get-ml-memory.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-memory-stats
         #
         def get_memory_stats(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_memory_stats' }
@@ -48,7 +53,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _node_id
-                     "_ml/memory/#{Utils.__listify(_node_id)}/_stats"
+                     "_ml/memory/#{Utils.listify(_node_id)}/_stats"
                    else
                      '_ml/memory/_stats'
                    end

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

@@ -15,26 +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
-        # Gets stats for anomaly detection job model snapshot upgrades that are in progress.
+        # Get anomaly detection job model snapshot upgrade usage info.
         #
-        # @option arguments [String] :job_id The ID of the job. May be a wildcard, comma separated list or `_all`.
-        # @option arguments [String] :snapshot_id The ID of the snapshot. May be a wildcard, comma separated list or `_all`.
-        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs or no snapshots. (This includes the `_all` string.)
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [String] :snapshot_id A numerical character string that uniquely identifies the model snapshot. You can get information for multiple
+        #  snapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using +_all+,
+        #  by specifying +*+ as the snapshot ID, or by omitting the snapshot ID. (*Required*)
+        # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
+        #  -  Contains wildcard expressions and there are no jobs that match.
+        #  -  Contains the _all string or no identifiers and there are no matches.
+        #  -  Contains wildcard expressions and there are only partial matches.
+        #  The default value is true, which returns an empty jobs array when there are no matches and the subset of results
+        #  when there are partial matches. If this parameter is false, the request returns a 404 status code when there are
+        #  no matches or only partial matches.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-job-model-snapshot-upgrade-stats.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-model-snapshot-upgrade-stats
         #
         def get_model_snapshot_upgrade_stats(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_model_snapshot_upgrade_stats' }
 
-          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?
@@ -52,7 +60,7 @@ module Elasticsearch
           _snapshot_id = arguments.delete(:snapshot_id)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots/#{Utils.__listify(_snapshot_id)}/_upgrade/_stats"
+          path   = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/model_snapshots/#{Utils.listify(_snapshot_id)}/_upgrade/_stats"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,32 +15,35 @@
 # 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
-        # Retrieves information about model snapshots.
+        # Get model snapshots info.
         #
-        # @option arguments [String] :job_id The ID of the job to fetch
-        # @option arguments [String] :snapshot_id The ID of the snapshot to fetch
-        # @option arguments [Integer] :from Skips a number of documents
-        # @option arguments [Integer] :size The default number of documents returned in queries as a string.
-        # @option arguments [Date] :start The filter 'start' query parameter
-        # @option arguments [Date] :end The filter 'end' query parameter
-        # @option arguments [String] :sort Name of the field to sort on
-        # @option arguments [Boolean] :desc True if the results should be sorted in descending order
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [String] :snapshot_id A numerical character string that uniquely identifies the model snapshot. You can get information for multiple
+        #  snapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using +_all+,
+        #  by specifying +*+ as the snapshot ID, or by omitting the snapshot ID.
+        # @option arguments [Boolean] :desc If true, the results are sorted in descending order.
+        # @option arguments [String, Time] :end Returns snapshots with timestamps earlier than this time.
+        # @option arguments [Integer] :from Skips the specified number of snapshots. Server default: 0.
+        # @option arguments [Integer] :size Specifies the maximum number of snapshots to obtain. Server default: 100.
+        # @option arguments [String] :sort Specifies the sort field for the requested snapshots. By default, the
+        #  snapshots are sorted by their timestamp.
+        # @option arguments [String, Time] :start Returns snapshots with timestamps after this time.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Model snapshot selection criteria
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-snapshot.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-model-snapshots
         #
         def get_model_snapshots(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_model_snapshots' }
 
-          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?
@@ -62,11 +65,11 @@ module Elasticsearch
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = if _job_id && _snapshot_id
-                   "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots/#{Utils.__listify(_snapshot_id)}"
-                 else
-                   "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots"
-                 end
+          path   = if _job_id && _snapshot_id
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/model_snapshots/#{Utils.listify(_snapshot_id)}"
+                   else
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/model_snapshots"
+                   end
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,27 +15,59 @@
 # 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
-        # Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.
+        # 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.
         #
-        # @option arguments [String] :job_id The job IDs for which to calculate overall bucket results
-        # @option arguments [Integer] :top_n The number of top job bucket scores to be used in the overall_score calculation
-        # @option arguments [String] :bucket_span The span of the overall buckets. Defaults to the longest job bucket_span
-        # @option arguments [Double] :overall_score Returns overall buckets with overall scores higher than this value
-        # @option arguments [Boolean] :exclude_interim If true overall buckets that include interim buckets will be excluded
-        # @option arguments [String] :start Returns overall buckets with timestamps after this time
-        # @option arguments [String] :end Returns overall buckets with timestamps earlier than this time
-        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. It can be a job identifier, a
+        #  group name, a comma-separated list of jobs or groups, or a wildcard
+        #  expression.You can summarize the bucket results for all anomaly detection jobs by
+        #  using +_all+ or by specifying +*+ as the +<job_id>+. (*Required*)
+        # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
+        #  - Contains wildcard expressions and there are no jobs that match.
+        #  - Contains the +_all+ string or no identifiers and there are no matches.
+        #  - Contains wildcard expressions and there are only partial matches.
+        #  If +true+, the request returns an empty +jobs+ array when there are no
+        #  matches and the subset of results when there are partial matches. If this
+        #  parameter is +false+, the request returns a +404+ status code when there
+        #  are no matches or only partial matches. Server default: true.
+        # @option arguments [Time] :bucket_span The span of the overall buckets. Must be greater or equal to the largest
+        #  bucket span of the specified anomaly detection jobs, which is the default
+        #  value.By default, an overall bucket has a span equal to the largest bucket span
+        #  of the specified anomaly detection jobs. To override that behavior, use
+        #  the optional +bucket_span+ parameter.
+        # @option arguments [String, Time] :end Returns overall buckets with timestamps earlier than this time.
+        # @option arguments [Boolean] :exclude_interim If +true+, the output excludes interim results.
+        # @option arguments [Double, String] :overall_score Returns overall buckets with overall scores greater than or equal to this
+        #  value.
+        # @option arguments [String, Time] :start Returns overall buckets with timestamps after this time.
+        # @option arguments [Integer] :top_n The number of top anomaly detection job bucket scores to be used in the
+        #  +overall_score+ calculation. Server default: 1.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Overall bucket selection details if not provided in URI
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-overall-buckets.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-overall-buckets
         #
         def get_overall_buckets(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_overall_buckets' }
@@ -60,7 +92,7 @@ module Elasticsearch
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/overall_buckets"
+          path   = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/overall_buckets"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(