elasticsearch-api 9.2.0 → 9.3.0

data/lib/elasticsearch/api/actions/indices/put_sample_configuration.rb

@@ -0,0 +1,82 @@
+# 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.
+#
+# 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 Indices
+      module Actions
+        # Create or update sampling configuration.
+        # Create or update the sampling configuration for the specified index.
+        # This functionality is in technical preview and may be changed or removed in a future
+        # release. Elastic will apply best effort to fix any issues, but features in technical
+        # preview are not subject to the support SLA of official GA features.
+        #
+        # @option arguments [String] :index The name of the index or data stream. (*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.
+        # @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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch#TODO
+        #
+        def put_sample_configuration(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'indices.put_sample_configuration' }
+
+          defined_params = [:index].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?
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _index = arguments.delete(:index)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "#{Utils.listify(_index)}/_sample/config"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/indices/put_template.rb

@@ -45,7 +45,7 @@ module Elasticsearch
         # @option arguments [Integer] :order Order in which Elasticsearch applies this template if index
         #  matches multiple templates.Templates with lower 'order' values are merged first. Templates with higher
         #  'order' values are merged later, overriding templates with lower values.
-        # @option arguments [String] :cause User defined reason for creating/updating the index template Server default: .
+        # @option arguments [String] :cause User defined reason for creating or updating the index template Server default: "".
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
         #  when they occur.
         # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response

data/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb

@@ -35,8 +35,9 @@ module Elasticsearch
         # This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.
         #
         # @option arguments [String, Array] :index A comma-separated list of index names to reload analyzers for (*Required*)
-        # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-        # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
+        # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices.
+        #  (This includes `_all` string or when no indices have been specified)
+        # @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open.
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
         # @option arguments [String] :resource Changed resource to reload analyzers from if applicable
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

data/lib/elasticsearch/api/actions/indices/remove_block.rb

@@ -26,7 +26,7 @@ module Elasticsearch
         # Remove an index block from an index.
         # Index blocks limit the operations allowed on an index by blocking specific operation types.
         #
-        # @option arguments [String] :index A comma-separated list or wildcard expression of index names used to limit the request.
+        # @option arguments [String, Array] :index A comma-separated list or wildcard expression of index names used to limit the request.
         #  By default, you must explicitly name the indices you are removing blocks from.
         #  To allow the removal of blocks from indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`.
         #  You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API. (*Required*)

data/lib/elasticsearch/api/actions/indices/resolve_index.rb

@@ -36,14 +36,6 @@ module Elasticsearch
         #  This behavior applies even if the request targets other open indices.
         #  For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. Server default: true.
         # @option arguments [String, Array<String>] :mode Filter indices by index mode - standard, lookup, time_series, etc. Comma-separated list of IndexMode. Empty means no filter.
-        # @option arguments [String] :project_routing Specifies a subset of projects to target using project
-        #  metadata tags in a subset of Lucene query syntax.
-        #  Allowed Lucene queries: the _alias tag and a single value (possibly wildcarded).
-        #  Examples:
-        #   _alias:my-project
-        #   _alias:_origin
-        #   _alias:*pr*
-        #  Supported in serverless only.
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
         #  when they occur.
         # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
@@ -56,6 +48,7 @@ module Elasticsearch
         # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
         #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-resolve-index
         #
@@ -72,11 +65,16 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body = nil
+          body = arguments.delete(:body)
 
           _name = arguments.delete(:name)
 
-          method = Elasticsearch::API::HTTP_GET
+          method = if body
+                     Elasticsearch::API::HTTP_POST
+                   else
+                     Elasticsearch::API::HTTP_GET
+                   end
+
           path   = "_resolve/index/#{Utils.listify(_name)}"
           params = Utils.process_params(arguments)
 

data/lib/elasticsearch/api/actions/indices/stats.rb

@@ -31,12 +31,12 @@ module Elasticsearch
         # NOTE: When moving to another node, the shard-level statistics for a shard are cleared.
         # Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.
         #
-        # @option arguments [String, Array<String>] :metric Limit the information returned the specific metrics.
+        # @option arguments [String, Array<String>] :metric Limit the information returned the specific metrics
         # @option arguments [String, Array] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
         # @option arguments [String, Array<String>] :completion_fields Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
         # @option arguments [String, Array<String>] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument
         #  determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
-        #  such as `open,hidden`.
+        #  such as `open,hidden`. Server default: open.
         # @option arguments [String, Array<String>] :fielddata_fields Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
         # @option arguments [String, Array<String>] :fields Comma-separated list or wildcard expressions of fields to include in the statistics.
         # @option arguments [Boolean] :forbid_closed_indices If true, statistics are not collected from closed indices. Server default: true.

data/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb

@@ -22,13 +22,13 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Perform chat completion inference
+        # Perform chat completion inference on the service.
         # The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation.
-        # It only works with the `chat_completion` task type for `openai` and `elastic` inference services.
+        # It only works with the `chat_completion` task type.
         # NOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming.
         # The Chat completion inference API and the Stream inference API differ in their response structure and capabilities.
         # The Chat completion inference API provides more comprehensive customization options through more fields and function calling support.
-        # If you use the `openai`, `hugging_face` or the `elastic` service, use the Chat completion inference API.
+        # To determine whether a given inference service supports this task type, please see the page for that service.
         #
         # @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.

data/lib/elasticsearch/api/actions/inference/completion.rb

@@ -22,7 +22,11 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Perform completion inference on the service
+        # Perform completion inference on the service.
+        # Get responses for completion tasks.
+        # This API works only with the completion task type.
+        # IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.
+        # This API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege).
         #
         # @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.

data/lib/elasticsearch/api/actions/inference/delete.rb

@@ -22,11 +22,12 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Delete an inference endpoint
+        # Delete an inference endpoint.
+        # This API requires the manage_inference cluster privilege (the built-in `inference_admin` role grants this privilege).
         #
         # @option arguments [String] :task_type The task type
         # @option arguments [String] :inference_id The inference identifier. (*Required*)
-        # @option arguments [Boolean] :dry_run When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned.
+        # @option arguments [Boolean] :dry_run When true, checks the semantic_text fields and inference processors that reference the endpoint and returns them in a list, but does not delete the endpoint.
         # @option arguments [Boolean] :force When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields.
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
         #  when they occur.

data/lib/elasticsearch/api/actions/inference/get.rb

@@ -22,7 +22,8 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Get an inference endpoint
+        # Get an inference endpoint.
+        # This API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege).
         #
         # @option arguments [String] :task_type The task type
         # @option arguments [String] :inference_id The inference Id

data/lib/elasticsearch/api/actions/inference/put.rb

@@ -32,19 +32,22 @@ module Elasticsearch
         # * Amazon Bedrock (`completion`, `text_embedding`)
         # * Amazon SageMaker (`chat_completion`, `completion`, `rerank`, `sparse_embedding`, `text_embedding`)
         # * Anthropic (`completion`)
-        # * Azure AI Studio (`completion`, 'rerank', `text_embedding`)
-        # * Azure OpenAI (`completion`, `text_embedding`)
+        # * Azure AI Studio (`completion`, `rerank`, `text_embedding`)
+        # * Azure OpenAI (`chat_completion`, `completion`, `text_embedding`)
         # * Cohere (`completion`, `rerank`, `text_embedding`)
         # * DeepSeek (`chat_completion`, `completion`)
         # * Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland)
         # * ELSER (`sparse_embedding`)
         # * Google AI Studio (`completion`, `text_embedding`)
         # * Google Vertex AI (`chat_completion`, `completion`, `rerank`, `text_embedding`)
+        # * Groq (`chat_completion`)
         # * Hugging Face (`chat_completion`, `completion`, `rerank`, `text_embedding`)
         # * JinaAI (`rerank`, `text_embedding`)
         # * Llama (`chat_completion`, `completion`, `text_embedding`)
         # * Mistral (`chat_completion`, `completion`, `text_embedding`)
+        # * Nvidia (`chat_completion`, `completion`, `text_embedding`, `rerank`)
         # * OpenAI (`chat_completion`, `completion`, `text_embedding`)
+        # * OpenShift AI (`chat_completion`, `completion`, `rerank`, `text_embedding`)
         # * VoyageAI (`rerank`, `text_embedding`)
         # * Watsonx inference integration (`text_embedding`)
         #

data/lib/elasticsearch/api/actions/inference/put_groq.rb

@@ -0,0 +1,79 @@
+# 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.
+#
+# 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 Inference
+      module Actions
+        # Create a Groq inference endpoint.
+        # Create an inference endpoint to perform an inference task with the `groq` service.
+        #
+        # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
+        # @option arguments [String] :groq_inference_id The unique identifier of the inference endpoint. (*Required*)
+        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-groq
+        #
+        def put_groq(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'inference.put_groq' }
+
+          defined_params = [:task_type, :groq_inference_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?
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
+          raise ArgumentError, "Required argument 'groq_inference_id' missing" unless arguments[:groq_inference_id]
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _task_type = arguments.delete(:task_type)
+
+          _groq_inference_id = arguments.delete(:groq_inference_id)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_groq_inference_id)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/inference/put_nvidia.rb

@@ -0,0 +1,84 @@
+# 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.
+#
+# 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 Inference
+      module Actions
+        # Create an Nvidia inference endpoint.
+        # Create an inference endpoint to perform an inference task with the `nvidia` service.
+        #
+        # @option arguments [String] :task_type The type of the inference task that the model will perform.
+        #  NOTE: The `chat_completion` task type only supports streaming and only through the _stream API. (*Required*)
+        # @option arguments [String] :nvidia_inference_id The unique identifier of the inference endpoint. (*Required*)
+        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-nvidia
+        #
+        def put_nvidia(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'inference.put_nvidia' }
+
+          defined_params = [:task_type, :nvidia_inference_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?
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
+
+          unless arguments[:nvidia_inference_id]
+            raise ArgumentError,
+                  "Required argument 'nvidia_inference_id' missing"
+          end
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _task_type = arguments.delete(:task_type)
+
+          _nvidia_inference_id = arguments.delete(:nvidia_inference_id)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_nvidia_inference_id)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/inference/put_openshift_ai.rb

@@ -0,0 +1,84 @@
+# 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.
+#
+# 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 Inference
+      module Actions
+        # Create an OpenShift AI inference endpoint.
+        # Create an inference endpoint to perform an inference task with the `openshift_ai` service.
+        #
+        # @option arguments [String] :task_type The type of the inference task that the model will perform.
+        #  NOTE: The `chat_completion` task type only supports streaming and only through the _stream API. (*Required*)
+        # @option arguments [String] :openshiftai_inference_id The unique identifier of the inference endpoint. (*Required*)
+        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
+        # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
+        #
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-openshift-ai
+        #
+        def put_openshift_ai(arguments = {})
+          request_opts = { endpoint: arguments[:endpoint] || 'inference.put_openshift_ai' }
+
+          defined_params = [:task_type, :openshiftai_inference_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?
+
+          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type]
+
+          unless arguments[:openshiftai_inference_id]
+            raise ArgumentError,
+                  "Required argument 'openshiftai_inference_id' missing"
+          end
+
+          arguments = arguments.clone
+          headers = arguments.delete(:headers) || {}
+
+          body = arguments.delete(:body)
+
+          _task_type = arguments.delete(:task_type)
+
+          _openshiftai_inference_id = arguments.delete(:openshiftai_inference_id)
+
+          method = Elasticsearch::API::HTTP_PUT
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_openshiftai_inference_id)}"
+          params = Utils.process_params(arguments)
+
+          Elasticsearch::API::Response.new(
+            perform_request(method, path, params, body, headers, request_opts)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/inference/rerank.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Perform reranking inference on the service
+        # Perform reranking inference on the service.
         #
         # @option arguments [String] :inference_id The unique identifier for the inference endpoint. (*Required*)
         # @option arguments [Time] :timeout The amount of time to wait for the inference request to complete. Server default: 30s.

data/lib/elasticsearch/api/actions/inference/sparse_embedding.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Perform sparse embedding inference on the service
+        # Perform sparse embedding inference on the service.
         #
         # @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.

data/lib/elasticsearch/api/actions/inference/stream_completion.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Perform streaming inference.
+        # Perform streaming completion inference on the service.
         # Get real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation.
         # This API works only with the completion task type.
         # IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.

data/lib/elasticsearch/api/actions/inference/text_embedding.rb

@@ -22,7 +22,7 @@ module Elasticsearch
   module API
     module Inference
       module Actions
-        # Perform text embedding inference on the service
+        # Perform text embedding inference on the service.
         #
         # @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.

data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb

@@ -31,7 +31,7 @@ module Elasticsearch
         #  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.
-        # @option arguments [Boolean] :summary Return pipelines without their definitions (default: false)
+        # @option arguments [Boolean] :summary Return pipelines without their definitions
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
         #  when they occur.
         # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response

data/lib/elasticsearch/api/actions/license/post_start_basic.rb

@@ -29,7 +29,7 @@ module Elasticsearch
         # You must then re-submit the API request with the `acknowledge` parameter set to `true`.
         # To check the status of your basic license, use the get basic license API.
         #
-        # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false)
+        # @option arguments [Boolean] :acknowledge Whether the user has acknowledged acknowledge messages
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. 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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors

data/lib/elasticsearch/api/actions/license/post_start_trial.rb

@@ -28,8 +28,8 @@ module Elasticsearch
         # For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.
         # To check the status of your trial, use the get trial status API.
         #
-        # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false)
-        # @option arguments [String] :type The type of trial license to generate (default: "trial")
+        # @option arguments [Boolean] :acknowledge Whether the user has acknowledged acknowledge messages
+        # @option arguments [String] :type The type of trial license to generate Server default: trial.
         # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
         # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
         #  when they occur.

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

@@ -52,6 +52,7 @@ module Elasticsearch
         # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
         #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-start-data-frame-analytics
         #
@@ -68,7 +69,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body = nil
+          body = arguments.delete(:body)
 
           _id = arguments.delete(:id)
 

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

@@ -37,7 +37,7 @@ module Elasticsearch
         #  If this setting is greater than the number of hardware threads
         #  it will automatically be changed to a value less than the number of hardware threads.
         #  If adaptive_allocations is enabled, do not set this value, because it’s automatically set. Server default: 1.
-        # @option arguments [String] :priority The deployment priority.
+        # @option arguments [String] :priority The deployment priority
         # @option arguments [Integer] :queue_capacity Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds
         #  this value, new requests are rejected with a 429 error. Server default: 1024.
         # @option arguments [Integer] :threads_per_allocation Sets the number of threads used by each model allocation during inference. This generally increases

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

@@ -53,6 +53,7 @@ module Elasticsearch
         # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
         #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
+        # @option arguments [Hash] :body request body
         #
         # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-stop-data-frame-analytics
         #
@@ -69,7 +70,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body = nil
+          body = arguments.delete(:body)
 
           _id = arguments.delete(:id)