elastic-enterprise-search 7.15.1 → 7.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af43f95c32828fa2a4c5d44f12f430ebaf6ca3ec3fee1f1d6c48b02348e15bee
-  data.tar.gz: eb3df761787c3e537cff53bb50c2a44eedacb4dc99c4c609b303bd1ef3734c3d
+  metadata.gz: e3331736a101d1b938e0911742b67fe42a42849e179e8f5b575f9f2b07dafda2
+  data.tar.gz: 3ef839006353cd13259ec36ddf0244c2c6812f19add3a04b48dd169e2d66238c
 SHA512:
-  metadata.gz: 50e6b28a6b395d26ea2bde7a00211b381d85d3483cda75b6d254d53b14f076c07f88306e2dea718a409ad8412faedfd2dd59062e4a75712bd5071ea6fba0901a
-  data.tar.gz: 8a38e574a9a7877afa2aa7bcc1ca377ebff4d71c122dec2c8b43bf9e441ef89f908a42055b42f111e9bfa1db24423819e4da867f8575f74350f7adf91d2dc810
+  metadata.gz: 5f1d529bdbd13f0c550bee3f475ee799ec537e39ffc172b18119a194fe61c27a8452c56e1cd1ee8cb68a6d60fb56da92bc4cadad82d35650119df7ef21647e09
+  data.tar.gz: 36465dbde68f27f1d39a7afb829e890e6ccda5c6b4fce70186ecc229ada201de89a13fbbd198d2c6a5b483ac4e4e5c28abd516633d5a45c7b241bc2ecc92d6ff

data/.ci/test-matrix.yml

@@ -6,7 +6,7 @@ RUBY_VERSION:
   - 2.5
 
 STACK_VERSION:
-  - 7.15-SNAPSHOT
+  - 7.16-SNAPSHOT
 
 SERVICE:
   - appsearch

data/.github/workflows/testing.yml

@@ -1,4 +1,4 @@
-name: 7.15
+name: 7.x
 on: [push, pull_request]
 
 jobs:

data/docs/guide/app-search-api.asciidoc

@@ -196,6 +196,9 @@ client.create_crawler_domain(engine_name, body: body)
 # Get crawler domain information
 client.crawler_domain(engine_name, domain_id: domain_id)
 
+# List crawler domains
+client.list_crawler_domains(engine_name)
+
 # Update a crawler domain
 body = { name: 'https://www.wikipedia.org' }
 client.put_crawler_domain(engine_name, domain_id: domain_id, domain: body)
@@ -301,6 +304,29 @@ client.crawler_process_crawl_denied_urls(engine_name, process_crawl_id: id)
 # Cancel an active crawl request, stopping a running crawl if needed.
 client.delete_crawler_active_crawl_request(engine_name)
 ----------------------------
+=== Adaptive Relevance
+
+
+The adaptive relevance API is a **beta** feature. Beta features are subject to change and are not covered by the support SLA of general release (GA) features. Elastic plans to promote this feature to GA in a future release. The adaptive relevance API is not available at all Elastic subscription levels. Refer to the Elastic subscriptions pages for https://www.elastic.co/subscriptions/cloud[Elastic Cloud] and https://www.elastic.co/subscriptions[self-managed] deployments.
+
+[source,rb]
+----------------------------
+# Retrieve adaptive relevance settings
+client.adaptive_relevance_settings(engine_name)
+
+# Update adaptive relevance settings for an engine
+body = { curation: { enabled: true } }
+client.put_adaptive_relevance_settings(engine_name, body: body)
+
+# List suggestions
+client.list_adaptive_relevance_suggestions(engine_name)
+
+# Update adaptive relevance
+client.put_adaptive_relevance_suggestions(engine_name, body: body)
+
+# Retrive adaptive relevance
+client.adaptive_relevance_suggestions(engine_name, search_suggestion_query: 'suggestion')
+----------------------------
 
 === Other API Endpoints
 

data/docs/guide/release_notes/716.asciidoc

