elasticsearch-api 8.19.3 → 9.0.0

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

@@ -15,34 +15,42 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash 589cd632d091bc0a512c46d5d81ac1f961b60127
-# @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 Inference
       module Actions
-        # Create a Cohere inference endpoint
+        # Create a Cohere inference endpoint.
+        # Create an inference endpoint to perform an inference task with the +cohere+ service.
+        # When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
+        # After creating the endpoint, wait for the model deployment to complete before using it.
+        # To verify the deployment status, use the get trained model statistics API.
+        # Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
+        # Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
         #
-        # @option arguments [String] :task_type The task type (options: completion, rerank, text_embedding)
-        # @option arguments [String] :cohere_inference_id The inference Id
-        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created.
+        # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
+        # @option arguments [String] :cohere_inference_id The unique identifier of the inference endpoint. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The inference endpoint's task and service settings (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-cohere.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-cohere
         #
         def put_cohere(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put_cohere' }
 
-          defined_params = %i[task_type cohere_inference_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:task_type, :cohere_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 'cohere_inference_id' missing" unless arguments[:cohere_inference_id]
+
+          unless arguments[:cohere_inference_id]
+            raise ArgumentError,
+                  "Required argument 'cohere_inference_id' missing"
+          end
 
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
@@ -54,8 +62,8 @@ module Elasticsearch
           _cohere_inference_id = arguments.delete(:cohere_inference_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_cohere_inference_id)}"
-          params = Utils.process_params(arguments)
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_cohere_inference_id)}"
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -15,32 +15,32 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash 589cd632d091bc0a512c46d5d81ac1f961b60127
-# @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 Inference
       module Actions
-        # Create an Elasticsearch inference endpoint
+        # Create an Elasticsearch inference endpoint.
+        # Create an inference endpoint to perform an inference task with the +elasticsearch+ service.
         #
-        # @option arguments [String] :task_type The task type (options: rerank, sparse_embedding, text_embedding)
-        # @option arguments [String] :elasticsearch_inference_id The inference Id
-        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created.
+        # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
+        # @option arguments [String] :elasticsearch_inference_id The unique identifier of the inference endpoint.
+        #  The must not match the +model_id+. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The inference endpoint's task and service settings (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-elasticsearch.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-elasticsearch
         #
         def put_elasticsearch(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put_elasticsearch' }
 
-          defined_params = %i[task_type elasticsearch_inference_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:task_type, :elasticsearch_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[:elasticsearch_inference_id]
@@ -58,8 +58,8 @@ module Elasticsearch
           _elasticsearch_inference_id = arguments.delete(:elasticsearch_inference_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_elasticsearch_inference_id)}"
-          params = Utils.process_params(arguments)
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_elasticsearch_inference_id)}"
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -15,32 +15,32 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash 589cd632d091bc0a512c46d5d81ac1f961b60127
-# @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 Inference
       module Actions
-        # Create an ELSER inference endpoint
+        # Create an ELSER inference endpoint.
+        # Create an inference endpoint to perform an inference task with the +elser+ service.
+        # You can also deploy ELSER by using the Elasticsearch inference integration.
         #
-        # @option arguments [String] :task_type The task type (options: sparse_embedding)
-        # @option arguments [String] :elser_inference_id The inference Id
-        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created.
+        # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
+        # @option arguments [String] :elser_inference_id The unique identifier of the inference endpoint. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The inference endpoint's task and service settings (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-elser.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-elser
         #
         def put_elser(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put_elser' }
 
-          defined_params = %i[task_type elser_inference_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:task_type, :elser_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 'elser_inference_id' missing" unless arguments[:elser_inference_id]
 
@@ -54,8 +54,8 @@ module Elasticsearch
           _elser_inference_id = arguments.delete(:elser_inference_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_elser_inference_id)}"
-          params = Utils.process_params(arguments)
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_elser_inference_id)}"
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -15,32 +15,36 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash 589cd632d091bc0a512c46d5d81ac1f961b60127
-# @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 Inference
       module Actions
-        # Create an Google AI Studio inference endpoint
+        # Create an Google AI Studio inference endpoint.
+        # Create an inference endpoint to perform an inference task with the +googleaistudio+ service.
+        # When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
+        # After creating the endpoint, wait for the model deployment to complete before using it.
+        # To verify the deployment status, use the get trained model statistics API.
+        # Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
+        # Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
         #
