elastic-enterprise-search 0.3.1 → 7.12.1

data/lib/elastic/app-search/api/log_clickthrough.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Click - Send data about clicked results
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :query_text Search query text (*Required*)
+        # @option arguments :document_id The ID of the document that was clicked on (*Required*)
+        # @option arguments [String] :request_id The request ID returned in the meta tag of a search API response
+        # @option arguments [Array] :tags Array of strings representing additional information you wish to track with the clickthrough
+        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/clickthrough.html
+        #
+        def log_clickthrough(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'query_text' missing" unless arguments[:query_text]
+          raise ArgumentError, "Required parameter 'document_id' missing" unless arguments[:document_id]
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+          arguments['query'] = arguments.delete(:query_text)
+
+          request(
+            :post,
+            "api/as/v1/engines/#{engine_name}/click/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/multi_search.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Search - Run several search in the same request
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Object] :body One or more queries to execute in parallel (*Required*)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/multi-search.html
+        #
+        def multi_search(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/as/v1/engines/#{engine_name}/multi_search/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/put_curation.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Curations - Update an existing curation
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Array] :queries List of affected search queries (*Required*)
+        # @option arguments [String] :curation_id  (*Required*)
+        # @option arguments :promoted_doc_ids List of promoted document IDs
+        # @option arguments :hidden_doc_ids List of hidden document IDs
+        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/curations.html#curations-update
+        #
+        def put_curation(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'queries' missing" unless arguments[:queries]
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'curation_id' missing" unless arguments[:curation_id]
+
+          curation_id = arguments[:curation_id]
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :put,
+            "api/as/v1/engines/#{engine_name}/curations/#{curation_id}/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/put_documents.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Documents - Partial update of documents
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Array] :documents List of documents to update (*Required*)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/documents.html#documents-partial
+        #
+        def put_documents(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'documents' missing" unless arguments[:documents]
+
+          documents = arguments.delete(:documents) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :patch,
+            "api/as/v1/engines/#{engine_name}/documents/",
+            arguments,
+            documents,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/put_schema.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Schema - Update schema for the current engine
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Object] :schema Schema description (*Required*)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/schema.html#schema-patch
+        #
+        def put_schema(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'schema' missing" unless arguments[:schema]
+
+          schema = arguments.delete(:schema) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/as/v1/engines/#{engine_name}/schema/",
+            arguments,
+            schema,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/put_search_settings.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Searchsettings - Update search settings for the engine
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Object] :body Search settings (*Required*)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/search-settings.html#search-settings-update
+        #
+        def put_search_settings(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :put,
+            "api/as/v1/engines/#{engine_name}/search_settings/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/put_synonym_set.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Synonyms - Update a synonym set by ID
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :synonym_set_id  (*Required*)
+        # @option arguments [Object] :body Synonym set description (*Required*)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/synonyms.html#synonyms-update
+        #
+        def put_synonym_set(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'synonym_set_id' missing" unless arguments[:synonym_set_id]
+          raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
+
+          synonym_set_id = arguments[:synonym_set_id]
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :put,
+            "api/as/v1/engines/#{engine_name}/synonyms/#{synonym_set_id}/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/query_suggestion.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Querysuggestion - Provide relevant query suggestions for incomplete queries
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :query A partial query for which to receive suggestions (*Required*)
+        # @option arguments [Array] :fields List of fields to use to generate suggestions. Defaults to all text fields
+        # @option arguments [Integer] :size Number of query suggestions to return. Must be between 1 and 20. Defaults to 5
+        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/query-suggestion.html
+        #
+        def query_suggestion(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'query' missing" unless arguments[:query]
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/as/v1/engines/#{engine_name}/query_suggestion/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/reset_search_settings.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Searchsettings - Reset search settings for the engine
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/search-settings.html#search-settings-reset
+        #
+        def reset_search_settings(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/as/v1/engines/#{engine_name}/search_settings/reset/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end