elasticsearch-serverless 0.1.0.20231031.pre → 0.2.0

data/lib/elasticsearch-serverless/api/inference/get.rb

@@ -0,0 +1,64 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch-specification
+#
+module ElasticsearchServerless
+  module API
+    module Inference
+      module Actions
+        # Get an inference endpoint
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :task_type The task type
+        # @option arguments [String] :inference_id The inference Id
+        # @option arguments [Hash] :headers Custom HTTP headers
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html
+        #
+        def get(arguments = {})
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = nil
+
+          _task_type = arguments.delete(:task_type)
+
+          _inference_id = arguments.delete(:inference_id)
+
+          method = ElasticsearchServerless::API::HTTP_GET
+          path   = if _task_type && _inference_id
+                     "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_inference_id)}"
+                   elsif _inference_id
+                     "_inference/#{Utils.listify(_inference_id)}"
+                   else
+                     "_inference"
+                   end
+          params = {}
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/api/inference/inference.rb

@@ -0,0 +1,66 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch-specification
+#
+module ElasticsearchServerless
+  module API
+    module Inference
+      module Actions
+        # Perform inference on the service
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :task_type The task type
+        # @option arguments [String] :inference_id The inference Id (*Required*)
+        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html
+        #
+        def inference(arguments = {})
+          raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _task_type = arguments.delete(:task_type)
+
+          _inference_id = arguments.delete(:inference_id)
+
+          method = ElasticsearchServerless::API::HTTP_POST
+          path   = if _task_type && _inference_id
+                     "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_inference_id)}"
+                   else
+                     "_inference/#{Utils.listify(_inference_id)}"
+                   end
+          params = Utils.process_params(arguments)
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/api/inference/put.rb

