[API] Adds ml.[infer,start,stop]trained_model_deployment

Author: picandocodigo

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/infer_trained_model_deployment.rb

@@ -0,0 +1,63 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+          # Evaluate a trained model.
+          # This functionality is Experimental and may be changed or removed
+          # completely in a future release. Elastic will take a best effort approach
+          # to fix any issues, but experimental features are not subject to the
+          # support SLA of official GA features.
+          #
+          # @option arguments [String] :model_id The ID of the model to perform inference on
+          # @option arguments [Time] :timeout Controls the time to wait for the inference result
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/ml-df-analytics-apis.html
+          #
+          def infer_trained_model_deployment(arguments = {})
+            raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _model_id = arguments.delete(:model_id)
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_ml/trained_models/#{Elasticsearch::API::Utils.__listify(_model_id)}/deployment/_infer"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments,
+                                                                             ParamsRegistry.get(__method__)
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:infer_trained_model_deployment, [
+            :timeout
+          ].freeze)
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/start_trained_model_deployment.rb

@@ -0,0 +1,63 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+          # Start a trained model deployment.
+          # This functionality is Experimental and may be changed or removed
+          # completely in a future release. Elastic will take a best effort approach
+          # to fix any issues, but experimental features are not subject to the
+          # support SLA of official GA features.
+          #
+          # @option arguments [String] :model_id The ID of the model to deploy
+          # @option arguments [Time] :timeout Controls the time to wait until the model is deployed
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/ml-df-analytics-apis.html
+          #
+          def start_trained_model_deployment(arguments = {})
+            raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _model_id = arguments.delete(:model_id)
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_ml/trained_models/#{Elasticsearch::API::Utils.__listify(_model_id)}/deployment/_start"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments,
+                                                                             ParamsRegistry.get(__method__)
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:start_trained_model_deployment, [
+            :timeout
+          ].freeze)
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/stop_trained_model_deployment.rb

@@ -0,0 +1,54 @@
+# 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.
+
+module Elasticsearch
+  module XPack
+    module API
+      module MachineLearning
+        module Actions
+          # Stop a trained model deployment.
+          # This functionality is Experimental and may be changed or removed
+          # completely in a future release. Elastic will take a best effort approach
+          # to fix any issues, but experimental features are not subject to the
+          # support SLA of official GA features.
+          #
+          # @option arguments [String] :model_id The ID of the model to undeploy
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/ml-df-analytics-apis.html
+          #
+          def stop_trained_model_deployment(arguments = {})
+            raise ArgumentError, "Required argument 'model_id' missing" unless arguments[:model_id]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _model_id = arguments.delete(:model_id)
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_ml/trained_models/#{Elasticsearch::API::Utils.__listify(_model_id)}/deployment/_stop"
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/spec/xpack/machine_learning/infer_trained_model_deployment_spec.rb

@@ -0,0 +1,46 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'client#ml.infer_trained_model_deployment' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_ml/trained_models/foo/deployment/_infer',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.ml.infer_trained_model_deployment(model_id: 'foo')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::XPack::API }.new
+  end
+
+  context 'when a model_id is not provided' do
+    it 'raises an exception' do
+      expect {
+        client.ml.infer_trained_model_deployment
+      }.to raise_exception(ArgumentError)
+    end
+  end
+end

elasticsearch-xpack/spec/xpack/machine_learning/start_trained_model_deployment_spec.rb

@@ -0,0 +1,46 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'client#ml.start_trained_model_deployment' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_ml/trained_models/foo/deployment/_start',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.ml.start_trained_model_deployment(model_id: 'foo')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::XPack::API }.new
+  end
+
+  context 'when a model_id is not provided' do
+    it 'raises an exception' do
+      expect {
+        client.ml.start_trained_model_deployment
+      }.to raise_exception(ArgumentError)
+    end
+  end
+end

elasticsearch-xpack/spec/xpack/machine_learning/stop_trained_model_deployment_spec.rb

@@ -0,0 +1,46 @@
+# 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.
+
+require 'spec_helper'
+
+describe 'client#ml.stop_trained_model_deployment' do
+  let(:expected_args) do
+    [
+      'POST',
+      '_ml/trained_models/foo/deployment/_stop',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.ml.stop_trained_model_deployment(model_id: 'foo')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::XPack::API }.new
+  end
+
+  context 'when a model_id is not provided' do
+    it 'raises an exception' do
+      expect {
+        client.ml.stop_trained_model_deployment
+      }.to raise_exception(ArgumentError)
+    end
+  end
+end