-        # @option arguments [String] :task_type The task type (options: completion, text_embedding)
-        # @option arguments [String] :googleaistudio_inference_id The inference Id
-        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created.
+        # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
+        # @option arguments [String] :googleaistudio_inference_id The unique identifier of the inference endpoint. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The inference endpoint's task and service settings (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-google-ai-studio.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-googleaistudio
         #
         def put_googleaistudio(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put_googleaistudio' }
 
-          defined_params = %i[task_type googleaistudio_inference_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:task_type, :googleaistudio_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[:googleaistudio_inference_id]
@@ -58,8 +62,8 @@ module Elasticsearch
           _googleaistudio_inference_id = arguments.delete(:googleaistudio_inference_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_googleaistudio_inference_id)}"
-          params = Utils.process_params(arguments)
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_googleaistudio_inference_id)}"
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -15,32 +15,36 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash 589cd632d091bc0a512c46d5d81ac1f961b60127
-# @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 Inference
       module Actions
-        # Create a Google Vertex AI inference endpoint
+        # Create a Google Vertex AI inference endpoint.
+        # Create an inference endpoint to perform an inference task with the +googlevertexai+ service.
+        # When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
+        # After creating the endpoint, wait for the model deployment to complete before using it.
+        # To verify the deployment status, use the get trained model statistics API.
+        # Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
+        # Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
         #
-        # @option arguments [String] :task_type The task type (options: rerank, text_embedding, completion, chat_completion)
-        # @option arguments [String] :googlevertexai_inference_id The inference Id
-        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created.
+        # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
+        # @option arguments [String] :googlevertexai_inference_id The unique identifier of the inference endpoint. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The inference endpoint's task and service settings (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-google-vertex-ai.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-googlevertexai
         #
         def put_googlevertexai(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put_googlevertexai' }
 
-          defined_params = %i[task_type googlevertexai_inference_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:task_type, :googlevertexai_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[:googlevertexai_inference_id]
@@ -58,8 +62,8 @@ module Elasticsearch
           _googlevertexai_inference_id = arguments.delete(:googlevertexai_inference_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_googlevertexai_inference_id)}"
-          params = Utils.process_params(arguments)
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_googlevertexai_inference_id)}"
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -15,32 +15,47 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash 589cd632d091bc0a512c46d5d81ac1f961b60127
-# @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 Inference
       module Actions
-        # Create a Hugging Face inference endpoint
+        # Create a Hugging Face inference endpoint.
+        # Create an inference endpoint to perform an inference task with the +hugging_face+ service.
+        # You must first create an inference endpoint on the Hugging Face endpoint page to get an endpoint URL.
+        # Select the model you want to use on the new endpoint creation page (for example +intfloat/e5-small-v2+), then select the sentence embeddings task under the advanced configuration section.
+        # Create the endpoint and copy the URL after the endpoint initialization has been finished.
+        # The following models are recommended for the Hugging Face service:
+        # * +all-MiniLM-L6-v2+
+        # * +all-MiniLM-L12-v2+
+        # * +all-mpnet-base-v2+
+        # * +e5-base-v2+
+        # * +e5-small-v2+
+        # * +multilingual-e5-base+
+        # * +multilingual-e5-small+
+        # When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
+        # After creating the endpoint, wait for the model deployment to complete before using it.
+        # To verify the deployment status, use the get trained model statistics API.
+        # Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
+        # Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
         #
-        # @option arguments [String] :task_type The task type (options: chat_completion, completion, rerank, text_embedding)
-        # @option arguments [String] :huggingface_inference_id The inference Id
-        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created.
+        # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
+        # @option arguments [String] :huggingface_inference_id The unique identifier of the inference endpoint. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The inference endpoint's task and service settings (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-hugging-face.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-hugging-face
         #
         def put_hugging_face(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put_hugging_face' }
 
-          defined_params = %i[task_type huggingface_inference_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:task_type, :huggingface_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[:huggingface_inference_id]
@@ -58,8 +73,8 @@ module Elasticsearch
           _huggingface_inference_id = arguments.delete(:huggingface_inference_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_huggingface_inference_id)}"
-          params = Utils.process_params(arguments)
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_huggingface_inference_id)}"
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -15,34 +15,44 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash 589cd632d091bc0a512c46d5d81ac1f961b60127
-# @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 Inference
       module Actions
-        # Create an JinaAI inference endpoint
+        # Create an JinaAI inference endpoint.
+        # Create an inference endpoint to perform an inference task with the +jinaai+ service.
+        # To review the available +rerank+ models, refer to <https://jina.ai/reranker>.
+        # To review the available +text_embedding+ models, refer to the <https://jina.ai/embeddings/>.
+        # When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
+        # After creating the endpoint, wait for the model deployment to complete before using it.
+        # To verify the deployment status, use the get trained model statistics API.
+        # Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
+        # Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
         #