@@ -0,0 +1,16 @@
+[[release_notes_716]]
+=== 7.16 Release notes
+
+[discrete]
+==== General
+
+- Tested with Elastic Enterprise Search API version 7.16.0.
+
+[discrete]
+==== App Search
+
+- Adds Adaptive Relevance APIs. The adaptive relevance API is a **beta** feature. Beta features are subject to change and are not covered by the support SLA of general release (GA) features. Elastic plans to promote this feature to GA in a future release. The adaptive relevance API is not available at all Elastic subscription levels. Refer to the Elastic subscriptions pages for https://www.elastic.co/subscriptions/cloud[Elastic Cloud] and https://www.elastic.co/subscriptions[self-managed] deployments: `adaptive_relevance_settings`, `adaptive_relevance_suggestions`, `list adaptive_relevance_suggestions`, `put_adaptive_relevance_settings`, `put_adaptive_relevance_suggestions`.
+- Adds `list_crawler_domains` - Returns a list of crawler domains
+
+==== Workplace Search
+- Adds `list_documents` -  List documents from a custom content source

data/docs/guide/release_notes/index.asciidoc

@@ -5,6 +5,7 @@
 [discrete]
 === 7.x
 
+* <<release_notes_716, 7.16.0 Release Notes>>
 * <<release_notes_715, 7.15.0 Release Notes>>
 * <<release_notes_714, 7.14.0 Release Notes>>
 * <<release_notes_713, 7.13.0 Release Notes>>
@@ -12,6 +13,7 @@
 * <<release_notes_711, 7.11.0 Release Notes>>
 * <<release_notes_710, 7.10.0.beta.1 Release Notes>>
 
+include::716.asciidoc[]
 include::715.asciidoc[]
 include::714.asciidoc[]
 include::713.asciidoc[]

data/docs/guide/workplace-search-api.asciidoc

@@ -59,6 +59,9 @@ response = client.index_documents(content_source_id, body: documents)
 # Retrieve a document by ID from a specified content source
 client.document(content_source_id, document_id: '75015d85370d')
 
+# List documents from a custom content source
+client.list_documents(content_source_id)
+
 # Delete Documents
 client.delete_documents(content_source_id, document_ids: ['e68fbc2688f1', 'c535e226aee3'])
 

