elastic-enterprise-search 8.1.0 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdfa7f9a297b7be12956c4afb18c566ef6362be6f80b7ddcdf210a63de35792b
-  data.tar.gz: c0ea8e919e929a7a9a03dd183198d7a29f49b95a9fc1e044fb6d1c4becf87adf
+  metadata.gz: 5beefad27301e777c767b0759b154f6e0bba47db65e0e02cacd206f4ff2c2696
+  data.tar.gz: 86610a1a51529bf54c454e93f2977a1968887e3737e1bfd2ef058b255a1b1975
 SHA512:
-  metadata.gz: 9bf7a70b4070b475c5929dee3dce93841db5150bd3502b1b22595ed037cc7f9fbb60e4ade158009af80059ee84f727c192663efd4e9913697bb5860110a327f5
-  data.tar.gz: 11ce05ae809478b90e8980b43b0c28fdfa33d79bb3d398fcf832d1bdb25c7495600cde089bb9d448d3a39599e17484c59bce1704f8f4f0fc5fc362eb2215ce37
+  metadata.gz: f0e0e3f3bcf5994ea89f6dc399527c1a02b5b2699ed3af62fedf9d7bf62b32d2c475b104988190b7be5f1d1368ed73241f53392c6934663a76425648bfadf5f7
+  data.tar.gz: 691d3a79357db4880f777fd4a6975c9a434ade303037d7a94523d82e67266c553d7fded40e7f883b6e283d438b7a66d8d8dce7a72a48c4387c65b746c359aa4b

data/.ci/jobs/{elastic+enterprise-search-ruby+7.15.yml → elastic+enterprise-search-ruby+7.17.yml}

@@ -1,12 +1,12 @@
 ---
 - job:
-    name: elastic+enterprise-search-ruby+7.15
-    display-name: 'elastic / enterprise-search-ruby # 7.15'
-    description: Testing the enterprise-search-ruby 7.15 branch.
+    name: elastic+enterprise-search-ruby+7.17
+    display-name: 'elastic / enterprise-search-ruby # 7.17'
+    description: Testing the enterprise-search-ruby 7.17 branch.
     junit_results: "*-junit.xml"
     parameters:
     - string:
         name: branch_specifier
-        default: refs/heads/7.15
+        default: refs/heads/7.17
         description: the Git branch specifier to build (<branchName>, <tagName>,
           <commitId>, etc.)

data/.ci/jobs/{elastic+enterprise-search-ruby+7.16.yml → elastic+enterprise-search-ruby+8.0.yml}

@@ -1,12 +1,12 @@
 ---
 - job:
-    name: elastic+enterprise-search-ruby+7.16
-    display-name: 'elastic / enterprise-search-ruby # 7.16'
-    description: Testing the enterprise-search-ruby 7.16 branch.
+    name: elastic+enterprise-search-ruby+8.0
+    display-name: 'elastic / enterprise-search-ruby # 8.0'
+    description: Testing the enterprise-search-ruby 8.0 branch.
     junit_results: "*-junit.xml"
     parameters:
     - string:
         name: branch_specifier
-        default: refs/heads/7.16
+        default: refs/heads/8.0
         description: the Git branch specifier to build (<branchName>, <tagName>,
           <commitId>, etc.)

data/.ci/run-enterprise-search.sh

@@ -54,6 +54,7 @@ docker run \
   --env "elasticsearch.ssl.certificate=/usr/share/app-search/config/certs/testnode.crt" \
   --env "elasticsearch.ssl.certificate_authority=/usr/share/app-search/config/certs/ca.crt" \
   --env "elasticsearch.ssl.key=/usr/share/app-search/config/certs/testnode.key" \
+  --env "ELASTICSEARCH_SEARCH_API=true" \
   --volume $ssl_cert:/usr/share/app-search/config/certs/testnode.crt \
   --volume $ssl_key:/usr/share/app-search/config/certs/testnode.key \
   --volume $ssl_ca:/usr/share/app-search/config/certs/ca.crt \

data/.ci/test-matrix.yml

@@ -5,7 +5,7 @@ RUBY_VERSION:
   - 2.7
 
 STACK_VERSION:
-  - 8.1-SNAPSHOT
+  - 8.2.0-SNAPSHOT
 
 SERVICE:
   - appsearch

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

@@ -336,6 +336,27 @@ client.put_adaptive_relevance_settings(engine_name, body: body)
 client.refresh_adaptive_relevance_update_process(engine_name, adaptive_relevance_suggestion_type: 'curation')
 ----------------------------
 
+=== Elasticsearch Search
+
+Utilize the API to passthrough and execute raw Elasticsearch queries against the indices that power Enterprise Search engines.
+
+[source,rb]
+----------------------------
+es_request = { body: { query: { bool: { must: { term: { title: 'test' } } } } } }
+client.search_es_search(engine_name, body: { request: es_request })
+----------------------------
+
+=== Search Explain
+
+Submit a search and retrieve an Elasticsearch query.
+
+[source,rb]
+----------------------------
+response = client.search_explain(engine_name, body: { query: 'test' })
+response.body['query_string']
+# => "GET enterprise-search-engine-app-search-explain/_search"
+----------------------------
+
 === Other API Endpoints
 
 [source,rb]

data/docs/guide/release_notes/82.asciidoc

@@ -0,0 +1,31 @@
+[[release_notes_82]]
+=== 8.2.0 Release notes
+
+[discrete]
+==== General
+
+- Tested with Elastic Enterprise Search API version 8.2.0.
+- Tested with Ruby 2.7, 3.0, 3.1, JRuby 9.3. Older versions of Ruby have reached end of life and been removed from the testing matrices. Minimum required Ruby version is Ruby 2.6 to keep compatibility with JRuby 9.3, but it may be upgraded to 2.7 once JRuby 9.4 comes out.
+
+[discrete]
+==== App Search
+[discrete]
+==== New APIs
+
+* Adds Elasticsearch Search API (In Technical Preview): Utilize the API to passthrough and execute raw Elasticsearch queries against the indices that power Enterprise Search engines.
+
++
+[source,rb]
+----------------------------
+es_request = { body: { query: { bool: { must: { term: { title: 'test' } } } } } }
+client.search_es_search(engine_name, body: { request: es_request })
+----------------------------
+
+* Adds Search Explain API: Submit a search and retrieve an Elasticsearch query.
++
+[source,rb]
+----------------------------
+response = client.search_explain(engine_name, body: { query: 'test' })
+response.body['query_string']
+# => "GET enterprise-search-engine-app-search-explain/_search"
+----------------------------

data/docs/guide/release_notes/index.asciidoc

@@ -3,6 +3,8 @@
 
 [discrete]
 === 8.x
+
+* <<release_notes_82, 8.2.0 Release Notes>>
 * <<release_notes_81, 8.1.0 Release Notes>>
 * <<release_notes_80, 8.0.0 Release Notes>>
 
@@ -18,6 +20,7 @@
 * <<release_notes_711, 7.11.0 Release Notes>>
 * <<release_notes_710, 7.10.0.beta.1 Release Notes>>
 
+include::82.asciidoc[]
 include::81.asciidoc[]
 include::80.asciidoc[]
 include::717.asciidoc[]

data/elastic-enterprise-search.gemspec

@@ -47,7 +47,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'elastic-transport', '8.0.0.pre.1'
+  s.add_dependency 'elastic-transport', '8.0.0.pre.3'
   s.add_runtime_dependency 'jwt', '>= 1.5', '< 3.0'
   s.add_development_dependency 'awesome_print'
   s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION)

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

@@ -29,7 +29,7 @@ module Elastic
         # @option arguments [String] :search_suggestion_query Query to obtain suggestions (*Required*)
         # @option arguments [Hash] :body
         # @option body :page
-        # @option body [string] :filters
+        # @option body [Hash] :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

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

@@ -31,7 +31,7 @@ module Elastic
         # @option body [Array<string>] :queries List of affected search queries
         # @option body [Array<string>] :promoted List of promoted document IDs
         # @option body [Array<string>] :hidden List of hidden document IDs
-        # @option body [Hash] :suggestion
+        # @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

@@ -28,7 +28,7 @@ module Elastic
         # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :body
         # @option body :page
-        # @option body [string] :filters
+        # @option body [Hash] :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

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

@@ -27,7 +27,7 @@ module Elastic
         # @param [String] engine_name Name of the engine (*Required*)
         # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :body (Required: curation)
-        # @option body [Hash] :curation (Required: )
+        # @option body [Hash] :curation
         # @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

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

@@ -32,7 +32,7 @@ module Elastic
         # @option body [Array<string>] :queries List of affected search queries
         # @option body [Array<string>] :promoted List of promoted document IDs
         # @option body [Array<string>] :hidden List of hidden document IDs
-        # @option body [Hash] :suggestion
+        # @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/app-search/api/search_es_search.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
+        # ElasticsearchSearch - Run a search
+        # Execute the provided Elasticsearch search query against an App Search Engine
+        #
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Hash] :body (Required: request)
+        # @option body :request
+        # @option body :analytics
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/elasticsearch-search-api-reference.html
+        #
+        def search_es_search(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'body (request)' missing" unless arguments[:body]
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+          request(
+            :post,
+            "api/as/v0/engines/#{engine_name}/elasticsearch/_search/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# 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
+        # SearchExplain - Retrieve the search query
+        # Submit a search and retrieve an Elasticsearch query
+        #
+        # @param [String] engine_name Name of the engine (*Required*)
+        # @param [Hash] arguments endpoint arguments
+        # @option arguments [Hash] :body (Required: query)
+        # @option body [string] :query
+        # @option body :analytics
+        # @option body :boost
+        # @option body :facets
+        # @option body :filters
+        # @option body :group
+        # @option body :page
+        # @option body :result_fields
+        # @option body :search_fields
+        # @option body :sort
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/search-explain.html
+        #
+        def search_explain(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'body (query)' missing" unless arguments[:body]
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+          request(
+            :post,
+            "api/as/v0/engines/#{engine_name}/search_explain/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -26,7 +26,7 @@ module Elastic
       # @param [Hash] arguments endpoint arguments
       # @option arguments [Hash] :headers optional HTTP headers to send with the request
       #
-      # @see https://www.elastic.co/guide/en/enterprise-search/current/management-apis.html
+      # @see https://www.elastic.co/guide/en/enterprise-search/current/monitoring-apis.html#monitoring-apis-version-api
       #
       def version(arguments = {})
         headers = arguments.delete(:headers) || {}

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

@@ -19,6 +19,6 @@
 
 module Elastic
   module EnterpriseSearch
-    VERSION = '8.1.0'
+    VERSION = '8.2.0'
   end
 end

data/spec/integration/app-search/elasticsearch_search_spec.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.
+
+# frozen_string_literal: true
+
+require_relative "#{__dir__}/app_search_helper.rb"
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  context 'Elasticsearch Search' do
+    let(:engine_name) { 'elasticsearch-books' }
+    let(:documents) do
+      [
+        { title: 'Beasts Before Us', author: 'Elsa Panciroli' },
+        { title: 'The Rise and Fall of the Dinosaurs', author: 'Steve Brusatte' },
+        { title: 'Raptor Red', author: 'Robert T. Bakker' },
+        { title: 'The Earth: A biography of life', author: 'Dr. Elsa Panciroli' }
+      ]
+    end
+    let(:api_key_name) { 'my-api-key' }
+
+    before do
+      # Use API Key in client, save a backup to restore original auth:
+      @old_client = @client.dup
+      api_key_body = { name: api_key_name, type: 'private', read: true, write: true, access_all_engines: true }
+      response = client.create_api_key(body: api_key_body)
+      @client.http_auth = response.body['key']
+      create_engine(engine_name)
+      client.index_documents(engine_name, documents: documents)
+      sleep 1
+    end
+
+    after do
+      # Restore original client:
+      @client = @old_client
+      delete_engines
+      client.delete_api_key(api_key_name: api_key_name)
+    end
+
+    it 'performs an ES search' do
+      es_request = { body: { query: { bool: { must: { term: { author: 'panciroli' } } } } } }
+      response = client.search_es_search(engine_name, body: { request: es_request })
+      expect(response.status).to eq 200
+      expect(response.body['hits']['hits'].count).to eq 2
+      expect do
+        response.body['hits']['hits'].map { |a| a['_source']['author'] } == ['Elsa Panciroli', 'Dr. Elsa Panciroli']
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# 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 'Elasticsearch Search' do
+    let(:engine_name) { 'app-search-explain' }
+    let(:documents) do
+      [
+        { title: 'Beasts Before Us', author: 'Elsa Panciroli' },
+        { title: 'The Rise and Fall of the Dinosaurs', author: 'Steve Brusatte' },
+        { title: 'Raptor Red', author: 'Robert T. Bakker' },
+        { title: 'The Earth: A biography of life', author: 'Dr. Elsa Panciroli' }
+      ]
+    end
+    let(:api_key_name) { 'my-api-key' }
+
+    before do
+      # Use API Key in client, save a backup to restore original auth:
+      @old_client = @client.dup
+      api_key_body = { name: api_key_name, type: 'private', read: true, write: true, access_all_engines: true }
+      response = client.create_api_key(body: api_key_body)
+      @client.http_auth = response.body['key']
+      create_engine(engine_name)
+      client.index_documents(engine_name, documents: documents)
+      sleep 1
+    end
+
+    after do
+      # Restore original client:
+      @client = @old_client
+      delete_engines
+      client.delete_api_key(api_key_name: api_key_name)
+    end
+
+    it 'explains a Search query' do
+      response = client.search_explain(engine_name, body: { query: 'Raptor Red' })
+      expect(response.status).to eq 200
+      expect(response.body['query_string']).to eq 'GET enterprise-search-engine-app-search-explain/_search'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastic-enterprise-search
 version: !ruby/object:Gem::Version
-  version: 8.1.0
+  version: 8.2.0
 platform: ruby
 authors:
 - Fernando Briano
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.0.0.pre.1
+        version: 8.0.0.pre.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 8.0.0.pre.1
+        version: 8.0.0.pre.3
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -164,8 +164,8 @@ files:
 - ".ci/functions/imports.sh"
 - ".ci/functions/wait-for-container.sh"
 - ".ci/jobs/defaults.yml"
-- ".ci/jobs/elastic+enterprise-search-ruby+7.15.yml"
-- ".ci/jobs/elastic+enterprise-search-ruby+7.16.yml"
+- ".ci/jobs/elastic+enterprise-search-ruby+7.17.yml"
+- ".ci/jobs/elastic+enterprise-search-ruby+8.0.yml"
 - ".ci/jobs/elastic+enterprise-search-ruby+main.yml"
 - ".ci/jobs/elastic+enterprise-search-ruby+pull-request.yml"
 - ".ci/make.sh"
@@ -207,6 +207,7 @@ files:
 - docs/guide/release_notes/717.asciidoc
 - docs/guide/release_notes/80.asciidoc
 - docs/guide/release_notes/81.asciidoc
+- docs/guide/release_notes/82.asciidoc
 - docs/guide/release_notes/index.asciidoc
 - docs/guide/workplace-search-api.asciidoc
 - elastic-enterprise-search.gemspec
@@ -290,6 +291,8 @@ files:
 - lib/elastic/app-search/api/reset_search_settings.rb
 - lib/elastic/app-search/api/schema.rb
 - lib/elastic/app-search/api/search.rb
+- lib/elastic/app-search/api/search_es_search.rb
+- lib/elastic/app-search/api/search_explain.rb
 - lib/elastic/app-search/api/search_settings.rb
 - lib/elastic/app-search/api/synonym_set.rb
 - lib/elastic/app-search/api/top_clicks_analytics.rb
@@ -366,7 +369,9 @@ files:
 - spec/integration/app-search/crawler_user_agent_spec.rb
 - spec/integration/app-search/curations_spec.rb
 - spec/integration/app-search/documents_spec.rb
+- spec/integration/app-search/elasticsearch_search_spec.rb
 - spec/integration/app-search/engines_spec.rb
+- spec/integration/app-search/explain_search_spec.rb
 - spec/integration/app-search/log_clickthrough_spec.rb
 - spec/integration/app-search/meta_engines_spec.rb
 - spec/integration/app-search/query_suggestion_spec.rb