-        # @option arguments [String] :task_type The task type (options: rerank, text_embedding)
-        # @option arguments [String] :jinaai_inference_id The inference Id
-        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created.
+        # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
+        # @option arguments [String] :jinaai_inference_id The unique identifier of the inference endpoint. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The inference endpoint's task and service settings (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-jinaai.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-jinaai
         #
         def put_jinaai(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put_jinaai' }
 
-          defined_params = %i[task_type jinaai_inference_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:task_type, :jinaai_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 'jinaai_inference_id' missing" unless arguments[:jinaai_inference_id]
+
+          unless arguments[:jinaai_inference_id]
+            raise ArgumentError,
+                  "Required argument 'jinaai_inference_id' missing"
+          end
 
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
@@ -54,8 +64,8 @@ module Elasticsearch
           _jinaai_inference_id = arguments.delete(:jinaai_inference_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_jinaai_inference_id)}"
-          params = Utils.process_params(arguments)
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_jinaai_inference_id)}"
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -15,32 +15,37 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash 589cd632d091bc0a512c46d5d81ac1f961b60127
-# @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 Inference
       module Actions
-        # Create a Mistral inference endpoint
+        # Create a Mistral inference endpoint.
+        # Creates an inference endpoint to perform an inference task with the +mistral+ service.
+        # When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
+        # After creating the endpoint, wait for the model deployment to complete before using it.
+        # To verify the deployment status, use the get trained model statistics API.
+        # Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
+        # Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
         #
-        # @option arguments [String] :task_type The task type (options: text_embedding, completion, chat_completion)
-        # @option arguments [String] :mistral_inference_id The inference Id
-        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created.
+        # @option arguments [String] :task_type The task type.
+        #  The only valid task type for the model to perform is +text_embedding+. (*Required*)
+        # @option arguments [String] :mistral_inference_id The unique identifier of the inference endpoint. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The inference endpoint's task and service settings (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-mistral.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-mistral
         #
         def put_mistral(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put_mistral' }
 
-          defined_params = %i[task_type mistral_inference_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:task_type, :mistral_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[:mistral_inference_id]
@@ -58,8 +63,8 @@ module Elasticsearch
           _mistral_inference_id = arguments.delete(:mistral_inference_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_mistral_inference_id)}"
-          params = Utils.process_params(arguments)
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_mistral_inference_id)}"
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -15,34 +15,43 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash 589cd632d091bc0a512c46d5d81ac1f961b60127
-# @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 Inference
       module Actions
-        # Create an OpenAI inference endpoint
+        # Create an OpenAI inference endpoint.
+        # Create an inference endpoint to perform an inference task with the +openai+ service.
+        # When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running.
+        # After creating the endpoint, wait for the model deployment to complete before using it.
+        # To verify the deployment status, use the get trained model statistics API.
+        # Look for +"state": "fully_allocated"+ in the response and ensure that the +"allocation_count"+ matches the +"target_allocation_count"+.
+        # Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
         #
-        # @option arguments [String] :task_type The task type (options: chat_completion, completion, text_embedding)
-        # @option arguments [String] :openai_inference_id The inference ID
-        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created.
+        # @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] :openai_inference_id The unique identifier of the inference endpoint. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The inference endpoint's task and service settings (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-openai.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-openai
         #
         def put_openai(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put_openai' }
 
-          defined_params = %i[task_type openai_inference_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:task_type, :openai_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 'openai_inference_id' missing" unless arguments[:openai_inference_id]
+
+          unless arguments[:openai_inference_id]
+            raise ArgumentError,
+                  "Required argument 'openai_inference_id' missing"
+          end
 
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
@@ -54,8 +63,8 @@ module Elasticsearch
           _openai_inference_id = arguments.delete(:openai_inference_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_openai_inference_id)}"
-          params = Utils.process_params(arguments)
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_openai_inference_id)}"
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -15,32 +15,32 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash 589cd632d091bc0a512c46d5d81ac1f961b60127
-# @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 Inference
       module Actions
-        # Create a VoyageAI inference endpoint
+        # Create a VoyageAI inference endpoint.
+        # Create an inference endpoint to perform an inference task with the +voyageai+ service.
+        # Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
         #
-        # @option arguments [String] :task_type The task type (options: text_embedding, rerank)
-        # @option arguments [String] :voyageai_inference_id The inference ID
-        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created.
+        # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*)
+        # @option arguments [String] :voyageai_inference_id The unique identifier of the inference endpoint. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The inference endpoint's task and service settings (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/infer-service-voyageai.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-voyageai
         #
         def put_voyageai(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put_voyageai' }
 
-          defined_params = %i[task_type voyageai_inference_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:task_type, :voyageai_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[:voyageai_inference_id]
@@ -58,8 +58,8 @@ module Elasticsearch
           _voyageai_inference_id = arguments.delete(:voyageai_inference_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_voyageai_inference_id)}"
-          params = Utils.process_params(arguments)
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_voyageai_inference_id)}"
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)