elasticsearch-api 8.18.0 → 9.0.1

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(

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

@@ -15,23 +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
-        # Predicts the future behavior of a time series by using its historical behavior.
+        # Predict future behavior of a time series.
+        # Forecasts are not supported for jobs that perform population analysis; an
+        # error occurs if you try to create a forecast for a job that has an
+        # +over_field_name+ in its configuration. Forcasts predict future behavior
+        # based on historical data.
         #
-        # @option arguments [String] :job_id The ID of the job to forecast for
-        # @option arguments [Time] :duration The duration of the forecast
-        # @option arguments [Time] :expires_in The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity.
-        # @option arguments [String] :max_model_memory The max memory able to be used by the forecast. Default is 20mb.
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. The job must be open when you
+        #  create a forecast; otherwise, an error occurs. (*Required*)
+        # @option arguments [Time] :duration A period of time that indicates how far into the future to forecast. For
+        #  example, +30d+ corresponds to 30 days. The forecast starts at the last
+        #  record that was processed. Server default: 1d.
+        # @option arguments [Time] :expires_in The period of time that forecast results are retained. After a forecast
+        #  expires, the results are deleted. If set to a value of 0, the forecast is
+        #  never automatically deleted. Server default: 14d.
+        # @option arguments [String] :max_model_memory The maximum memory the forecast can use. If the forecast needs to use
+        #  more than the provided amount, it will spool to disk. Default is 20mb,
+        #  maximum is 500mb and minimum is 1mb. If set to 40% or more of the job’s
+        #  configured memory limit, it is automatically reduced to below that
+        #  amount. Server default: 20mb.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Query parameters can be specified in the body
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-forecast.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-forecast
         #
         def forecast(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.forecast' }
@@ -51,7 +64,7 @@ module Elasticsearch
           _job_id = arguments.delete(:job_id)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_forecast"
+          path   = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_forecast"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,35 +15,39 @@
 # 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 buckets.
+        # Get anomaly detection job results for buckets.
+        # The API presents a chronological view of the records, grouped by bucket.
         #
-        # @option arguments [String] :job_id ID of the job to get bucket results from
-        # @option arguments [String] :timestamp The timestamp of the desired single bucket result
-        # @option arguments [Boolean] :expand Include anomaly records
-        # @option arguments [Boolean] :exclude_interim Exclude interim results
-        # @option arguments [Integer] :from skips a number of buckets
-        # @option arguments [Integer] :size specifies a max number of buckets to get
-        # @option arguments [String] :start Start time filter for buckets
-        # @option arguments [String] :end End time filter for buckets
-        # @option arguments [Double] :anomaly_score Filter for the most anomalous buckets
-        # @option arguments [String] :sort Sort buckets by a particular field
-        # @option arguments [Boolean] :desc Set the sort direction
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [String, Time] :timestamp The timestamp of a single bucket result. If you do not specify this
+        #  parameter, the API returns information about all buckets.
+        # @option arguments [Float] :anomaly_score Returns buckets with anomaly scores greater or equal than this value. Server default: 0.
+        # @option arguments [Boolean] :desc If +true+, the buckets are sorted in descending order.
+        # @option arguments [String, Time] :end Returns buckets with timestamps earlier than this time. +-1+ 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.
+        # @option arguments [Boolean] :expand If true, the output includes anomaly records.
+        # @option arguments [Integer] :from Skips the specified number of buckets. Server default: 0.
+        # @option arguments [Integer] :size Specifies the maximum number of buckets to obtain. Server default: 100.
+        # @option arguments [String] :sort Specifies the sort field for the requested buckets. Server default: timestamp.
+        # @option arguments [String, Time] :start Returns buckets with timestamps after this time. +-1+ 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 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-bucket.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-buckets
         #
         def get_buckets(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_buckets' }
 
-          defined_params = %i[job_id timestamp].each_with_object({}) do |variable, set_variables|
+          defined_params = [:job_id, :timestamp].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?
@@ -65,11 +69,11 @@ module Elasticsearch
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = if _job_id && _timestamp
-                   "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/buckets/#{Utils.__listify(_timestamp)}"
-                 else
-                   "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/buckets"
-                 end
+          path   = if _job_id && _timestamp
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/buckets/#{Utils.listify(_timestamp)}"
+                   else
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/buckets"
+                   end
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,24 +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
-        # Retrieves information about the scheduled events in calendars.
+        # Get info about events in calendars.
         #
-        # @option arguments [String] :calendar_id The ID of the calendar containing the events
-        # @option arguments [String] :job_id Get events for the job. When this option is used calendar_id must be '_all'
-        # @option arguments [String] :start Get events after this time
-        # @option arguments [Date] :end Get events before this time
-        # @option arguments [Integer] :from Skips a number of events
-        # @option arguments [Integer] :size Specifies a max number of events to get
+        # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using +_all+ or +*+ or by omitting the calendar identifier. (*Required*)
+        # @option arguments [String, Time] :end Specifies to get events with timestamps earlier than this time.
+        # @option arguments [Integer] :from Skips the specified number of events. Server default: 0.
+        # @option arguments [String] :job_id Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of +_all+ or +*+.
+        # @option arguments [Integer] :size Specifies the maximum number of events to obtain. Server default: 100.
+        # @option arguments [String, Time] :start Specifies to get events with timestamps after this time.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-calendar-event.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-calendar-events
         #
         def get_calendar_events(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_calendar_events' }
@@ -52,7 +52,7 @@ module Elasticsearch
           _calendar_id = arguments.delete(:calendar_id)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_ml/calendars/#{Utils.__listify(_calendar_id)}/events"
+          path   = "_ml/calendars/#{Utils.listify(_calendar_id)}/events"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,22 +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 configuration information for calendars.
+        # Get calendar configuration info.
         #
-        # @option arguments [String] :calendar_id The ID of the calendar to fetch
-        # @option arguments [Integer] :from skips a number of calendars
-        # @option arguments [Integer] :size specifies a max number of calendars to get
+        # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using +_all+ or +*+ or by omitting the calendar identifier.
+        # @option arguments [Integer] :from Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. Server default: 0.
+        # @option arguments [Integer] :size Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. Server default: 10000.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The from and size parameters optionally sent in the body
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-get-calendar.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-calendars
         #
         def get_calendars(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_calendars' }
@@ -53,11 +53,11 @@ module Elasticsearch
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = if _calendar_id
-                   "_ml/calendars/#{Utils.__listify(_calendar_id)}"
-                 else
-                   '_ml/calendars'
-                 end
+          path   = if _calendar_id
+                     "_ml/calendars/#{Utils.listify(_calendar_id)}"
+                   else
+                     '_ml/calendars'
+                   end
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,29 +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
-        # Retrieves anomaly detection job results for one or more categories.
+        # Get anomaly detection job results for categories.
         #
-        # @option arguments [String] :job_id The name of the job
-        # @option arguments [Long] :category_id The identifier of the category definition of interest
-        # @option arguments [Integer] :from skips a number of categories
-        # @option arguments [Integer] :size specifies a max number of categories to get
-        # @option arguments [String] :partition_field_value Specifies the partition to retrieve categories for. This is optional, and should never be used for jobs where per-partition categorization is disabled.
+        # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
+        # @option arguments [String] :category_id Identifier for the category, which is unique in the job. If you specify
+        #  neither the category ID nor the partition_field_value, the API returns
+        #  information about all categories. If you specify only the
+        #  partition_field_value, it returns information about all categories for
+        #  the specified partition.
+        # @option arguments [Integer] :from Skips the specified number of categories. Server default: 0.
+        # @option arguments [String] :partition_field_value Only return categories for the specified partition.
+        # @option arguments [Integer] :size Specifies the maximum number of categories to obtain. Server default: 100.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body Category 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-category.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-categories
         #
         def get_categories(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_categories' }
 
-          defined_params = %i[job_id category_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:job_id, :category_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?
@@ -59,11 +63,11 @@ module Elasticsearch
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = if _job_id && _category_id
-                   "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/categories/#{Utils.__listify(_category_id)}"
-                 else
-                   "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/categories"
-                 end
+          path   = if _job_id && _category_id
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/categories/#{Utils.listify(_category_id)}"
+                   else
+                     "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/categories"
+                   end
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,23 +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
-        # Retrieves configuration information for data frame analytics jobs.
+        # Get data frame analytics job configuration info.
+        # You can get information for multiple data frame analytics jobs in a single
+        # API request by using a comma-separated list of data frame analytics jobs or a
+        # wildcard expression.
         #
-        # @option arguments [String] :id The ID of the data frame analytics to fetch
-        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)
-        # @option arguments [Integer] :from skips a number of analytics
-        # @option arguments [Integer] :size specifies a max number of analytics to get
-        # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on data frame analytics PUT
+        # @option arguments [String] :id Identifier for the data frame analytics job. If you do not specify this
+        #  option, the API returns information for the first hundred data frame
+        #  analytics jobs.
+        # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
+        #  - Contains wildcard expressions and there are no data frame analytics
+        #  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 returns an empty data_frame_analytics 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 [Integer] :from Skips the specified number of data frame analytics jobs. Server default: 0.
+        # @option arguments [Integer] :size Specifies the maximum number of data frame analytics jobs to obtain. Server default: 100.
+        # @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/get-dfanalytics.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-data-frame-analytics
         #
         def get_data_frame_analytics(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_data_frame_analytics' }
@@ -50,7 +65,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _id
-                     "_ml/data_frame/analytics/#{Utils.__listify(_id)}"
+                     "_ml/data_frame/analytics/#{Utils.listify(_id)}"
                    else
                      '_ml/data_frame/analytics'
                    end

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

@@ -15,23 +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
-        # Retrieves usage information for data frame analytics jobs.
+        # Get data frame analytics jobs usage info.
         #
-        # @option arguments [String] :id The ID of the data frame analytics stats to fetch
-        # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)
-        # @option arguments [Integer] :from skips a number of analytics
-        # @option arguments [Integer] :size specifies a max number of analytics to get
-        # @option arguments [Boolean] :verbose whether the stats response should be verbose
+        # @option arguments [String] :id Identifier for the data frame analytics job. If you do not specify this
+        #  option, the API returns information for the first hundred data frame
+        #  analytics jobs.
+        # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:
+        #  - Contains wildcard expressions and there are no data frame analytics
+        #  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 returns an empty data_frame_analytics 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 [Integer] :from Skips the specified number of data frame analytics jobs. Server default: 0.
+        # @option arguments [Integer] :size Specifies the maximum number of data frame analytics jobs to obtain. Server default: 100.
+        # @option arguments [Boolean] :verbose Defines whether the stats response should be verbose.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-dfanalytics-stats.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-data-frame-analytics-stats
         #
         def get_data_frame_analytics_stats(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'ml.get_data_frame_analytics_stats' }
@@ -50,7 +60,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = if _id
-                     "_ml/data_frame/analytics/#{Utils.__listify(_id)}/_stats"
+                     "_ml/data_frame/analytics/#{Utils.listify(_id)}/_stats"
                    else
                      '_ml/data_frame/analytics/_stats'
                    end