@@ -0,0 +1,66 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch-specification
+#
+module ElasticsearchServerless
+  module API
+    module Inference
+      module Actions
+        # Create an inference endpoint
+        # This functionality is Experimental and may be changed or removed
+        # completely in a future release. Elastic will take a best effort approach
+        # to fix any issues, but experimental features are not subject to the
+        # support SLA of official GA features.
+        #
+        # @option arguments [String] :task_type The task type
+        # @option arguments [String] :inference_id The inference Id (*Required*)
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body inference_config
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html
+        #
+        def put(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _task_type = arguments.delete(:task_type)
+
+          _inference_id = arguments.delete(:inference_id)
+
+          method = ElasticsearchServerless::API::HTTP_PUT
+          path   = if _task_type && _inference_id
+                     "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_inference_id)}"
+                   else
+                     "_inference/#{Utils.listify(_inference_id)}"
+                   end
+          params = {}
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/api/ingest/delete_pipeline.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Ingest
       module Actions
-        # Deletes a pipeline.
+        # Deletes one or more existing ingest pipeline.
         #
         # @option arguments [String] :id Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of +*+. (*Required*)
         # @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.

data/lib/elasticsearch-serverless/api/ingest/get_pipeline.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Ingest
       module Actions
-        # Returns a pipeline.
+        # Returns information about one or more ingest pipelines.
+        # This API returns a local reference of the pipeline.
         #
         # @option arguments [String] :id Comma-separated list of pipeline IDs to retrieve. Wildcard (+*+) expressions are supported. To get all ingest pipelines, omit this parameter or use +*+.
         # @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.

data/lib/elasticsearch-serverless/api/ingest/processor_grok.rb

@@ -22,7 +22,9 @@ module ElasticsearchServerless
   module API
     module Ingest
       module Actions
-        # Returns a list of the built-in patterns.
+        # Extracts structured fields out of a single text field within a document.
+        # You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
+        # A grok pattern is like a regular expression that supports aliased expressions that can be reused.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         #

data/lib/elasticsearch-serverless/api/ingest/put_pipeline.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module Ingest
       module Actions
-        # Creates or updates a pipeline.
+        # Creates or updates an ingest pipeline.
+        # Changes made using this API take effect immediately.
         #
         # @option arguments [String] :id ID of the ingest pipeline to create or update. (*Required*)
         # @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.

data/lib/elasticsearch-serverless/api/ingest/simulate.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Ingest
       module Actions
-        # Allows to simulate a pipeline with example documents.
+        # Executes an ingest pipeline against a set of provided documents.
         #
         # @option arguments [String] :id Pipeline to test. If you don’t specify a +pipeline+ in the request body, this parameter is required.
         # @option arguments [Boolean] :verbose If +true+, the response includes output data for each processor in the executed pipeline.

data/lib/elasticsearch-serverless/api/license/get.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module License
       module Actions
-        # Retrieves licensing information for the cluster
+        # This API returns information about the type of license, when it was issued, and when it expires, for example.
+        # For more information about the different types of licenses, see https://www.elastic.co/subscriptions.
         #
         # @option arguments [Boolean] :accept_enterprise If +true+, this parameter returns enterprise for Enterprise license types. If +false+, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility. This parameter is deprecated and will always be set to true in 8.x. Server default: true.
         # @option arguments [Boolean] :local Specifies whether to retrieve local information. The default value is +false+, which means the information is retrieved from the master node.

data/lib/elasticsearch-serverless/api/logstash/delete_pipeline.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Logstash
       module Actions
-        # Deletes Logstash Pipelines used by Central Management
+        # Deletes a pipeline used for Logstash Central Management.
         #
         # @option arguments [String] :id Identifier for the pipeline. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers

data/lib/elasticsearch-serverless/api/logstash/get_pipeline.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Logstash
       module Actions
-        # Retrieves Logstash Pipelines used by Central Management
+        # Retrieves pipelines used for Logstash Central Management.
         #
         # @option arguments [String, Array] :id Comma-separated list of pipeline identifiers.
         # @option arguments [Hash] :headers Custom HTTP headers

data/lib/elasticsearch-serverless/api/logstash/put_pipeline.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module Logstash
       module Actions
-        # Adds and updates Logstash Pipelines used for Central Management
+        # Creates or updates a pipeline used for Logstash Central Management.
         #
         # @option arguments [String] :id Identifier for the pipeline. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers

data/lib/elasticsearch-serverless/api/machine_learning/close_job.rb

@@ -22,7 +22,11 @@ module ElasticsearchServerless
   module API
     module MachineLearning
       module Actions
-        # Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle.
+        # Close anomaly detection jobs
+        # A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
+        # When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
+        # If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.
+        # When a datafeed that has a specified end date stops, it automatically closes its associated job.
         #
         # @option arguments [String] :job_id Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close 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 close all jobs by using +_all+ or by specifying +*+ as the job identifier. (*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; or contains wildcard expressions and there are only partial matches. By default, it returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If +false+, the request returns a 404 status code when there are no matches or only partial matches. Server default: true.

data/lib/elasticsearch-serverless/api/machine_learning/delete_calendar.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module MachineLearning
       module Actions
-        # Deletes a calendar.
+        # Removes all scheduled events from a calendar, then deletes it.
         #
         # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers

data/lib/elasticsearch-serverless/api/machine_learning/delete_data_frame_analytics.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module MachineLearning
       module Actions
-        # Deletes an existing data frame analytics job.
+        # Deletes a data frame analytics job.
         #
         # @option arguments [String] :id Identifier for the data frame analytics job. (*Required*)
         # @option arguments [Boolean] :force If +true+, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.

data/lib/elasticsearch-serverless/api/machine_learning/delete_filter.rb

@@ -23,6 +23,8 @@ module ElasticsearchServerless
     module MachineLearning
       module Actions
         # Deletes a filter.
+        # If an anomaly detection job references the filter, you cannot delete the
+        # filter. You must update or delete the job before you can delete the filter.
         #
         # @option arguments [String] :filter_id A string that uniquely identifies a filter. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers

data/lib/elasticsearch-serverless/api/machine_learning/delete_job.rb

@@ -22,7 +22,14 @@ module ElasticsearchServerless
   module API
     module MachineLearning
       module Actions
-        # Deletes an existing anomaly detection job.
+        # Deletes an anomaly detection job.
+        #
+        # All job configuration, model state and results are deleted.
+        # It is not currently possible to delete multiple jobs using wildcards or a
+        # comma separated list. If you delete a job that has a datafeed, the request
+        # first tries to delete the datafeed. This behavior is equivalent to calling
+        # the delete datafeed API with the same timeout and force parameters as the
+        # delete job request.
         #
         # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
         # @option arguments [Boolean] :force Use to forcefully delete an opened job; this method is quicker than closing and deleting the job.

data/lib/elasticsearch-serverless/api/machine_learning/delete_trained_model.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module MachineLearning
       module Actions
-        # Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.
+        # Deletes an existing trained inference model that is currently not referenced
+        # by an ingest pipeline.
         #
         # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
         # @option arguments [Boolean] :force Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.

data/lib/elasticsearch-serverless/api/machine_learning/delete_trained_model_alias.rb

@@ -22,7 +22,10 @@ module ElasticsearchServerless
   module API
     module MachineLearning
       module Actions
-        # Deletes a model alias that refers to the trained model
+        # Deletes a trained model alias.
+        # This API deletes an existing model alias that refers to a trained model. If
+        # the model alias is missing or refers to a model other than the one identified
+        # by the +model_id+, this API returns an error.
         #
         # @option arguments [String] :model_alias The model alias to delete. (*Required*)
         # @option arguments [String] :model_id The trained model ID to which the model alias refers. (*Required*)

data/lib/elasticsearch-serverless/api/machine_learning/estimate_model_memory.rb

@@ -22,7 +22,9 @@ module ElasticsearchServerless
   module API
     module MachineLearning
       module Actions
-        # Estimates the model memory
+        # Makes an estimation of the memory usage for an anomaly detection job model.
+        # It is based on analysis configuration details for the job and cardinality
+        # estimates for the fields it references.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body

data/lib/elasticsearch-serverless/api/machine_learning/evaluate_data_frame.rb

@@ -23,6 +23,10 @@ module ElasticsearchServerless
     module MachineLearning
       module Actions
         # Evaluates the data frame analytics for an annotated index.
+        # 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 request body

data/lib/elasticsearch-serverless/api/machine_learning/flush_job.rb

@@ -23,6 +23,14 @@ module ElasticsearchServerless
     module MachineLearning
       module Actions
         # Forces any buffered data to be processed by the job.
+        # 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 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.

data/lib/elasticsearch-serverless/api/machine_learning/get_data_frame_analytics.rb

@@ -23,6 +23,9 @@ module ElasticsearchServerless
     module MachineLearning
       module Actions
         # Retrieves configuration information for data frame analytics jobs.
+        # 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 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:  1. Contains wildcard expressions and there are no data frame analytics jobs that match. 2. Contains the +_all+ string or no identifiers and there are no matches. 3. 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.

data/lib/elasticsearch-serverless/api/machine_learning/get_datafeed_stats.rb

@@ -23,6 +23,12 @@ module ElasticsearchServerless
     module MachineLearning
       module Actions
         # Retrieves usage information for datafeeds.
+        # 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, 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:  1. Contains wildcard expressions and there are no datafeeds that match. 2. Contains the +_all+ string or no identifiers and there are no matches. 3. 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.

data/lib/elasticsearch-serverless/api/machine_learning/get_datafeeds.rb

@@ -23,6 +23,11 @@ module ElasticsearchServerless
     module MachineLearning
       module Actions
         # Retrieves configuration information for datafeeds.
+        # 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, 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:  1. Contains wildcard expressions and there are no datafeeds that match. 2. Contains the +_all+ string or no identifiers and there are no matches. 3. 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.

data/lib/elasticsearch-serverless/api/machine_learning/get_filters.rb

@@ -23,6 +23,7 @@ module ElasticsearchServerless
     module MachineLearning
       module Actions
         # Retrieves filters.
+        # You can get a single filter or all filters.
         #
         # @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.

data/lib/elasticsearch-serverless/api/machine_learning/get_jobs.rb

@@ -23,6 +23,10 @@ module ElasticsearchServerless
     module MachineLearning
       module Actions
         # Retrieves configuration information for anomaly detection jobs.
+        # 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, 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:  1. Contains wildcard expressions and there are no jobs that match. 2. Contains the _all string or no identifiers and there are no matches. 3. 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.

data/lib/elasticsearch-serverless/api/machine_learning/get_overall_buckets.rb

@@ -22,7 +22,23 @@ module ElasticsearchServerless
   module API
     module MachineLearning
       module Actions
-        # Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs.
+        # Retrieves 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 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:  1. Contains wildcard expressions and there are no jobs that match. 2. Contains the +_all+ string or no identifiers and there are no matches. 3. 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.

data/lib/elasticsearch-serverless/api/machine_learning/get_trained_models.rb

@@ -22,9 +22,9 @@ module ElasticsearchServerless
   module API
     module MachineLearning
       module Actions
-        # Retrieves configuration information for a trained inference model.
+        # Retrieves configuration information for a trained model.
         #
-        # @option arguments [String] :model_id The unique identifier of the trained model.
+        # @option arguments [String, Array] :model_id The unique identifier of the trained model or a model alias.  You can get information for multiple trained models in a single API request by using a comma-separated list of model IDs or a wildcard expression.
         # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:  - Contains wildcard expressions and there are no models 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, it returns an empty array when there are no matches and the subset of results when there are partial matches. Server default: true.
         # @option arguments [Boolean] :decompress_definition Specifies whether the included model definition should be returned as a JSON map (true) or in a custom compressed format (false). 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.

data/lib/elasticsearch-serverless/api/machine_learning/get_trained_models_stats.rb

@@ -22,7 +22,8 @@ module ElasticsearchServerless
   module API
     module MachineLearning
       module Actions
-        # Retrieves usage information for trained inference models.
+        # Retrieves usage information for trained models. You can get usage information for multiple trained
+        # models in a single API request by using a comma-separated list of model IDs or a wildcard expression.
         #
         # @option arguments [String, Array] :model_id The unique identifier of the trained model or a model alias. It can be a comma-separated list or a wildcard expression.
         # @option arguments [Boolean] :allow_no_match Specifies what to do when the request:  - Contains wildcard expressions and there are no models 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, it returns an empty array when there are no matches and the subset of results when there are partial matches. Server default: true.

data/lib/elasticsearch-serverless/api/machine_learning/infer_trained_model.rb

@@ -0,0 +1,63 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+# Auto generated from commit f284cc16f4d4b4289bc679aa1529bb504190fe80
+# @see https://github.com/elastic/elasticsearch-specification
+#
+module ElasticsearchServerless
+  module API
+    module MachineLearning
+      module Actions
+        # Evaluates a trained model.
+        #
+        # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*)
+        # @option arguments [Time] :timeout Controls the amount of time to wait for inference results. Server default: 10s.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # *Deprecation notice*:
+        # /_ml/trained_models/{model_id}/deployment/_infer is deprecated. Use /_ml/trained_models/{model_id}/_infer instead
+        # Deprecated since version 8.3.0
+        #
+        #
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/infer-trained-model.html
+        #
+        def infer_trained_model(arguments = {})
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _model_id = arguments.delete(:model_id)
+
+          method = ElasticsearchServerless::API::HTTP_POST
+          path   = if _model_id
+                     "_ml/trained_models/#{Utils.listify(_model_id)}/deployment/_infer"
+                   end
+          params = Utils.process_params(arguments)
+
+          ElasticsearchServerless::API::Response.new(
+            perform_request(method, path, params, body, headers)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch-serverless/api/machine_learning/open_job.rb

@@ -23,6 +23,13 @@ module ElasticsearchServerless
     module MachineLearning
       module Actions
         # Opens one or more anomaly detection jobs.
+        # An anomaly detection job must be opened in order for it to be ready to
+        # receive and analyze data. It can be opened and closed multiple times
+        # throughout its lifecycle.
+        # When you open a new job, it starts with an empty model.
+        # When you open an existing job, the most recent model state is automatically
+        # loaded. The job is ready to resume its analysis from where it left off, once
+        # new data is received.
         #
         # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*)
         # @option arguments [Time] :timeout Controls the time to wait until a job has opened. Server default: 30m.

data/lib/elasticsearch-serverless/api/machine_learning/post_calendar_events.rb

@@ -22,7 +22,7 @@ module ElasticsearchServerless
   module API
     module MachineLearning
       module Actions
-        # Posts scheduled events in a calendar.
+        # Adds scheduled events to a calendar.
         #
         # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers