elasticsearch-api 8.19.3 → 9.0.0

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

@@ -15,21 +15,21 @@
 # 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
         # Perform completion inference on the service
         #
-        # @option arguments [String] :inference_id The inference Id
-        # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete.
+        # @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 The inference payload (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/post-inference-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference
         #
         def completion(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.completion' }
@@ -39,7 +39,6 @@ module Elasticsearch
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
 
-          raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
           raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id]
 
           arguments = arguments.clone
@@ -50,7 +49,7 @@ module Elasticsearch
           _inference_id = arguments.delete(:inference_id)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_inference/completion/#{Utils.__listify(_inference_id)}"
+          path   = "_inference/completion/#{Utils.listify(_inference_id)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,27 +15,27 @@
 # 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
         # Delete an inference endpoint
         #
-        # @option arguments [String] :inference_id The inference Id
-        # @option arguments [String] :task_type The task type (options: sparse_embedding, text_embedding, rerank, completion, chat_completion)
-        # @option arguments [Boolean] :dry_run If true the endpoint will not be deleted and a list of ingest processors which reference this endpoint will be returned.
-        # @option arguments [Boolean] :force If true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields).
+        # @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] :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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-inference-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-delete
         #
         def delete(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.delete' }
 
-          defined_params = %i[inference_id task_type].each_with_object({}) do |variable, set_variables|
+          defined_params = [:inference_id, :task_type].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?
@@ -47,15 +47,15 @@ module Elasticsearch
 
           body = nil
 
-          _inference_id = arguments.delete(:inference_id)
-
           _task_type = arguments.delete(:task_type)
 
+          _inference_id = arguments.delete(:inference_id)
+
           method = Elasticsearch::API::HTTP_DELETE
           path   = if _task_type && _inference_id
-                     "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}"
+                     "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_inference_id)}"
                    else
-                     "_inference/#{Utils.__listify(_inference_id)}"
+                     "_inference/#{Utils.listify(_inference_id)}"
                    end
           params = Utils.process_params(arguments)
 

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

@@ -15,25 +15,25 @@
 # 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
         # Get an inference endpoint
         #
+        # @option arguments [String] :task_type The task type
         # @option arguments [String] :inference_id The inference Id
-        # @option arguments [String] :task_type The task type (options: sparse_embedding, text_embedding, rerank, completion, chat_completion)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-inference-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-get
         #
         def get(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.get' }
 
-          defined_params = %i[inference_id task_type].each_with_object({}) do |variable, set_variables|
+          defined_params = [:inference_id, :task_type].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?
@@ -43,15 +43,15 @@ module Elasticsearch
 
           body = nil
 
-          _inference_id = arguments.delete(:inference_id)
-
           _task_type = arguments.delete(:task_type)
 
+          _inference_id = arguments.delete(:inference_id)
+
           method = Elasticsearch::API::HTTP_GET
           path   = if _task_type && _inference_id
-                     "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}"
+                     "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_inference_id)}"
                    elsif _inference_id
-                     "_inference/#{Utils.__listify(_inference_id)}"
+                     "_inference/#{Utils.listify(_inference_id)}"
                    else
                      '_inference'
                    end

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

@@ -15,32 +15,35 @@
 # 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
-        # Perform inference on the service
+        # Perform inference on the service.
+        # This API enables you to use machine learning models to perform specific tasks on data that you provide as an input.
+        # It returns a response with the results of the tasks.
+        # The inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API.
+        # For details about using this API with a service, such as Amazon Bedrock, Anthropic, or HuggingFace, refer to the service-specific documentation.
         #
-        # @option arguments [String] :inference_id The inference Id
-        # @option arguments [String] :task_type The task type (options: sparse_embedding, text_embedding, rerank, completion, chat_completion)
-        # @option arguments [Time] :timeout The amount of time to wait for the inference request to complete.
+        # @option arguments [String] :task_type The type of inference task that the model performs.
+        # @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.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The inference payload (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/post-inference-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference
         #
         def inference(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.inference' }
 
-          defined_params = %i[inference_id task_type].each_with_object({}) do |variable, set_variables|
+          defined_params = [:inference_id, :task_type].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 'inference_id' missing" unless arguments[:inference_id]
 
           arguments = arguments.clone
@@ -48,15 +51,15 @@ module Elasticsearch
 
           body = arguments.delete(:body)
 
-          _inference_id = arguments.delete(:inference_id)
-
           _task_type = arguments.delete(:task_type)
 
+          _inference_id = arguments.delete(:inference_id)
+
           method = Elasticsearch::API::HTTP_POST
           path   = if _task_type && _inference_id
-                     "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}"
+                     "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_inference_id)}"
                    else
-                     "_inference/#{Utils.__listify(_inference_id)}"
+                     "_inference/#{Utils.listify(_inference_id)}"
                    end
           params = Utils.process_params(arguments)
 

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

@@ -15,27 +15,34 @@
 # 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 inference endpoint
+        # Create an inference endpoint.
+        # 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.
+        # 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, Mistral, Azure OpenAI, 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.
         #
-        # @option arguments [String] :inference_id The inference Id
-        # @option arguments [String] :task_type The task type (options: sparse_embedding, text_embedding, rerank, completion, chat_completion)
-        # @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
+        # @option arguments [String] :inference_id The inference 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 inference_config
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.19/put-inference-api.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put
         #
         def put(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put' }
 
-          defined_params = %i[inference_id task_type].each_with_object({}) do |variable, set_variables|
+          defined_params = [:inference_id, :task_type].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?
@@ -48,17 +55,17 @@ module Elasticsearch
 
           body = arguments.delete(:body)
 
-          _inference_id = arguments.delete(:inference_id)
-
           _task_type = arguments.delete(:task_type)
 
+          _inference_id = arguments.delete(:inference_id)
+
           method = Elasticsearch::API::HTTP_PUT
           path   = if _task_type && _inference_id
-                     "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}"
+                     "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_inference_id)}"
                    else
-                     "_inference/#{Utils.__listify(_inference_id)}"
+                     "_inference/#{Utils.listify(_inference_id)}"
                    end
-          params = Utils.process_params(arguments)
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/inference/put_alibabacloud.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 AlibabaCloud AI Search inference endpoint
+        # Create an AlibabaCloud AI Search inference endpoint.
+        # Create an inference endpoint to perform an inference task with the +alibabacloud-ai-search+ 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, sparse_embedding, text_embedding)
-        # @option arguments [String] :alibabacloud_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] :alibabacloud_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-alibabacloud-ai-search.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-alibabacloud
         #
         def put_alibabacloud(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put_alibabacloud' }
 
-          defined_params = %i[task_type alibabacloud_inference_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:task_type, :alibabacloud_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[:alibabacloud_inference_id]
@@ -58,8 +62,8 @@ module Elasticsearch
           _alibabacloud_inference_id = arguments.delete(:alibabacloud_inference_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_alibabacloud_inference_id)}"
-          params = Utils.process_params(arguments)
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_alibabacloud_inference_id)}"
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -15,32 +15,31 @@
 # 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 Amazon Bedrock inference endpoint
+        # Create an Amazon Bedrock inference endpoint.
+        # Creates an inference endpoint to perform an inference task with the +amazonbedrock+ service.
         #
-        # @option arguments [String] :task_type The task type (options: completion, text_embedding)
-        # @option arguments [String] :amazonbedrock_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] :amazonbedrock_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-amazon-bedrock.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-amazonbedrock
         #
         def put_amazonbedrock(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put_amazonbedrock' }
 
-          defined_params = %i[task_type amazonbedrock_inference_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:task_type, :amazonbedrock_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[:amazonbedrock_inference_id]
@@ -58,8 +57,8 @@ module Elasticsearch
           _amazonbedrock_inference_id = arguments.delete(:amazonbedrock_inference_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_amazonbedrock_inference_id)}"
-          params = Utils.process_params(arguments)
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_amazonbedrock_inference_id)}"
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/inference/put_anthropic.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 an Anthropic inference endpoint
+        # Create an Anthropic inference endpoint.
+        # Create an inference endpoint to perform an inference task with the +anthropic+ 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)
-        # @option arguments [String] :anthropic_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 +completion+. (*Required*)
+        # @option arguments [String] :anthropic_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-anthropic.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-anthropic
         #
         def put_anthropic(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put_anthropic' }
 
-          defined_params = %i[task_type anthropic_inference_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:task_type, :anthropic_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[:anthropic_inference_id]
@@ -58,8 +63,8 @@ module Elasticsearch
           _anthropic_inference_id = arguments.delete(:anthropic_inference_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_anthropic_inference_id)}"
-          params = Utils.process_params(arguments)
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_anthropic_inference_id)}"
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/inference/put_azureaistudio.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 Azure AI studio inference endpoint
+        # Create an Azure AI studio inference endpoint.
+        # Create an inference endpoint to perform an inference task with the +azureaistudio+ 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] :azureaistudio_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] :azureaistudio_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-azure-ai-studio.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-azureaistudio
         #
         def put_azureaistudio(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put_azureaistudio' }
 
-          defined_params = %i[task_type azureaistudio_inference_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:task_type, :azureaistudio_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[:azureaistudio_inference_id]
@@ -58,8 +62,8 @@ module Elasticsearch
           _azureaistudio_inference_id = arguments.delete(:azureaistudio_inference_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_azureaistudio_inference_id)}"
-          params = Utils.process_params(arguments)
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_azureaistudio_inference_id)}"
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

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

@@ -15,32 +15,41 @@
 # 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 Azure OpenAI inference endpoint
+        # Create an Azure OpenAI inference endpoint.
+        # Create an inference endpoint to perform an inference task with the +azureopenai+ service.
+        # The list of chat completion models that you can choose from in your Azure OpenAI deployment include:
+        # * {https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-4-and-gpt-4-turbo-models GPT-4 and GPT-4 Turbo models}
+        # * {https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35 GPT-3.5}
+        # The list of embeddings models that you can choose from in your deployment can be found in the {https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#embeddings Azure models documentation}.
+        # 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] :azureopenai_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] :azureopenai_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-azure-openai.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-azureopenai
         #
         def put_azureopenai(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'inference.put_azureopenai' }
 
-          defined_params = %i[task_type azureopenai_inference_id].each_with_object({}) do |variable, set_variables|
+          defined_params = [:task_type, :azureopenai_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[:azureopenai_inference_id]
@@ -58,8 +67,8 @@ module Elasticsearch
           _azureopenai_inference_id = arguments.delete(:azureopenai_inference_id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_azureopenai_inference_id)}"
-          params = Utils.process_params(arguments)
+          path   = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_azureopenai_inference_id)}"
+          params = {}
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)