data/lib/elastic/app-search/api/adaptive_relevance_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
+        # AdaptiveRelevanceSettings - Retrieve adaptive relevance settings
+        # Retrieve adaptive relevance settings
+        #
+        # @param engine_name [String] Name of the engine (*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/adaptive-relevance-api-reference.html#adaptive-relevance-api-get-engine-adaptive-relevance-settings
+        #
+        def adaptive_relevance_settings(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            "api/as/v0/engines/#{engine_name}/adaptive_relevance/settings/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# 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
+        # AdaptiveRelevanceSuggestions - Retrieve adaptive relevance
+        # Retrieve adaptive relevance for a single query
+        #
+        # @param engine_name [String] Name of the engine (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :search_suggestion_query Query to obtain suggestions (*Required*)
+        # @option arguments [Hash] :body
+        # @option body :page
+        # @option body :filters
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-get-engine-adaptive-relevance-suggestions-query
+        #
+        def adaptive_relevance_suggestions(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'search_suggestion_query' missing" unless arguments[:search_suggestion_query]
+
+          search_suggestion_query = arguments[:search_suggestion_query]
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/as/v0/engines/#{engine_name}/adaptive_relevance/suggestions/#{search_suggestion_query}/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -28,7 +28,7 @@ module Elastic
         # @option arguments [String] :body
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
-        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-validate-domain
         #
         def crawler_domain_validation_result(arguments = {})
           body = arguments.delete(:body) || {}

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

@@ -27,10 +27,9 @@ module Elastic
         # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
         # @option arguments [String] :body
-        # @option arguments [String] :url (*Required*)
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
-        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-trace-url
         #
         def crawler_url_tracing_result(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name

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

@@ -27,10 +27,9 @@ module Elastic
         # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
         # @option arguments [String] :body
-        # @option arguments [String] :url (*Required*)
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
-        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-validate-url
         #
         def crawler_url_validation_result(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name

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

@@ -33,6 +33,7 @@ module Elastic
         # @option body [String] :policy  (*Required)
         # @option body [String] :rule  (*Required)
         # @option body [String] :pattern  (*Required)
+        # @option body [String] :created_at
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawl-rules

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

@@ -30,6 +30,7 @@ module Elastic
         # @option arguments [Hash] :body  (Required: value)
         # @option body [String] :id
         # @option body [String] :value  (*Required)
+        # @option body [String] :created_at
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-entry-points

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

@@ -30,6 +30,7 @@ module Elastic
         # @option arguments [Hash] :body  (Required: url)
         # @option body [String] :id
         # @option body [String] :url  (*Required)
+        # @option body [String] :created_at
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-sitemaps

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

@@ -31,6 +31,7 @@ module Elastic
         # @option body [Array] :queries List of affected search queries (*Required)
         # @option body [Array] :promoted List of promoted document IDs
         # @option body [Array] :hidden List of hidden document IDs
+        # @option body :suggestion
         # @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-create

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

@@ -0,0 +1,53 @@
+# 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
+        # AdaptiveRelevanceSuggestions - Retrieve adaptive relevance
+        # Retrieve adaptive relevance
+        #
+        # @param engine_name [String] Name of the engine (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Hash] :body
+        # @option body :page
+        # @option body :filters
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-get-engine-adaptive-relevance-suggestions
+        #
+        def list_adaptive_relevance_suggestions(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/v0/engines/#{engine_name}/adaptive_relevance/suggestions/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/list_crawler_domains.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
+        # Crawler - List crawler domains
+        # Returns a list of crawler domains
+        #
+        # @param engine_name [String] Name of the engine (*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/web-crawler-api-reference.html#web-crawler-apis-get-crawler-domain
+        #
+        def list_crawler_domains(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            "api/as/v0/engines/#{engine_name}/crawler/domains/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -26,11 +26,11 @@ module Elastic
         #
         # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments :body Search request parameters
-        # @option body [String] :query Search query text (*Required*)
-        # @option body [String] :document_id The id of the document that was clicked on (*Required*)
-        # @option body [String] :request_id The request id returned in the meta tag of a search API response
-        # @option body [Array] :tags Array of strings representing additional information you wish to track with the clickthrough. You may submit up to 16 tags, and each may be up to 64 characters in length.
+        # @option arguments [Hash] :body  (Required: query, document_id)
+        # @option body [String] :query  (*Required)
+        # @option body [String] :request_id
+        # @option body :document_id  (*Required)
+        # @option body [Array] :tags
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/clickthrough.html

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

@@ -0,0 +1,52 @@
+# 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
+        # AdaptiveRelevanceSettings - Update adaptive relevance settings
+        # Update adaptive relevance settings
+        #
+        # @param engine_name [String] Name of the engine (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Hash] :body  (Required: curation)
+        # @option body [Object] :curation  (*Required)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-put-engine-adaptive-relevance-settings
+        #
+        def put_adaptive_relevance_settings(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :put,
+            "api/as/v0/engines/#{engine_name}/adaptive_relevance/settings/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/put_adaptive_relevance_suggestions.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
+        # AdaptiveRelevanceSuggestions - Update adaptive relevance
+        # Update adaptive relevance
+        #
+        # @param engine_name [String] Name of the engine (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Array] :body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/adaptive-relevance-api-reference.html#adaptive-relevance-api-put-engine-adaptive-relevance-suggestions
+        #
+        def put_adaptive_relevance_suggestions(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :put,
+            "api/as/v0/engines/#{engine_name}/adaptive_relevance/suggestions/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -34,6 +34,7 @@ module Elastic
         # @option body [String] :policy  (*Required)
         # @option body [String] :rule  (*Required)
         # @option body [String] :pattern  (*Required)
+        # @option body [String] :created_at
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-put-crawl-rule

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

@@ -31,6 +31,7 @@ module Elastic
         # @option arguments [Hash] :body  (Required: value)
         # @option body [String] :id
         # @option body [String] :value  (*Required)
+        # @option body [String] :created_at
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-put-entry-point

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

@@ -31,6 +31,7 @@ module Elastic
         # @option arguments [Hash] :body  (Required: url)
         # @option body [String] :id
         # @option body [String] :url  (*Required)
+        # @option body [String] :created_at
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-put-sitemap

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

@@ -32,6 +32,7 @@ module Elastic
         # @option body [Array] :queries List of affected search queries (*Required)
         # @option body [Array] :promoted List of promoted document IDs
         # @option body [Array] :hidden List of hidden document IDs
+        # @option body :suggestion
         # @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

data/lib/elastic/enterprise-search/version.rb

@@ -19,6 +19,6 @@
 
 module Elastic
   module EnterpriseSearch
-    VERSION = '7.15.1'
+    VERSION = '7.16.0'
   end
 end

data/lib/elastic/workplace-search/api/list_documents.rb

@@ -0,0 +1,55 @@
+# 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 WorkplaceSearch
+      module Actions
+        # Documents - Lists documents from a custom content source
+        # Lists documents from a custom content source
+        #
+        # @param content_source_id [String] Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Hash] :body
+        # @option body [Object] :page Paging controls for the result set
+        # @option body :filters
+        # @option body :sort
+        # @option body [String] :cursor
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-custom-sources-api.html#list-documents
+        #
+        def list_documents(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/ws/v1/sources/#{content_source_id}/documents/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/spec/integration/app-search/adaptive_relevance_spec.rb

@@ -0,0 +1,80 @@
+# 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.
+
+# frozen_string_literal: true
+
+require_relative "#{__dir__}/app_search_helper.rb"
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  context 'Adaptive Relevance' do
+    let(:engine_name) { 'adaptive-relevance' }
+
+    before do
+      create_engine(engine_name)
+    end
+
+    after do
+      delete_engines
+    end
+
+    it 'retrieves adaptive relevance settings' do
+      response = client.adaptive_relevance_settings(engine_name)
+      expect(response.body['curation'])
+      expect(response.status).to eq 200
+    end
+
+    it 'updates settings and lists adaptive relevance for an engine' do
+      body = { curation: { enabled: true } }
+      # Enables curations
+      response = client.put_adaptive_relevance_settings(engine_name, body: body)
+      expect(response.status).to eq 200
+      expect(response.body.dig('curation', 'enabled'))
+
+      # Lists suggestions
+      response = client.list_adaptive_relevance_suggestions(engine_name)
+      expect(response.status).to eq 200
+      expect(response.body['meta'])
+      expect(response.body['results'])
+    end
+
+    xit 'updates adaptive relevance' do
+      body = { curation: { enabled: true } }
+      client.put_adaptive_relevance_settings(engine_name, body: body)
+
+      # Index document and create curation:
+      id = client.index_documents(engine_name, documents: [{ title: 'experiment' }]).body.first['id']
+      body = { queries: ['test'], promoted: [id] }
+      client.create_curation(engine_name, body: body)
+      body = [{ query: 'test', type: 'curation', status: 'applied' }]
+      response = client.put_adaptive_relevance_suggestions(engine_name, body: body)
+
+      expect(response.status).to eq 200
+    end
+
+    xit 'retrieves an adaptive relevance' do
+      # Enables curations
+      client.put_adaptive_relevance_settings(engine_name, body: { curation: { enabled: true } })
+      id = client.index_documents(engine_name, documents: [{ title: 'experiment' }]).body.first['id']
+      body = { queries: ['test'], promoted: [id] }
+      client.create_curation(engine_name, body: body)
+
+      response = client.adaptive_relevance_suggestions(engine_name, search_suggestion_query: 'test')
+      expect(response.status).to eq 200
+      expect(response.body)
+    end
+  end
+end

data/spec/integration/app-search/api_logs_spec.rb

@@ -39,7 +39,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
     end
 
     after do
-      client.delete_engine(engine_name)
+      delete_engines
       client.delete_api_key(api_key_name: api_key_name)
     end
 

data/spec/integration/app-search/crawler_domain_spec.rb

@@ -34,7 +34,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
       sleep 1
     end
 
-    it 'creates and gets a crawler domain' do
+    it 'creates, gets and lists a crawler domain' do
       body = { name: name }
       response = client.create_crawler_domain(engine_name, body: body)
       @domain = response.body
@@ -48,6 +48,11 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
       expect(response.status).to eq 200
       expect(response.body['id']).to eq @domain['id']
       expect(response.body).to include('name' => name)
+
+      # client.list_crawler_domains
+      response = client.list_crawler_domains(engine_name)
+      expect(response.status).to eq 200
+      expect(response.body['results'].first['id']).to eq(@domain['id'])
     end
 
     it 'creates and updates a crawler domain' do

data/spec/integration/workplace-search/documents_spec.rb

@@ -67,6 +67,13 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
       expect(response.body['id']).to eq document_id
     end
 
+    it 'Lists documents in a content source' do
+      response = client.list_documents(content_source_id)
+      expect(response.status).to eq 200
+      expect(response.body['results'])
+      expect(response.body['meta'])
+    end
+
     it 'Deletes all documents in a content source' do
       response = client.delete_all_documents(content_source_id)
       expect(response.status).to eq 200

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-enterprise-search
 version: !ruby/object:Gem::Version
-  version: 7.15.1
+  version: 7.16.0
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch-transport
@@ -201,12 +201,15 @@ files:
 - docs/guide/release_notes/713.asciidoc
 - docs/guide/release_notes/714.asciidoc
 - docs/guide/release_notes/715.asciidoc
+- docs/guide/release_notes/716.asciidoc
 - docs/guide/release_notes/index.asciidoc
 - docs/guide/workplace-search-api.asciidoc
 - elastic-enterprise-search.gemspec
 - lib/data/ca-bundle.crt
 - lib/elastic-enterprise-search.rb
 - lib/elastic/.rubocop.yml
+- lib/elastic/app-search/api/adaptive_relevance_settings.rb
+- lib/elastic/app-search/api/adaptive_relevance_suggestions.rb
 - lib/elastic/app-search/api/add_meta_engine_source.rb
 - lib/elastic/app-search/api/api_key.rb
 - lib/elastic/app-search/api/api_logs.rb
@@ -252,8 +255,10 @@ files:
 - lib/elastic/app-search/api/documents.rb
 - lib/elastic/app-search/api/engine.rb
 - lib/elastic/app-search/api/index_documents.rb
+- lib/elastic/app-search/api/list_adaptive_relevance_suggestions.rb
 - lib/elastic/app-search/api/list_api_keys.rb
 - lib/elastic/app-search/api/list_crawler_crawl_requests.rb
+- lib/elastic/app-search/api/list_crawler_domains.rb
 - lib/elastic/app-search/api/list_crawler_process_crawls.rb
 - lib/elastic/app-search/api/list_curations.rb
 - lib/elastic/app-search/api/list_documents.rb
@@ -261,6 +266,8 @@ files:
 - lib/elastic/app-search/api/list_synonym_sets.rb
 - lib/elastic/app-search/api/log_clickthrough.rb
 - lib/elastic/app-search/api/multi_search.rb
+- lib/elastic/app-search/api/put_adaptive_relevance_settings.rb
+- lib/elastic/app-search/api/put_adaptive_relevance_suggestions.rb
 - lib/elastic/app-search/api/put_api_key.rb
 - lib/elastic/app-search/api/put_crawler_crawl_rule.rb
 - lib/elastic/app-search/api/put_crawler_crawl_schedule.rb
@@ -312,6 +319,7 @@ files:
 - lib/elastic/workplace-search/api/external_identity.rb
 - lib/elastic/workplace-search/api/index_documents.rb
 - lib/elastic/workplace-search/api/list_content_sources.rb
+- lib/elastic/workplace-search/api/list_documents.rb
 - lib/elastic/workplace-search/api/list_external_identities.rb
 - lib/elastic/workplace-search/api/list_permissions.rb
 - lib/elastic/workplace-search/api/list_synonym_sets.rb
@@ -336,6 +344,7 @@ files:
 - spec/fixtures/vcr/workplace_search/create_analytics_event.yml
 - spec/fixtures/vcr/workplace_search/oauth_request_token.yml
 - spec/fixtures/vcr/workplace_search/search_request.yml
+- spec/integration/app-search/adaptive_relevance_spec.rb
 - spec/integration/app-search/api_key_spec.rb
 - spec/integration/app-search/api_logs_spec.rb
 - spec/integration/app-search/app_search_helper.rb