opensearch-ruby 4.0.0.pre.beta.1 → 4.0.0.pre.beta.3

data/lib/opensearch/api/actions/ltr/stats.rb

@@ -0,0 +1,41 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Ltr
+      module Actions
+        # Provides information about the current status of the LTR plugin.
+        #
+        # @option args [Enumerable<String>] :node_id Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
+        # @option args [String] :timeout The time in milliseconds to wait for a response.
+        # @option args [Enumerable<String>] :stat Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats.
+        def stats(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _node_id = args.delete('node_id')
+          _stat = args.delete('stat')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_ltr', _node_id, 'stats', _stat)
+
+          Utils.validate_query_params! args, STATS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        STATS_QUERY_PARAMS = Set.new(%w[
+          timeout
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ml/chunk_model.rb

@@ -0,0 +1,40 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Ml
+      module Actions
+        # Uploads model chunk.
+        #
+        # @option args [Integer] :chunk_number *Required*
+        # @option args [String] :model_id *Required*
+        # @option args [Hash] :body
+        def chunk_model(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'chunk_number' missing" if args['chunk_number'].nil?
+          raise ArgumentError, "Required argument 'model_id' missing" if args['model_id'].nil?
+
+          _chunk_number = args.delete('chunk_number')
+          _model_id = args.delete('model_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_ml/models', _model_id, 'chunk', _chunk_number)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ml/create_controller.rb

@@ -0,0 +1,37 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Ml
+      module Actions
+        # Creates a controller.
+        #
+        # @option args [String] :model_id *Required*
+        # @option args [Hash] :body
+        def create_controller(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'model_id' missing" if args['model_id'].nil?
+
+          _model_id = args.delete('model_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_ml/controllers', _model_id)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ml/create_memory.rb

@@ -0,0 +1,32 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Ml
+      module Actions
+        # Create a memory.
+        #
+        # @option args [Hash] :body
+        def create_memory(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_ml/memory'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ml/create_message.rb

@@ -0,0 +1,37 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Ml
+      module Actions
+        # Create a message.
+        #
+        # @option args [String] :memory_id *Required*
+        # @option args [Hash] :body
+        def create_message(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'memory_id' missing" if args['memory_id'].nil?
+
+          _memory_id = args.delete('memory_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_ml/memory', _memory_id, 'messages')
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ml/create_model_meta.rb

@@ -0,0 +1,32 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Ml
+      module Actions
+        # Registers model metadata.
+        #
+        # @option args [Hash] :body
+        def create_model_meta(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_ml/models/meta'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ml/delete_agent.rb

@@ -16,21 +16,19 @@ module OpenSearch
         # Delete an agent.
         #
         # @option args [String] :agent_id *Required*
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete_agent(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'agent_id' missing" if args['agent_id'].nil?
 
           _agent_id = args.delete('agent_id')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_plugins/_ml/agents', _agent_id)
 
           Utils.validate_query_params! args
-          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+          transport.perform_delete_request method, url, args, body, headers
         end
       end
     end

data/lib/opensearch/api/actions/ml/delete_connector.rb

@@ -16,21 +16,19 @@ module OpenSearch
         # Deletes a standalone connector.
         #
         # @option args [String] :connector_id *Required*
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete_connector(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'connector_id' missing" if args['connector_id'].nil?
 
           _connector_id = args.delete('connector_id')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_plugins/_ml/connectors', _connector_id)
 
           Utils.validate_query_params! args
-          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+          transport.perform_delete_request method, url, args, body, headers
         end
       end
     end

data/lib/opensearch/api/actions/ml/delete_controller.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Ml
+      module Actions
+        # Deletes a controller.
+        #
+        # @option args [String] :model_id *Required*
+        def delete_controller(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'model_id' missing" if args['model_id'].nil?
+
+          _model_id = args.delete('model_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_plugins/_ml/controllers', _model_id)
+
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ml/delete_memory.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Ml
+      module Actions
+        # Delete a memory.
+        #
+        # @option args [String] :memory_id *Required*
+        def delete_memory(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'memory_id' missing" if args['memory_id'].nil?
+
+          _memory_id = args.delete('memory_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_plugins/_ml/memory', _memory_id)
+
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ml/delete_model.rb

@@ -16,21 +16,19 @@ module OpenSearch
         # Deletes a model.
         #
         # @option args [String] :model_id *Required*
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete_model(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'model_id' missing" if args['model_id'].nil?
 
           _model_id = args.delete('model_id')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_plugins/_ml/models', _model_id)
 
           Utils.validate_query_params! args
-          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+          transport.perform_delete_request method, url, args, body, headers
         end
       end
     end

data/lib/opensearch/api/actions/ml/delete_model_group.rb

@@ -16,21 +16,19 @@ module OpenSearch
         # Deletes a model group.
         #
         # @option args [String] :model_group_id *Required*
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete_model_group(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'model_group_id' missing" if args['model_group_id'].nil?
 
           _model_group_id = args.delete('model_group_id')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_plugins/_ml/model_groups', _model_group_id)
 
           Utils.validate_query_params! args
-          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+          transport.perform_delete_request method, url, args, body, headers
         end
       end
     end

data/lib/opensearch/api/actions/ml/delete_task.rb

@@ -16,21 +16,19 @@ module OpenSearch
         # Deletes a task.
         #
         # @option args [String] :task_id *Required*
-        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
         def delete_task(args = {})
           args = Utils.clone_and_normalize_arguments(args)
           raise ArgumentError, "Required argument 'task_id' missing" if args['task_id'].nil?
 
           _task_id = args.delete('task_id')
 
-          ignore  = args.delete('ignore') || []
           headers = args.delete('headers') || {}
           body    = args.delete('body')
           method  = 'DELETE'
           url     = Utils.build_url('_plugins/_ml/tasks', _task_id)
 
           Utils.validate_query_params! args
-          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+          transport.perform_delete_request method, url, args, body, headers
         end
       end
     end

data/lib/opensearch/api/actions/ml/execute_agent.rb

@@ -0,0 +1,37 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Ml
+      module Actions
+        # Execute an agent.
+        #
+        # @option args [String] :agent_id *Required*
+        # @option args [Hash] :body
+        def execute_agent(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'agent_id' missing" if args['agent_id'].nil?
+
+          _agent_id = args.delete('agent_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_ml/agents', _agent_id, '_execute')
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ml/execute_algorithm.rb

@@ -0,0 +1,37 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Ml
+      module Actions
+        # Execute an algorithm.
+        #
+        # @option args [String] :algorithm_name *Required*
+        # @option args [Hash] :body
+        def execute_algorithm(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'algorithm_name' missing" if args['algorithm_name'].nil?
+
+          _algorithm_name = args.delete('algorithm_name')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = Utils.build_url('_plugins/_ml/_execute', _algorithm_name)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ml/get_agent.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Ml
+      module Actions
+        # Get an agent.
+        #
+        # @option args [String] :agent_id *Required*
+        def get_agent(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'agent_id' missing" if args['agent_id'].nil?
+
+          _agent_id = args.delete('agent_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_ml/agents', _agent_id)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ml/get_all_memories.rb

@@ -0,0 +1,38 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Ml
+      module Actions
+        # Get all memories.
+        #
+        # @option args [Integer] :max_results The maximum number of results to return. If there are fewer memories than the number set in `max_results`, the response returns only the number of memories that exist. Default is `10`.
+        # @option args [Integer] :next_token The index of the first memory in the sorted list of memories to return. Memories are ordered by `create_time`. For example, if memories `A`, `B`, and `C` exist, `next_token=1` returns memories `B` and `C`. Default is `0` (return all memories).
+        def get_all_memories(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_ml/memory'
+
+          Utils.validate_query_params! args, GET_ALL_MEMORIES_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        GET_ALL_MEMORIES_QUERY_PARAMS = Set.new(%w[
+          max_results
+          next_token
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ml/get_all_messages.rb

@@ -0,0 +1,43 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Ml
+      module Actions
+        # Get all messages in a memory.
+        #
+        # @option args [String] :memory_id *Required*
+        # @option args [Integer] :max_results
+        # @option args [Integer] :next_token
+        def get_all_messages(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'memory_id' missing" if args['memory_id'].nil?
+
+          _memory_id = args.delete('memory_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_ml/memory', _memory_id, 'messages')
+
+          Utils.validate_query_params! args, GET_ALL_MESSAGES_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        GET_ALL_MESSAGES_QUERY_PARAMS = Set.new(%w[
+          max_results
+          next_token
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/ml/get_all_tools.rb

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Ml
+      module Actions
+        # Get tools.
+        #
+        def get_all_tools(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_ml/tools'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end